ECS / Client / list_gateways

list_gateways¶

ECS.Client.list_gateways(**kwargs)¶

Returns a list of gateways in your account. You can filter the results by gateway name and status. The results are paginated. We recommend that you use pagination to ensure that the operation returns quickly and successfully.

Request Syntax

response = client.list_gateways(
    names=[
        'string',
    ],
    status=[
        'ACTIVE'|'UPDATE_IN_PROGRESS'|'UPDATE_COMPLETE'|'UPDATE_FAILED'|'DELETED',
    ],
    maxResults=123,
    nextToken='string'
)

Parameters:

names (list) –
The gateway names to filter the results by. You can specify up to 10 names.
- (string) –
status (list) –
The gateway statuses to filter the results by.
- (string) –
  
  The status of a gateway.
maxResults (integer) – The maximum number of gateway results that ListGateways returns in a single page. The default is 100.
nextToken (string) – The nextToken value returned from a previous paginated ListGateways request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results.

Return type:

dict

Returns:

Response Syntax

{
    'gateways': [
        {
            'gatewayArn': 'string',
            'name': 'string',
            'status': 'ACTIVE'|'UPDATE_IN_PROGRESS'|'UPDATE_COMPLETE'|'UPDATE_FAILED'|'DELETED',
            'createdAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- gateways (list) –
  
  The list of gateways that match the request.
  - (dict) –
    
    A summary of a gateway that is returned by the ListGateways operation.
    - gatewayArn (string) –
      
      The Amazon Resource Name (ARN) of the gateway.
    - name (string) –
      
      The name of the gateway.
    - status (string) –
      
      The status of the gateway.
    - createdAt (datetime) –
      
      The Unix timestamp for the time when the gateway was created.
- nextToken (string) –
  
  The nextToken value to include in a future ListGateways request. When the results of a ListGateways request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

Exceptions

ECS.Client.exceptions.AccessDeniedException
ECS.Client.exceptions.ServerException
ECS.Client.exceptions.InvalidParameterException
ECS.Client.exceptions.ClientException
ECS.Client.exceptions.UnsupportedFeatureException