describe_carrier_gateways ¶

def describe_carrier_gateways(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    carrier_gateway_ids: Optional[
        "capo_ec2.types.carrier_gateway_id_set.CarrierGatewayIdSet"
    ] = None,
    filters: Optional["capo_ec2.types.filter_list.FilterList"] = None,
    max_results: Optional[
        "capo_ec2.types.carrier_gateway_max_results.CarrierGatewayMaxResults"
    ] = None,
    next_token: Optional["capo_ec2.types.string.String"] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
) -> (
    "capo_ec2.types.describe_carrier_gateways_result.DescribeCarrierGatewaysResult"
):
    """<p>Describes one or more of your carrier gateways.</p>

    Args:
        carrier_gateway_ids: <p>One or more carrier gateway IDs.</p>
        filters: <p>One or more filters.</p> <ul> <li> <p> <code>carrier-gateway-id</code> - The ID of the carrier gateway.</p> </li> <li> <p> <code>state</code> - The state of the carrier gateway (<code>pending</code> | <code>failed</code> | <code>available</code> | <code>deleting</code> | <code>deleted</code>).</p> </li> <li> <p> <code>owner-id</code> - The Amazon Web Services account ID of the owner of the carrier gateway.</p> </li> <li> <p> <code>tag</code>:<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 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> <li> <p> <code>vpc-id</code> - The ID of the VPC associated with the carrier gateway.</p> </li> </ul>
        max_results: <p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>
        next_token: <p>The token for the next page of results.</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>

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

    def _handler(
        req: "OperationRequest[capo_ec2.types.describe_carrier_gateways_request.DescribeCarrierGatewaysRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.describe_carrier_gateways_result.DescribeCarrierGatewaysResult"
    ]:
        import capo_ec2._operations.amazon_ec2.describe_carrier_gateways

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeCarrierGateways")
    )
    input_: capo_ec2.types.describe_carrier_gateways_request.DescribeCarrierGatewaysRequest = {}
    if carrier_gateway_ids is not None:
        input_["carrier_gateway_ids"] = carrier_gateway_ids
    if filters is not None:
        input_["filters"] = filters
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    if dry_run is not None:
        input_["dry_run"] = dry_run

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