EventBridge / Client / create_api_destination

create_api_destination#

EventBridge.Client.create_api_destination(**kwargs)#

Creates an API destination, which is an HTTP invocation endpoint configured as a target for events.

API destinations do not support private destinations, such as interface VPC endpoints.

For more information, see API destinations in the EventBridge User Guide.

See also: AWS API Documentation

Request Syntax

response = client.create_api_destination(
    Name='string',
    Description='string',
    ConnectionArn='string',
    InvocationEndpoint='string',
    HttpMethod='POST'|'GET'|'HEAD'|'OPTIONS'|'PUT'|'PATCH'|'DELETE',
    InvocationRateLimitPerSecond=123
)
Parameters:

  • Name (string) –

    [REQUIRED]

    The name for the API destination to create.

  • Description (string) – A description for the API destination to create.

  • ConnectionArn (string) –

    [REQUIRED]

    The ARN of the connection to use for the API destination. The destination endpoint must support the authorization type specified for the connection.

  • InvocationEndpoint (string) –

    [REQUIRED]

    The URL to the HTTP invocation endpoint for the API destination.

  • HttpMethod (string) –

    [REQUIRED]

    The method to use for the request to the HTTP invocation endpoint.

  • InvocationRateLimitPerSecond (integer) – The maximum number of requests per second to send to the HTTP invocation endpoint.

Return type:

dict

Returns:

Response Syntax

{
    'ApiDestinationArn': 'string',
    'ApiDestinationState': 'ACTIVE'|'INACTIVE',
    'CreationTime': datetime(2015, 1, 1),
    'LastModifiedTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    • ApiDestinationArn (string) –

      The ARN of the API destination that was created by the request.

    • ApiDestinationState (string) –

      The state of the API destination that was created by the request.

    • CreationTime (datetime) –

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

    • LastModifiedTime (datetime) –

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

Exceptions

  • EventBridge.Client.exceptions.ResourceAlreadyExistsException

  • EventBridge.Client.exceptions.ResourceNotFoundException

  • EventBridge.Client.exceptions.LimitExceededException

  • EventBridge.Client.exceptions.InternalException