Amazon Chime SDK Messaging

2023/03/21 - Amazon Chime SDK Messaging - 3 new api methods

Changes  Amazon Chime SDK messaging customers can now manage streaming configuration for messaging data for archival and analysis.

DeleteMessagingStreamingConfigurations (new) Link ¶

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

See also: AWS API Documentation

Request Syntax

client.delete_messaging_streaming_configurations(
    AppInstanceArn='string'
)
type AppInstanceArn

string

param AppInstanceArn

[REQUIRED]

The ARN of the streaming configurations being deleted.

returns

None

PutMessagingStreamingConfigurations (new) Link ¶

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

client.put_messaging_streaming_configurations(
    AppInstanceArn='string',
    StreamingConfigurations=[
        {
            'DataType': 'Channel'|'ChannelMessage',
            'ResourceArn': 'string'
        },
    ]
)
type AppInstanceArn

string

param AppInstanceArn

[REQUIRED]

The ARN of the streaming configuration.

type StreamingConfigurations

list

param StreamingConfigurations

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

rtype

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.

GetMessagingStreamingConfigurations (new) Link ¶

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

client.get_messaging_streaming_configurations(
    AppInstanceArn='string'
)
type AppInstanceArn

string

param AppInstanceArn

[REQUIRED]

The ARN of the streaming configurations.

rtype

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.