Amazon FSx Fsx File System Aliase API

openapi: 3.2.0
info:
  title: Amazon FSx File System Aliase API
  version: '2018-03-01'
  description: Generated from AWS's published Smithy model for Amazon FSx. 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://fsx.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: File System Aliase
paths:
  /#AssociateFileSystemAliases:
    post:
      operationId: AssociateFileSystemAliases
      summary: Associate File System Aliases
      description: 'Use this action to associate one or more Domain Name Server (DNS) aliases with an existing Amazon FSx for Windows File Server file system. A file system can have a maximum of 50 DNS aliases associated with it at any one time. If you try to associate a DNS alias that is already associated with the file system, FSx takes no action on that alias in the request. For more information, see Working with DNS Aliases and Walkthrough 5: Using DNS aliases to access your file system, including additional steps you must take to be able to access your file system using a DNS alias. The system response shows the DNS aliases that Amazon FSx is attempting to associate with the file system. Use the API operation to monitor the status of the aliases Amazon FSx is associating with the file system.'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AssociateFileSystemAliasesResponse'
        '400':
          description: BadRequest; FileSystemNotFound
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/BadRequest'
        '500':
          description: InternalServerError
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerError'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSSimbaAPIService_v20180301.AssociateFileSystemAliases
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/AssociateFileSystemAliasesRequest'
      tags:
      - File System Aliase
  /#DescribeFileSystemAliases:
    post:
      operationId: DescribeFileSystemAliases
      summary: Describe File System Aliases
      description: Returns the DNS aliases that are associated with the specified Amazon FSx for Windows File Server file system. A history of all DNS aliases that have been associated with and disassociated from the file system is available in the list of AdministrativeAction provided in the DescribeFileSystems operation response.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeFileSystemAliasesResponse'
        '400':
          description: BadRequest; FileSystemNotFound
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/BadRequest'
        '500':
          description: InternalServerError
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerError'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSSimbaAPIService_v20180301.DescribeFileSystemAliases
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeFileSystemAliasesRequest'
      tags:
      - File System Aliase
  /#DisassociateFileSystemAliases:
    post:
      operationId: DisassociateFileSystemAliases
      summary: Disassociate File System Aliases
      description: Use this action to disassociate, or remove, one or more Domain Name Service (DNS) aliases from an Amazon FSx for Windows File Server file system. If you attempt to disassociate a DNS alias that is not associated with the file system, Amazon FSx responds with an HTTP status code 400 (Bad Request). For more information, see Working with DNS Aliases. The system generated response showing the DNS aliases that Amazon FSx is attempting to disassociate from the file system. Use the API operation to monitor the status of the aliases Amazon FSx is disassociating with the file system.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DisassociateFileSystemAliasesResponse'
        '400':
          description: BadRequest; FileSystemNotFound
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/BadRequest'
        '500':
          description: InternalServerError
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerError'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSSimbaAPIService_v20180301.DisassociateFileSystemAliases
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DisassociateFileSystemAliasesRequest'
      tags:
      - File System Aliase
components:
  schemas:
    DescribeFileSystemAliasesResponse:
      type: object
      properties:
        Aliases:
          type: array
          items:
            $ref: '#/components/schemas/Alias'
          description: An array of one or more DNS aliases currently associated with the specified file system.
        NextToken:
          type: string
          description: Present if there are more DNS aliases than returned in the response (String). You can use the NextToken value in a later request to fetch additional descriptions.
    InternalServerError:
      type: object
      properties:
        Message:
          type: string
    DescribeFileSystemAliasesRequest:
      type: object
      properties:
        ClientRequestToken:
          type: string
        FileSystemId:
          type: string
          description: The ID of the file system to return the associated DNS aliases for (String).
        MaxResults:
          type: integer
          description: Maximum number of DNS aliases to return in the response (integer). This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the MaxResults parameter specified in the request and the service's internal maximum number of items per page.
        NextToken:
          type: string
          description: Opaque pagination token returned from a previous DescribeFileSystemAliases operation (String). If a token is included in the request, the action continues the list from where the previous returning call left off.
      required:
      - FileSystemId
    DisassociateFileSystemAliasesResponse:
      type: object
      properties:
        Aliases:
          type: array
          items:
            $ref: '#/components/schemas/Alias'
          description: An array of one or more DNS aliases that Amazon FSx is attempting to disassociate from the file system.
    AssociateFileSystemAliasesResponse:
      type: object
      properties:
        Aliases:
          type: array
          items:
            $ref: '#/components/schemas/Alias'
          description: An array of the DNS aliases that Amazon FSx is associating with the file system.
    BadRequest:
      type: object
      properties:
        Message:
          type: string
    AssociateFileSystemAliasesRequest:
      type: object
      properties:
        ClientRequestToken:
          type: string
        FileSystemId:
          type: string
          description: Specifies the file system with which you want to associate one or more DNS aliases.
        Aliases:
          type: array
          items:
            type: string
          description: 'An array of one or more DNS alias names to associate with the file system. The alias name has to comply with the following formatting requirements: Formatted as a fully-qualified domain name (FQDN), hostname.domain , for example, accounting.corp.example.com. Can contain alphanumeric characters and the hyphen (-). Cannot start or end with a hyphen. Can start with a numeric. For DNS alias names, Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes.'
      required:
      - FileSystemId
      - Aliases
    Alias:
      type: object
      properties:
        Name:
          type: string
          description: 'The name of the DNS alias. The alias name has to meet the following requirements: Formatted as a fully-qualified domain name (FQDN), hostname.domain, for example, accounting.example.com. Can contain alphanumeric characters, the underscore (_), and the hyphen (-). Cannot start or end with a hyphen. Can start with a numeric. For DNS names, Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes.'
        Lifecycle:
          type: string
          enum:
          - AVAILABLE
          - CREATING
          - DELETING
          - CREATE_FAILED
          - DELETE_FAILED
          description: Describes the state of the DNS alias. AVAILABLE - The DNS alias is associated with an Amazon FSx file system. CREATING - Amazon FSx is creating the DNS alias and associating it with the file system. CREATE_FAILED - Amazon FSx was unable to associate the DNS alias with the file system. DELETING - Amazon FSx is disassociating the DNS alias from the file system and deleting it. DELETE_FAILED - Amazon FSx was unable to disassociate the DNS alias from the file system.
    DisassociateFileSystemAliasesRequest:
      type: object
      properties:
        ClientRequestToken:
          type: string
        FileSystemId:
          type: string
          description: Specifies the file system from which to disassociate the DNS aliases.
        Aliases:
          type: array
          items:
            type: string
          description: An array of one or more DNS alias names to disassociate, or remove, from the file system.
      required:
      - FileSystemId
      - Aliases
  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: fsx
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/fsx/service/2018-03-01/fsx-2018-03-01.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)