Chime / Client / put_app_instance_streaming_configurations

put_app_instance_streaming_configurations#

Chime.Client.put_app_instance_streaming_configurations(**kwargs)#

The data streaming configurations of an AppInstance.

Warning

This API is is no longer supported and will not be updated. We recommend using the latest version, PutMessagingStreamingConfigurations, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Danger

This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.

See also: AWS API Documentation

Request Syntax

response = client.put_app_instance_streaming_configurations(
    AppInstanceArn='string',
    AppInstanceStreamingConfigurations=[
        {
            'AppInstanceDataType': 'Channel'|'ChannelMessage',
            'ResourceArn': 'string'
        },
    ]
)
Parameters:

  • AppInstanceArn (string) –

    [REQUIRED]

    The ARN of the AppInstance.

  • AppInstanceStreamingConfigurations (list) –

    [REQUIRED]

    The streaming configurations set for an AppInstance.

    • (dict) –

      The details of the streaming configuration of an AppInstance.

      • AppInstanceDataType (string) – [REQUIRED]

        The type of data to be streamed.

      • ResourceArn (string) – [REQUIRED]

        The resource ARN.

Return type:

dict

Returns:

Response Syntax

{
    'AppInstanceStreamingConfigurations': [
        {
            'AppInstanceDataType': 'Channel'|'ChannelMessage',
            'ResourceArn': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • AppInstanceStreamingConfigurations (list) –

      The streaming configurations of an AppInstance.

      • (dict) –

        The details of the streaming configuration of an AppInstance.

        • AppInstanceDataType (string) –

          The type of data to be streamed.

        • ResourceArn (string) –

          The resource ARN.

Exceptions

  • Chime.Client.exceptions.NotFoundException

  • Chime.Client.exceptions.BadRequestException

  • Chime.Client.exceptions.ForbiddenException

  • Chime.Client.exceptions.UnauthorizedClientException

  • Chime.Client.exceptions.ThrottledClientException

  • Chime.Client.exceptions.ServiceUnavailableException

  • Chime.Client.exceptions.ServiceFailureException