Skip to content

describe_location_smb

describe_location_smb(
    location_arn: LocationArn,
    *,
    config_overrides: Optional[DataSyncClientConfig] = None,
) -> DescribeLocationSmbResponse

Provides details about how an DataSync transfer location for a Server Message Block (SMB) file server is configured.

Parameters:

  • location_arn (LocationArn) –

    Specifies the Amazon Resource Name (ARN) of the SMB location that you want information about.

Raises:

Source code in docs_src/capo_datasync/_services/data_sync.py
def describe_location_smb(
    self,
    location_arn: "capo_datasync.types.location_arn.LocationArn",
    *,
    config_overrides: Optional[DataSyncClientConfig] = None,
) -> (
    "capo_datasync.types.describe_location_smb_response.DescribeLocationSmbResponse"
):
    """<p>Provides details about how an DataSync transfer location for a Server Message Block (SMB) file server is configured.</p>

    Args:
        location_arn: <p>Specifies the Amazon Resource Name (ARN) of the SMB location that you want information about.</p>

    Raises:
        capo_datasync.errors.internal_exception.InternalException: <p>This exception is thrown when an error occurs in the DataSync service.</p>
        capo_datasync.errors.invalid_request_exception.InvalidRequestException: <p>This exception is thrown when the client submits a malformed request.</p>
        capo_datasync.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_datasync.types.describe_location_smb_request.DescribeLocationSmbRequest]",
    ) -> OperationResponse[
        "capo_datasync.types.describe_location_smb_response.DescribeLocationSmbResponse"
    ]:
        import capo_datasync._operations.fmrs_service.describe_location_smb

        output, http_response = (
            capo_datasync._operations.fmrs_service.describe_location_smb.describe_location_smb(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeLocationSmb")
    )
    input_: capo_datasync.types.describe_location_smb_request.DescribeLocationSmbRequest = {
        "location_arn": location_arn
    }

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