A channel is a type of platform that you can deliver messages to. You can use the APNs sandbox channel to send push notification messages to the sandbox environment of the Apple Push Notification service
URI
(APNs). Before you can use Amazon Pinpoint to send notification messages to the APNs sandbox environment, you must enable the APNs sandbox channel for an Amazon Pinpoint application.
The APNs Sandbox Channel resource represents the status and authentication settings of the APNs sandbox channel for a specific application. You can use this resource to enable, retrieve information about, update, or disable (delete) the APNs sandbox channel for an application.
URI
/v1/apps/application-id/channels/apns_sandbox
HTTP methods
GET
Operation ID: GetApnsSandboxChannel
Retrieves information about the status and settings of the APNs sandbox channel for an application.
Path parameters
Name Type Required Description
application-id String True The unique identifier
for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
Header parameters
Name Type Required Description
accept String False Indicates which content
types, expressed as MIME types, the client understands.
Responses
Status code Response model Description
200 APNSSandboxChannelResponse (p. 38)The request succeeded.
400 MessageBody (p. 38) The request contains a syntax
error (BadRequestException).
403 MessageBody (p. 38) The request was denied
because access to the
specified resource is forbidden (ForbiddenException).
404 MessageBody (p. 38) The request failed because the
specified resource was not found (NotFoundException).
HTTP methods
Status code Response model Description
405 MessageBody (p. 38) The request failed because
the method is not allowed for the specified resource (MethodNotAllowedException).
413 MessageBody (p. 38) The request failed because
the payload for the body of the request is too large
(RequestEntityTooLargeException).
429 MessageBody (p. 38) The request failed because
too many requests were sent during a certain amount of time (TooManyRequestsException).
500 MessageBody (p. 38) The request failed due to
an unknown internal server error, exception, or failure (InternalServerErrorException).
PUT
Operation ID: UpdateApnsSandboxChannel
Enables the APNs sandbox channel for an application or updates the status and settings of the APNs sandbox channel for an application.
Path parameters
Name Type Required Description
application-id String True The unique identifier
for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
Header parameters
Name Type Required Description
accept String False Indicates which content
types, expressed as MIME types, the client understands.
Responses
Status code Response model Description
200 APNSSandboxChannelResponse (p. 38)The request succeeded.
HTTP methods
Status code Response model Description
400 MessageBody (p. 38) The request contains a syntax
error (BadRequestException).
403 MessageBody (p. 38) The request was denied
because access to the
specified resource is forbidden (ForbiddenException).
404 MessageBody (p. 38) The request failed because the
specified resource was not found (NotFoundException).
405 MessageBody (p. 38) The request failed because
the method is not allowed for the specified resource (MethodNotAllowedException).
413 MessageBody (p. 38) The request failed because
the payload for the body of the request is too large
(RequestEntityTooLargeException).
429 MessageBody (p. 38) The request failed because
too many requests were sent during a certain amount of time (TooManyRequestsException).
500 MessageBody (p. 38) The request failed due to
an unknown internal server error, exception, or failure (InternalServerErrorException).
DELETE
Operation ID: DeleteApnsSandboxChannel
Disables the APNs sandbox channel for an application and deletes any existing settings for the channel.
Path parameters
Name Type Required Description
application-id String True The unique identifier
for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
Header parameters
Name Type Required Description
accept String False Indicates which content
types, expressed as
HTTP methods
Name Type Required Description
MIME types, the client understands.
Responses
Status code Response model Description
200 APNSSandboxChannelResponse (p. 38)The request succeeded.
400 MessageBody (p. 38) The request contains a syntax
error (BadRequestException).
403 MessageBody (p. 38) The request was denied
because access to the
specified resource is forbidden (ForbiddenException).
404 MessageBody (p. 38) The request failed because the
specified resource was not found (NotFoundException).
405 MessageBody (p. 38) The request failed because
the method is not allowed for the specified resource (MethodNotAllowedException).
413 MessageBody (p. 38) The request failed because
the payload for the body of the request is too large
(RequestEntityTooLargeException).
429 MessageBody (p. 38) The request failed because
too many requests were sent during a certain amount of time (TooManyRequestsException).
500 MessageBody (p. 38) The request failed due to
an unknown internal server error, exception, or failure (InternalServerErrorException).
OPTIONS
Retrieves information about the communication requirements and options that are available for the APNs Sandbox Channel resource.
Path parameters
Name Type Required Description
application-id String True The unique identifier
for the application. This identifier is displayed as the Project ID on
Schemas
Name Type Required Description
the Amazon Pinpoint console.
Responses
Status code Response model Description
200 None The request succeeded.
Schemas
Request bodies
PUT schema
{ "Certificate": "string", "PrivateKey": "string", "Enabled": boolean, "TokenKeyId": "string", "TeamId": "string", "TokenKey": "string", "BundleId": "string",
"DefaultAuthenticationMethod": "string"
}
Response bodies
APNSSandboxChannelResponse schema
{ "ApplicationId": "string", "IsArchived": boolean, "Version": integer, "CreationDate": "string", "LastModifiedDate": "string", "LastModifiedBy": "string", "Id": "string",
"Enabled": boolean, "HasCredential": boolean, "Platform": "string", "HasTokenKey": boolean,
"DefaultAuthenticationMethod": "string"
}
MessageBody schema
{
"RequestID": "string", "Message": "string"
}
Properties
Properties
APNSSandboxChannelRequest
Specifies the status and settings of the APNs (Apple Push Notification service) sandbox channel for an application.
Certificate
The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using an APNs certificate.
Type: string Required: False
PrivateKey
The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with the APNs sandbox environment.
Type: string Required: False
Enabled
Specifies whether to enable the APNs sandbox channel for the application.
Type: boolean Required: False
TokenKeyId
The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using APNs tokens.
Type: string Required: False
TeamId
The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens.
Type: string Required: False
TokenKey
The authentication key to use for APNs tokens.
Type: string Required: False
Properties
BundleId
The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens.
Type: string Required: False
DefaultAuthenticationMethod
The default authentication method that you want Amazon Pinpoint to use when authenticating with the APNs sandbox environment, key or certificate.
Type: string Required: False
APNSSandboxChannelResponse
Provides information about the status and settings of the APNs (Apple Push Notification service) sandbox channel for an application.
ApplicationId
The unique identifier for the application that the APNs sandbox channel applies to.
Type: string Required: False
IsArchived
Specifies whether the APNs sandbox channel is archived.
Type: boolean Required: False
Version
The current version of the APNs sandbox channel.
Type: integer Required: False
CreationDate
The date and time when the APNs sandbox channel was enabled.
Type: string Required: False
LastModifiedDate
The date and time when the APNs sandbox channel was last modified.
Type: string
Properties
Required: False
LastModifiedBy
The user who last modified the APNs sandbox channel.
Type: string Required: False
Id
(Deprecated) An identifier for the APNs sandbox channel. This property is retained only for backward compatibility.
Type: string Required: False
Enabled
Specifies whether the APNs sandbox channel is enabled for the application.
Type: boolean Required: False
HasCredential
(Not used) This property is retained only for backward compatibility.
Type: boolean Required: False
Platform
The type of messaging or notification platform for the channel. For the APNs sandbox channel, this value is APNS_SANDBOX.
Type: string Required: True
HasTokenKey
Specifies whether the APNs sandbox channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.
Type: boolean Required: False
DefaultAuthenticationMethod
The default authentication method that Amazon Pinpoint uses to authenticate with the APNs sandbox environment for this channel, key or certificate.
Type: string
See also
Required: False
MessageBody
Provides information about an API request or response.
RequestID
The unique identifier for the request or response.
Type: string Required: False
Message
The message that's returned from the API.
Type: string Required: False
See also
For more information about using this API in one of the language-specific AWS SDKs and references, see the following:
GetApnsSandboxChannel
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
UpdateApnsSandboxChannel
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3