Skip to content

ECS  >  Operations  >  describe_gateway_resources

describe_gateway_resources

Operation

describe_gateway_resources async

describe_gateway_resources(request: DescribeGatewayResourcesInput | DescribeGatewayResourcesInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeGatewayResourcesOutput
describe_gateway_resources(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeGatewayResourcesInputDict]) -> DescribeGatewayResourcesOutput

Returns the infrastructure that a gateway has created and manages, so that you can follow the traffic path from top-level shared resources, such as load balancers, to the service-specific resources represented as gateway routes. Responses include only the Amazon Resource Names (ARNs) of gateway-managed infrastructure. For the current state of a resource, describe it with the corresponding Amazon Web Services service (Elastic Load Balancing, Amazon EC2, or Amazon Web Services Certificate Manager). The results are paginated.

Parameters:

Name Type Description Default
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
DescribeGatewayResourcesOutput

An instance of DescribeGatewayResourcesOutput.

Input

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

Model

DescribeGatewayResourcesInput dataclass

Bases: _SerdeShape

Dataclass for DescribeGatewayResourcesInput structure.

Attributes
gateway class-attribute instance-attribute
gateway: str | None = ...

The name or Amazon Resource Name (ARN) of the gateway.

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

The maximum number of results that the operation returns in a single page. The maximum value is 20 and the default is 10.

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

The nextToken value returned from a previous paginated request.

Dictionaries

DescribeGatewayResourcesInputDict

Bases: TypedDict

Dictionary form of DescribeGatewayResourcesInput.

Attributes
gateway instance-attribute
gateway: Required[str]

The name or Amazon Resource Name (ARN) of the gateway.

max_results instance-attribute
max_results: int | None

The maximum number of results that the operation returns in a single page. The maximum value is 20 and the default is 10.

next_token instance-attribute
next_token: str | None

The nextToken value returned from a previous paginated request.

Output

DescribeGatewayResourcesOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeGatewayResourcesOutput structure.

Attributes

gateway_resources class-attribute instance-attribute
gateway_resources: GatewayResources | None = ...

The infrastructure resources that the gateway manages, grouped by gateway type.

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

The nextToken value to include in a future request to retrieve the next page of results. This value is null when there are no more results to return.

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.