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

CreateConnector

Creates a connector that links an external cloud provider to Amazon Inspector for vulnerability scanning.

Request Syntax


POST /connector/create HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "description": "string",
   "name": "string",
   "provider": "string",
   "providerDetail": { ... },
   "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, case-sensitive identifier that you provide to ensure that the operation completes no more than one time. If this token matches a previous request, the service ignores the request but does not return an error.

Type: String

Required: No

description

A description of the connector.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 200.

Pattern: [^\p{C}]*

Required: No

name

The name of the connector.

Type: String

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

Pattern: [\p{L}\p{N}_-]+

Required: Yes

provider

The cloud provider for the connector.

Type: String

Valid Values: AZURE

Required: Yes

providerDetail

The provider-specific configuration details for the connector.

Type: ProviderDetailCreate object

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

Required: Yes

tags

The tags to apply to the connector.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 50 items.

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

Key Pattern: (?!aws:)[\p{L}\p{Z}\p{N}_.:/=+\-@]*

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "connectorArn": "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 created connector.

Type: String

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

Pattern: arn:aws(-[a-z]+)*:inspector2:[a-z0-9-]+:[0-9]{12}:connector/([a-f0-9-]+|aws-service-connector/.+/[a-f0-9-]+)

Errors

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

AccessDeniedException

You do not have sufficient access to perform this action.

For Enable, you receive this error if you attempt to use a feature in an unsupported AWS Region.

HTTP Status Code: 403

ConflictException

A conflict occurred. This exception occurs when the same resource is being modified by concurrent requests.

HTTP Status Code: 409

InternalServerException

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

retryAfterSeconds: The number of seconds to wait before retrying the request.

HTTP Status Code: 500

ServiceQuotaExceededException

You have exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use Service Quotas to request a service quota increase.

resourceId: The ID of the resource that exceeds a service quota.

HTTP Status Code: 402

ThrottlingException

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

retryAfterSeconds: The number of seconds to wait before retrying the request.

HTTP Status Code: 429

ValidationException

The request has failed validation due to missing required fields or having invalid inputs.

fields: The fields that failed validation.
reason: The reason for the validation failure.

HTTP Status Code: 400