ChimeSDKMessaging / Client / get_messaging_streaming_configurations

get_messaging_streaming_configurations#

ChimeSDKMessaging.Client.get_messaging_streaming_configurations(**kwargs)#

Retrieves the data streaming configuration for an AppInstance. For more information, see Streaming messaging data in the Amazon Chime SDK Developer Guide.

See also: AWS API Documentation

Request Syntax

response = client.get_messaging_streaming_configurations(
    AppInstanceArn='string'
)
Parameters:

AppInstanceArn (string) –

[REQUIRED]

The ARN of the streaming configurations.

Return type:

dict

Returns:

Response Syntax

{
    'StreamingConfigurations': [
        {
            'DataType': 'Channel'|'ChannelMessage',
            'ResourceArn': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • StreamingConfigurations (list) –

      The streaming settings.

      • (dict) –

        The configuration for connecting a messaging stream to Amazon Kinesis.

        • DataType (string) –

          The data type of the configuration.

        • ResourceArn (string) –

          The ARN of the resource in the configuration.

Exceptions

  • ChimeSDKMessaging.Client.exceptions.BadRequestException

  • ChimeSDKMessaging.Client.exceptions.ForbiddenException

  • ChimeSDKMessaging.Client.exceptions.NotFoundException

  • ChimeSDKMessaging.Client.exceptions.UnauthorizedClientException

  • ChimeSDKMessaging.Client.exceptions.ThrottledClientException

  • ChimeSDKMessaging.Client.exceptions.ServiceUnavailableException

  • ChimeSDKMessaging.Client.exceptions.ServiceFailureException