AppSync / Client / list_channel_namespaces

list_channel_namespaces#

AppSync.Client.list_channel_namespaces(**kwargs)#

Lists the channel namespaces for a specified Api.

ListChannelNamespaces returns only high level details for the channel namespace. To retrieve code handlers, use GetChannelNamespace.

See also: AWS API Documentation

Request Syntax

response = client.list_channel_namespaces(
    apiId='string',
    nextToken='string',
    maxResults=123
)
Parameters:

  • apiId (string) –

    [REQUIRED]

    The Api ID.

  • nextToken (string) – An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.

  • maxResults (integer) – The maximum number of results that you want the request to return.

Return type:

dict

Returns:

Response Syntax

{
    'channelNamespaces': [
        {
            'apiId': 'string',
            'name': 'string',
            'subscribeAuthModes': [
                {
                    'authType': 'API_KEY'|'AWS_IAM'|'AMAZON_COGNITO_USER_POOLS'|'OPENID_CONNECT'|'AWS_LAMBDA'
                },
            ],
            'publishAuthModes': [
                {
                    'authType': 'API_KEY'|'AWS_IAM'|'AMAZON_COGNITO_USER_POOLS'|'OPENID_CONNECT'|'AWS_LAMBDA'
                },
            ],
            'codeHandlers': 'string',
            'tags': {
                'string': 'string'
            },
            'channelNamespaceArn': 'string',
            'created': datetime(2015, 1, 1),
            'lastModified': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • channelNamespaces (list) –

      The ChannelNamespace objects.

      • (dict) –

        Describes a channel namespace associated with an Api. The ChannelNamespace contains the definitions for code handlers for the Api.

        • apiId (string) –

          The Api ID.

        • name (string) –

          The name of the channel namespace. This name must be unique within the Api.

        • subscribeAuthModes (list) –

          The authorization mode to use for subscribing to messages on the channel namespace. This configuration overrides the default ``Api``authorization configuration.

          • (dict) –

            Describes an authorization configuration. Use AuthMode to specify the publishing and subscription authorization configuration for an Event API.

            • authType (string) –

              The authorization type.

        • publishAuthModes (list) –

          The authorization mode to use for publishing messages on the channel namespace. This configuration overrides the default ``Api``authorization configuration.

          • (dict) –

            Describes an authorization configuration. Use AuthMode to specify the publishing and subscription authorization configuration for an Event API.

            • authType (string) –

              The authorization type.

        • codeHandlers (string) –

          The event handler functions that run custom business logic to process published events and subscribe requests.

        • tags (dict) –

          A map with keys of TagKey objects and values of TagValue objects.

          • (string) –

            The key for the tag.

            • (string) –

              The value for the tag.

        • channelNamespaceArn (string) –

          The Amazon Resource Name (ARN) for the ChannelNamespace.

        • created (datetime) –

          The date and time that the ChannelNamespace was created.

        • lastModified (datetime) –

          The date and time that the ChannelNamespace was last changed.

    • nextToken (string) –

      An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.

Exceptions