SecurityHub / Client / create_connector_v2

create_connector_v2

SecurityHub.Client.create_connector_v2(**kwargs)

Grants permission to create a connectorV2 based on input parameters. This API is in preview release and subject to change.

See also: AWS API Documentation

Request Syntax

response = client.create_connector_v2(
    Name='string',
    Description='string',
    Provider={
        'JiraCloud': {
            'ProjectKey': 'string'
        },
        'ServiceNow': {
            'InstanceName': 'string',
            'ClientId': 'string',
            'ClientSecret': 'string'
        }
    },
    KmsKeyArn='string',
    Tags={
        'string': 'string'
    },
    ClientToken='string'
)

Parameters:

• Name (string) –

  [REQUIRED]

  The unique name of the connectorV2.

• Description (string) – The description of the connectorV2.

• Provider (dict) –

  [REQUIRED]

  The third-party provider’s service configuration.

  Note

  This is a Tagged Union structure. Only one of the following top level keys can be set: JiraCloud, ServiceNow.

  • JiraCloud (dict) –

    The configuration settings required to establish an integration with Jira Cloud.

    • ProjectKey (string) –

      The project key for a JiraCloud instance.

  • ServiceNow (dict) –

    The configuration settings required to establish an integration with ServiceNow ITSM.

    • InstanceName (string) – [REQUIRED]

      The instance name of ServiceNow ITSM.

    • ClientId (string) – [REQUIRED]

      The client ID of ServiceNow ITSM.

    • ClientSecret (string) – [REQUIRED]

      The client secret of ServiceNow ITSM.

• KmsKeyArn (string) – The Amazon Resource Name (ARN) of KMS key used to encrypt secrets for the connectorV2.

• Tags (dict) –

  The tags to add to the connectorV2 when you create.

  • (string) –

    • (string) –

• ClientToken (string) –

  A unique identifier used to ensure idempotency.

  This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'ConnectorArn': 'string',
    'ConnectorId': 'string',
    'AuthUrl': 'string'
}

Response Structure

• (dict) –

  • ConnectorArn (string) –

    The Amazon Resource Name (ARN) of the connectorV2.

  • ConnectorId (string) –

    The UUID of the connectorV2 to identify connectorV2 resource.

  • AuthUrl (string) –

    The Url provide to customers for OAuth auth code flow.

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