URI HTTP methods Schemas Properties See also

Gateway instance: list

URI

/v1/gateway-instances

HTTP methods

GET

Operation ID: ListGatewayInstances

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
Name	Type	Required	Description
`filterArn`	String	False	Filter the list results to display only the bridges associated with the selected ARN.
`nextToken`	String	False	The token that identifies which batch of results that you want to see. For example, you submit a ListEntitlements 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 ListEntitlements request a second time and specify the NextToken value.
`maxResults`	String	False	The maximum number of results to return per API request. For example, you submit a ListEntitlements request with MaxResults set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.) The service might return fewer results than the MaxResults value. If MaxResults is not included in the request, the service defaults to pagination with a maximum of 20 results per page.

Responses
Status code	Response model	Description
`200`	`ListGatewayInstancesResponse`	AWS Elemental MediaConnect returned the list of instances in the gateway successfully.
`400`	`ResponseError`	The request that you submitted is not valid.
`409`	`ResponseError`	There was a conflict when trying to add the requested output
`429`	`ResponseError`	You have exceeded the service request rate limit for your MediaConnect account.
`500`	`ResponseError`	MediaConnect can't fulfill your request because it encountered an unexpected condition.
`503`	`ResponseError`	MediaConnect is currently unavailable. Try again later.

Schemas

Response bodies


{
  "instances": [
    {
      "instanceId": "string",
      "instanceState": enum,
      "gatewayInstanceArn": "string",
      "gatewayArn": "string"
    }
  ],
  "nextToken": "string"
}


{
  "message": "string"
}

Properties

ListGatewayInstancesResponse

The result of a successful ListGatewayInstances request. The response includes instance summaries and the NextToken to use in a subsequent ListInstances request.

Property	Type	Required	Description
`instances`	Array of type ListedGatewayInstance	True	A list of instance summaries.
`nextToken`	string	False	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.

ListedGatewayInstance

Provides a summary of an instance.

Property	Type	Required	Description
`gatewayArn`	string	True	The Amazon Resource Name (ARN) of the gateway.
`gatewayInstanceArn`	string	True	The Amazon Resource Name (ARN) of the instance.
`instanceId`	string	True	The instance ID generated by the SSM install. This will begin with "mi-".
`instanceState`	string Values: `REGISTERING \| ACTIVE \| DEREGISTERING \| DEREGISTERED \| REGISTRATION_ERROR \| DEREGISTRATION_ERROR`	False	The status of the instance.

ResponseError

An exception raised by MediaConnect when you submit a request that cannot be completed. For more information, see the error message and documentation for the operation.

Property	Type	Required	Description
`message`	string	True	The specific error message that MediaConnect returns to help you understand the reason that the request did not succeed.