Lists custom tape pools. You specify custom tape pools to list by specifying one or more custom tape pool Amazon Resource Names (ARNs). If you don't specify a custom tape pool ARN, the operation lists all custom tape pools.
This operation supports pagination. You can optionally specify the Limit parameter in the body to limit the number of tape pools in the response. If the number of tape pools returned in the response is truncated, the response includes a Marker element that you can use in your subsequent request to retrieve the next set of tape pools.
Parameters:
-
pool_ar_ns
(Optional[PoolARNs], default:
None
)
–
The Amazon Resource Name (ARN) of each of the custom tape pools you want to list. If you don't specify a custom tape pool ARN, the response lists all custom tape pools.
-
marker
(Optional[Marker], default:
None
)
–
A string that indicates the position at which to begin the returned list of tape pools.
-
limit
(Optional[PositiveIntObject], default:
None
)
–
An optional number limit for the tape pools in the list returned by this call.
Raises:
-
InternalServerError
–
An internal server error has occurred during the request. For more information, see the error and message fields.
-
InvalidGatewayRequestException
–
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
-
UnknownServiceError
–
The service returned an error code this client does not model.
Source code in docs_src/capo_storage_gateway/_services/storage_gateway.py
| def list_tape_pools(
self,
*,
config_overrides: Optional[StorageGatewayClientConfig] = None,
pool_ar_ns: Optional["capo_storage_gateway.types.pool_ar_ns.PoolARNs"] = None,
marker: Optional["capo_storage_gateway.types.marker.Marker"] = None,
limit: Optional[
"capo_storage_gateway.types.positive_int_object.PositiveIntObject"
] = None,
) -> "capo_storage_gateway.types.list_tape_pools_output.ListTapePoolsOutput":
"""<p>Lists custom tape pools. You specify custom tape pools to list by specifying one or more custom tape pool Amazon Resource Names (ARNs). If you don't specify a custom tape pool ARN, the operation lists all custom tape pools.</p> <p>This operation supports pagination. You can optionally specify the <code>Limit</code> parameter in the body to limit the number of tape pools in the response. If the number of tape pools returned in the response is truncated, the response includes a <code>Marker</code> element that you can use in your subsequent request to retrieve the next set of tape pools.</p>
Args:
pool_ar_ns: <p>The Amazon Resource Name (ARN) of each of the custom tape pools you want to list. If you don't specify a custom tape pool ARN, the response lists all custom tape pools. </p>
marker: <p>A string that indicates the position at which to begin the returned list of tape pools.</p>
limit: <p>An optional number limit for the tape pools in the list returned by this call.</p>
Raises:
capo_storage_gateway.errors.internal_server_error.InternalServerError: <p>An internal server error has occurred during the request. For more information, see the error and message fields.</p>
capo_storage_gateway.errors.invalid_gateway_request_exception.InvalidGatewayRequestException: <p>An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.</p>
capo_storage_gateway.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_storage_gateway.types.list_tape_pools_input.ListTapePoolsInput]",
) -> OperationResponse[
"capo_storage_gateway.types.list_tape_pools_output.ListTapePoolsOutput"
]:
import capo_storage_gateway._operations.storage_gateway_20130630.list_tape_pools
output, http_response = (
capo_storage_gateway._operations.storage_gateway_20130630.list_tape_pools.list_tape_pools(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListTapePools")
)
input_: capo_storage_gateway.types.list_tape_pools_input.ListTapePoolsInput = {}
if pool_ar_ns is not None:
input_["pool_ar_ns"] = pool_ar_ns
if marker is not None:
input_["marker"] = marker
if limit is not None:
input_["limit"] = limit
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|