IoT / Client / update_stream

update_stream#

IoT.Client.update_stream(**kwargs)#

Updates an existing stream. The stream version will be incremented by one.

Requires permission to access the UpdateStream action.

See also: AWS API Documentation

Request Syntax

response = client.update_stream(
    streamId='string',
    description='string',
    files=[
        {
            'fileId': 123,
            's3Location': {
                'bucket': 'string',
                'key': 'string',
                'version': 'string'
            }
        },
    ],
    roleArn='string'
)
Parameters:

  • streamId (string) –

    [REQUIRED]

    The stream ID.

  • description (string) – The description of the stream.

  • files (list) –

    The files associated with the stream.

    • (dict) –

      Represents a file to stream.

      • fileId (integer) –

        The file ID.

      • s3Location (dict) –

        The location of the file in S3.

        • bucket (string) –

          The S3 bucket.

        • key (string) –

          The S3 key.

        • version (string) –

          The S3 bucket version.

  • roleArn (string) – An IAM role that allows the IoT service principal assumes to access your S3 files.

Return type:

dict

Returns:

Response Syntax

{
    'streamId': 'string',
    'streamArn': 'string',
    'description': 'string',
    'streamVersion': 123
}

Response Structure

  • (dict) –

    • streamId (string) –

      The stream ID.

    • streamArn (string) –

      The stream ARN.

    • description (string) –

      A description of the stream.

    • streamVersion (integer) –

      The stream version.

Exceptions