Gets a list of the file shares for a specific S3 File Gateway, or the list of file shares that belong to the calling Amazon Web Services account. This operation is only supported for S3 File Gateways.
Parameters:
-
gateway_arn
(Optional[GatewayARN], default:
None
)
–
The Amazon Resource Name (ARN) of the gateway whose file shares you want to list. If this field is not present, all file shares under your account are listed.
-
limit
(Optional[PositiveIntObject], default:
None
)
–
The maximum number of file shares to return in the response. The value must be an integer with a value greater than zero. Optional.
-
marker
(Optional[Marker], default:
None
)
–
Opaque pagination token returned from a previous ListFileShares operation. If present, Marker specifies where to continue the list from after a previous call to ListFileShares. Optional.
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_file_shares(
self,
*,
config_overrides: Optional[StorageGatewayClientConfig] = None,
gateway_arn: Optional[
"capo_storage_gateway.types.gateway_arn.GatewayARN"
] = None,
limit: Optional[
"capo_storage_gateway.types.positive_int_object.PositiveIntObject"
] = None,
marker: Optional["capo_storage_gateway.types.marker.Marker"] = None,
) -> "capo_storage_gateway.types.list_file_shares_output.ListFileSharesOutput":
"""<p>Gets a list of the file shares for a specific S3 File Gateway, or the list of file shares that belong to the calling Amazon Web Services account. This operation is only supported for S3 File Gateways.</p>
Args:
gateway_arn: <p>The Amazon Resource Name (ARN) of the gateway whose file shares you want to list. If this field is not present, all file shares under your account are listed.</p>
limit: <p>The maximum number of file shares to return in the response. The value must be an integer with a value greater than zero. Optional.</p>
marker: <p>Opaque pagination token returned from a previous ListFileShares operation. If present, <code>Marker</code> specifies where to continue the list from after a previous call to ListFileShares. Optional.</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_file_shares_input.ListFileSharesInput]",
) -> OperationResponse[
"capo_storage_gateway.types.list_file_shares_output.ListFileSharesOutput"
]:
import capo_storage_gateway._operations.storage_gateway_20130630.list_file_shares
output, http_response = (
capo_storage_gateway._operations.storage_gateway_20130630.list_file_shares.list_file_shares(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListFileShares")
)
input_: capo_storage_gateway.types.list_file_shares_input.ListFileSharesInput = {}
if gateway_arn is not None:
input_["gateway_arn"] = gateway_arn
if limit is not None:
input_["limit"] = limit
if marker is not None:
input_["marker"] = marker
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|