Skip to content

list_gateway_targets

Operation

list_gateway_targets

list_gateway_targets(request: ListGatewayTargetsInput | ListGatewayTargetsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListGatewayTargetsInputDict]) -> ListGatewayTargetsOutput

Lists all targets for a specific gateway.

Parameters:

Name Type Description Default
request ListGatewayTargetsInput | ListGatewayTargetsInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[ListGatewayTargetsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListGatewayTargetsOutput

An instance of ListGatewayTargetsOutput.

list_gateway_targets async

list_gateway_targets(request: ListGatewayTargetsInput | ListGatewayTargetsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListGatewayTargetsInputDict]) -> ListGatewayTargetsOutput

Lists all targets for a specific gateway.

Parameters:

Name Type Description Default
request ListGatewayTargetsInput | ListGatewayTargetsInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[ListGatewayTargetsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListGatewayTargetsOutput

An instance of ListGatewayTargetsOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

ListGatewayTargetsInputDict

Bases: TypedDict

Dictionary form of ListGatewayTargetsInput.

Attributes

gateway_identifier instance-attribute
gateway_identifier: Required[str]

The identifier of the gateway to list targets for.

max_results instance-attribute
max_results: int | 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 instance-attribute
next_token: str | 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.

ListGatewayTargetsInput dataclass

Bases: _SerdeShape

Dataclass for ListGatewayTargetsInput structure.

Attributes

gateway_identifier class-attribute instance-attribute
gateway_identifier: str | None = ...

The identifier of the gateway to list targets for.

max_results class-attribute instance-attribute
max_results: int | 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 = ...

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

ListGatewayTargetsOutput dataclass

Bases: _SerdeShape

Dataclass for ListGatewayTargetsOutput structure.

Attributes

items instance-attribute

The list of gateway target summaries.

next_token class-attribute instance-attribute
next_token: str | 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 = ...

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.