EventBridge / Client / list_connections

list_connections#

EventBridge.Client.list_connections(**kwargs)#

Retrieves a list of connections from the account.

See also: AWS API Documentation

Request Syntax

response = client.list_connections(
    NamePrefix='string',
    ConnectionState='CREATING'|'UPDATING'|'DELETING'|'AUTHORIZED'|'DEAUTHORIZED'|'AUTHORIZING'|'DEAUTHORIZING'|'ACTIVE'|'FAILED_CONNECTIVITY',
    NextToken='string',
    Limit=123
)
Parameters:

  • NamePrefix (string) – A name prefix to filter results returned. Only connections with a name that starts with the prefix are returned.

  • ConnectionState (string) – The state of the connection.

  • NextToken (string) –

    The token returned by a previous call, which you can use to retrieve the next set of results.

    The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.

    Using an expired pagination token results in an HTTP 400 InvalidToken error.

  • Limit (integer) – The maximum number of connections to return.

Return type:

dict

Returns:

Response Syntax

{
    'Connections': [
        {
            'ConnectionArn': 'string',
            'Name': 'string',
            'ConnectionState': 'CREATING'|'UPDATING'|'DELETING'|'AUTHORIZED'|'DEAUTHORIZED'|'AUTHORIZING'|'DEAUTHORIZING'|'ACTIVE'|'FAILED_CONNECTIVITY',
            'StateReason': 'string',
            'AuthorizationType': 'BASIC'|'OAUTH_CLIENT_CREDENTIALS'|'API_KEY',
            'CreationTime': datetime(2015, 1, 1),
            'LastModifiedTime': datetime(2015, 1, 1),
            'LastAuthorizedTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Connections (list) –

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

      • (dict) –

        Contains information about a connection.

        • ConnectionArn (string) –

          The ARN of the connection.

        • Name (string) –

          The name of the connection.

        • ConnectionState (string) –

          The state of the connection.

        • StateReason (string) –

          The reason that the connection is in the connection state.

        • AuthorizationType (string) –

          The authorization type specified for the connection.

          Note

          OAUTH tokens are refreshed when a 401 or 407 response is returned.

        • CreationTime (datetime) –

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

        • LastModifiedTime (datetime) –

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

        • LastAuthorizedTime (datetime) –

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

    • NextToken (string) –

      A token indicating there are more results available. If there are no more results, no token is included in the response.

      The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.

      Using an expired pagination token results in an HTTP 400 InvalidToken error.

Exceptions