Skip to content

describe_smb_file_shares

describe_smb_file_shares(
    file_share_arn_list: FileShareARNList,
    *,
    config_overrides: Optional[StorageGatewayClientConfig] = None,
) -> DescribeSMBFileSharesOutput

Gets a description for one or more Server Message Block (SMB) file shares from a S3 File Gateway. This operation is only supported for S3 File Gateways.

Parameters:

  • file_share_arn_list (FileShareARNList) –

    An array containing the Amazon Resource Name (ARN) of each file share to be described.

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 describe_smb_file_shares(
    self,
    file_share_arn_list: "capo_storage_gateway.types.file_share_arn_list.FileShareARNList",
    *,
    config_overrides: Optional[StorageGatewayClientConfig] = None,
) -> "capo_storage_gateway.types.describe_smb_file_shares_output.DescribeSMBFileSharesOutput":
    """<p>Gets a description for one or more Server Message Block (SMB) file shares from a S3 File Gateway. This operation is only supported for S3 File Gateways.</p>

    Args:
        file_share_arn_list: <p>An array containing the Amazon Resource Name (ARN) of each file share to be described.</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.describe_smb_file_shares_input.DescribeSMBFileSharesInput]",
    ) -> OperationResponse[
        "capo_storage_gateway.types.describe_smb_file_shares_output.DescribeSMBFileSharesOutput"
    ]:
        import capo_storage_gateway._operations.storage_gateway_20130630.describe_smb_file_shares

        output, http_response = (
            capo_storage_gateway._operations.storage_gateway_20130630.describe_smb_file_shares.describe_smb_file_shares(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeSMBFileShares")
    )
    input_: capo_storage_gateway.types.describe_smb_file_shares_input.DescribeSMBFileSharesInput = {
        "file_share_arn_list": file_share_arn_list
    }

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