Skip to content

list_gateway_rules

Operation

list_gateway_rules

list_gateway_rules(request: ListGatewayRulesInput | ListGatewayRulesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListGatewayRulesInputDict]) -> ListGatewayRulesOutput

Lists all rules for a gateway.

Parameters:

Name Type Description Default
request ListGatewayRulesInput | ListGatewayRulesInputDict | 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[ListGatewayRulesInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListGatewayRulesOutput

An instance of ListGatewayRulesOutput.

list_gateway_rules async

list_gateway_rules(request: ListGatewayRulesInput | ListGatewayRulesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListGatewayRulesInputDict]) -> ListGatewayRulesOutput

Lists all rules for a gateway.

Parameters:

Name Type Description Default
request ListGatewayRulesInput | ListGatewayRulesInputDict | 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[ListGatewayRulesInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListGatewayRulesOutput

An instance of ListGatewayRulesOutput.

Input

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

ListGatewayRulesInputDict

Bases: TypedDict

Dictionary form of ListGatewayRulesInput.

Attributes

gateway_identifier instance-attribute
gateway_identifier: Required[str]

The identifier of the gateway to list rules 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

The pagination token from a previous request.

ListGatewayRulesInput dataclass

Bases: _SerdeShape

Dataclass for ListGatewayRulesInput structure.

Attributes

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

The identifier of the gateway to list rules 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 = ...

The pagination token from a previous request.

Output

ListGatewayRulesOutput dataclass

Bases: _SerdeShape

Dataclass for ListGatewayRulesOutput structure.

Attributes

gateway_rules instance-attribute
gateway_rules: list[GatewayRuleDetail]

The list of gateway rules.

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

The pagination token to use in a subsequent request.

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.