GetConnection
Returns the connection ARN and details such as status, owner, and provider type.
Request Syntax
{
"ConnectionArn": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- ConnectionArn
-
The Amazon Resource Name (ARN) of a connection.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Pattern:
arn:aws(-[\w]+)*:.+:.+:[0-9]{12}:.+Required: Yes
Response Syntax
{
"Connection": {
"ConnectionArn": "string",
"ConnectionName": "string",
"ConnectionStatus": "string",
"HostArn": "string",
"OwnerAccountId": "string",
"ProviderType": "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.
- Connection
-
The connection details, such as status, owner, and provider type.
Type: Connection object
Errors
For information about the errors that are common to all actions, see Common Errors.
- ResourceNotFoundException
-
Resource not found. Verify the connection resource ARN and try again.
HTTP Status Code: 400
- ResourceUnavailableException
-
Resource not found. Verify the ARN for the host resource and try again.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
