Skip to content

describe_egress_only_internet_gateways

Operation

describe_egress_only_internet_gateways

Describes your egress-only internet gateways. The default is to describe all your egress-only internet gateways. Alternatively, you can specify specific egress-only internet gateway IDs or filter the results to include only the egress-only internet gateways that match specific criteria.

Parameters:

Name Type Description Default
request DescribeEgressOnlyInternetGatewaysInput | DescribeEgressOnlyInternetGatewaysInputDict | 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[DescribeEgressOnlyInternetGatewaysInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeEgressOnlyInternetGatewaysOutput

An instance of DescribeEgressOnlyInternetGatewaysOutput.

describe_egress_only_internet_gateways async

Describes your egress-only internet gateways. The default is to describe all your egress-only internet gateways. Alternatively, you can specify specific egress-only internet gateway IDs or filter the results to include only the egress-only internet gateways that match specific criteria.

Parameters:

Name Type Description Default
request DescribeEgressOnlyInternetGatewaysInput | DescribeEgressOnlyInternetGatewaysInputDict | 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[DescribeEgressOnlyInternetGatewaysInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeEgressOnlyInternetGatewaysOutput

An instance of DescribeEgressOnlyInternetGatewaysOutput.

Input

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

DescribeEgressOnlyInternetGatewaysInputDict

Bases: TypedDict

Dictionary form of DescribeEgressOnlyInternetGatewaysInput.

Attributes

dry_run instance-attribute
dry_run: bool | None

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

egress_only_internet_gateway_ids instance-attribute
egress_only_internet_gateway_ids: Sequence[str] | None

The IDs of the egress-only internet gateways.

filters instance-attribute
filters: Sequence[Filter | FilterDict] | None

The filters.

  • tag - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

max_results instance-attribute
max_results: int | None

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.

next_token instance-attribute
next_token: str | None

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

DescribeEgressOnlyInternetGatewaysInput dataclass

Bases: _SerdeShape

Dataclass for DescribeEgressOnlyInternetGatewaysInput structure.

Attributes

dry_run class-attribute instance-attribute
dry_run: bool | None = ...

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

egress_only_internet_gateway_ids class-attribute instance-attribute
egress_only_internet_gateway_ids: list[str] | None = ...

The IDs of the egress-only internet gateways.

filters class-attribute instance-attribute
filters: list[Filter] | None = ...

The filters.

  • tag - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

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

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.

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

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

Output

DescribeEgressOnlyInternetGatewaysOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeEgressOnlyInternetGatewaysOutput structure.

Attributes

egress_only_internet_gateways class-attribute instance-attribute
egress_only_internet_gateways: list[EgressOnlyInternetGateway] | None = ...

Information about the egress-only internet gateways.

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

The token to include in another request to get the next page of items. This value is null when there are no more items 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.