SecurityHub / Client / list_connectors_v2

list_connectors_v2

SecurityHub.Client.list_connectors_v2(**kwargs)

Grants permission to retrieve a list of connectorsV2 and their metadata for the calling account.

See also: AWS API Documentation

Request Syntax

response = client.list_connectors_v2(
    NextToken='string',
    MaxResults=123,
    ProviderName='JIRA_CLOUD'|'SERVICENOW'|'AZURE',
    ConnectorStatus='CONNECTED'|'DEGRADED'|'FAILED_TO_CONNECT'|'PENDING_AUTHORIZATION'|'PENDING_CONFIGURATION'|'UNKNOWN',
    EnablementStatus='ENABLED'|'PENDING_ENABLEMENT'|'FAILED_TO_ENABLE'|'PENDING_UPDATE'|'FAILED_TO_UPDATE'|'PENDING_DELETION'|'FAILED_TO_DELETE'
)

Parameters:

• NextToken (string) – The pagination token per the Amazon Web Services Pagination standard

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

• ProviderName (string) – The name of the third-party provider.

• ConnectorStatus (string) – The status for the connectorV2.

• 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': 'JIRA_CLOUD'|'SERVICENOW'|'AZURE',
                'ConnectorStatus': 'CONNECTED'|'DEGRADED'|'FAILED_TO_CONNECT'|'PENDING_AUTHORIZATION'|'PENDING_CONFIGURATION'|'UNKNOWN',
                'ProviderConfiguration': {
                    'JiraCloud': {
                        'CloudId': 'string',
                        'ProjectKey': 'string',
                        'Domain': 'string',
                        'AuthUrl': 'string',
                        'AuthStatus': 'ACTIVE'|'FAILED'
                    },
                    'ServiceNow': {
                        'InstanceName': 'string',
                        'SecretArn': 'string',
                        'AuthStatus': 'ACTIVE'|'FAILED'
                    },
                    'Azure': {
                        'AWSConfigConnectorArn': 'string',
                        'ScopeConfiguration': {
                            'ScopeType': 'TENANT'|'SUBSCRIPTION',
                            'ScopeValues': [
                                'string',
                            ]
                        },
                        'AzureRegions': [
                            'string',
                        ]
                    }
                }
            },
            'CreatedAt': datetime(2015, 1, 1),
            'EnablementStatus': 'ENABLED'|'PENDING_ENABLEMENT'|'FAILED_TO_ENABLE'|'PENDING_UPDATE'|'FAILED_TO_UPDATE'|'PENDING_DELETION'|'FAILED_TO_DELETE',
            'EnablementStatusReason': 'string'
        },
    ]
}

Response Structure

• (dict) –

  • NextToken (string) –

    The pagination token to use to request the next page of results. Otherwise, this parameter is null.

  • Connectors (list) –

    An array of connectorV2 summaries.

    • (dict) –

      A condensed overview of the connectorV2..

      • ConnectorArn (string) –

        The Amazon Resource Name (ARN) of the connectorV2.

      • ConnectorId (string) –

        The UUID of the connectorV2 to identify connectorV2 resource.

      • Name (string) –

        The Name field contains the user-defined name assigned to the integration connector. This helps identify and manage multiple connectors within Security Hub.

      • Description (string) –

        The description of the connectorV2.

      • ProviderSummary (dict) –

        The connectorV2 third party provider configuration summary.

        • ProviderName (string) –

          The name of the provider.

        • ConnectorStatus (string) –

          The status for the connectorV2.

        • ProviderConfiguration (dict) –

          The third-party provider detail for a service configuration.

          Note

          This is a Tagged Union structure. Only one of the following top level keys will be set: JiraCloud, ServiceNow, 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'}
          

          • JiraCloud (dict) –

            Details about a Jira Cloud integration.

            • CloudId (string) –

              The cloud id of the Jira Cloud.

            • ProjectKey (string) –

              The projectKey of Jira Cloud.

            • Domain (string) –

              The URL domain of your Jira Cloud instance.

            • AuthUrl (string) –

              The URL to provide to customers for OAuth auth code flow.

            • AuthStatus (string) –

              The status of the authorization between Jira Cloud and the service.

          • ServiceNow (dict) –

            Details about a ServiceNow ITSM integration.

            • InstanceName (string) –

              The instanceName of ServiceNow ITSM.

            • SecretArn (string) –

              The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the ServiceNow credentials.

            • AuthStatus (string) –

              The status of the authorization between ServiceNow and the service.

          • Azure (dict) –

            Details about a Microsoft Azure CSPM integration.

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

        ISO 8601 UTC timestamp for the time create the connectorV2.

      • EnablementStatus (string) –

        The enablement status of the connector.

      • EnablementStatusReason (string) –

        The reason for the current enablement status. Provides additional context when the connector is in a failed state.

Exceptions

• SecurityHub.Client.exceptions.AccessDeniedException

• SecurityHub.Client.exceptions.InternalServerException

• SecurityHub.Client.exceptions.ValidationException

• SecurityHub.Client.exceptions.ThrottlingException

• SecurityHub.Client.exceptions.ConflictException

• SecurityHub.Client.exceptions.ResourceNotFoundException