Skip to content

list_capacity_tasks

list_capacity_tasks(
    *,
    config_overrides: Optional[OutpostsClientConfig] = None,
    outpost_identifier_filter: Optional[OutpostIdentifier] = None,
    max_results: Optional[MaxResults1000] = None,
    next_token: Optional[Token] = None,
    capacity_task_status_filter: Optional[CapacityTaskStatusList] = None,
) -> ListCapacityTasksOutput

Lists the capacity tasks for your Amazon Web Services account.

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.

Parameters:

  • outpost_identifier_filter (Optional[OutpostIdentifier], default: None ) –

    Filters the results by an Outpost ID or an Outpost ARN.

  • capacity_task_status_filter (Optional[CapacityTaskStatusList], default: None ) –

    A list of statuses. For example, REQUESTED or WAITING_FOR_EVACUATION.

Raises:

Source code in docs_src/capo_outposts/_services/outposts.py
def list_capacity_tasks(
    self,
    *,
    config_overrides: Optional[OutpostsClientConfig] = None,
    outpost_identifier_filter: Optional[
        "capo_outposts.types.outpost_identifier.OutpostIdentifier"
    ] = None,
    max_results: Optional[
        "capo_outposts.types.max_results1000.MaxResults1000"
    ] = None,
    next_token: Optional["capo_outposts.types.token.Token"] = None,
    capacity_task_status_filter: Optional[
        "capo_outposts.types.capacity_task_status_list.CapacityTaskStatusList"
    ] = None,
) -> "capo_outposts.types.list_capacity_tasks_output.ListCapacityTasksOutput":
    """<p>Lists the capacity tasks 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:
        outpost_identifier_filter: <p>Filters the results by an Outpost ID or an Outpost ARN.</p>
        capacity_task_status_filter: <p>A list of statuses. For example, <code>REQUESTED</code> or <code>WAITING_FOR_EVACUATION</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.not_found_exception.NotFoundException: <p>The specified request is not valid.</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_capacity_tasks_input.ListCapacityTasksInput]",
    ) -> OperationResponse[
        "capo_outposts.types.list_capacity_tasks_output.ListCapacityTasksOutput"
    ]:
        import capo_outposts._operations.outposts_olaf_service.list_capacity_tasks

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListCapacityTasks")
    )
    input_: capo_outposts.types.list_capacity_tasks_input.ListCapacityTasksInput = {}
    if outpost_identifier_filter is not None:
        input_["outpost_identifier_filter"] = outpost_identifier_filter
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    if capacity_task_status_filter is not None:
        input_["capacity_task_status_filter"] = capacity_task_status_filter

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