SecurityHub / Client / get_connector_v2

get_connector_v2

SecurityHub.Client.get_connector_v2(**kwargs)

Grants permission to retrieve details for a connectorV2 based on connector id. This API is in preview release and subject to change.

See also: AWS API Documentation

Request Syntax

response = client.get_connector_v2(
    ConnectorId='string'
)
Parameters:

ConnectorId (string) –

[REQUIRED]

The UUID of the connectorV2 to identify connectorV2 resource.

Return type:

dict

Returns:

Response Syntax

{
    'ConnectorArn': 'string',
    'ConnectorId': 'string',
    'Name': 'string',
    'Description': 'string',
    'KmsKeyArn': 'string',
    'CreatedAt': datetime(2015, 1, 1),
    'LastUpdatedAt': datetime(2015, 1, 1),
    'Health': {
        'ConnectorStatus': 'CONNECTED'|'FAILED_TO_CONNECT'|'PENDING_CONFIGURATION'|'PENDING_AUTHORIZATION',
        'Message': 'string',
        'LastCheckedAt': datetime(2015, 1, 1)
    },
    'ProviderDetail': {
        'JiraCloud': {
            'CloudId': 'string',
            'ProjectKey': 'string',
            'Domain': 'string',
            'AuthUrl': 'string',
            'AuthStatus': 'ACTIVE'|'FAILED'
        },
        'ServiceNow': {
            'InstanceName': 'string',
            'ClientId': 'string',
            'AuthStatus': 'ACTIVE'|'FAILED'
        }
    }
}

Response Structure

  • (dict) –

    • 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 of the connectorV2.

    • Description (string) –

      The description of the connectorV2.

    • KmsKeyArn (string) –

      The Amazon Resource Name (ARN) of KMS key used for the connectorV2.

    • CreatedAt (datetime) –

      ISO 8601 UTC timestamp for the time create the connectorV2.

    • LastUpdatedAt (datetime) –

      ISO 8601 UTC timestamp for the time update the connectorV2 connectorStatus.

    • Health (dict) –

      The current health status for connectorV2

      • ConnectorStatus (string) –

        The status of the connectorV2.

      • Message (string) –

        The message for the reason of connectorStatus change.

      • LastCheckedAt (datetime) –

        ISO 8601 UTC timestamp for the time check the health status of the connectorV2.

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

        • ClientId (string) –

          The clientId of ServiceNow ITSM.

        • AuthStatus (string) –

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

Exceptions