UpdateConnectorV2
Grants permission to update a connectorV2 based on its id and input parameters.
Request Syntax
PATCH /connectorsv2/ConnectorId+ HTTP/1.1
Content-type: application/json
{
"Description": "string",
"Provider": { ... }
}URI Request Parameters
The request uses the following URI parameters.
- ConnectorId
-
The UUID of the connectorV2 to identify connectorV2 resource.
Pattern:
.*\S.*Required: Yes
Request Body
The request accepts the following data in JSON format.
- Description
-
The description of the connectorV2.
Type: String
Pattern:
.*\S.*Required: No
- Provider
-
The third-party provider’s service configuration.
Type: ProviderUpdateConfiguration object
Note: This object is a Union. Only one member of this object can be specified or returned.
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"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.
- ConnectorStatus
-
The status of the connector after the update.
Type: String
Valid Values:
CONNECTED | DEGRADED | FAILED_TO_CONNECT | PENDING_AUTHORIZATION | PENDING_CONFIGURATION | UNKNOWN - EnablementStatus
-
The enablement status of the connector after the update.
Type: String
Valid Values:
ENABLED | PENDING_ENABLEMENT | FAILED_TO_ENABLE | PENDING_UPDATE | FAILED_TO_UPDATE | PENDING_DELETION | FAILED_TO_DELETE
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
- 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
