Amazon DataSync

Amazon DataSync Datasync Location Object Storage API

The Datasync Location Object Storage API from Amazon DataSync — 3 operation(s) for datasync location object storage.

GitHub OpenAPI
Business capability
IT Infrastructure Management BC-600.50

Operations 3

POST /#CreateLocationObjectStorage Create Location Object Storage #
POST /#DescribeLocationObjectStorage Describe Location Object Storage #
POST /#UpdateLocationObjectStorage Update Location Object Storage #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/amazon-datasync/openapi/amazon-datasync-location-object-storage-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-object-storage-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-object-storage-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: AWS DataSync Location Object Storage 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 Object Storage
paths:
  /#CreateLocationObjectStorage:
    post:
      operationId: CreateLocationObjectStorage
      summary: Create Location Object Storage
      description: Creates a transfer location for an object storage system. DataSync can use this location as a source or destination for transferring data. You can make transfers with or without a DataSync agent. Before you begin, make sure that you understand the prerequisites for DataSync to work with object storage systems.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateLocationObjectStorageResponse'
        '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.CreateLocationObjectStorage
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateLocationObjectStorageRequest'
      tags:
      - Location Object Storage
  /#DescribeLocationObjectStorage:
    post:
      operationId: DescribeLocationObjectStorage
      summary: Describe Location Object Storage
      description: Provides details about how an DataSync transfer location for an object storage system is configured.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeLocationObjectStorageResponse'
        '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.DescribeLocationObjectStorage
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeLocationObjectStorageRequest'
      tags:
      - Location Object Storage
  /#UpdateLocationObjectStorage:
    post:
      operationId: UpdateLocationObjectStorage
      summary: Update Location Object Storage
      description: Modifies the following configuration parameters of the object storage transfer location that you're using with DataSync. For more information, see Configuring DataSync transfers with an object storage system.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateLocationObjectStorageResponse'
        '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.UpdateLocationObjectStorage
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateLocationObjectStorageRequest'
      tags:
      - Location Object Storage
components:
  schemas:
    DescribeLocationObjectStorageRequest:
      type: object
      properties:
        LocationArn:
          type: string
          description: Specifies the Amazon Resource Name (ARN) of the object storage system location.
      required:
      - LocationArn
    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
    DescribeLocationObjectStorageResponse:
      type: object
      properties:
        LocationArn:
          type: string
          description: The ARN of the object storage system location.
        LocationUri:
          type: string
          description: The URI of the object storage system location.
        AccessKey:
          type: string
          description: The access key (for example, a user name) required to authenticate with the object storage system.
        ServerPort:
          type: integer
          description: The port that your object storage server accepts inbound network traffic on (for example, port 443).
        ServerProtocol:
          type: string
          enum:
          - HTTPS
          - HTTP
          description: The protocol that your object storage system uses to communicate.
        AgentArns:
          type: array
          items:
            type: string
          description: The ARNs of the DataSync agents that can connect with your object storage system.
        CreationTime:
          type: string
          format: date-time
          description: The time that the location was created.
        ServerCertificate:
          type: string
          format: byte
          description: The certificate chain for DataSync to authenticate with your object storage system if the system uses a private or self-signed certificate authority (CA).
        ManagedSecretConfig:
          $ref: '#/components/schemas/ManagedSecretConfig'
        CmkSecretConfig:
          $ref: '#/components/schemas/CmkSecretConfig'
        CustomSecretConfig:
          $ref: '#/components/schemas/CustomSecretConfig'
    CreateLocationObjectStorageResponse:
      type: object
      properties:
        LocationArn:
          type: string
          description: Specifies the ARN of the object storage system location that you create.
    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.
    UpdateLocationObjectStorageRequest:
      type: object
      properties:
        LocationArn:
          type: string
          description: Specifies the ARN of the object storage system location that you're updating.
        ServerPort:
          type: integer
          description: Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443).
        ServerProtocol:
          type: string
          enum:
          - HTTPS
          - HTTP
          description: Specifies the protocol that your object storage server uses to communicate.
        Subdirectory:
          type: string
          description: Specifies the object prefix for your object storage server. If this is a source location, DataSync only copies objects with this prefix. If this is a destination location, DataSync writes all objects with this prefix.
        ServerHostname:
          type: string
          description: Specifies the domain name or IP address (IPv4 or IPv6) of the object storage server that your DataSync agent connects to.
        AccessKey:
          type: string
          description: Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server.
        SecretKey:
          type: string
          description: Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server. If you provide a secret using SecretKey, but do not provide secret configuration details using CmkSecretConfig or CustomSecretConfig, then DataSync stores the token using your Amazon Web Services account's Secrets Manager secret.
        AgentArns:
          type: array
          items:
            type: string
          description: (Optional) Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can connect with your object storage system. If you are setting up an agentless cross-cloud transfer, you do not need to specify a value for this parameter. You cannot add or remove agents from a storage location after you initially create it.
        ServerCertificate:
          type: string
          format: byte
          description: 'Specifies a certificate chain for DataSync to authenticate with your object storage system if the system uses a private or self-signed certificate authority (CA). You must specify a single .pem file with a full certificate chain (for example, file:///home/user/.ssh/object_storage_certificates.pem). The certificate chain might include: The object storage system''s certificate All intermediate certificates (if there are any) The root certificate of the signing CA You can concatenate your certificates into a .pem file (which can be up to 32768 bytes before base64 encoding). The following example c'
        CmkSecretConfig:
          $ref: '#/components/schemas/CmkSecretConfig'
        CustomSecretConfig:
          $ref: '#/components/schemas/CustomSecretConfig'
      required:
      - LocationArn
    ManagedSecretConfig:
      type: object
      properties:
        SecretArn:
          type: string
          description: Specifies the ARN for an Secrets Manager secret.
    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.
    UpdateLocationObjectStorageResponse:
      type: object
      properties: {}
    CreateLocationObjectStorageRequest:
      type: object
      properties:
        ServerHostname:
          type: string
          description: Specifies the domain name or IP address (IPv4 or IPv6) of the object storage server that your DataSync agent connects to.
        ServerPort:
          type: integer
          description: Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443).
        ServerProtocol:
          type: string
          enum:
          - HTTPS
          - HTTP
          description: Specifies the protocol that your object storage server uses to communicate. If not specified, the default value is HTTPS.
        Subdirectory:
          type: string
          description: Specifies the object prefix for your object storage server. If this is a source location, DataSync only copies objects with this prefix. If this is a destination location, DataSync writes all objects with this prefix.
        BucketName:
          type: string
          description: Specifies the name of the object storage bucket involved in the transfer.
        AccessKey:
          type: string
          description: Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server.
        SecretKey:
          type: string
          description: Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server. If you provide a secret using SecretKey, but do not provide secret configuration details using CmkSecretConfig or CustomSecretConfig, then DataSync stores the token using your Amazon Web Services account's Secrets Manager secret.
        AgentArns:
          type: array
          items:
            type: string
          description: (Optional) Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can connect with your object storage system. If you are setting up an agentless cross-cloud transfer, you do not need to specify a value for this parameter. Make sure you configure this parameter correctly when you first create your storage location. You cannot add or remove agents from a storage location after you create it.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/TagListEntry'
          description: Specifies the key-value pair that represents a tag that you want to add to the resource. Tags can help you manage, filter, and search for your resources. We recommend creating a name tag for your location.
        ServerCertificate:
          type: string
          format: byte
          description: 'Specifies a certificate chain for DataSync to authenticate with your object storage system if the system uses a private or self-signed certificate authority (CA). You must specify a single .pem file with a full certificate chain (for example, file:///home/user/.ssh/object_storage_certificates.pem). The certificate chain might include: The object storage system''s certificate All intermediate certificates (if there are any) The root certificate of the signing CA You can concatenate your certificates into a .pem file (which can be up to 32768 bytes before base64 encoding). The following example c'
        CmkSecretConfig:
          $ref: '#/components/schemas/CmkSecretConfig'
        CustomSecretConfig:
          $ref: '#/components/schemas/CustomSecretConfig'
      required:
      - ServerHostname
      - BucketName
    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)