describe_internet_gateways ¶

def describe_internet_gateways(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    next_token: Optional["capo_ec2.types.string.String"] = None,
    max_results: Optional[
        "capo_ec2.types.describe_internet_gateways_max_results.DescribeInternetGatewaysMaxResults"
    ] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
    internet_gateway_ids: Optional[
        "capo_ec2.types.internet_gateway_id_list.InternetGatewayIdList"
    ] = None,
    filters: Optional["capo_ec2.types.filter_list.FilterList"] = None,
) -> "capo_ec2.types.describe_internet_gateways_result.DescribeInternetGatewaysResult":
    """<p>Describes your internet gateways. The default is to describe all your internet gateways. Alternatively, you can specify specific internet gateway IDs or filter the results to include only the internet gateways that match specific criteria.</p>

    Args:
        next_token: <p>The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.</p>
        max_results: <p>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 <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination">Pagination</a>.</p>
        dry_run: <p>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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
        internet_gateway_ids: <p>The IDs of the internet gateways.</p> <p>Default: Describes all your internet gateways.</p>
        filters: <p>The filters.</p> <ul> <li> <p> <code>attachment.state</code> - The current state of the attachment between the gateway and the VPC (<code>available</code>). Present only if a VPC is attached.</p> </li> <li> <p> <code>attachment.vpc-id</code> - The ID of an attached VPC.</p> </li> <li> <p> <code>internet-gateway-id</code> - The ID of the Internet gateway.</p> </li> <li> <p> <code>owner-id</code> - The ID of the Amazon Web Services account that owns the internet gateway.</p> </li> <li> <p> <code>tag</code> - 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 <code>Owner</code> and the value <code>TeamA</code>, specify <code>tag:Owner</code> for the filter name and <code>TeamA</code> for the filter value.</p> </li> <li> <p> <code>tag-key</code> - 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.</p> </li> </ul>

    Raises:
        capo_ec2.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To describe the Internet gateway for a VPC
        This example describes the Internet gateway for the specified VPC.

        >>> client.describe_internet_gateways(filters=[{'Name': 'attachment.vpc-id', 'Values': ['vpc-a01106c2']}])
    """

    def _handler(
        req: "OperationRequest[capo_ec2.types.describe_internet_gateways_request.DescribeInternetGatewaysRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.describe_internet_gateways_result.DescribeInternetGatewaysResult"
    ]:
        import capo_ec2._operations.amazon_ec2.describe_internet_gateways

        output, http_response = (
            capo_ec2._operations.amazon_ec2.describe_internet_gateways.describe_internet_gateways(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeInternetGateways")
    )
    input_: capo_ec2.types.describe_internet_gateways_request.DescribeInternetGatewaysRequest = {}
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results
    if dry_run is not None:
        input_["dry_run"] = dry_run
    if internet_gateway_ids is not None:
        input_["internet_gateway_ids"] = internet_gateway_ids
    if filters is not None:
        input_["filters"] = filters

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output