describe_carrier_gateways¶
Operation¶
describe_carrier_gateways
¶
describe_carrier_gateways(request: DescribeCarrierGatewaysInput | DescribeCarrierGatewaysInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeCarrierGatewaysInputDict]) -> DescribeCarrierGatewaysOutput
Describes one or more of your carrier gateways.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DescribeCarrierGatewaysInput | DescribeCarrierGatewaysInputDict | 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[DescribeCarrierGatewaysInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DescribeCarrierGatewaysOutput
|
An instance of |
describe_carrier_gateways
async
¶
describe_carrier_gateways(request: DescribeCarrierGatewaysInput | DescribeCarrierGatewaysInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeCarrierGatewaysInputDict]) -> DescribeCarrierGatewaysOutput
Describes one or more of your carrier gateways.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DescribeCarrierGatewaysInput | DescribeCarrierGatewaysInputDict | 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[DescribeCarrierGatewaysInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DescribeCarrierGatewaysOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
DescribeCarrierGatewaysInputDict
¶
Bases: TypedDict
Dictionary form of DescribeCarrierGatewaysInput.
Attributes¶
carrier_gateway_ids
instance-attribute
¶
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 keyOwnerand the valueTeamA, specifytag:Ownerfor the filter name andTeamAfor 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.
DescribeCarrierGatewaysInput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeCarrierGatewaysInput structure.
Attributes¶
carrier_gateway_ids
class-attribute
instance-attribute
¶
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
¶
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 keyOwnerand the valueTeamA, specifytag:Ownerfor the filter name andTeamAfor 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.
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
¶
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.