ChimeSDKMessaging / Client / put_messaging_streaming_configurations

put_messaging_streaming_configurations

ChimeSDKMessaging.Client.put_messaging_streaming_configurations(**kwargs)

Sets 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.put_messaging_streaming_configurations(
    AppInstanceArn='string',
    StreamingConfigurations=[
        {
            'DataType': 'Channel'|'ChannelMessage',
            'ResourceArn': 'string'
        },
    ]
)

Parameters:

• AppInstanceArn (string) –

  [REQUIRED]

  The ARN of the streaming configuration.

• StreamingConfigurations (list) –

  [REQUIRED]

  The streaming configurations.

  • (dict) –

    The configuration for connecting a messaging stream to Amazon Kinesis.

    • DataType (string) – [REQUIRED]

      The data type of the configuration.

    • ResourceArn (string) – [REQUIRED]

      The ARN of the resource in the configuration.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

• (dict) –

  • StreamingConfigurations (list) –

    The requested streaming configurations.

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

• ChimeSDKMessaging.Client.exceptions.BadRequestException

• ChimeSDKMessaging.Client.exceptions.ForbiddenException

• ChimeSDKMessaging.Client.exceptions.UnauthorizedClientException

• ChimeSDKMessaging.Client.exceptions.ThrottledClientException

• ChimeSDKMessaging.Client.exceptions.ConflictException

• ChimeSDKMessaging.Client.exceptions.ServiceUnavailableException

• ChimeSDKMessaging.Client.exceptions.ServiceFailureException