Amazon DataSync Datasync Location Hdf API

openapi: 3.2.0
info:
  title: AWS DataSync Location Hdf 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 Hdf
paths:
  /#CreateLocationHdfs:
    post:
      operationId: CreateLocationHdfs
      summary: Create Location Hdfs
      description: Creates a transfer location for a Hadoop Distributed File System (HDFS). DataSync can use this location as a source or destination for transferring data. Before you begin, make sure that you understand how DataSync accesses HDFS clusters.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateLocationHdfsResponse'
        '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.CreateLocationHdfs
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateLocationHdfsRequest'
      tags:
      - Location Hdf
  /#DescribeLocationHdfs:
    post:
      operationId: DescribeLocationHdfs
      summary: Describe Location Hdfs
      description: Provides details about how an DataSync transfer location for a Hadoop Distributed File System (HDFS) is configured.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeLocationHdfsResponse'
        '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.DescribeLocationHdfs
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeLocationHdfsRequest'
      tags:
      - Location Hdf
  /#UpdateLocationHdfs:
    post:
      operationId: UpdateLocationHdfs
      summary: Update Location Hdfs
      description: Modifies the following configuration parameters of the Hadoop Distributed File System (HDFS) transfer location that you're using with DataSync. For more information, see Configuring DataSync transfers with an HDFS cluster.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateLocationHdfsResponse'
        '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.UpdateLocationHdfs
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateLocationHdfsRequest'
      tags:
      - Location Hdf
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
    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.
    HdfsNameNode:
      type: object
      properties:
        Hostname:
          type: string
          description: The hostname of the NameNode in the HDFS cluster. This value is the IP address or Domain Name Service (DNS) name of the NameNode. An agent that's installed on-premises uses this hostname to communicate with the NameNode in the network.
        Port:
          type: integer
          description: The port that the NameNode uses to listen to client requests.
      required:
      - Hostname
      - Port
    DescribeLocationHdfsResponse:
      type: object
      properties:
        LocationArn:
          type: string
          description: The ARN of the HDFS location.
        LocationUri:
          type: string
          description: The URI of the HDFS location.
        NameNodes:
          type: array
          items:
            $ref: '#/components/schemas/HdfsNameNode'
          description: The NameNode that manages the HDFS namespace.
        BlockSize:
          type: integer
          description: The size of the data blocks to write into the HDFS cluster.
        ReplicationFactor:
          type: integer
          description: The number of DataNodes to replicate the data to when writing to the HDFS cluster.
        KmsKeyProviderUri:
          type: string
          description: The URI of the HDFS cluster's Key Management Server (KMS).
        QopConfiguration:
          $ref: '#/components/schemas/QopConfiguration'
        AuthenticationType:
          type: string
          enum:
          - SIMPLE
          - KERBEROS
          description: The type of authentication used to determine the identity of the user.
        SimpleUser:
          type: string
          description: The user name to identify the client on the host operating system. This parameter is used if the AuthenticationType is defined as SIMPLE.
        KerberosPrincipal:
          type: string
          description: The Kerberos principal with access to the files and folders on the HDFS cluster. This parameter is used if the AuthenticationType is defined as KERBEROS.
        AgentArns:
          type: array
          items:
            type: string
          description: The ARNs of the DataSync agents that can connect with your HDFS cluster.
        CreationTime:
          type: string
          format: date-time
          description: The time that the HDFS location was created.
        ManagedSecretConfig:
          $ref: '#/components/schemas/ManagedSecretConfig'
        CmkSecretConfig:
          $ref: '#/components/schemas/CmkSecretConfig'
        CustomSecretConfig:
          $ref: '#/components/schemas/CustomSecretConfig'
    DescribeLocationHdfsRequest:
      type: object
      properties:
        LocationArn:
          type: string
          description: Specifies the Amazon Resource Name (ARN) of the HDFS location.
      required:
      - LocationArn
    ManagedSecretConfig:
      type: object
      properties:
        SecretArn:
          type: string
          description: Specifies the ARN for an Secrets Manager secret.
    UpdateLocationHdfsRequest:
      type: object
      properties:
        LocationArn:
          type: string
          description: The Amazon Resource Name (ARN) of the source HDFS cluster location.
        Subdirectory:
          type: string
          description: A subdirectory in the HDFS cluster. This subdirectory is used to read data from or write data to the HDFS cluster.
        NameNodes:
          type: array
          items:
            $ref: '#/components/schemas/HdfsNameNode'
          description: 'The NameNode that manages the HDFS namespace. The NameNode performs operations such as opening, closing, and renaming files and directories. The NameNode contains the information to map blocks of data to the DataNodes. The number of NameNodes you can specify depends on the task mode: Enhanced mode – You can specify multiple NameNodes for HDFS High Availability (HA) configurations. Basic mode – You can specify only one NameNode.'
        BlockSize:
          type: integer
          description: The size of the data blocks to write into the HDFS cluster.
        ReplicationFactor:
          type: integer
          description: The number of DataNodes to replicate the data to when writing to the HDFS cluster.
        KmsKeyProviderUri:
          type: string
          description: The URI of the HDFS cluster's Key Management Server (KMS).
        QopConfiguration:
          $ref: '#/components/schemas/QopConfiguration'
        AuthenticationType:
          type: string
          enum:
          - SIMPLE
          - KERBEROS
          description: The type of authentication used to determine the identity of the user.
        SimpleUser:
          type: string
          description: The user name used to identify the client on the host operating system.
        KerberosPrincipal:
          type: string
          description: The Kerberos principal with access to the files and folders on the HDFS cluster.
        KerberosKeytab:
          type: string
          format: byte
          description: The Kerberos key table (keytab) that contains mappings between the defined Kerberos principal and the encrypted keys. You can load the keytab from a file by providing the file's address.
        KerberosKrb5Conf:
          type: string
          format: byte
          description: The krb5.conf file that contains the Kerberos configuration information. You can load the krb5.conf file by providing the file's address. If you're using the CLI, it performs the base64 encoding for you. Otherwise, provide the base64-encoded text.
        AgentArns:
          type: array
          items:
            type: string
          description: The Amazon Resource Names (ARNs) of the DataSync agents that can connect to your HDFS cluster.
        CmkSecretConfig:
          $ref: '#/components/schemas/CmkSecretConfig'
        CustomSecretConfig:
          $ref: '#/components/schemas/CustomSecretConfig'
      required:
      - LocationArn
    UpdateLocationHdfsResponse:
      type: object
      properties: {}
    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.
    CreateLocationHdfsRequest:
      type: object
      properties:
        Subdirectory:
          type: string
          description: A subdirectory in the HDFS cluster. This subdirectory is used to read data from or write data to the HDFS cluster. If the subdirectory isn't specified, it will default to /.
        NameNodes:
          type: array
          items:
            $ref: '#/components/schemas/HdfsNameNode'
          description: 'The NameNode that manages the HDFS namespace. The NameNode performs operations such as opening, closing, and renaming files and directories. The NameNode contains the information to map blocks of data to the DataNodes. The number of NameNodes you can specify depends on the task mode: Enhanced mode – You can specify multiple NameNodes for HDFS High Availability (HA) configurations. Basic mode – You can specify only one NameNode.'
        BlockSize:
          type: integer
          description: The size of data blocks to write into the HDFS cluster. The block size must be a multiple of 512 bytes. The default block size is 128 mebibytes (MiB).
        ReplicationFactor:
          type: integer
          description: The number of DataNodes to replicate the data to when writing to the HDFS cluster. By default, data is replicated to three DataNodes.
        KmsKeyProviderUri:
          type: string
          description: The URI of the HDFS cluster's Key Management Server (KMS).
        QopConfiguration:
          $ref: '#/components/schemas/QopConfiguration'
        AuthenticationType:
          type: string
          enum:
          - SIMPLE
          - KERBEROS
          description: The type of authentication used to determine the identity of the user.
        SimpleUser:
          type: string
          description: The user name used to identify the client on the host operating system. If SIMPLE is specified for AuthenticationType, this parameter is required.
        KerberosPrincipal:
          type: string
          description: The Kerberos principal with access to the files and folders on the HDFS cluster. If KERBEROS is specified for AuthenticationType, this parameter is required.
        KerberosKeytab:
          type: string
          format: byte
          description: The Kerberos key table (keytab) that contains mappings between the defined Kerberos principal and the encrypted keys. You can load the keytab from a file by providing the file's address. If KERBEROS is specified for AuthenticationType, this parameter is required.
        KerberosKrb5Conf:
          type: string
          format: byte
          description: The krb5.conf file that contains the Kerberos configuration information. You can load the krb5.conf file by providing the file's address. If you're using the CLI, it performs the base64 encoding for you. Otherwise, provide the base64-encoded text. If KERBEROS is specified for AuthenticationType, this parameter is required.
        AgentArns:
          type: array
          items:
            type: string
          description: The Amazon Resource Names (ARNs) of the DataSync agents that can connect to your HDFS cluster.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/TagListEntry'
          description: The key-value pair that represents the tag that you want to add to the location. The value can be an empty string. We recommend using tags to name your resources.
        CmkSecretConfig:
          $ref: '#/components/schemas/CmkSecretConfig'
        CustomSecretConfig:
          $ref: '#/components/schemas/CustomSecretConfig'
      required:
      - NameNodes
      - AuthenticationType
      - AgentArns
    CreateLocationHdfsResponse:
      type: object
      properties:
        LocationArn:
          type: string
          description: The ARN of the source HDFS cluster location that you create.
    QopConfiguration:
      type: object
      properties:
        RpcProtection:
          type: string
          enum:
          - DISABLED
          - AUTHENTICATION
          - INTEGRITY
          - PRIVACY
          description: The RPC protection setting configured on the HDFS cluster. This setting corresponds to your hadoop.rpc.protection setting in your core-site.xml file on your Hadoop cluster.
        DataTransferProtection:
          type: string
          enum:
          - DISABLED
          - AUTHENTICATION
          - INTEGRITY
          - PRIVACY
          description: The data transfer protection setting configured on the HDFS cluster. This setting corresponds to your dfs.data.transfer.protection setting in the hdfs-site.xml file on your Hadoop cluster.
    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)