describe_volumes ¶

def describe_volumes(
    self,
    *,
    config_overrides: Optional[FSxClientConfig] = None,
    volume_ids: Optional["capo_fsx.types.volume_ids.VolumeIds"] = None,
    filters: Optional["capo_fsx.types.volume_filters.VolumeFilters"] = None,
    max_results: Optional["capo_fsx.types.max_results.MaxResults"] = None,
    next_token: Optional["capo_fsx.types.next_token.NextToken"] = None,
) -> "capo_fsx.types.describe_volumes_response.DescribeVolumesResponse":
    """<p>Describes one or more Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volumes.</p>

    Args:
        volume_ids: <p>The IDs of the volumes whose descriptions you want to retrieve.</p>
        filters: <p>Enter a filter <code>Name</code> and <code>Values</code> pair to view a select set of volumes.</p>

    Raises:
        capo_fsx.errors.bad_request.BadRequest: <p>A generic error indicating a failure with a client request.</p>
        capo_fsx.errors.internal_server_error.InternalServerError: <p>A generic error indicating a server-side failure.</p>
        capo_fsx.errors.volume_not_found.VolumeNotFound: <p>No Amazon FSx volumes were found based upon the supplied parameters.</p>
        capo_fsx.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_fsx.types.describe_volumes_request.DescribeVolumesRequest]",
    ) -> OperationResponse[
        "capo_fsx.types.describe_volumes_response.DescribeVolumesResponse"
    ]:
        import capo_fsx._operations.aws_simba_api_service_v20180301.describe_volumes

        output, http_response = (
            capo_fsx._operations.aws_simba_api_service_v20180301.describe_volumes.describe_volumes(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_fsx.types.describe_volumes_response.DescribeVolumesResponse",
    ) -> dict[str, Any]:
        import capo_fsx.types.describe_volumes_response

        return capo_fsx.types.describe_volumes_response.redact_sensitive(output)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("DescribeVolumes", redact_output=_redact_output),
    )
    input_: capo_fsx.types.describe_volumes_request.DescribeVolumesRequest = {}
    if volume_ids is not None:
        input_["volume_ids"] = volume_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

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