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

CreateConnectorV2

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

Request Syntax


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

{
   "ClientToken": "string",
   "Description": "string",
   "KmsKeyArn": "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.

Type: String

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

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

Required: No

Description

The description of the connectorV2.

Type: String

Pattern: .*\S.*

Required: No

KmsKeyArn

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

Type: String

Pattern: .*\S.*

Required: No

Name

The unique name of the connectorV2.

Type: String

Pattern: .*\S.*

Required: Yes

Provider

The third-party provider’s service configuration.

Type: ProviderConfiguration 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 connectorV2 when you create.

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

{
   "AuthUrl": "string",
   "ConnectorArn": "string",
   "ConnectorId": "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.

AuthUrl

The Url provide to customers for OAuth auth code flow.

Type: String

Pattern: .*\S.*

ConnectorArn

The Amazon Resource Name (ARN) of the connectorV2.

Type: String

Pattern: .*\S.*

ConnectorId

The UUID of the connectorV2 to identify connectorV2 resource.

Type: String

Pattern: .*\S.*

Errors

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

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

ResourceNotFoundException

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

HTTP Status Code: 404

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