You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::EC2::Types::DescribeCarrierGatewaysRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::EC2::Types::DescribeCarrierGatewaysRequest
- Defined in:
- (unknown)
Overview
When passing DescribeCarrierGatewaysRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
carrier_gateway_ids: ["CarrierGatewayId"],
filters: [
{
name: "String",
values: ["String"],
},
],
max_results: 1,
next_token: "String",
dry_run: false,
}
Instance Attribute Summary collapse
-
#carrier_gateway_ids ⇒ Array<String>
One or more carrier gateway IDs.
-
#dry_run ⇒ Boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.
-
#filters ⇒ Array<Types::Filter>
One or more filters.
-
#max_results ⇒ Integer
The maximum number of results to return with a single call.
-
#next_token ⇒ String
The token for the next page of results.
Instance Attribute Details
#carrier_gateway_ids ⇒ Array<String>
One or more carrier gateway IDs.
#dry_run ⇒ Boolean
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 ⇒ Array<Types::Filter>
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 AWS 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 keyOwner
and the valueTeamA
, specifytag:Owner
for the filter name andTeamA
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 ⇒ Integer
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 ⇒ String
The token for the next page of results.