ListConnections - Amazon EventBridge
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

ListConnections

Retrieves a list of connections from the account.

Request Syntax

{ "ConnectionState": "string", "Limit": number, "NamePrefix": "string", "NextToken": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ConnectionState

The state of the connection.

Type: String

Valid Values: CREATING | UPDATING | DELETING | AUTHORIZED | DEAUTHORIZED | AUTHORIZING | DEAUTHORIZING

Required: No

Limit

The maximum number of connections to return.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NamePrefix

A name prefix to filter results returned. Only connections with a name that starts with the prefix are returned.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [\.\-_A-Za-z0-9]+

Required: No

NextToken

The token returned by a previous call to retrieve the next set of results.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

Response Syntax

{ "Connections": [ { "AuthorizationType": "string", "ConnectionArn": "string", "ConnectionState": "string", "CreationTime": number, "LastAuthorizedTime": number, "LastModifiedTime": number, "Name": "string", "StateReason": "string" } ], "NextToken": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Connections

An array of connections objects that include details about the connections.

Type: Array of Connection objects

NextToken

A token you can use in a subsequent request to retrieve the next set of results.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalException

This exception occurs due to unexpected causes.

HTTP Status Code: 500

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: