Pinpoint / Client / get_channels

get_channels

Pinpoint.Client.get_channels(**kwargs)

Retrieves information about the history and status of each channel for an application.

See also: AWS API Documentation

Request Syntax

response = client.get_channels(
    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

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

Response Structure

• (dict) –

  The request succeeded.

  • ChannelsResponse (dict) –

    Provides information about the general settings and status of all channels for an application, including channels that aren’t enabled for the application.

    • Channels (dict) –

      A map that contains a multipart response for each channel. For each item in this object, the ChannelType is the key and the Channel is the value.

      • (string) –

        • (dict) –

          Provides information about the general settings and status of a channel for an application.

          • ApplicationId (string) –

            The unique identifier for the application.

          • CreationDate (string) –

            The date and time, in ISO 8601 format, when the channel was enabled.

          • Enabled (boolean) –

            Specifies whether the 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 channel. This property is retained only for backward compatibility.

          • IsArchived (boolean) –

            Specifies whether the channel is archived.

          • LastModifiedBy (string) –

            The user who last modified the channel.

          • LastModifiedDate (string) –

            The date and time, in ISO 8601 format, when the channel was last modified.

          • Version (integer) –

            The current version of the 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