Amazon FSx Fsx Storage Virtual Machine API

openapi: 3.2.0
info:
  title: Amazon FSx Storage Virtual Machine API
  version: '2018-03-01'
  description: Generated from AWS's published Smithy model for Amazon FSx. 4 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: Storage Virtual Machine
paths:
  /#CreateStorageVirtualMachine:
    post:
      operationId: CreateStorageVirtualMachine
      summary: Create Storage Virtual Machine
      description: Creates a storage virtual machine (SVM) for an Amazon FSx for ONTAP file system.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateStorageVirtualMachineResponse'
        '400':
          description: ActiveDirectoryError; BadRequest; FileSystemNotFound; IncompatibleParameterError; ServiceLimitExceeded; UnsupportedOperation
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ActiveDirectoryError'
        '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.CreateStorageVirtualMachine
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateStorageVirtualMachineRequest'
      tags:
      - Storage Virtual Machine
  /#DeleteStorageVirtualMachine:
    post:
      operationId: DeleteStorageVirtualMachine
      summary: Delete Storage Virtual Machine
      description: Deletes an existing Amazon FSx for ONTAP storage virtual machine (SVM). Prior to deleting an SVM, you must delete all non-root volumes in the SVM, otherwise the operation will fail.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteStorageVirtualMachineResponse'
        '400':
          description: BadRequest; IncompatibleParameterError; StorageVirtualMachineNotFound
          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.DeleteStorageVirtualMachine
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteStorageVirtualMachineRequest'
      tags:
      - Storage Virtual Machine
  /#DescribeStorageVirtualMachines:
    post:
      operationId: DescribeStorageVirtualMachines
      summary: Describe Storage Virtual Machines
      description: Describes one or more Amazon FSx for NetApp ONTAP storage virtual machines (SVMs).
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeStorageVirtualMachinesResponse'
        '400':
          description: BadRequest; StorageVirtualMachineNotFound
          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.DescribeStorageVirtualMachines
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeStorageVirtualMachinesRequest'
      tags:
      - Storage Virtual Machine
  /#UpdateStorageVirtualMachine:
    post:
      operationId: UpdateStorageVirtualMachine
      summary: Update Storage Virtual Machine
      description: Updates an FSx for ONTAP storage virtual machine (SVM).
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateStorageVirtualMachineResponse'
        '400':
          description: BadRequest; IncompatibleParameterError; StorageVirtualMachineNotFound; UnsupportedOperation
          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.UpdateStorageVirtualMachine
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateStorageVirtualMachineRequest'
      tags:
      - Storage Virtual Machine
components:
  schemas:
    DescribeStorageVirtualMachinesRequest:
      type: object
      properties:
        StorageVirtualMachineIds:
          type: array
          items:
            type: string
          description: Enter the ID of one or more SVMs that you want to view.
        Filters:
          type: array
          items:
            $ref: '#/components/schemas/StorageVirtualMachineFilter'
          description: Enter a filter name:value pair to view a select set of SVMs.
        MaxResults:
          type: integer
        NextToken:
          type: string
    DeleteStorageVirtualMachineRequest:
      type: object
      properties:
        ClientRequestToken:
          type: string
        StorageVirtualMachineId:
          type: string
          description: The ID of the SVM that you want to delete.
      required:
      - StorageVirtualMachineId
    LifecycleTransitionReason:
      type: object
      properties:
        Message:
          type: string
    CreateStorageVirtualMachineRequest:
      type: object
      properties:
        ActiveDirectoryConfiguration:
          $ref: '#/components/schemas/CreateSvmActiveDirectoryConfiguration'
        ClientRequestToken:
          type: string
        FileSystemId:
          type: string
        Name:
          type: string
          description: The name of the SVM.
        SvmAdminPassword:
          type: string
          description: The password to use when managing the SVM using the NetApp ONTAP CLI or REST API. If you do not specify a password, you can still use the file system's fsxadmin user to manage the SVM.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
        RootVolumeSecurityStyle:
          type: string
          enum:
          - UNIX
          - NTFS
          - MIXED
          description: 'The security style of the root volume of the SVM. Specify one of the following values: UNIX if the file system is managed by a UNIX administrator, the majority of users are NFS clients, and an application accessing the data uses a UNIX user as the service account. NTFS if the file system is managed by a Microsoft Windows administrator, the majority of users are SMB clients, and an application accessing the data uses a Microsoft Windows user as the service account. MIXED This is an advanced setting. For more information, see Volume security style in the Amazon FSx for NetApp ONTAP User Guide.'
      required:
      - FileSystemId
      - Name
    ActiveDirectoryError:
      type: object
      properties:
        ActiveDirectoryId:
          type: string
          description: The directory ID of the directory that an error pertains to.
        Type:
          type: string
          enum:
          - DOMAIN_NOT_FOUND
          - INCOMPATIBLE_DOMAIN_MODE
          - WRONG_VPC
          - INVALID_NETWORK_TYPE
          - INVALID_DOMAIN_STAGE
          description: The type of Active Directory error.
        Message:
          type: string
      required:
      - ActiveDirectoryId
    UpdateStorageVirtualMachineResponse:
      type: object
      properties:
        StorageVirtualMachine:
          $ref: '#/components/schemas/StorageVirtualMachine'
    SelfManagedActiveDirectoryConfigurationUpdates:
      type: object
      properties:
        UserName:
          type: string
          description: Specifies the updated user name for the service account on your self-managed Active Directory domain. Amazon FSx uses this account to join to your self-managed Active Directory domain. This account must have the permissions required to join computers to the domain in the organizational unit provided in OrganizationalUnitDistinguishedName.
        Password:
          type: string
          description: Specifies the updated password for the service account on your self-managed Active Directory domain. Amazon FSx uses this account to join to your self-managed Active Directory domain.
        DnsIps:
          type: array
          items:
            type: string
          description: A list of up to three DNS server or domain controller IP addresses in your self-managed Active Directory domain.
        DomainName:
          type: string
          description: Specifies an updated fully qualified domain name of your self-managed Active Directory configuration.
        OrganizationalUnitDistinguishedName:
          type: string
          description: Specifies an updated fully qualified distinguished name of the organization unit within your self-managed Active Directory.
        FileSystemAdministratorsGroup:
          type: string
          description: For FSx for ONTAP file systems only - Specifies the updated name of the self-managed Active Directory domain group whose members are granted administrative privileges for the Amazon FSx resource.
        DomainJoinServiceAccountSecret:
          type: string
          description: Specifies the updated Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret containing the self-managed Active Directory domain join service account credentials. Amazon FSx uses this account to join to your self-managed Active Directory domain.
    SelfManagedActiveDirectoryAttributes:
      type: object
      properties:
        DomainName:
          type: string
          description: The fully qualified domain name of the self-managed AD directory.
        OrganizationalUnitDistinguishedName:
          type: string
          description: The fully qualified distinguished name of the organizational unit within the self-managed AD directory to which the Windows File Server or ONTAP storage virtual machine (SVM) instance is joined.
        FileSystemAdministratorsGroup:
          type: string
          description: The name of the domain group whose members have administrative privileges for the FSx file system.
        UserName:
          type: string
          description: The user name for the service account on your self-managed AD domain that FSx uses to join to your AD domain.
        DnsIps:
          type: array
          items:
            type: string
          description: A list of up to three IP addresses of DNS servers or domain controllers in the self-managed AD directory.
        DomainJoinServiceAccountSecret:
          type: string
          description: The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret containing the service account credentials used to join the file system to your self-managed Active Directory domain.
    SelfManagedActiveDirectoryConfiguration:
      type: object
      properties:
        DomainName:
          type: string
          description: The fully qualified domain name of the self-managed AD directory, such as corp.example.com.
        OrganizationalUnitDistinguishedName:
          type: string
          description: (Optional) The fully qualified distinguished name of the organizational unit within your self-managed AD directory. Amazon FSx only accepts OU as the direct parent of the file system. An example is OU=FSx,DC=yourdomain,DC=corp,DC=com. To learn more, see RFC 2253. If none is provided, the FSx file system is created in the default location of your self-managed AD directory. Only Organizational Unit (OU) objects can be the direct parent of the file system that you're creating.
        FileSystemAdministratorsGroup:
          type: string
          description: (Optional) The name of the domain group whose members are granted administrative privileges for the file system. Administrative privileges include taking ownership of files and folders, setting audit controls (audit ACLs) on files and folders, and administering the file system remotely by using the FSx Remote PowerShell. The group that you specify must already exist in your domain. If you don't provide one, your AD domain's Domain Admins group is used.
        UserName:
          type: string
          description: The user name for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain. This account must have the permission to join computers to the domain in the organizational unit provided in OrganizationalUnitDistinguishedName, or in the default location of your AD domain.
        Password:
          type: string
          description: The password for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain.
        DnsIps:
          type: array
          items:
            type: string
          description: A list of up to three IP addresses of DNS servers or domain controllers in the self-managed AD directory.
        DomainJoinServiceAccountSecret:
          type: string
          description: 'The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret containing the self-managed Active Directory domain join service account credentials. When provided, Amazon FSx uses the credentials stored in this secret to join the file system to your self-managed Active Directory domain. The secret must contain two key-value pairs: CUSTOMER_MANAGED_ACTIVE_DIRECTORY_USERNAME - The username for the service account CUSTOMER_MANAGED_ACTIVE_DIRECTORY_PASSWORD - The password for the service account For more information, see Using Amazon FSx for Windows with your self-managed Microso'
      required:
      - DomainName
      - DnsIps
    BadRequest:
      type: object
      properties:
        Message:
          type: string
    InternalServerError:
      type: object
      properties:
        Message:
          type: string
    SvmEndpoint:
      type: object
      properties:
        DNSName:
          type: string
        IpAddresses:
          type: array
          items:
            type: string
          description: The SVM endpoint's IPv4 addresses.
        Ipv6Addresses:
          type: array
          items:
            type: string
          description: The SVM endpoint's IPv6 addresses.
    UpdateSvmActiveDirectoryConfiguration:
      type: object
      properties:
        SelfManagedActiveDirectoryConfiguration:
          $ref: '#/components/schemas/SelfManagedActiveDirectoryConfigurationUpdates'
        NetBiosName:
          type: string
          description: Specifies an updated NetBIOS name of the AD computer object NetBiosName to which an SVM is joined.
    DescribeStorageVirtualMachinesResponse:
      type: object
      properties:
        StorageVirtualMachines:
          type: array
          items:
            $ref: '#/components/schemas/StorageVirtualMachine'
          description: Returned after a successful DescribeStorageVirtualMachines operation, describing each SVM.
        NextToken:
          type: string
    SvmEndpoints:
      type: object
      properties:
        Iscsi:
          $ref: '#/components/schemas/SvmEndpoint'
        Management:
          $ref: '#/components/schemas/SvmEndpoint'
        Nfs:
          $ref: '#/components/schemas/SvmEndpoint'
        Smb:
          $ref: '#/components/schemas/SvmEndpoint'
    CreateSvmActiveDirectoryConfiguration:
      type: object
      properties:
        NetBiosName:
          type: string
          description: The NetBIOS name of the Active Directory computer object that will be created for your SVM.
        SelfManagedActiveDirectoryConfiguration:
          $ref: '#/components/schemas/SelfManagedActiveDirectoryConfiguration'
      required:
      - NetBiosName
    DeleteStorageVirtualMachineResponse:
      type: object
      properties:
        StorageVirtualMachineId:
          type: string
          description: The ID of the SVM Amazon FSx is deleting.
        Lifecycle:
          type: string
          enum:
          - CREATED
          - CREATING
          - DELETING
          - FAILED
          - MISCONFIGURED
          - PENDING
          description: Describes the lifecycle state of the SVM being deleted.
    UpdateStorageVirtualMachineRequest:
      type: object
      properties:
        ActiveDirectoryConfiguration:
          $ref: '#/components/schemas/UpdateSvmActiveDirectoryConfiguration'
        ClientRequestToken:
          type: string
        StorageVirtualMachineId:
          type: string
          description: The ID of the SVM that you want to update, in the format svm-0123456789abcdef0.
        SvmAdminPassword:
          type: string
          description: Specifies a new SvmAdminPassword.
      required:
      - StorageVirtualMachineId
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: A value that specifies the TagKey, the name of the tag. Tag keys must be unique for the resource to which they are attached.
        Value:
          type: string
          description: 'A value that specifies the TagValue, the value assigned to the corresponding tag key. Tag values can be null and don''t have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April.'
      required:
      - Key
      - Value
    CreateStorageVirtualMachineResponse:
      type: object
      properties:
        StorageVirtualMachine:
          $ref: '#/components/schemas/StorageVirtualMachine'
    SvmActiveDirectoryConfiguration:
      type: object
      properties:
        NetBiosName:
          type: string
          description: The NetBIOS name of the AD computer object to which the SVM is joined.
        SelfManagedActiveDirectoryConfiguration:
          $ref: '#/components/schemas/SelfManagedActiveDirectoryAttributes'
    StorageVirtualMachineFilter:
      type: object
      properties:
        Name:
          type: string
          enum:
          - file-system-id
          description: The name for this filter.
        Values:
          type: array
          items:
            type: string
          description: The values of the filter. These are all the values for any of the applied filters.
    StorageVirtualMachine:
      type: object
      properties:
        ActiveDirectoryConfiguration:
          $ref: '#/components/schemas/SvmActiveDirectoryConfiguration'
        CreationTime:
          type: string
          format: date-time
        Endpoints:
          $ref: '#/components/schemas/SvmEndpoints'
        FileSystemId:
          type: string
        Lifecycle:
          type: string
          enum:
          - CREATED
          - CREATING
          - DELETING
          - FAILED
          - MISCONFIGURED
          - PENDING
          description: Describes the SVM's lifecycle status. CREATED - The SVM is fully available for use. CREATING - Amazon FSx is creating the new SVM. DELETING - Amazon FSx is deleting an existing SVM. FAILED - Amazon FSx was unable to create the SVM. MISCONFIGURED - The SVM is in a failed but recoverable state. PENDING - Amazon FSx has not started creating the SVM.
        Name:
          type: string
          description: The name of the SVM, if provisioned.
        ResourceARN:
          type: string
        StorageVirtualMachineId:
          type: string
          description: The SVM's system generated unique ID.
        Subtype:
          type: string
          enum:
          - DEFAULT
          - DP_DESTINATION
          - SYNC_DESTINATION
          - SYNC_SOURCE
          description: Describes the SVM's subtype.
        UUID:
          type: string
          description: The SVM's UUID (universally unique identifier).
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
        LifecycleTransitionReason:
          $ref: '#/components/schemas/LifecycleTransitionReason'
        RootVolumeSecurityStyle:
          type: string
          enum:
          - UNIX
          - NTFS
          - MIXED
          description: The security style of the root volume of the SVM.
  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)