| « PreviousNext » | |
  | Did this page help you? Yes | No | Tell us about it... |
DescribeInternetGateways
Description
Describes one or more of your Internet gateways.
Request Parameters
InternetGatewayId.nOne or more Internet gateway IDs.
Type: String
Default: None
Required: No
Filter.n.NameThe name of a filter. See the Supported Filters section for a list of supported filter names.
Type: String
Default: None
Required: No
Filter.n.Value.mA value for the filter. See the Supported Filters section for a list of supported values for each filter.
Type: String
Default: None
Required: No
Supported Filters
You can specify filters so that the response includes information for only certain Internet gateways. For example, you can use a filter to specify that you're interested in the Internet gateways with particular tags. You can specify multiple values for a filter. The response includes information for an Internet gateway only if it matches at least one of the filter values that you specified.
You can specify multiple filters; for example, specify Internet gateways that are attached to a specific VPC and have a specific tag. The response includes information for an Internet gateway only if it matches all the filters that you specified. If there's no match, no special message is returned, the response is simply empty.
You can use wildcards in a filter value. An asterisk (*) matches zero or more characters, and a question mark (?) matches exactly one character. You can escape special characters using a backslash (\) before the character. For example, a value of \*amazon\?\\ searches for the literal string *amazon?\.
The following are the available filters.
attachment.stateThe current state of the attachment between the gateway and the VPC. Returned only if a VPC is attached.
Type: String
Valid value:
availableattachment.vpc-idThe ID of an attached VPC.
Type: String
internet-gateway-idThe ID of the Internet gateway.
Type: String
tag-keyThe key of a tag assigned to the resource. This filter is independent of the
tag-valuefilter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag keyPurpose(regardless of what the tag's value is), and the tag valueX(regardless of what the tag's key is). If you want to list only resources where Purpose is X, see thetag:filter.keyFor more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide.
Type: String
tag-valueThe value of a tag assigned to the resource. This filter is independent of the
tag-keyfilter.Type: String
tag:keyFilters the response based on a specific tag/value combination.
Example: To list just the resources that have been assigned tag Purpose=X, specify:
Filter.1.Name=tag:PurposeFilter.1.Value.1=XExample: To list just resources that have been assigned tag Purpose=X OR Purpose=Y, specify:
Filter.1.Name=tag:PurposeFilter.1.Value.1=XFilter.1.Value.2=Y
Response Elements
The following elements are returned in a
DescribeInternetGatewaysResponse element.
requestIdThe ID of the request.
Type: xsd:string
internetGatewaySetA list of Internet gateways, each one wrapped in an
itemelement.Type: InternetGatewayType
Examples
Example Request
This example describes your Internet gateways.
https://ec2.amazonaws.com/?Action=DescribeInternetGateways
Example Response
<DescribeInternetGatewaysResponse xmlns="http://ec2.amazonaws.com/doc/2013-02-01/">
<requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId>
<internetGatewaySet>
<item>
<internetGatewayId>igw-eaad4883EXAMPLE</internetGatewayId>
<attachmentSet>
<item>
<vpcId>vpc-11ad4878</vpcId>
<state>available</state>
</item>
</attachmentSet>
<tagSet/>
</item>
</internetGatewaySet>
</DescribeInternetGatewaysResponse>
