Skip to content

EC2  >  Operations  >  describe_carrier_gateways

describe_carrier_gateways

Operation

describe_carrier_gateways async

describe_carrier_gateways(request: DescribeCarrierGatewaysInput | DescribeCarrierGatewaysInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeCarrierGatewaysOutput
describe_carrier_gateways(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeCarrierGatewaysInputDict]) -> DescribeCarrierGatewaysOutput

Describes one or more of your carrier gateways.

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
DescribeCarrierGatewaysOutput

An instance of DescribeCarrierGatewaysOutput.

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

DescribeCarrierGatewaysInput dataclass

Bases: _SerdeShape

Dataclass for DescribeCarrierGatewaysInput structure.

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

One or more carrier gateway IDs.

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.

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

One or more filters.

  • carrier-gateway-id - The ID of the carrier gateway.

  • state - The state of the carrier gateway (pending | failed | available | deleting | deleted).

  • owner-id - The Amazon Web Services account ID of the owner of the carrier gateway.

  • tag:<key> - 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.

  • vpc-id - The ID of the VPC associated with the carrier gateway.

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

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

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

The token for the next page of results.

Dictionaries

DescribeCarrierGatewaysInputDict

Bases: TypedDict

Dictionary form of DescribeCarrierGatewaysInput.

Attributes
carrier_gateway_ids instance-attribute
carrier_gateway_ids: Sequence[str] | None

One or more carrier gateway IDs.

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.

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

One or more filters.

  • carrier-gateway-id - The ID of the carrier gateway.

  • state - The state of the carrier gateway (pending | failed | available | deleting | deleted).

  • owner-id - The Amazon Web Services account ID of the owner of the carrier gateway.

  • tag:<key> - 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.

  • vpc-id - The ID of the VPC associated with the carrier gateway.

max_results instance-attribute
max_results: int | None

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

next_token instance-attribute
next_token: str | None

The token for the next page of results.

Output

DescribeCarrierGatewaysOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeCarrierGatewaysOutput structure.

Attributes

carrier_gateways class-attribute instance-attribute
carrier_gateways: list[CarrierGateway] | None = ...

Information about the carrier gateway.

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

The token to use 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.