GetConnectorV2
Grants permission to retrieve details for a connectorV2 based on connector id. This API is in preview release and subject to change.
Request Syntax
GET /connectorsv2/ConnectorId+ HTTP/1.1
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 does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"ConnectorArn": "string",
"ConnectorId": "string",
"CreatedAt": "string",
"Description": "string",
"Health": {
"ConnectorStatus": "string",
"LastCheckedAt": "string",
"Message": "string"
},
"KmsKeyArn": "string",
"LastUpdatedAt": "string",
"Name": "string",
"ProviderDetail": { ... }
}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 connectorV2.
Type: String
Pattern:
.*\S.* - ConnectorId
-
The UUID of the connectorV2 to identify connectorV2 resource.
Type: String
Pattern:
.*\S.* - CreatedAt
-
ISO 8601 UTC timestamp for the time create the connectorV2.
Type: Timestamp
- Description
-
The description of the connectorV2.
Type: String
Pattern:
.*\S.* - Health
-
The current health status for connectorV2
Type: HealthCheck object
- KmsKeyArn
-
The Amazon Resource Name (ARN) of KMS key used for the connectorV2.
Type: String
Pattern:
.*\S.* - LastUpdatedAt
-
ISO 8601 UTC timestamp for the time update the connectorV2 connectorStatus.
Type: Timestamp
- Name
-
The name of the connectorV2.
Type: String
Pattern:
.*\S.* - ProviderDetail
-
The third-party provider detail for a service configuration.
Type: ProviderDetail object
Note: This object is a Union. Only one member of this object can be specified or returned.
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
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: