v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1456332247.5 KB

Creates a connection. A connection defines the authorization type and credentials to use for authorization with an API destination HTTP endpoint.

post/#X-Amz-Target=AWSEvents.CreateConnection

Headers

X-Amz-Target'AWSEvents.CreateConnection' required

Request body

Namestring required

The name for the connection to create.

Descriptionstring

A description for the connection to create.

AuthorizationType'BASIC' | 'OAUTH_CLIENT_CREDENTIALS' | 'API_KEY' required
<p>The type of authorization to use for the connection.</p> <note> <p>OAUTH tokens are refreshed when a 401 or 407 response is returned.</p> </note>

Response

Success

ConnectionArnstring

The ARN of the connection that was created by the request.

ConnectionState'CREATING' | 'UPDATING' | 'DELETING' | 'AUTHORIZED' | 'DEAUTHORIZED' | 'AUTHORIZING' | 'DEAUTHORIZING'

The state of the connection that was created by the request.

CreationTimestring date-time

A time stamp for the time that the connection was created.

LastModifiedTimestring date-time

A time stamp for the time that the connection was last updated.