CloudWatchObservabilityAdminService / Client / get_connector

get_connector

CloudWatchObservabilityAdminService.Client.get_connector(**kwargs)

Retrieves the details of a connector.

See also: AWS API Documentation

Request Syntax

response = client.get_connector(
    ConnectorIdentifier='string'
)
Parameters:

ConnectorIdentifier (string) –

[REQUIRED]

The connector. Specify one of the following:

  • The Amazon Resource Name (ARN) of the connector

  • The ID of the connector

Return type:

dict

Returns:

Response Syntax

{
    'Connector': {
        'Arn': 'string',
        'Provider': 'AZURE',
        'ConnectorConfiguration': {
            'Azure': {
                'TenantIdentifier': 'string',
                'ClientIdentifier': 'string'
            }
        },
        'RoleArn': 'string',
        'Name': 'string',
        'CreatedTimeStamp': 123
    }
}

Response Structure

  • (dict) –

    • Connector (dict) –

      The connector.

      • Arn (string) –

        The Amazon Resource Name (ARN) of the connector.

      • Provider (string) –

        The cloud provider that the connector connects to.

      • ConnectorConfiguration (dict) –

        The configuration for connecting to the third-party cloud provider.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: Azure. 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'}
        
        • Azure (dict) –

          The configuration of a connector to Microsoft Azure.

          • TenantIdentifier (string) –

            The ID of the Microsoft Entra ID tenant.

          • ClientIdentifier (string) –

            The application (client) ID of the Azure app registration. The app registration must have a federated identity credential that trusts the Amazon Web Services OpenID Connect (OIDC) issuer for your account.

      • RoleArn (string) –

        The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that CloudWatch assumes to obtain credentials for the third-party cloud provider.

      • Name (string) –

        The name of the connector.

      • CreatedTimeStamp (integer) –

        The time when the connector was created, in milliseconds since the Unix epoch.

Exceptions