Skip to content

Bedrock AgentCore Control  >  Operations  >  list_gateways

list_gateways

Operation

list_gateways async 

list_gateways(input: ListGatewaysInput, plugins: list[Plugin] | None = None) -> ListGatewaysOutput

Lists all gateways in the account.

Parameters:

Name Type Description Default
input ListGatewaysInput

An instance of ListGatewaysInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
ListGatewaysOutput

An instance of ListGatewaysOutput.

Input

ListGatewaysInput dataclass

Dataclass for ListGatewaysInput structure.

Attributes

max_results class-attribute instance-attribute 
max_results: int | None = None

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.

next_token class-attribute instance-attribute 
next_token: str | None = None

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.

Output

ListGatewaysOutput dataclass

Dataclass for ListGatewaysOutput structure.

Attributes

items instance-attribute 
items: list[GatewaySummary]

The list of gateway summaries.

next_token class-attribute instance-attribute 
next_token: str | None = None

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.

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = field(default=EMPTY_RESPONSE_METADATA, repr=False, compare=False)

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.