MediaConnect / Client / list_gateway_instances

list_gateway_instances¶

MediaConnect.Client.list_gateway_instances(**kwargs)¶

Displays a list of instances associated with the Amazon Web Services 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).

Request Syntax

response = client.list_gateway_instances(
    FilterArn='string',
    MaxResults=123,
    NextToken='string'
)

Parameters:

FilterArn (string) – Filter the list results to display only the instances associated with the selected Gateway ARN.
MaxResults (integer) –
The maximum number of results to return per API request.

For example, you submit a ListInstances 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 10 results per page.
NextToken (string) –
The token that identifies the 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.

Return type:

dict

Returns:

Response Syntax

{
    'Instances': [
        {
            'GatewayArn': 'string',
            'GatewayInstanceArn': 'string',
            'InstanceId': 'string',
            'InstanceState': 'REGISTERING'|'ACTIVE'|'DEREGISTERING'|'DEREGISTERED'|'REGISTRATION_ERROR'|'DEREGISTRATION_ERROR'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- Instances (list) –
  
  A list of instance summaries.
  - (dict) –
    
    A summary of an instance.
    - GatewayArn (string) –
      
      The Amazon Resource Name (ARN) of the gateway.
    - GatewayInstanceArn (string) –
      
      The Amazon Resource Name (ARN) of the instance.
    - InstanceId (string) –
      
      The managed instance ID generated by the SSM install. This will begin with “mi-“.
    - InstanceState (string) –
      
      The status of the instance.
- NextToken (string) –
  
  The token that identifies the 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.

Exceptions

MediaConnect.Client.exceptions.BadRequestException
MediaConnect.Client.exceptions.TooManyRequestsException
MediaConnect.Client.exceptions.ConflictException
MediaConnect.Client.exceptions.InternalServerErrorException
MediaConnect.Client.exceptions.ServiceUnavailableException