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-nf-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

openapi: 3.2.0
info:
  title: AWS DataSync Location Nf 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 Nf
paths:
  /#CreateLocationNfs:
    post:
      operationId: CreateLocationNfs
      summary: Create Location Nfs
      description: Creates a transfer location for a Network File System (NFS) file server. DataSync can use this location as a source or destination for transferring data. Before you begin, make sure that you understand how DataSync accesses NFS file servers.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateLocationNfsResponse'
        '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.CreateLocationNfs
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateLocationNfsRequest'
      tags:
      - Location Nf
  /#DescribeLocationNfs:
    post:
      operationId: DescribeLocationNfs
      summary: Describe Location Nfs
      description: Provides details about how an DataSync transfer location for a Network File System (NFS) file server is configured.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeLocationNfsResponse'
        '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.DescribeLocationNfs
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeLocationNfsRequest'
      tags:
      - Location Nf
  /#UpdateLocationNfs:
    post:
      operationId: UpdateLocationNfs
      summary: Update Location Nfs
      description: Modifies the following configuration parameters of the Network File System (NFS) transfer location that you're using with DataSync. For more information, see Configuring transfers with an NFS file server.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateLocationNfsResponse'
        '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.UpdateLocationNfs
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateLocationNfsRequest'
      tags:
      - Location Nf
components:
  schemas:
    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
    CreateLocationNfsRequest:
      type: object
      properties:
        Subdirectory:
          type: string
          description: Specifies the export path in your NFS file server that you want DataSync to mount. This path (or a subdirectory of the path) is where DataSync transfers data to or from. For information on configuring an export for DataSync, see Accessing NFS file servers.
        ServerHostname:
          type: string
          description: Specifies the DNS name or IP address (IPv4 or IPv6) of the NFS file server that your DataSync agent connects to.
        OnPremConfig:
          $ref: '#/components/schemas/OnPremConfig'
        MountOptions:
          $ref: '#/components/schemas/NfsMountOptions'
        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:
      - Subdirectory
      - ServerHostname
      - OnPremConfig
    UpdateLocationNfsRequest:
      type: object
      properties:
        LocationArn:
          type: string
          description: Specifies the Amazon Resource Name (ARN) of the NFS transfer location that you want to update.
        Subdirectory:
          type: string
          description: Specifies the export path in your NFS file server that you want DataSync to mount. This path (or a subdirectory of the path) is where DataSync transfers data to or from. For information on configuring an export for DataSync, see Accessing NFS file servers.
        ServerHostname:
          type: string
          description: Specifies the DNS name or IP address (IPv4 or IPv6) of the NFS file server that your DataSync agent connects to.
        OnPremConfig:
          $ref: '#/components/schemas/OnPremConfig'
        MountOptions:
          $ref: '#/components/schemas/NfsMountOptions'
      required:
      - LocationArn
    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'
    DescribeLocationNfsRequest:
      type: object
      properties:
        LocationArn:
          type: string
          description: Specifies the Amazon Resource Name (ARN) of the NFS location that you want information about.
      required:
      - LocationArn
    UpdateLocationNfsResponse:
      type: object
      properties: {}
    DescribeLocationNfsResponse:
      type: object
      properties:
        LocationArn:
          type: string
          description: The ARN of the NFS location.
        LocationUri:
          type: string
          description: The URI of the NFS location.
        OnPremConfig:
          $ref: '#/components/schemas/OnPremConfig'
        MountOptions:
          $ref: '#/components/schemas/NfsMountOptions'
        CreationTime:
          type: string
          format: date-time
          description: The time when the NFS location was created.
    OnPremConfig:
      type: object
      properties:
        AgentArns:
          type: array
          items:
            type: string
          description: The Amazon Resource Names (ARNs) of the DataSync agents that can connect to your NFS file server. You can specify more than one agent. For more information, see Using multiple DataSync agents.
      required:
      - AgentArns
    CreateLocationNfsResponse:
      type: object
      properties:
        LocationArn:
          type: string
          description: The ARN of the transfer location that you created for your NFS file server.
    InvalidRequestException:
      type: object
      properties:
        message:
          type: string
        errorCode:
          type: string
        datasyncErrorCode:
          type: string
    InternalException:
      type: object
      properties:
        message:
          type: string
        errorCode:
          type: string
  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)