BedrockAgentCoreControl / Client / list_gateways

list_gateways¶

BedrockAgentCoreControl.Client.list_gateways(**kwargs)¶

Lists all gateways in the account.

Request Syntax

response = client.list_gateways(
    maxResults=123,
    nextToken='string'
)

Parameters:

maxResults (integer) – The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
nextToken (string) – If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

Return type:

dict

Returns:

Response Syntax

{
    'items': [
        {
            'gatewayId': 'string',
            'name': 'string',
            'status': 'CREATING'|'UPDATING'|'UPDATE_UNSUCCESSFUL'|'DELETING'|'READY'|'FAILED',
            'description': 'string',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'authorizerType': 'CUSTOM_JWT'|'AWS_IAM'|'NONE',
            'protocolType': 'MCP'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- items (list) –
  
  The list of gateway summaries.
  - (dict) –
    
    Contains summary information about a gateway.
    - gatewayId (string) –
      
      The unique identifier of the gateway.
    - name (string) –
      
      The name of the gateway.
    - status (string) –
      
      The current status of the gateway.
    - description (string) –
      
      The description of the gateway.
    - createdAt (datetime) –
      
      The timestamp when the gateway was created.
    - updatedAt (datetime) –
      
      The timestamp when the gateway was last updated.
    - authorizerType (string) –
      
      The type of authorizer used by the gateway.
    - protocolType (string) –
      
      The protocol type used by the gateway.
- nextToken (string) –
  
  If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

Exceptions

BedrockAgentCoreControl.Client.exceptions.ValidationException
BedrockAgentCoreControl.Client.exceptions.AccessDeniedException
BedrockAgentCoreControl.Client.exceptions.ThrottlingException
BedrockAgentCoreControl.Client.exceptions.InternalServerException