Pinpoint / Client / put_event_stream

put_event_stream#

Pinpoint.Client.put_event_stream(**kwargs)#

Creates a new event stream for an application or updates the settings of an existing event stream for an application.

See also: AWS API Documentation

Request Syntax

response = client.put_event_stream(
    ApplicationId='string',
    WriteEventStream={
        'DestinationStreamArn': 'string',
        'RoleArn': 'string'
    }
)
Parameters:

  • ApplicationId (string) –

    [REQUIRED]

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

  • WriteEventStream (dict) –

    [REQUIRED]

    Specifies the Amazon Resource Name (ARN) of an event stream to publish events to and the AWS Identity and Access Management (IAM) role to use when publishing those events.

    • DestinationStreamArn (string) – [REQUIRED]

      The Amazon Resource Name (ARN) of the Amazon Kinesis data stream or Amazon Kinesis Data Firehose delivery stream that you want to publish event data to.

      For a Kinesis data stream, the ARN format is: arn:aws:kinesis:region:account-id:stream/stream_name

      For a Kinesis Data Firehose delivery stream, the ARN format is: arn:aws:firehose:region:account-id:deliverystream/stream_name

    • RoleArn (string) – [REQUIRED]

      The AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to publish event data to the stream in your AWS account.

Return type:

dict

Returns:

Response Syntax

{
    'EventStream': {
        'ApplicationId': 'string',
        'DestinationStreamArn': 'string',
        'ExternalId': 'string',
        'LastModifiedDate': 'string',
        'LastUpdatedBy': 'string',
        'RoleArn': 'string'
    }
}

Response Structure

  • (dict) –

    The request succeeded.

    • EventStream (dict) –

      Specifies settings for publishing event data to an Amazon Kinesis data stream or an Amazon Kinesis Data Firehose delivery stream.

      • ApplicationId (string) –

        The unique identifier for the application to publish event data for.

      • DestinationStreamArn (string) –

        The Amazon Resource Name (ARN) of the Amazon Kinesis data stream or Amazon Kinesis Data Firehose delivery stream to publish event data to.

        For a Kinesis data stream, the ARN format is: arn:aws:kinesis:region:account-id:stream/stream_name

        For a Kinesis Data Firehose delivery stream, the ARN format is: arn:aws:firehose:region:account-id:deliverystream/stream_name

      • ExternalId (string) –

        (Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when publishing event data, but we removed this requirement. We don’t recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.

      • LastModifiedDate (string) –

        The date, in ISO 8601 format, when the event stream was last modified.

      • LastUpdatedBy (string) –

        The IAM user who last modified the event stream.

      • RoleArn (string) –

        The AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to publish event data to the stream in your AWS account.

Exceptions

  • Pinpoint.Client.exceptions.BadRequestException

  • Pinpoint.Client.exceptions.InternalServerErrorException

  • Pinpoint.Client.exceptions.PayloadTooLargeException

  • Pinpoint.Client.exceptions.ForbiddenException

  • Pinpoint.Client.exceptions.NotFoundException

  • Pinpoint.Client.exceptions.MethodNotAllowedException

  • Pinpoint.Client.exceptions.TooManyRequestsException