Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . events ]

create-api-destination

Description

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

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-api-destination
--name <value>
[--description <value>]
--connection-arn <value>
--invocation-endpoint <value>
--http-method <value>
[--invocation-rate-limit-per-second <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--name (string)

The name for the API destination to create.

--description (string)

A description for the API destination to create.

--connection-arn (string)

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

--invocation-endpoint (string)

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

--http-method (string)

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

Possible values:

  • POST
  • GET
  • HEAD
  • OPTIONS
  • PUT
  • PATCH
  • DELETE

--invocation-rate-limit-per-second (integer)

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

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 -> (timestamp)

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

LastModifiedTime -> (timestamp)

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