ConfigService / Client / get_connector

get_connector

ConfigService.Client.get_connector(**kwargs)

Returns the details of the specified connector.

See also: AWS API Documentation

Request Syntax

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

Arn (string) –

[REQUIRED]

The Amazon Resource Name (ARN) of the connector.

Return type:

dict

Returns:

Response Syntax

{
    'Connector': {
        'name': 'string',
        'arn': 'string',
        'connectorConfiguration': {
            'azure': {
                'tenantIdentifier': 'string',
                'clientIdentifier': 'string'
            },
            'gcp': {
                'gcpOrganizationId': 'string',
                'serviceAccountEmail': 'string',
                'workloadIdentityPoolProvider': 'string'
            }
        },
        'createdTime': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) –

    • Connector (dict) –

      The details of the specified connector.

      • name (string) –

        The name of the connector.

      • arn (string) –

        The Amazon Resource Name (ARN) of the connector.

      • connectorConfiguration (dict) –

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

        • azure (dict) –

          The configuration for an Azure connector.

          • tenantIdentifier (string) –

            The Azure tenant identifier.

          • clientIdentifier (string) –

            The Azure client identifier.

        • gcp (dict) –

          The configuration for a Google Cloud connector.

          • gcpOrganizationId (string) –

            The ID of the Google Cloud organization that contains the connector’s management project, which is the project of the service account in serviceAccountEmail.

            Required if the management project belongs to an organization. A connector needs an organization ID to record an entire organization or more than one project. Omit it only if the management project doesn’t belong to an organization. In that case, the connector can record only the management project.

          • serviceAccountEmail (string) –

            The email address of the Google Cloud service account that Config uses to access your Google Cloud resources. The format is SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com.

            The project that contains this service account is the connector’s management project. If the connector has no gcpOrganizationId, it can record only the management project.

          • workloadIdentityPoolProvider (string) –

            The full resource name of the Google Cloud workload identity pool provider that trusts Config. The format is projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/providers/PROVIDER_ID.

      • createdTime (datetime) –

        The date and time that the connector was created.

Exceptions