ListInstances
This API is in preview release for Amazon Connect and is subject to change.
Return a list of instances which are in active state, creation-in-progress state, and failed state. Instances that aren't successfully created (they are in a failed state) are returned only for 24 hours after the CreateInstance API was invoked.
Request Syntax
GET /instance?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- MaxResults
-
The maximum number of results to return per page.
Valid Range: Minimum value of 1. Maximum value of 10.
- NextToken
-
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"InstanceSummaryList": [
{
"Arn": "string",
"CreatedTime": number,
"Id": "string",
"IdentityManagementType": "string",
"InboundCallsEnabled": boolean,
"InstanceAccessUrl": "string",
"InstanceAlias": "string",
"InstanceStatus": "string",
"OutboundCallsEnabled": boolean,
"ServiceRole": "string"
}
],
"NextToken": "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.
- InstanceSummaryList
-
Information about the instances.
Type: Array of InstanceSummary objects
- NextToken
-
If there are additional results, this is the token for the next set of results.
Type: String
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
- InvalidRequestException
-
The request is not valid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
