Skip to content

CognitoStreams

Used by
Source code in docs_src/capo_cognito_sync/types/cognito_streams.py 
13
14
15
16
17
18
19
20
21
class CognitoStreams(TypedDict, closed=True):
    stream_name: NotRequired["capo_cognito_sync.types.stream_name.StreamName"]
    """The name of the Cognito stream to receive updates. This stream must be in the developers account and in the same region as the identity pool."""
    role_arn: NotRequired["capo_cognito_sync.types.assume_role_arn.AssumeRoleArn"]
    """The ARN of the role Amazon Cognito can assume in order to publish to the stream. This role must grant access to Amazon Cognito (cognito-sync) to invoke PutRecord on your Cognito stream."""
    streaming_status: NotRequired[
        "capo_cognito_sync.types.streaming_status.StreamingStatus"
    ]
    """Status of the Cognito streams. Valid values are: <p>ENABLED - Streaming of updates to identity pool is enabled.</p> <p>DISABLED - Streaming of updates to identity pool is disabled. Bulk publish will also fail if StreamingStatus is DISABLED.</p>"""

role_arn instance-attribute 

role_arn: NotRequired[AssumeRoleArn]

The ARN of the role Amazon Cognito can assume in order to publish to the stream. This role must grant access to Amazon Cognito (cognito-sync) to invoke PutRecord on your Cognito stream.

stream_name instance-attribute 

stream_name: NotRequired[StreamName]

The name of the Cognito stream to receive updates. This stream must be in the developers account and in the same region as the identity pool.

streaming_status instance-attribute 

streaming_status: NotRequired[StreamingStatus]

Status of the Cognito streams. Valid values are:

ENABLED - Streaming of updates to identity pool is enabled.

DISABLED - Streaming of updates to identity pool is disabled. Bulk publish will also fail if StreamingStatus is DISABLED.