Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateConnector

Creates a connector to a third-party cloud provider in Security Hub CSPM. A connector establishes a connection between Security Hub CSPM and a third-party cloud provider, enabling Security Hub CSPM to ingest security findings and resource data from the connected environment.

Request Syntax


POST /connectors HTTP/1.1
Content-type: application/json

{
   "ClientToken": "string",
   "Description": "string",
   "Name": "string",
   "Provider": { ... },
   "Tags": { 
      "string" : "string" 
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

ClientToken

A unique identifier used to ensure idempotency of the request.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Pattern: ^[\x21-\x7E]{1,64}$

Required: No

Description

The description of the connector.

Type: String

Pattern: .*\S.*

Required: No

Name

The name of the connector. Must be unique within the account.

Type: String

Pattern: .*\S.*

Required: Yes

Provider

The configuration for the cloud provider to connect to. Currently supports Azure.

Type: CspmProviderConfiguration object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: Yes

Tags

The tags to add to the connector resource.

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$

Value Length Constraints: Maximum length of 256.

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "ConnectorArn": "string",
   "ConnectorId": "string",
   "ConnectorStatus": "string",
   "EnablementStatus": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ConnectorArn

The Amazon Resource Name (ARN) of the connector.

Type: String

Pattern: .*\S.*

ConnectorId

The unique identifier of the connector.

Type: String

Pattern: .*\S.*

ConnectorStatus

The connectivity status of the connector.

Type: String

Valid Values: CONNECTED | DEGRADED | FAILED_TO_CONNECT | UNKNOWN

EnablementStatus

The enablement status of the connector.

Type: String

Valid Values: ENABLED | PENDING_ENABLEMENT | PENDING_UPDATE | PENDING_DELETION

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

You don't have permission to perform the action specified in the request.

HTTP Status Code: 403

ConflictException

The request causes conflict with the current state of the service resource.

HTTP Status Code: 409

InternalServerException

The request has failed due to an internal failure of the service.

HTTP Status Code: 500

InvalidAccessException

The account doesn't have permission to perform this action.

HTTP Status Code: 401

ResourceNotFoundException

The request was rejected because we can't find the specified resource.

HTTP Status Code: 404

ServiceQuotaExceededException

The request was rejected because it would exceed the service quota limit.

HTTP Status Code: 402

ThrottlingException

The limit on the number of requests per second was exceeded.

HTTP Status Code: 429

ValidationException

The request has failed validation because it's missing required fields or has invalid inputs.

HTTP Status Code: 400