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

UpdateConnectorDestination

Updates the properties of an existing connector destination.

Request Syntax


PUT /connector-destinations/Identifier HTTP/1.1
Content-type: application/json

{
   "AuthConfig": { 
      "oAuthUpdate": { 
         "oAuthCompleteRedirectUrl": "string",
         "proactiveRefreshTokenRenewal": { 
            "DaysBeforeRenewal": number,
            "enabled": boolean
         }
      }
   },
   "AuthType": "string",
   "Description": "string",
   "Name": "string",
   "SecretsManager": { 
      "arn": "string",
      "versionId": "string"
   }
}

URI Request Parameters

The request uses the following URI parameters.

Identifier

The unique identifier of the connector destination to update.

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

Pattern: [A-Za-z0-9-_]+

Required: Yes

Request Body

The request accepts the following data in JSON format.

AuthConfig

The updated authentication configuration details for the connector destination.

Type: AuthConfigUpdate object

Required: No

AuthType

The new authentication type to use for the connector destination.

Type: String

Valid Values: OAUTH

Required: No

Description

The new description to assign to the connector destination.

Type: String

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

Pattern: [0-9A-Za-z_\- ]+

Required: No

Name

The new display name to assign to the connector destination.

Type: String

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

Pattern: [A-Za-z0-9-_ ]+

Required: No

SecretsManager

The updated AWS Secrets Manager configuration for the connector destination.

Type: SecretsManager object

Required: No

Response Syntax


HTTP/1.1 204

Response Elements

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors

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

AccessDeniedException

User is not authorized.

HTTP Status Code: 403

InternalServerException

Internal error from the service that indicates an unexpected error or that the service is unavailable.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource does not exist.

HTTP Status Code: 404

ThrottlingException

The rate exceeds the limit.

HTTP Status Code: 429

ValidationException

A validation error occurred when performing the API request.

HTTP Status Code: 400