Amazon DataSync Datasync Location Smb API

openapi: 3.2.0
info:
  title: AWS DataSync Location Smb 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 Smb
paths:
  /#CreateLocationSmb:
    post:
      operationId: CreateLocationSmb
      summary: Create Location Smb
      description: Creates a transfer location for a Server Message Block (SMB) 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 SMB file servers. For more information, see Providing DataSync access to SMB file servers.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateLocationSmbResponse'
        '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.CreateLocationSmb
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateLocationSmbRequest'
      tags:
      - Location Smb
  /#DescribeLocationSmb:
    post:
      operationId: DescribeLocationSmb
      summary: Describe Location Smb
      description: Provides details about how an DataSync transfer location for a Server Message Block (SMB) file server is configured.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeLocationSmbResponse'
        '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.DescribeLocationSmb
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeLocationSmbRequest'
      tags:
      - Location Smb
  /#UpdateLocationSmb:
    post:
      operationId: UpdateLocationSmb
      summary: Update Location Smb
      description: Modifies the following configuration parameters of the Server Message Block (SMB) transfer location that you're using with DataSync. For more information, see Configuring DataSync transfers with an SMB file server.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateLocationSmbResponse'
        '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.UpdateLocationSmb
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateLocationSmbRequest'
      tags:
      - Location Smb
components:
  schemas:
    UpdateLocationSmbResponse:
      type: object
      properties: {}
    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
    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'
    UpdateLocationSmbRequest:
      type: object
      properties:
        LocationArn:
          type: string
          description: Specifies the ARN of the SMB location that you want to update.
        Subdirectory:
          type: string
          description: Specifies the name of the share exported by your SMB file server where DataSync will read or write data. You can include a subdirectory in the share path (for example, /path/to/subdirectory). Make sure that other SMB clients in your network can also mount this path. To copy all data in the specified subdirectory, DataSync must be able to mount the SMB share and access all of its data. For more information, see Providing DataSync access to SMB file servers.
        ServerHostname:
          type: string
          description: Specifies the domain name or IP address (IPv4 or IPv6) of the SMB file server that your DataSync agent connects to. If you're using Kerberos authentication, you must specify a domain name.
        User:
          type: string
          description: Specifies the user name that can mount your SMB file server and has permission to access the files and folders involved in your transfer. This parameter applies only if AuthenticationType is set to NTLM. For information about choosing a user with the right level of access for your transfer, see Providing DataSync access to SMB file servers.
        Domain:
          type: string
          description: Specifies the Windows domain name that your SMB file server belongs to. This parameter applies only if AuthenticationType is set to NTLM. If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right file server.
        Password:
          type: string
          description: Specifies the password of the user who can mount your SMB file server and has permission to access the files and folders involved in your transfer. This parameter applies only if AuthenticationType is set to NTLM.
        CmkSecretConfig:
          $ref: '#/components/schemas/CmkSecretConfig'
        CustomSecretConfig:
          $ref: '#/components/schemas/CustomSecretConfig'
        AgentArns:
          type: array
          items:
            type: string
          description: Specifies the DataSync agent (or agents) that can connect to your SMB file server. You specify an agent by using its Amazon Resource Name (ARN).
        MountOptions:
          $ref: '#/components/schemas/SmbMountOptions'
        AuthenticationType:
          type: string
          enum:
          - NTLM
          - KERBEROS
          description: Specifies the authentication protocol that DataSync uses to connect to your SMB file server. DataSync supports NTLM (default) and KERBEROS authentication. For more information, see Providing DataSync access to SMB file servers.
        DnsIpAddresses:
          type: array
          items:
            type: string
          description: Specifies the IP addresses (IPv4 or IPv6) for the DNS servers that your SMB file server belongs to. This parameter applies only if AuthenticationType is set to KERBEROS. If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right SMB file server.
        KerberosPrincipal:
          type: string
          description: Specifies a Kerberos prinicpal, which is an identity in your Kerberos realm that has permission to access the files, folders, and file metadata in your SMB file server. A Kerberos principal might look like HOST/kerberosuser@MYDOMAIN.ORG. Principal names are case sensitive. Your DataSync task execution will fail if the principal that you specify for this parameter doesn’t exactly match the principal that you use to create the keytab file.
        KerberosKeytab:
          type: string
          format: byte
          description: Specifies your Kerberos key table (keytab) file, which includes mappings between your Kerberos principal and encryption keys. To avoid task execution errors, make sure that the Kerberos principal that you use to create the keytab file matches exactly what you specify for KerberosPrincipal.
        KerberosKrb5Conf:
          type: string
          format: byte
          description: Specifies a Kerberos configuration file (krb5.conf) that defines your Kerberos realm configuration. The file must be base64 encoded. If you're using the CLI, the encoding is done for you.
      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.
    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.
    DescribeLocationSmbResponse:
      type: object
      properties:
        LocationArn:
          type: string
          description: The ARN of the SMB location.
        LocationUri:
          type: string
          description: The URI of the SMB location.
        AgentArns:
          type: array
          items:
            type: string
          description: The ARNs of the DataSync agents that can connect with your SMB file server.
        User:
          type: string
          description: The user that can mount and access the files, folders, and file metadata in your SMB file server. This element applies only if AuthenticationType is set to NTLM.
        Domain:
          type: string
          description: The name of the Windows domain that the SMB file server belongs to. This element applies only if AuthenticationType is set to NTLM.
        MountOptions:
          $ref: '#/components/schemas/SmbMountOptions'
        CreationTime:
          type: string
          format: date-time
          description: The time that the SMB location was created.
        DnsIpAddresses:
          type: array
          items:
            type: string
          description: The IPv4 or IPv6 addresses for the DNS servers that your SMB file server belongs to. This element applies only if AuthenticationType is set to KERBEROS.
        KerberosPrincipal:
          type: string
          description: The Kerberos principal that has permission to access the files, folders, and file metadata in your SMB file server.
        AuthenticationType:
          type: string
          enum:
          - NTLM
          - KERBEROS
          description: The authentication protocol that DataSync uses to connect to your SMB file server.
        ManagedSecretConfig:
          $ref: '#/components/schemas/ManagedSecretConfig'
        CmkSecretConfig:
          $ref: '#/components/schemas/CmkSecretConfig'
        CustomSecretConfig:
          $ref: '#/components/schemas/CustomSecretConfig'
    CreateLocationSmbRequest:
      type: object
      properties:
        Subdirectory:
          type: string
          description: Specifies the name of the share exported by your SMB file server where DataSync will read or write data. You can include a subdirectory in the share path (for example, /path/to/subdirectory). Make sure that other SMB clients in your network can also mount this path. To copy all data in the subdirectory, DataSync must be able to mount the SMB share and access all of its data. For more information, see Providing DataSync access to SMB file servers.
        ServerHostname:
          type: string
          description: Specifies the domain name or IP address (IPv4 or IPv6) of the SMB file server that your DataSync agent connects to. If you're using Kerberos authentication, you must specify a domain name.
        User:
          type: string
          description: Specifies the user that can mount and access the files, folders, and file metadata in your SMB file server. This parameter applies only if AuthenticationType is set to NTLM. For information about choosing a user with the right level of access for your transfer, see Providing DataSync access to SMB file servers.
        Domain:
          type: string
          description: Specifies the Windows domain name that your SMB file server belongs to. This parameter applies only if AuthenticationType is set to NTLM. If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right file server.
        Password:
          type: string
          description: Specifies the password of the user who can mount your SMB file server and has permission to access the files and folders involved in your transfer. This parameter applies only if AuthenticationType is set to NTLM.
        CmkSecretConfig:
          $ref: '#/components/schemas/CmkSecretConfig'
        CustomSecretConfig:
          $ref: '#/components/schemas/CustomSecretConfig'
        AgentArns:
          type: array
          items:
            type: string
          description: Specifies the DataSync agent (or agents) that can connect to your SMB file server. You specify an agent by using its Amazon Resource Name (ARN).
        MountOptions:
          $ref: '#/components/schemas/SmbMountOptions'
        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.
        AuthenticationType:
          type: string
          enum:
          - NTLM
          - KERBEROS
          description: Specifies the authentication protocol that DataSync uses to connect to your SMB file server. DataSync supports NTLM (default) and KERBEROS authentication. For more information, see Providing DataSync access to SMB file servers.
        DnsIpAddresses:
          type: array
          items:
            type: string
          description: Specifies the IPv4 or IPv6 addresses for the DNS servers that your SMB file server belongs to. This parameter applies only if AuthenticationType is set to KERBEROS. If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right SMB file server.
        KerberosPrincipal:
          type: string
          description: Specifies a Kerberos principal, which is an identity in your Kerberos realm that has permission to access the files, folders, and file metadata in your SMB file server. A Kerberos principal might look like HOST/kerberosuser@MYDOMAIN.ORG. Principal names are case sensitive. Your DataSync task execution will fail if the principal that you specify for this parameter doesn’t exactly match the principal that you use to create the keytab file.
        KerberosKeytab:
          type: string
          format: byte
          description: Specifies your Kerberos key table (keytab) file, which includes mappings between your Kerberos principal and encryption keys. To avoid task execution errors, make sure that the Kerberos principal that you use to create the keytab file matches exactly what you specify for KerberosPrincipal.
        KerberosKrb5Conf:
          type: string
          format: byte
          description: Specifies a Kerberos configuration file (krb5.conf) that defines your Kerberos realm configuration. The file must be base64 encoded. If you're using the CLI, the encoding is done for you.
      required:
      - Subdirectory
      - ServerHostname
      - AgentArns
    CreateLocationSmbResponse:
      type: object
      properties:
        LocationArn:
          type: string
          description: The ARN of the SMB location that you created.
    DescribeLocationSmbRequest:
      type: object
      properties:
        LocationArn:
          type: string
          description: Specifies the Amazon Resource Name (ARN) of the SMB 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
  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)