---
title: "GET /v1/gateway-instances"
method: GET
path: "/v1/gateway-instances"
---

# GET /v1/gateway-instances

`GET /v1/gateway-instances`

Displays a list of instances associated with the AWS account. This request returns a paginated result. You can use the filterArn property to display only the instances associated with the selected Gateway Amazon Resource Name (ARN).

## Query parameters

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

## Response `200`

Success

- ListGatewayInstancesResponse
  - `Instances` ListedGatewayInstance[] — A list of instance summaries.
    - `GatewayArn` string, required — The Amazon Resource Name (ARN) of the gateway.
    - `GatewayInstanceArn` string, required — The Amazon Resource Name (ARN) of the instance.
    - `InstanceId` string, required — The managed instance ID generated by the SSM install. This will begin with "mi-".
    - `InstanceState` 'REGISTERING' | 'ACTIVE' | 'DEREGISTERING' | 'DEREGISTERED' | 'REGISTRATION_ERROR' | 'DEREGISTRATION_ERROR' — The status of the instance.
  - `NextToken` string — The token that identifies which batch of results that you want to see. For example, you submit a ListInstances request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListInstances request a second time and specify the NextToken value.

## Other responses

- `480` — ServiceUnavailableException
- `481` — TooManyRequestsException
- `482` — BadRequestException
- `483` — InternalServerErrorException
- `484` — ConflictException

---

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