MediaConnect / Client / list_gateways

list_gateways#

MediaConnect.Client.list_gateways(**kwargs)#

Displays a list of gateways that are associated with this account. This request returns a paginated result.

Request Syntax

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

Parameters:

MaxResults (integer) –
The maximum number of results to return per API request.

For example, you submit a ListGateways 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 ListGateways 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 ListGateways request a second time and specify the NextToken value.

Return type:

dict

Returns:

Response Syntax

{
    'Gateways': [
        {
            'GatewayArn': 'string',
            'GatewayState': 'CREATING'|'ACTIVE'|'UPDATING'|'ERROR'|'DELETING'|'DELETED',
            'Name': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- Gateways (list) –
  
  A list of gateway summaries.
  - (dict) –
    
    A summary of a gateway, including its name, ARN, and status.
    - GatewayArn (string) –
      
      The Amazon Resource Name (ARN) of the gateway.
    - GatewayState (string) –
      
      The status of the gateway.
    - Name (string) –
      
      The name of the gateway.
- NextToken (string) –
  
  The token that identifies the batch of results that you want to see.
  
  For example, you submit a ListGateways 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 ListGateways 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