Skip to content

DescribeApiDestinationResponse

Source code in docs_src/capo_cloudwatch_events/types/describe_api_destination_response.py
class DescribeApiDestinationResponse(TypedDict, closed=True):
    api_destination_arn: NotRequired[
        "capo_cloudwatch_events.types.api_destination_arn.ApiDestinationArn"
    ]
    """<p>The ARN of the API destination retrieved.</p>"""
    name: NotRequired[
        "capo_cloudwatch_events.types.api_destination_name.ApiDestinationName"
    ]
    """<p>The name of the API destination retrieved.</p>"""
    description: NotRequired[
        "capo_cloudwatch_events.types.api_destination_description.ApiDestinationDescription"
    ]
    """<p>The description for the API destination retrieved.</p>"""
    api_destination_state: NotRequired[
        "capo_cloudwatch_events.types.api_destination_state.ApiDestinationState"
    ]
    """<p>The state of the API destination retrieved.</p>"""
    connection_arn: NotRequired[
        "capo_cloudwatch_events.types.connection_arn.ConnectionArn"
    ]
    """<p>The ARN of the connection specified for the API destination retrieved.</p>"""
    invocation_endpoint: NotRequired[
        "capo_cloudwatch_events.types.https_endpoint.HttpsEndpoint"
    ]
    """<p>The URL to use to connect to the HTTP endpoint.</p>"""
    http_method: NotRequired[
        "capo_cloudwatch_events.types.api_destination_http_method.ApiDestinationHttpMethod"
    ]
    """<p>The method to use to connect to the HTTP endpoint.</p>"""
    invocation_rate_limit_per_second: NotRequired[
        "capo_cloudwatch_events.types.api_destination_invocation_rate_limit_per_second.ApiDestinationInvocationRateLimitPerSecond"
    ]
    """<p>The maximum number of invocations per second to specified for the API destination. Note that if you set the invocation rate maximum to a value lower the rate necessary to send all events received on to the destination HTTP endpoint, some events may not be delivered within the 24-hour retry window. If you plan to set the rate lower than the rate necessary to deliver all events, consider using a dead-letter queue to catch events that are not delivered within 24 hours.</p>"""
    creation_time: NotRequired["capo_cloudwatch_events.types.timestamp.Timestamp"]
    """<p>A time stamp for the time that the API destination was created.</p>"""
    last_modified_time: NotRequired["capo_cloudwatch_events.types.timestamp.Timestamp"]
    """<p>A time stamp for the time that the API destination was last modified.</p>"""

api_destination_arn instance-attribute

api_destination_arn: NotRequired[ApiDestinationArn]

The ARN of the API destination retrieved.

api_destination_state instance-attribute

api_destination_state: NotRequired[ApiDestinationState]

The state of the API destination retrieved.

connection_arn instance-attribute

connection_arn: NotRequired[ConnectionArn]

The ARN of the connection specified for the API destination retrieved.

creation_time instance-attribute

creation_time: NotRequired[Timestamp]

A time stamp for the time that the API destination was created.

description instance-attribute

description: NotRequired[ApiDestinationDescription]

The description for the API destination retrieved.

http_method instance-attribute

http_method: NotRequired[ApiDestinationHttpMethod]

The method to use to connect to the HTTP endpoint.

invocation_endpoint instance-attribute

invocation_endpoint: NotRequired[HttpsEndpoint]

The URL to use to connect to the HTTP endpoint.

invocation_rate_limit_per_second instance-attribute

invocation_rate_limit_per_second: NotRequired[
    ApiDestinationInvocationRateLimitPerSecond
]

The maximum number of invocations per second to specified for the API destination. Note that if you set the invocation rate maximum to a value lower the rate necessary to send all events received on to the destination HTTP endpoint, some events may not be delivered within the 24-hour retry window. If you plan to set the rate lower than the rate necessary to deliver all events, consider using a dead-letter queue to catch events that are not delivered within 24 hours.

last_modified_time instance-attribute

last_modified_time: NotRequired[Timestamp]

A time stamp for the time that the API destination was last modified.

name instance-attribute

name: NotRequired[ApiDestinationName]

The name of the API destination retrieved.