SSM / Client / get_cloud_connector

get_cloud_connector¶

SSM.Client.get_cloud_connector(**kwargs)¶

Returns detailed information about a cloud connector.

Request Syntax

response = client.get_cloud_connector(
    CloudConnectorId='string'
)

Parameters:

CloudConnectorId (string) –

[REQUIRED]

The ID of the cloud connector to retrieve information about.

Return type:

dict

Returns:

Response Syntax

{
    'CloudConnectorArn': 'string',
    'DisplayName': 'string',
    'Description': 'string',
    'RoleArn': 'string',
    'Configuration': {
        'AzureConfiguration': {
            'TenantId': 'string',
            'TenantDisplayName': 'string',
            'ApplicationId': 'string',
            'ApplicationDisplayName': 'string',
            'Targets': {
                'Subscriptions': [
                    {
                        'Id': 'string',
                        'DisplayName': 'string'
                    },
                ]
            }
        }
    },
    'ConfigConnectorArn': 'string',
    'CreatedAt': datetime(2015, 1, 1),
    'UpdatedAt': datetime(2015, 1, 1)
}

Response Structure

(dict) –
- CloudConnectorArn (string) –
  
  The ARN 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.
- Configuration (dict) –
  
  The configuration details for the third-party cloud environment connection.
  Note
  This is a Tagged Union structure. Only one of the following top level keys will be set: AzureConfiguration. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
  'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
  - AzureConfiguration (dict) –
    
    The access details and targets for connecting to a Microsoft Azure environment.
    - TenantId (string) –
      
      The ID of the Azure tenant.
    - TenantDisplayName (string) –
      
      The display name of the Azure tenant.
    - ApplicationId (string) –
      
      The ID of the Azure application registration used for authentication.
    - ApplicationDisplayName (string) –
      
      The display name of the Azure application registration.
    - Targets (dict) –
      
      The target Azure subscriptions for the cloud connector.
      Note
      This is a Tagged Union structure. Only one of the following top level keys will be set: Subscriptions. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - Subscriptions (list) –
        
        A list of Azure subscriptions to target.
        
        (dict) –
        
        Information about an Azure subscription targeted by the cloud connector.
        
        Id (string) –
        
        The ID of the Azure subscription.
        
        DisplayName (string) –
        
        The display name of the Azure subscription.
- ConfigConnectorArn (string) –
  
  The ARN of the Amazon Web Services Config connector associated with this 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.