Skip to content

describe_egress_only_internet_gateways async

describe_egress_only_internet_gateways(
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    dry_run: Optional[Boolean] = None,
    egress_only_internet_gateway_ids: Optional[EgressOnlyInternetGatewayIdList] = None,
    max_results: Optional[DescribeEgressOnlyInternetGatewaysMaxResults] = None,
    next_token: Optional[String] = None,
    filters: Optional[FilterList] = None,
) -> DescribeEgressOnlyInternetGatewaysResult

Describes your egress-only internet gateways. The default is to describe all your egress-only internet gateways. Alternatively, you can specify specific egress-only internet gateway IDs or filter the results to include only the egress-only internet gateways that match specific criteria.

Parameters:

  • dry_run (Optional[Boolean], default: 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.

  • egress_only_internet_gateway_ids (Optional[EgressOnlyInternetGatewayIdList], default: None ) –

    The IDs of the egress-only internet gateways.

  • max_results (Optional[DescribeEgressOnlyInternetGatewaysMaxResults], default: None ) –

    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 Pagination.

  • next_token (Optional[String], default: None ) –

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

  • filters (Optional[FilterList], default: None ) –

    The filters.

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

Raises:

Source code in docs_src/capo_ec2/_services/async_ec2.py
async def describe_egress_only_internet_gateways(
    self,
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
    egress_only_internet_gateway_ids: Optional[
        "capo_ec2.types.egress_only_internet_gateway_id_list.EgressOnlyInternetGatewayIdList"
    ] = None,
    max_results: Optional[
        "capo_ec2.types.describe_egress_only_internet_gateways_max_results.DescribeEgressOnlyInternetGatewaysMaxResults"
    ] = None,
    next_token: Optional["capo_ec2.types.string.String"] = None,
    filters: Optional["capo_ec2.types.filter_list.FilterList"] = None,
) -> "capo_ec2.types.describe_egress_only_internet_gateways_result.DescribeEgressOnlyInternetGatewaysResult":
    """<p>Describes your egress-only internet gateways. The default is to describe all your egress-only internet gateways. Alternatively, you can specify specific egress-only internet gateway IDs or filter the results to include only the egress-only internet gateways that match specific criteria.</p>

    Args:
        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>
        egress_only_internet_gateway_ids: <p>The IDs of the egress-only internet gateways.</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>
        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>
        filters: <p>The filters.</p> <ul> <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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_ec2.types.describe_egress_only_internet_gateways_request.DescribeEgressOnlyInternetGatewaysRequest]",
    ) -> AsyncOperationResponse[
        "capo_ec2.types.describe_egress_only_internet_gateways_result.DescribeEgressOnlyInternetGatewaysResult"
    ]:
        import capo_ec2._operations.amazon_ec2.describe_egress_only_internet_gateways

        (
            output,
            http_response,
        ) = await capo_ec2._operations.amazon_ec2.describe_egress_only_internet_gateways.async_describe_egress_only_internet_gateways(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeEgressOnlyInternetGateways")
    )
    input_: capo_ec2.types.describe_egress_only_internet_gateways_request.DescribeEgressOnlyInternetGatewaysRequest = {}
    if dry_run is not None:
        input_["dry_run"] = dry_run
    if egress_only_internet_gateway_ids is not None:
        input_["egress_only_internet_gateway_ids"] = (
            egress_only_internet_gateway_ids
        )
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    if filters is not None:
        input_["filters"] = filters

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output