EventBridge / Client / list_connections

list_connections#

EventBridge.Client.list_connections(**kwargs)#

Retrieves a list of connections from the account.

Request Syntax

response = client.list_connections(
    NamePrefix='string',
    ConnectionState='CREATING'|'UPDATING'|'DELETING'|'AUTHORIZED'|'DEAUTHORIZED'|'AUTHORIZING'|'DEAUTHORIZING',
    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 to retrieve the next set of results.
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',
            '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 you can use in a subsequent request to retrieve the next set of results.

Exceptions

EventBridge.Client.exceptions.InternalException