AuroraDSQL / Client / get_stream

get_stream

AuroraDSQL.Client.get_stream(**kwargs)

Retrieves information about a stream.

See also: AWS API Documentation

Request Syntax

response = client.get_stream(
    clusterIdentifier='string',
    streamIdentifier='string'
)

Parameters:

• clusterIdentifier (string) –

  [REQUIRED]

  The ID of the cluster containing the stream to retrieve.

• streamIdentifier (string) –

  [REQUIRED]

  The ID of the stream to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'clusterIdentifier': 'string',
    'streamIdentifier': 'string',
    'arn': 'string',
    'status': 'CREATING'|'ACTIVE'|'DELETING'|'DELETED'|'FAILED'|'IMPAIRED',
    'creationTime': datetime(2015, 1, 1),
    'ordering': 'UNORDERED',
    'format': 'JSON',
    'targetDefinition': {
        'kinesis': {
            'streamArn': 'string',
            'roleArn': 'string'
        }
    },
    'statusReason': {
        'error': 'KINESIS_THROUGHPUT_EXCEEDED'|'KINESIS_STREAM_NOT_FOUND'|'ROLE_ACCESS_DENIED'|'KINESIS_ACCESS_DENIED'|'KINESIS_KMS_ACCESS_DENIED'|'KINESIS_OVERSIZE_RECORD'|'CLUSTER_CMK_INACCESSIBLE'|'INTERNAL_ERROR',
        'updatedAt': datetime(2015, 1, 1)
    },
    'tags': {
        'string': 'string'
    }
}

Response Structure

• (dict) –

  The output of a retrieved stream.

  • clusterIdentifier (string) –

    The ID of the cluster for the retrieved stream.

  • streamIdentifier (string) –

    The ID of the retrieved stream.

  • arn (string) –

    The ARN of the retrieved stream.

  • status (string) –

    The current status of the retrieved stream.

  • creationTime (datetime) –

    The time when the stream was created.

  • ordering (string) –

    The ordering mode of the stream.

  • format (string) –

    The format of the stream records.

  • targetDefinition (dict) –

    The target definition for the stream destination.

    Note

    This is a Tagged Union structure. Only one of the following top level keys will be set: kinesis. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

    'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
    

    • kinesis (dict) –

      Kinesis stream target configuration.

      • streamArn (string) –

        The ARN of the Kinesis stream.

      • roleArn (string) –

        The ARN of the IAM role that grants permission to write to the Kinesis stream. This can be a standard role ( arn:aws:iam::account-id:role/role-name) or a role with a path prefix ( arn:aws:iam::account-id:role/service-role/role-name), such as roles auto-created by the console.

  • statusReason (dict) –

    Stream status reason with error code and timestamp (if applicable).

    • error (string) –

      The error code for the stream failure.

    • updatedAt (datetime) –

      The timestamp when the status was updated.

  • tags (dict) –

    A map of tags associated with the stream.

    • (string) –

      Unique tag key, maximum 128 Unicode characters in UTF-8.

      • (string) –

        Tag value, maximum 256 Unicode characters in UTF-8.

Exceptions

• AuroraDSQL.Client.exceptions.ThrottlingException

• AuroraDSQL.Client.exceptions.AccessDeniedException

• AuroraDSQL.Client.exceptions.ValidationException

• AuroraDSQL.Client.exceptions.InternalServerException

• AuroraDSQL.Client.exceptions.ResourceNotFoundException