Skip to content

describe_location_fsx_ontap

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

Provides details about how an DataSync transfer location for an Amazon FSx for NetApp ONTAP file system is configured.

If your location uses SMB, the DescribeLocationFsxOntap operation doesn't actually return a Password.

Parameters:

  • location_arn (LocationArn) –

    Specifies the Amazon Resource Name (ARN) of the FSx for ONTAP file system location that you want information about.

Raises:

Source code in docs_src/capo_datasync/_services/data_sync.py
def describe_location_fsx_ontap(
    self,
    location_arn: "capo_datasync.types.location_arn.LocationArn",
    *,
    config_overrides: Optional[DataSyncClientConfig] = None,
) -> "capo_datasync.types.describe_location_fsx_ontap_response.DescribeLocationFsxOntapResponse":
    """<p>Provides details about how an DataSync transfer location for an Amazon FSx for NetApp ONTAP file system is configured.</p> <note> <p>If your location uses SMB, the <code>DescribeLocationFsxOntap</code> operation doesn't actually return a <code>Password</code>.</p> </note>

    Args:
        location_arn: <p>Specifies the Amazon Resource Name (ARN) of the FSx for ONTAP file system 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_fsx_ontap_request.DescribeLocationFsxOntapRequest]",
    ) -> OperationResponse[
        "capo_datasync.types.describe_location_fsx_ontap_response.DescribeLocationFsxOntapResponse"
    ]:
        import capo_datasync._operations.fmrs_service.describe_location_fsx_ontap

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

    def _redact_output(
        output: "capo_datasync.types.describe_location_fsx_ontap_response.DescribeLocationFsxOntapResponse",
    ) -> dict[str, Any]:
        import capo_datasync.types.describe_location_fsx_ontap_response

        return capo_datasync.types.describe_location_fsx_ontap_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("DescribeLocationFsxOntap", redact_output=_redact_output),
    )
    input_: capo_datasync.types.describe_location_fsx_ontap_request.DescribeLocationFsxOntapRequest = {
        "location_arn": location_arn
    }

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