get_apns_sandbox_channel

get_apns_sandbox_channel(**kwargs)

Retrieves information about the status and settings of the APNs sandbox channel for an application.

See also: AWS API Documentation

Request Syntax

response = client.get_apns_sandbox_channel(
    ApplicationId='string'
)

Parameters

ApplicationId (string) --

[REQUIRED]

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

Return type

dict

Returns

Response Syntax

{
    'APNSSandboxChannelResponse': {
        'ApplicationId': 'string',
        'CreationDate': 'string',
        'DefaultAuthenticationMethod': 'string',
        'Enabled': True|False,
        'HasCredential': True|False,
        'HasTokenKey': True|False,
        'Id': 'string',
        'IsArchived': True|False,
        'LastModifiedBy': 'string',
        'LastModifiedDate': 'string',
        'Platform': 'string',
        'Version': 123
    }
}

Response Structure

• (dict) --

  The request succeeded.

  • APNSSandboxChannelResponse (dict) --

    Provides information about the status and settings of the APNs (Apple Push Notification service) sandbox channel for an application.

    • ApplicationId (string) --

      The unique identifier for the application that the APNs sandbox channel applies to.

    • CreationDate (string) --

      The date and time when the APNs sandbox channel was enabled.

    • DefaultAuthenticationMethod (string) --

      The default authentication method that Amazon Pinpoint uses to authenticate with the APNs sandbox environment for this channel, key or certificate.

    • Enabled (boolean) --

      Specifies whether the APNs sandbox channel is enabled for the application.

    • HasCredential (boolean) --

      (Not used) This property is retained only for backward compatibility.

    • HasTokenKey (boolean) --

      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.

    • Id (string) --

      (Deprecated) An identifier for the APNs sandbox channel. This property is retained only for backward compatibility.

    • IsArchived (boolean) --

      Specifies whether the APNs sandbox channel is archived.

    • LastModifiedBy (string) --

      The user who last modified the APNs sandbox channel.

    • LastModifiedDate (string) --

      The date and time when the APNs sandbox channel was last modified.

    • Platform (string) --

      The type of messaging or notification platform for the channel. For the APNs sandbox channel, this value is APNS_SANDBOX.

    • Version (integer) --

      The current version of the APNs sandbox channel.

Exceptions

• Pinpoint.Client.exceptions.BadRequestException
• Pinpoint.Client.exceptions.InternalServerErrorException
• Pinpoint.Client.exceptions.PayloadTooLargeException
• Pinpoint.Client.exceptions.ForbiddenException
• Pinpoint.Client.exceptions.NotFoundException
• Pinpoint.Client.exceptions.MethodNotAllowedException
• Pinpoint.Client.exceptions.TooManyRequestsException