Skip to content

ApiDestination

Source code in docs_src/capo_eventbridge/types/api_destination.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
class ApiDestination(TypedDict, closed=True):
    api_destination_arn: NotRequired[
        "capo_eventbridge.types.api_destination_arn.ApiDestinationArn"
    ]
    """<p>The ARN of the API destination.</p>"""
    name: NotRequired["capo_eventbridge.types.api_destination_name.ApiDestinationName"]
    """<p>The name of the API destination.</p>"""
    api_destination_state: NotRequired[
        "capo_eventbridge.types.api_destination_state.ApiDestinationState"
    ]
    """<p>The state of the API destination.</p>"""
    connection_arn: NotRequired["capo_eventbridge.types.connection_arn.ConnectionArn"]
    """<p>The ARN of the connection specified for the API destination.</p>"""
    invocation_endpoint: NotRequired[
        "capo_eventbridge.types.https_endpoint.HttpsEndpoint"
    ]
    """<p>The URL to the endpoint for the API destination.</p>"""
    http_method: NotRequired[
        "capo_eventbridge.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_eventbridge.types.api_destination_invocation_rate_limit_per_second.ApiDestinationInvocationRateLimitPerSecond"
    ]
    """<p>The maximum number of invocations per second to send to the HTTP endpoint.</p>"""
    creation_time: NotRequired["capo_eventbridge.types.timestamp.Timestamp"]
    """<p>A time stamp for the time that the API destination was created.</p>"""
    last_modified_time: NotRequired["capo_eventbridge.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.

api_destination_state instance-attribute 

api_destination_state: NotRequired[ApiDestinationState]

The state of the API destination.

connection_arn instance-attribute 

connection_arn: NotRequired[ConnectionArn]

The ARN of the connection specified for the API destination.

creation_time instance-attribute 

creation_time: NotRequired[Timestamp]

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

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 the endpoint for the API destination.

invocation_rate_limit_per_second instance-attribute 

invocation_rate_limit_per_second: NotRequired[
    ApiDestinationInvocationRateLimitPerSecond
]

The maximum number of invocations per second to send to the HTTP endpoint.

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.