list_outposts ¶

def list_outposts(
    self,
    *,
    config_overrides: Optional[OutpostsClientConfig] = None,
    next_token: Optional["capo_outposts.types.token.Token"] = None,
    max_results: Optional[
        "capo_outposts.types.max_results1000.MaxResults1000"
    ] = None,
    life_cycle_status_filter: Optional[
        "capo_outposts.types.life_cycle_status_list.LifeCycleStatusList"
    ] = None,
    availability_zone_filter: Optional[
        "capo_outposts.types.availability_zone_list.AvailabilityZoneList"
    ] = None,
    availability_zone_id_filter: Optional[
        "capo_outposts.types.availability_zone_id_list.AvailabilityZoneIdList"
    ] = None,
) -> "capo_outposts.types.list_outposts_output.ListOutpostsOutput":
    """<p>Lists the Outposts for your Amazon Web Services account.</p> <p>Use filters to return specific results. If you specify multiple filters, the results include only the resources that match all of the specified filters. For a filter where you can specify multiple values, the results include items that match any of the values that you specify for the filter.</p>

    Args:
        life_cycle_status_filter: <p>Filters the results by the lifecycle status.</p>
        availability_zone_filter: <p>Filters the results by Availability Zone (for example, <code>us-east-1a</code>).</p>
        availability_zone_id_filter: <p>Filters the results by AZ ID (for example, <code>use1-az1</code>).</p>

    Raises:
        capo_outposts.errors.access_denied_exception.AccessDeniedException: <p>You do not have permission to perform this operation.</p>
        capo_outposts.errors.internal_server_exception.InternalServerException: <p>An internal error has occurred.</p>
        capo_outposts.errors.validation_exception.ValidationException: <p>A parameter is not valid.</p>
        capo_outposts.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_outposts.types.list_outposts_input.ListOutpostsInput]",
    ) -> OperationResponse[
        "capo_outposts.types.list_outposts_output.ListOutpostsOutput"
    ]:
        import capo_outposts._operations.outposts_olaf_service.list_outposts

        output, http_response = (
            capo_outposts._operations.outposts_olaf_service.list_outposts.list_outposts(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListOutposts")
    )
    input_: capo_outposts.types.list_outposts_input.ListOutpostsInput = {}
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results
    if life_cycle_status_filter is not None:
        input_["life_cycle_status_filter"] = life_cycle_status_filter
    if availability_zone_filter is not None:
        input_["availability_zone_filter"] = availability_zone_filter
    if availability_zone_id_filter is not None:
        input_["availability_zone_id_filter"] = availability_zone_id_filter

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