SecurityHub / Client / list_connectors

list_connectors

SecurityHub.Client.list_connectors(**kwargs)

Lists the CSPM connectors and their metadata for the calling account.

See also: AWS API Documentation

Request Syntax

response = client.list_connectors(
    NextToken='string',
    MaxResults=123,
    ProviderName='AZURE',
    ConnectorStatus='CONNECTED'|'DEGRADED'|'FAILED_TO_CONNECT'|'UNKNOWN',
    EnablementStatus='ENABLED'|'PENDING_ENABLEMENT'|'PENDING_UPDATE'|'PENDING_DELETION'
)

Parameters:

• NextToken (string) – The pagination token to request the next page of results.

• MaxResults (integer) – The maximum number of results to return.

• ProviderName (string) – The name of the cloud provider to filter connectors by.

• ConnectorStatus (string) – The connectivity status to filter connectors by.

• EnablementStatus (string) – The enablement status to filter connectors by.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'Connectors': [
        {
            'ConnectorArn': 'string',
            'ConnectorId': 'string',
            'Name': 'string',
            'Description': 'string',
            'ProviderSummary': {
                'ProviderName': 'AZURE',
                'ConnectorStatus': 'CONNECTED'|'DEGRADED'|'FAILED_TO_CONNECT'|'UNKNOWN',
                'ProviderConfiguration': {
                    'Azure': {
                        'AWSConfigConnectorArn': 'string',
                        'ScopeConfiguration': {
                            'ScopeType': 'TENANT'|'SUBSCRIPTION',
                            'ScopeValues': [
                                'string',
                            ]
                        },
                        'AzureRegions': [
                            'string',
                        ]
                    }
                }
            },
            'CreatedAt': datetime(2015, 1, 1),
            'CreatedBy': 'string',
            'EnablementStatus': 'ENABLED'|'PENDING_ENABLEMENT'|'PENDING_UPDATE'|'PENDING_DELETION'
        },
    ]
}

Response Structure

• (dict) –

  • NextToken (string) –

    The pagination token to use to request the next page of results. If there are no additional results, this value is null.

  • Connectors (list) –

    An array of connector summaries.

    • (dict) –

      A summary of a CSPM connector.

      • 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.

      • ProviderSummary (dict) –

        A summary of the cloud provider configuration for the connector.

        • ProviderName (string) –

          The name of the cloud provider.

        • ConnectorStatus (string) –

          The connectivity status of the connector.

        • ProviderConfiguration (dict) –

          The provider configuration details.

          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) –

      • CreatedAt (datetime) –

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

      • 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