Amazon WorkSpaces #X Amz Target=WorkspacesService.CreateStandbyWorkspaces API

openapi: 3.0.0
info:
  version: '2015-04-08'
  x-release: v4
  title: 'Amazon WorkSpaces #X Amz Target=WorkspacesService.AssociateConnectionAlias #X Amz Target=WorkspacesService.AssociateConnectionAlias #X Amz Target=WorkspacesService.CreateStandbyWorkspaces API'
  description: <fullname>Amazon WorkSpaces Service</fullname> <p>Amazon WorkSpaces enables you to provision virtual, cloud-based Microsoft Windows or Amazon Linux desktops for your users, known as <i>WorkSpaces</i>. WorkSpaces eliminates the need to procure and deploy hardware or install complex software. You can quickly add or remove users as your needs change. Users can access their virtual desktops from multiple devices or web browsers.</p> <p>This API Reference provides detailed information about the actions, data types, parameters, and errors of the WorkSpaces service. For more information about the supported Amazon Web Services Regions, endpoints, and service quotas of the Amazon WorkSpaces service, see <a href="https://docs.aws.amazon.com/general/latest/gr/wsp.html">WorkSpaces endpoints and quotas</a> in the <i>Amazon Web Services General Reference</i>.</p> <p>You can also manage your WorkSpaces resources using the WorkSpaces console, Command Line Interface (CLI), and SDKs. For more information about administering WorkSpaces, see the <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/">Amazon WorkSpaces Administration Guide</a>. For more information about using the Amazon WorkSpaces client application or web browser to access provisioned WorkSpaces, see the <a href="https://docs.aws.amazon.com/workspaces/latest/userguide/">Amazon WorkSpaces User Guide</a>. For more information about using the CLI to manage your WorkSpaces resources, see the <a href="https://docs.aws.amazon.com/cli/latest/reference/workspaces/index.html">WorkSpaces section of the CLI Reference</a>.</p>
  x-logo:
    url: https://twitter.com/awscloud/profile_image?size=original
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: workspaces
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/workspaces-2015-04-08.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
      version: 1.0.0
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://workspaces.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon WorkSpaces multi-region endpoint
- url: https://workspaces.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon WorkSpaces multi-region endpoint
- url: http://workspaces.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon WorkSpaces endpoint for China (Beijing) and China (Ningxia)
- url: https://workspaces.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon WorkSpaces endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#X Amz Target=WorkspacesService.CreateStandbyWorkspaces'
paths:
  /#X-Amz-Target=WorkspacesService.CreateStandbyWorkspaces:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    post:
      operationId: CreateStandbyWorkspaces
      description: Creates a standby WorkSpace in a secondary Region.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateStandbyWorkspacesResult'
        '480':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '481':
          description: InvalidParameterValuesException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValuesException'
        '482':
          description: OperationNotSupportedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationNotSupportedException'
        '483':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '484':
          description: ResourceLimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceLimitExceededException'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateStandbyWorkspacesRequest'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - WorkspacesService.CreateStandbyWorkspaces
      summary: Amazon WorkSpaces Create Standby Workspaces
      tags:
      - '#X Amz Target=WorkspacesService.CreateStandbyWorkspaces'
components:
  parameters:
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
    X-Amz-Security-Token:
      name: X-Amz-Security-Token
      in: header
      schema:
        type: string
      required: false
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
    X-Amz-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
  schemas:
    FailedCreateStandbyWorkspacesRequestList:
      type: array
      items:
        $ref: '#/components/schemas/FailedCreateStandbyWorkspacesRequest'
    ResourceLimitExceededException: {}
    TagValue:
      type: string
      maxLength: 255
    Region:
      type: string
      pattern: ^[-0-9a-z]{1,31}$
      minLength: 1
      maxLength: 31
    CreateStandbyWorkspacesRequest:
      type: object
      required:
      - PrimaryRegion
      - StandbyWorkspaces
      title: CreateStandbyWorkspacesRequest
      properties:
        PrimaryRegion:
          allOf:
          - $ref: '#/components/schemas/Region'
          - description: The Region of the primary WorkSpace.
        StandbyWorkspaces:
          allOf:
          - $ref: '#/components/schemas/StandbyWorkspacesList'
          - description: Information about the standby WorkSpace to be created.
    Tag:
      type: object
      required:
      - Key
      properties:
        Key:
          allOf:
          - $ref: '#/components/schemas/TagKey'
          - description: The key of the tag.
        Value:
          allOf:
          - $ref: '#/components/schemas/TagValue'
          - description: The value of the tag.
      description: Describes a tag.
    PendingCreateStandbyWorkspacesRequestList:
      type: array
      items:
        $ref: '#/components/schemas/PendingCreateStandbyWorkspacesRequest'
    WorkspaceId:
      type: string
      pattern: ^ws-[0-9a-z]{8,63}$
    PendingCreateStandbyWorkspacesRequest:
      type: object
      properties:
        UserName:
          allOf:
          - $ref: '#/components/schemas/UserName'
          - description: <p>Describes the standby WorkSpace that was created.</p> <p>Because this operation is asynchronous, the identifier returned is not immediately available for use with other operations. For example, if you call <a href="https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaces.html"> DescribeWorkspaces</a> before the WorkSpace is created, the information returned can be incomplete. </p>
        DirectoryId:
          allOf:
          - $ref: '#/components/schemas/DirectoryId'
          - description: The identifier of the directory for the standby WorkSpace.
        State:
          allOf:
          - $ref: '#/components/schemas/WorkspaceState'
          - description: The operational state of the standby WorkSpace.
        WorkspaceId:
          allOf:
          - $ref: '#/components/schemas/WorkspaceId'
          - description: The identifier of the standby WorkSpace.
      description: Information about the standby WorkSpace.
    StandbyWorkspacesList:
      type: array
      items:
        $ref: '#/components/schemas/StandbyWorkspace'
    WorkspaceState:
      type: string
      enum:
      - PENDING
      - AVAILABLE
      - IMPAIRED
      - UNHEALTHY
      - REBOOTING
      - STARTING
      - REBUILDING
      - RESTORING
      - MAINTENANCE
      - ADMIN_MAINTENANCE
      - TERMINATING
      - TERMINATED
      - SUSPENDED
      - UPDATING
      - STOPPING
      - STOPPED
      - ERROR
    VolumeEncryptionKey:
      type: string
    DirectoryId:
      type: string
      pattern: ^d-[0-9a-f]{8,63}$
      minLength: 10
      maxLength: 65
    InvalidParameterValuesException: {}
    CreateStandbyWorkspacesResult:
      type: object
      properties:
        FailedStandbyRequests:
          allOf:
          - $ref: '#/components/schemas/FailedCreateStandbyWorkspacesRequestList'
          - description: 'Information about the standby WorkSpace that could not be created. '
        PendingStandbyRequests:
          allOf:
          - $ref: '#/components/schemas/PendingCreateStandbyWorkspacesRequestList'
          - description: Information about the standby WorkSpace that was created.
    WorkspaceErrorCode:
      type: string
    ResourceNotFoundException: {}
    AccessDeniedException: {}
    Description:
      type: string
    OperationNotSupportedException: {}
    StandbyWorkspace:
      type: object
      required:
      - PrimaryWorkspaceId
      - DirectoryId
      properties:
        PrimaryWorkspaceId:
          allOf:
          - $ref: '#/components/schemas/WorkspaceId'
          - description: The identifier of the standby WorkSpace.
        VolumeEncryptionKey:
          allOf:
          - $ref: '#/components/schemas/VolumeEncryptionKey'
          - description: The volume encryption key of the standby WorkSpace.
        DirectoryId:
          allOf:
          - $ref: '#/components/schemas/DirectoryId'
          - description: The identifier of the directory for the standby WorkSpace.
        Tags:
          allOf:
          - $ref: '#/components/schemas/TagList'
          - description: The tags associated with the standby WorkSpace.
      description: Describes a standby WorkSpace.
    TagKey:
      type: string
      minLength: 1
      maxLength: 127
    FailedCreateStandbyWorkspacesRequest:
      type: object
      properties:
        StandbyWorkspaceRequest:
          allOf:
          - $ref: '#/components/schemas/StandbyWorkspace'
          - description: Information about the standby WorkSpace that could not be created.
        ErrorCode:
          allOf:
          - $ref: '#/components/schemas/WorkspaceErrorCode'
          - description: The error code that is returned if the standby WorkSpace could not be created.
        ErrorMessage:
          allOf:
          - $ref: '#/components/schemas/Description'
          - description: The text of the error message that is returned if the standby WorkSpace could not be created.
      description: Describes the standby WorkSpace that could not be created.
    TagList:
      type: array
      items:
        $ref: '#/components/schemas/Tag'
    UserName:
      type: string
      minLength: 1
      maxLength: 63
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/workspaces/
x-hasEquivalentPaths: true