---
title: "GET /instance"
method: GET
path: "/instance"
---

# GET /instance

`GET /instance`

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.

## Query parameters

- `nextToken` string
- `maxResults` integer
- `MaxResults` string
- `NextToken` string

## Response `200`

Success

- ListInstancesResponse
  - `InstanceSummaryList` InstanceSummary[] — Information about the instances.
    - `Id` string — The identifier of the instance.
    - `Arn` string — The Amazon Resource Name (ARN) of the instance.
    - `IdentityManagementType` 'SAML' | 'CONNECT_MANAGED' | 'EXISTING_DIRECTORY' — The identity management type of the instance.
    - `InstanceAlias` string, password — The alias of the instance.
    - `CreatedTime` string, date-time — When the instance was created.
    - `ServiceRole` string — The service role of the instance.
    - `InstanceStatus` 'CREATION_IN_PROGRESS' | 'ACTIVE' | 'CREATION_FAILED' — The state of the instance.
    - `InboundCallsEnabled` boolean — Whether inbound calls are enabled.
    - `OutboundCallsEnabled` boolean — Whether outbound calls are enabled.
  - `NextToken` string — If there are additional results, this is the token for the next set of results.

## Other responses

- `480` — InvalidRequestException
- `481` — InternalServiceException

---

[API](https://skmtc.net/aws/apis/connect.md) · [All operations](https://skmtc.net/aws/apis/connect/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/connect/versions/fbcf0a4faed2/schema)