DescribeQuickConnect
Describes the quick connect.
Request Syntax
GET /quick-connects/InstanceId/QuickConnectId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- InstanceId
-
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: Yes
- QuickConnectId
-
The identifier for the quick connect.
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"QuickConnect": {
"Description": "string",
"LastModifiedRegion": "string",
"LastModifiedTime": number,
"Name": "string",
"QuickConnectARN": "string",
"QuickConnectConfig": {
"PhoneConfig": {
"PhoneNumber": "string"
},
"QueueConfig": {
"ContactFlowId": "string",
"QueueId": "string"
},
"QuickConnectType": "string",
"UserConfig": {
"ContactFlowId": "string",
"UserId": "string"
}
},
"QuickConnectId": "string",
"Tags": {
"string" : "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.
- QuickConnect
-
Information about the quick connect.
Type: QuickConnect object
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServiceException
-
Request processing failed because of an error or failure with the service.
HTTP Status Code: 500
- InvalidParameterException
-
One or more of the specified parameters are not valid.
HTTP Status Code: 400
- InvalidRequestException
-
The request is not valid.
HTTP Status Code: 400
- ResourceNotFoundException
-
The specified resource was not found.
HTTP Status Code: 404
- ThrottlingException
-
The throttling limit has been exceeded.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
