SSM / Client / list_cloud_connectors

list_cloud_connectors¶

SSM.Client.list_cloud_connectors(**kwargs)¶

Returns a list of cloud connectors in the current Amazon Web Services account and Amazon Web Services Region.

Request Syntax

response = client.list_cloud_connectors(
    MaxResults=123,
    NextToken='string',
    Filters=[
        {
            'FilterKey': 'SubscriptionId'|'TenantId',
            'FilterValues': [
                'string',
            ]
        },
    ]
)

Parameters:

MaxResults (integer) – The maximum number of items to return for this call.
NextToken (string) – The token for the next set of items to return. (You received this token from a previous call.)
Filters (list) –
One or more filters to limit the cloud connectors returned in the response.
- (dict) –
  
  A filter for listing cloud connectors.
  - FilterKey (string) –
    
    The name of the filter key.
  - FilterValues (list) –
    
    The filter values. Valid values for each filter key are as follows:
    
    SubscriptionId
    
    The Azure subscription ID to filter by. To return only tenant-level connectors, specify NONE.
    
    TenantId
    
    The Azure tenant ID to filter by. Filters the results to connectors that target the specified tenant.
    - (string) –

Return type:

dict

Returns:

Response Syntax

{
    'CloudConnectors': [
        {
            'CloudConnectorId': 'string',
            'DisplayName': 'string',
            'Description': 'string',
            'RoleArn': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- CloudConnectors (list) –
  
  A list of cloud connector summary objects.
  - (dict) –
    
    Summary information about a cloud connector.
    - CloudConnectorId (string) –
      
      The ID of the cloud connector.
    - DisplayName (string) –
      
      The friendly name of the cloud connector.
    - Description (string) –
      
      The description of the cloud connector.
    - RoleArn (string) –
      
      The ARN of the IAM role used by the cloud connector.
    - CreatedAt (datetime) –
      
      The date and time the cloud connector was created.
    - UpdatedAt (datetime) –
      
      The date and time the cloud connector was last updated.
- NextToken (string) –
  
  The token to use when requesting the next set of items.

Exceptions

SSM.Client.exceptions.InternalServerError