Pinpoint / Client / update_adm_channel

update_adm_channel#

Pinpoint.Client.update_adm_channel(**kwargs)#

Enables the ADM channel for an application or updates the status and settings of the ADM channel for an application.

See also: AWS API Documentation

Request Syntax

response = client.update_adm_channel(
    ADMChannelRequest={
        'ClientId': 'string',
        'ClientSecret': 'string',
        'Enabled': True|False
    },
    ApplicationId='string'
)
Parameters:

  • ADMChannelRequest (dict) –

    [REQUIRED]

    Specifies the status and settings of the ADM (Amazon Device Messaging) channel for an application.

    • ClientId (string) – [REQUIRED]

      The Client ID that you received from Amazon to send messages by using ADM.

    • ClientSecret (string) – [REQUIRED]

      The Client Secret that you received from Amazon to send messages by using ADM.

    • Enabled (boolean) –

      Specifies whether to enable the ADM channel for the application.

  • 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

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

Response Structure

  • (dict) –

    The request succeeded.

    • ADMChannelResponse (dict) –

      Provides information about the status and settings of the ADM (Amazon Device Messaging) channel for an application.

      • ApplicationId (string) –

        The unique identifier for the application that the ADM channel applies to.

      • CreationDate (string) –

        The date and time when the ADM channel was enabled.

      • Enabled (boolean) –

        Specifies whether the ADM channel is enabled for the application.

      • HasCredential (boolean) –

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

      • Id (string) –

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

      • IsArchived (boolean) –

        Specifies whether the ADM channel is archived.

      • LastModifiedBy (string) –

        The user who last modified the ADM channel.

      • LastModifiedDate (string) –

        The date and time when the ADM channel was last modified.

      • Platform (string) –

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

      • Version (integer) –

        The current version of the ADM channel.

Exceptions