Amazon DataSync

Amazon DataSync Datasync Location Fsx Ontap API

The Datasync Location Fsx Ontap API from Amazon DataSync — 3 operation(s) for datasync location fsx ontap.

GitHub OpenAPI
Business capability
IT Infrastructure Management BC-600.50

Operations 3

POST /#CreateLocationFsxOntap Create Location Fsx Ontap #
POST /#DescribeLocationFsxOntap Describe Location Fsx Ontap #
POST /#UpdateLocationFsxOntap Update Location Fsx Ontap #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/amazon-datasync/openapi/amazon-datasync-location-fsx-ontap-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-ontap-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-ontap-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: AWS DataSync Location Fsx Ontap 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 Ontap
paths:
  /#CreateLocationFsxOntap:
    post:
      operationId: CreateLocationFsxOntap
      summary: Create Location Fsx Ontap
      description: Creates a transfer location for an Amazon FSx for NetApp ONTAP 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 ONTAP file systems.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateLocationFsxOntapResponse'
        '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.CreateLocationFsxOntap
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateLocationFsxOntapRequest'
      tags:
      - Location Fsx Ontap
  /#DescribeLocationFsxOntap:
    post:
      operationId: DescribeLocationFsxOntap
      summary: Describe Location Fsx Ontap
      description: 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.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeLocationFsxOntapResponse'
        '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.DescribeLocationFsxOntap
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeLocationFsxOntapRequest'
      tags:
      - Location Fsx Ontap
  /#UpdateLocationFsxOntap:
    post:
      operationId: UpdateLocationFsxOntap
      summary: Update Location Fsx Ontap
      description: Modifies the following configuration parameters of the Amazon FSx for NetApp ONTAP transfer location that you're using with DataSync. For more information, see Configuring DataSync transfers with FSx for ONTAP.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateLocationFsxOntapResponse'
        '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.UpdateLocationFsxOntap
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateLocationFsxOntapRequest'
      tags:
      - Location Fsx Ontap
components:
  schemas:
    DescribeLocationFsxOntapResponse:
      type: object
      properties:
        CreationTime:
          type: string
          format: date-time
          description: The time that the location was created.
        LocationArn:
          type: string
          description: The ARN of the FSx for ONTAP file system location.
        LocationUri:
          type: string
          description: The uniform resource identifier (URI) of the FSx for ONTAP file system location.
        Protocol:
          $ref: '#/components/schemas/FsxProtocol'
        SecurityGroupArns:
          type: array
          items:
            type: string
          description: The security groups that DataSync uses to access your FSx for ONTAP file system.
        StorageVirtualMachineArn:
          type: string
          description: The ARN of the storage virtual machine (SVM) on your FSx for ONTAP file system where you're copying data to or from.
        FsxFilesystemArn:
          type: string
          description: The ARN of the FSx for ONTAP file system.
    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.
    CreateLocationFsxOntapResponse:
      type: object
      properties:
        LocationArn:
          type: string
          description: Specifies the ARN of the FSx for ONTAP file system location that you create.
    DescribeLocationFsxOntapRequest:
      type: object
      properties:
        LocationArn:
          type: string
          description: Specifies the Amazon Resource Name (ARN) of the FSx for ONTAP file system location that you want information about.
      required:
      - LocationArn
    InvalidRequestException:
      type: object
      properties:
        message:
          type: string
        errorCode:
          type: string
        datasyncErrorCode:
          type: string
    InternalException:
      type: object
      properties:
        message:
          type: string
        errorCode:
          type: string
    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'
    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.
    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'
    ManagedSecretConfig:
      type: object
      properties:
        SecretArn:
          type: string
          description: Specifies the ARN for an Secrets Manager secret.
    FsxUpdateProtocolSmb:
      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 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.
        CmkSecretConfig:
          $ref: '#/components/schemas/CmkSecretConfig'
        CustomSecretConfig:
          $ref: '#/components/schemas/CustomSecretConfig'
    FsxUpdateProtocol:
      type: object
      properties:
        NFS:
          $ref: '#/components/schemas/FsxProtocolNfs'
        SMB:
          $ref: '#/components/schemas/FsxUpdateProtocolSmb'
    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
    CreateLocationFsxOntapRequest:
      type: object
      properties:
        Protocol:
          $ref: '#/components/schemas/FsxProtocol'
        SecurityGroupArns:
          type: array
          items:
            type: string
          description: 'Specifies the Amazon EC2 security groups that provide access to your file system''s preferred subnet. The security groups must allow outbound traffic on the following ports (depending on the protocol you use): Network File System (NFS): TCP ports 111, 635, and 2049 Server Message Block (SMB): TCP port 445 Your file system''s security groups must also allow inbound traffic on the same ports.'
        StorageVirtualMachineArn:
          type: string
          description: Specifies the ARN of the storage virtual machine (SVM) in your file system where you want to copy data to or from.
        Subdirectory:
          type: string
          description: Specifies a path to the file share in the SVM where you want to transfer data to or from. You can specify a junction path (also known as a mount point), qtree path (for NFS file shares), or share name (for SMB file shares). For example, your mount path might be /vol1, /vol1/tree1, or /share1. Don't specify a junction path in the SVM's root volume. For more information, see Managing FSx for ONTAP storage virtual machines in the Amazon FSx for NetApp ONTAP User Guide.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/TagListEntry'
          description: Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your location.
      required:
      - Protocol
      - SecurityGroupArns
      - StorageVirtualMachineArn
    UpdateLocationFsxOntapRequest:
      type: object
      properties:
        LocationArn:
          type: string
          description: Specifies the Amazon Resource Name (ARN) of the FSx for ONTAP transfer location that you're updating.
        Protocol:
          $ref: '#/components/schemas/FsxUpdateProtocol'
        Subdirectory:
          type: string
          description: Specifies a path to the file share in the storage virtual machine (SVM) where you want to transfer data to or from. You can specify a junction path (also known as a mount point), qtree path (for NFS file shares), or share name (for SMB file shares). For example, your mount path might be /vol1, /vol1/tree1, or /share1. Don't specify a junction path in the SVM's root volume. For more information, see Managing FSx for ONTAP storage virtual machines in the Amazon FSx for NetApp ONTAP User Guide.
      required:
      - LocationArn
    UpdateLocationFsxOntapResponse:
      type: object
      properties: {}
    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
    FsxProtocol:
      type: object
      properties:
        NFS:
          $ref: '#/components/schemas/FsxProtocolNfs'
        SMB:
          $ref: '#/components/schemas/FsxProtocolSmb'
  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)