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-window-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 Fsx Window 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 Window
paths:
  /#CreateLocationFsxWindows:
    post:
      operationId: CreateLocationFsxWindows
      summary: Create Location Fsx Windows
      description: Creates a transfer location for an Amazon FSx for Windows File Server 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 Windows File Server file systems.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateLocationFsxWindowsResponse'
        '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.CreateLocationFsxWindows
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateLocationFsxWindowsRequest'
      tags:
      - Location Fsx Window
  /#DescribeLocationFsxWindows:
    post:
      operationId: DescribeLocationFsxWindows
      summary: Describe Location Fsx Windows
      description: Provides details about how an DataSync transfer location for an Amazon FSx for Windows File Server file system is configured.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeLocationFsxWindowsResponse'
        '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.DescribeLocationFsxWindows
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeLocationFsxWindowsRequest'
      tags:
      - Location Fsx Window
  /#UpdateLocationFsxWindows:
    post:
      operationId: UpdateLocationFsxWindows
      summary: Update Location Fsx Windows
      description: Modifies the following configuration parameters of the Amazon FSx for Windows File Server transfer location that you're using with DataSync. For more information, see Configuring DataSync transfers with FSx for Windows File Server.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateLocationFsxWindowsResponse'
        '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.UpdateLocationFsxWindows
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateLocationFsxWindowsRequest'
      tags:
      - Location Fsx Window
components:
  schemas:
    DescribeLocationFsxWindowsResponse:
      type: object
      properties:
        LocationArn:
          type: string
          description: The ARN of the FSx for Windows File Server location.
        LocationUri:
          type: string
          description: The uniform resource identifier (URI) of the FSx for Windows File Server location.
        SecurityGroupArns:
          type: array
          items:
            type: string
          description: The ARNs of the Amazon EC2 security groups that provide access to your file system's preferred subnet. For information about configuring security groups for file system access, see the Amazon FSx for Windows File Server User Guide .
        CreationTime:
          type: string
          format: date-time
          description: The time that the FSx for Windows File Server location was created.
        User:
          type: string
          description: The user with the permissions to mount and access the FSx for Windows File Server file system.
        Domain:
          type: string
          description: The name of the Microsoft Active Directory domain that the FSx for Windows File Server file system belongs to.
        ManagedSecretConfig:
          $ref: '#/components/schemas/ManagedSecretConfig'
        CmkSecretConfig:
          $ref: '#/components/schemas/CmkSecretConfig'
        CustomSecretConfig:
          $ref: '#/components/schemas/CustomSecretConfig'
    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
    UpdateLocationFsxWindowsResponse:
      type: object
      properties: {}
    CreateLocationFsxWindowsRequest:
      type: object
      properties:
        Subdirectory:
          type: string
          description: Specifies a mount path for your file system using forward slashes. This is where DataSync reads or writes data (depending on if this is a source or destination location).
        FsxFilesystemArn:
          type: string
          description: Specifies the Amazon Resource Name (ARN) for the FSx for Windows File Server file system.
        SecurityGroupArns:
          type: array
          items:
            type: string
          description: 'Specifies the ARNs of the Amazon EC2 security groups that provide access to your file system''s preferred subnet. The security groups that you specify must be able to communicate with your file system''s security groups. For information about configuring security groups for file system access, see the Amazon FSx for Windows File Server User Guide . If you choose a security group that doesn''t allow connections from within itself, do one of the following: Configure the security group to allow it to communicate within itself. Choose a different security group that can communicate with the mount tar'
        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.
        User:
          type: string
          description: Specifies the user with the permissions to mount and access the files, folders, and file metadata in your FSx for Windows File Server file system. For information about choosing a user with the right level of access for your transfer, see required permissions for FSx for Windows File Server locations.
        Domain:
          type: string
          description: Specifies the name of the Windows domain that the FSx for Windows File Server file system belongs to. If you have multiple Active Directory domains in your environment, configuring this parameter makes sure that DataSync connects to the right file system.
        Password:
          type: string
          description: Specifies the password of the user with the permissions to mount and access the files, folders, and file metadata in your FSx for Windows File Server file system.
        CmkSecretConfig:
          $ref: '#/components/schemas/CmkSecretConfig'
        CustomSecretConfig:
          $ref: '#/components/schemas/CustomSecretConfig'
      required:
      - FsxFilesystemArn
      - SecurityGroupArns
      - User
    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.
    ManagedSecretConfig:
      type: object
      properties:
        SecretArn:
          type: string
          description: Specifies the ARN for an Secrets Manager secret.
    UpdateLocationFsxWindowsRequest:
      type: object
      properties:
        LocationArn:
          type: string
          description: Specifies the ARN of the FSx for Windows File Server transfer location that you're updating.
        Subdirectory:
          type: string
          description: Specifies a mount path for your file system using forward slashes. DataSync uses this subdirectory to read or write data (depending on whether the file system is a source or destination location).
        Domain:
          type: string
          description: Specifies the name of the Windows domain that your FSx for Windows File Server file system belongs to. If you have multiple Active Directory domains in your environment, configuring this parameter makes sure that DataSync connects to the right file system.
        User:
          type: string
          description: Specifies the user with the permissions to mount and access the files, folders, and file metadata in your FSx for Windows File Server file system. For information about choosing a user with the right level of access for your transfer, see required permissions for FSx for Windows File Server locations.
        Password:
          type: string
          description: Specifies the password of the user with the permissions to mount and access the files, folders, and file metadata in your FSx for Windows File Server file system.
        CmkSecretConfig:
          $ref: '#/components/schemas/CmkSecretConfig'
        CustomSecretConfig:
          $ref: '#/components/schemas/CustomSecretConfig'
      required:
      - LocationArn
    CreateLocationFsxWindowsResponse:
      type: object
      properties:
        LocationArn:
          type: string
          description: The ARN of the FSx for Windows File Server file system location you created.
    DescribeLocationFsxWindowsRequest:
      type: object
      properties:
        LocationArn:
          type: string
          description: Specifies the Amazon Resource Name (ARN) of the FSx for Windows File Server location.
      required:
      - LocationArn
    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.
    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)