AppSync / Client / get_channel_namespace

get_channel_namespace#

AppSync.Client.get_channel_namespace(**kwargs)#

Retrieves the channel namespace for a specified Api.

See also: AWS API Documentation

Request Syntax

response = client.get_channel_namespace(
    apiId='string',
    name='string'
)
Parameters:

  • apiId (string) –

    [REQUIRED]

    The Api ID.

  • name (string) –

    [REQUIRED]

    The name of the ChannelNamespace.

Return type:

dict

Returns:

Response Syntax

{
    'channelNamespace': {
        '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)
    }
}

Response Structure

  • (dict) –

    • channelNamespace (dict) –

      The ChannelNamespace object.

      • 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.

Exceptions