Amazon DataSync

Amazon DataSync Datasync Location Fsx Open Zf API

The Datasync Location Fsx Open Zf API from Amazon DataSync — 3 operation(s) for datasync location fsx open zf.

GitHub OpenAPI
Business capability
IT Infrastructure Management BC-600.50

Operations 3

POST /#CreateLocationFsxOpenZfs Create Location Fsx Open Zfs #
POST /#DescribeLocationFsxOpenZfs Describe Location Fsx Open Zfs #
POST /#UpdateLocationFsxOpenZfs Update Location Fsx Open Zfs #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/amazon-datasync/openapi/amazon-datasync-location-fsx-open-zf-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/amazon-datasync:amazon-datasync-location-fsx-open-zf-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

amazon-datasync-location-fsx-open-zf-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: AWS DataSync Location Fsx Open Zf API
  version: '2018-11-09'
  description: Generated from AWS's published Smithy model for AWS DataSync. 3 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://datasync.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Location Fsx Open Zf
paths:
  /#CreateLocationFsxOpenZfs:
    post:
      operationId: CreateLocationFsxOpenZfs
      summary: Create Location Fsx Open Zfs
      description: Creates a transfer location for an Amazon FSx for OpenZFS file system. DataSync can use this location as a source or destination for transferring data. Before you begin, make sure that you understand how DataSync accesses FSx for OpenZFS file systems. Request parameters related to SMB aren't supported with the CreateLocationFsxOpenZfs operation.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateLocationFsxOpenZfsResponse'
        '500':
          description: InternalException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalException'
        '400':
          description: InvalidRequestException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - FmrsService.CreateLocationFsxOpenZfs
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateLocationFsxOpenZfsRequest'
      tags:
      - Location Fsx Open Zf
  /#DescribeLocationFsxOpenZfs:
    post:
      operationId: DescribeLocationFsxOpenZfs
      summary: Describe Location Fsx Open Zfs
      description: Provides details about how an DataSync transfer location for an Amazon FSx for OpenZFS file system is configured. Response elements related to SMB aren't supported with the DescribeLocationFsxOpenZfs operation.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeLocationFsxOpenZfsResponse'
        '500':
          description: InternalException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalException'
        '400':
          description: InvalidRequestException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - FmrsService.DescribeLocationFsxOpenZfs
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeLocationFsxOpenZfsRequest'
      tags:
      - Location Fsx Open Zf
  /#UpdateLocationFsxOpenZfs:
    post:
      operationId: UpdateLocationFsxOpenZfs
      summary: Update Location Fsx Open Zfs
      description: Modifies the following configuration parameters of the Amazon FSx for OpenZFS transfer location that you're using with DataSync. For more information, see Configuring DataSync transfers with FSx for OpenZFS. Request parameters related to SMB aren't supported with the UpdateLocationFsxOpenZfs operation.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateLocationFsxOpenZfsResponse'
        '500':
          description: InternalException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalException'
        '400':
          description: InvalidRequestException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - FmrsService.UpdateLocationFsxOpenZfs
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateLocationFsxOpenZfsRequest'
      tags:
      - Location Fsx Open Zf
components:
  schemas:
    CreateLocationFsxOpenZfsRequest:
      type: object
      properties:
        FsxFilesystemArn:
          type: string
          description: The Amazon Resource Name (ARN) of the FSx for OpenZFS file system.
        Protocol:
          $ref: '#/components/schemas/FsxProtocol'
        SecurityGroupArns:
          type: array
          items:
            type: string
          description: The ARNs of the security groups that are used to configure the FSx for OpenZFS file system.
        Subdirectory:
          type: string
          description: A subdirectory in the location's path that must begin with /fsx. DataSync uses this subdirectory to read or write data (depending on whether the file system is a source or destination location).
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/TagListEntry'
          description: The key-value pair that represents a tag that you want to add to the resource. The value can be an empty string. This value helps you manage, filter, and search for your resources. We recommend that you create a name tag for your location.
      required:
      - FsxFilesystemArn
      - Protocol
      - SecurityGroupArns
    FsxProtocolNfs:
      type: object
      properties:
        MountOptions:
          $ref: '#/components/schemas/NfsMountOptions'
    SmbMountOptions:
      type: object
      properties:
        Version:
          type: string
          enum:
          - AUTOMATIC
          - SMB2
          - SMB3
          - SMB1
          - SMB2_0
          description: 'By default, DataSync automatically chooses an SMB protocol version based on negotiation with your SMB file server. You also can configure DataSync to use a specific SMB version, but we recommend doing this only if DataSync has trouble negotiating with the SMB file server automatically. These are the following options for configuring the SMB version: AUTOMATIC (default): DataSync and the SMB file server negotiate the highest version of SMB that they mutually support between 2.1 and 3.1.1. This is the recommended option. If you instead choose a specific version that your file server doesn''t supp'
    TagListEntry:
      type: object
      properties:
        Key:
          type: string
          description: The key for an Amazon Web Services resource tag.
        Value:
          type: string
          description: The value for an Amazon Web Services resource tag.
      required:
      - Key
    UpdateLocationFsxOpenZfsRequest:
      type: object
      properties:
        LocationArn:
          type: string
          description: Specifies the Amazon Resource Name (ARN) of the FSx for OpenZFS transfer location that you're updating.
        Protocol:
          $ref: '#/components/schemas/FsxProtocol'
        Subdirectory:
          type: string
          description: Specifies a subdirectory in the location's path that must begin with /fsx. DataSync uses this subdirectory to read or write data (depending on whether the file system is a source or destination location).
      required:
      - LocationArn
    CustomSecretConfig:
      type: object
      properties:
        SecretArn:
          type: string
          description: Specifies the ARN for an Secrets Manager secret.
        SecretAccessRoleArn:
          type: string
          description: Specifies the ARN for the Identity and Access Management role that DataSync uses to access the secret specified for SecretArn.
    NfsMountOptions:
      type: object
      properties:
        Version:
          type: string
          enum:
          - AUTOMATIC
          - NFS3
          - NFS4_0
          - NFS4_1
          - NFS4_2
          description: 'Specifies the NFS version that you want DataSync to use when mounting your NFS share. If the server refuses to use the version specified, the task fails. You can specify the following options: AUTOMATIC (default): DataSync chooses NFS version 4.1. For Amazon FSx for OpenZFS locations, DataSync first attempts to use NFS version 4.2, then falls back to version 4.1, and then to earlier versions if needed. NFS3: Stateless protocol version that allows for asynchronous writes on the server. NFSv4_0: Stateful, firewall-friendly protocol version that supports delegations and pseudo file systems. NFSv4'
    FsxProtocol:
      type: object
      properties:
        NFS:
          $ref: '#/components/schemas/FsxProtocolNfs'
        SMB:
          $ref: '#/components/schemas/FsxProtocolSmb'
    ManagedSecretConfig:
      type: object
      properties:
        SecretArn:
          type: string
          description: Specifies the ARN for an Secrets Manager secret.
    DescribeLocationFsxOpenZfsResponse:
      type: object
      properties:
        LocationArn:
          type: string
          description: The ARN of the FSx for OpenZFS location that was described.
        LocationUri:
          type: string
          description: 'The uniform resource identifier (URI) of the FSx for OpenZFS location that was described. Example: fsxz://us-west-2.fs-1234567890abcdef02/fsx/folderA/folder'
        SecurityGroupArns:
          type: array
          items:
            type: string
          description: The ARNs of the security groups that are configured for the FSx for OpenZFS file system.
        Protocol:
          $ref: '#/components/schemas/FsxProtocol'
        CreationTime:
          type: string
          format: date-time
          description: The time that the FSx for OpenZFS location was created.
    DescribeLocationFsxOpenZfsRequest:
      type: object
      properties:
        LocationArn:
          type: string
          description: The Amazon Resource Name (ARN) of the FSx for OpenZFS location to describe.
      required:
      - LocationArn
    FsxProtocolSmb:
      type: object
      properties:
        Domain:
          type: string
          description: Specifies the name of the Windows domain that your storage virtual machine (SVM) belongs to. If you have multiple domains in your environment, configuring this setting makes sure that DataSync connects to the right SVM. If you have multiple Active Directory domains in your environment, configuring this parameter makes sure that DataSync connects to the right SVM.
        MountOptions:
          $ref: '#/components/schemas/SmbMountOptions'
        Password:
          type: string
          description: Specifies the password of a user who has permission to access your SVM.
        User:
          type: string
          description: Specifies a user that can mount and access the files, folders, and metadata in your SVM. For information about choosing a user with the right level of access for your transfer, see Using the SMB protocol.
        ManagedSecretConfig:
          $ref: '#/components/schemas/ManagedSecretConfig'
        CmkSecretConfig:
          $ref: '#/components/schemas/CmkSecretConfig'
        CustomSecretConfig:
          $ref: '#/components/schemas/CustomSecretConfig'
      required:
      - User
    CreateLocationFsxOpenZfsResponse:
      type: object
      properties:
        LocationArn:
          type: string
          description: The ARN of the FSx for OpenZFS file system location that you created.
    CmkSecretConfig:
      type: object
      properties:
        SecretArn:
          type: string
          description: Specifies the ARN for the DataSync-managed Secrets Manager secret that that is used to access a specific storage location. This property is generated by DataSync and is read-only. DataSync encrypts this secret with the KMS key that you specify for KmsKeyArn.
        KmsKeyArn:
          type: string
          description: Specifies the ARN for the customer-managed KMS key that DataSync uses to encrypt the DataSync-managed secret stored for SecretArn. DataSync provides this key to Secrets Manager.
    InternalException:
      type: object
      properties:
        message:
          type: string
        errorCode:
          type: string
    InvalidRequestException:
      type: object
      properties:
        message:
          type: string
        errorCode:
          type: string
        datasyncErrorCode:
          type: string
    UpdateLocationFsxOpenZfsResponse:
      type: object
      properties: {}
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: datasync
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/datasync/service/2018-11-09/datasync-2018-11-09.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)