SecurityHub / Client / get_connector

get_connector

SecurityHub.Client.get_connector(**kwargs)

Retrieves details for a CSPM connector based on the connector ID.

See also: AWS API Documentation

Request Syntax

response = client.get_connector(
    ConnectorId='string'
)

Parameters:

ConnectorId (string) –

[REQUIRED]

The unique identifier of the connector to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'ConnectorArn': 'string',
    'ConnectorId': 'string',
    'Name': 'string',
    'Description': 'string',
    'CreatedAt': datetime(2015, 1, 1),
    'LastUpdatedAt': datetime(2015, 1, 1),
    'Health': {
        'ConnectorStatus': 'CONNECTED'|'DEGRADED'|'FAILED_TO_CONNECT'|'UNKNOWN',
        'Message': 'string',
        'LastCheckedAt': datetime(2015, 1, 1),
        'Issues': [
            {
                'Code': 'AUTHENTICATION_FAILURE'|'STREAM_AUTHORIZATION_FAILURE'|'DISCOVERY_FAILURE'|'STREAM_LIMIT_EXCEEDED'|'STREAM_DISCONNECTED'|'RECORDING_FAILURE'|'NO_HEALTH_DATA',
                'Message': 'string'
            },
        ]
    },
    'ProviderDetail': {
        'Azure': {
            'AWSConfigConnectorArn': 'string',
            'ScopeConfiguration': {
                'ScopeType': 'TENANT'|'SUBSCRIPTION',
                'ScopeValues': [
                    'string',
                ]
            },
            'AzureRegions': [
                'string',
            ]
        }
    },
    'CreatedBy': 'string',
    'EnablementStatus': 'ENABLED'|'PENDING_ENABLEMENT'|'PENDING_UPDATE'|'PENDING_DELETION'
}

Response Structure

• (dict) –

  • ConnectorArn (string) –

    The Amazon Resource Name (ARN) of the connector.

  • ConnectorId (string) –

    The unique identifier of the connector.

  • Name (string) –

    The name of the connector.

  • Description (string) –

    The description of the connector.

  • CreatedAt (datetime) –

    The ISO 8601 UTC timestamp indicating when the connector was created.

  • LastUpdatedAt (datetime) –

    The ISO 8601 UTC timestamp indicating when the connector was last updated.

  • Health (dict) –

    The health status of the connector, including connectivity status and last check time.

    • ConnectorStatus (string) –

      The connectivity status of the connector.

    • Message (string) –

      A message describing the reason for the current connector status.

    • LastCheckedAt (datetime) –

      The ISO 8601 UTC timestamp indicating when the health status was last checked.

    • Issues (list) –

      A list of health issues associated with the connector.

      • (dict) –

        Represents a specific health issue detected for a connector.

        • Code (string) –

          The error code that identifies the type of health issue.

        • Message (string) –

          A human-readable message that describes the health issue.

  • ProviderDetail (dict) –

    The cloud provider configuration details for the connector.

    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 Azure provider detail.

      • AWSConfigConnectorArn (string) –

        The ARN of the multi-cloud configuration connector used to establish the connection to Azure.

      • ScopeConfiguration (dict) –

        The scope configuration that defines which Azure resources are monitored.

        • ScopeType (string) –

          The type of scope. Valid values are tenant and subscription.

        • ScopeValues (list) –

          The list of scope values, such as subscription IDs, when the scope type is subscription.

          • (string) –

      • AzureRegions (list) –

        The list of Azure regions being monitored.

        • (string) –

  • CreatedBy (string) –

    The service principal that created the connector.

  • EnablementStatus (string) –

    The enablement status of the connector.

Exceptions

• SecurityHub.Client.exceptions.AccessDeniedException

• SecurityHub.Client.exceptions.InternalServerException

• SecurityHub.Client.exceptions.InvalidAccessException

• SecurityHub.Client.exceptions.ValidationException

• SecurityHub.Client.exceptions.ThrottlingException

• SecurityHub.Client.exceptions.ConflictException

• SecurityHub.Client.exceptions.ResourceNotFoundException