Amazon WorkSpaces #X Amz Target=WorkspacesService.DescribeConnectionAliases 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.DescribeConnectionAliases 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.DescribeConnectionAliases'
paths:
  /#X-Amz-Target=WorkspacesService.DescribeConnectionAliases:
    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: DescribeConnectionAliases
      description: Retrieves a list that describes the connection aliases used for cross-Region redirection. For more information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html"> Cross-Region Redirection for Amazon WorkSpaces</a>.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeConnectionAliasesResult'
        '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'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeConnectionAliasesRequest'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - WorkspacesService.DescribeConnectionAliases
      summary: Amazon WorkSpaces Describe Connection Aliases
      tags:
      - '#X Amz Target=WorkspacesService.DescribeConnectionAliases'
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:
    DescribeConnectionAliasesResult:
      type: object
      properties:
        ConnectionAliases:
          allOf:
          - $ref: '#/components/schemas/ConnectionAliasList'
          - description: Information about the specified connection aliases.
        NextToken:
          allOf:
          - $ref: '#/components/schemas/PaginationToken'
          - description: 'The token to use to retrieve the next page of results. This value is null when there are no more results to return. '
    AwsAccount:
      type: string
      pattern: ^\d{12}$
    ConnectionIdentifier:
      type: string
      pattern: ^[a-zA-Z0-9]+$
      minLength: 1
      maxLength: 20
    ConnectionAliasAssociation:
      type: object
      properties:
        AssociationStatus:
          allOf:
          - $ref: '#/components/schemas/AssociationStatus'
          - description: The association status of the connection alias.
        AssociatedAccountId:
          allOf:
          - $ref: '#/components/schemas/AwsAccount'
          - description: The identifier of the Amazon Web Services account that associated the connection alias with a directory.
        ResourceId:
          allOf:
          - $ref: '#/components/schemas/NonEmptyString'
          - description: The identifier of the directory associated with a connection alias.
        ConnectionIdentifier:
          allOf:
          - $ref: '#/components/schemas/ConnectionIdentifier'
          - description: The identifier of the connection alias association. You use the connection identifier in the DNS TXT record when you're configuring your DNS routing policies.
      description: Describes a connection alias association that is used for cross-Region redirection. For more information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html"> Cross-Region Redirection for Amazon WorkSpaces</a>.
    PaginationToken:
      type: string
      minLength: 1
      maxLength: 2048
    NonEmptyString:
      type: string
      minLength: 1
    Limit:
      type: integer
      minimum: 1
      maximum: 25
    ConnectionAlias:
      type: object
      properties:
        ConnectionString:
          allOf:
          - $ref: '#/components/schemas/ConnectionString'
          - description: The connection string specified for the connection alias. The connection string must be in the form of a fully qualified domain name (FQDN), such as <code>www.example.com</code>.
        AliasId:
          allOf:
          - $ref: '#/components/schemas/ConnectionAliasId'
          - description: The identifier of the connection alias.
        State:
          allOf:
          - $ref: '#/components/schemas/ConnectionAliasState'
          - description: The current state of the connection alias.
        OwnerAccountId:
          allOf:
          - $ref: '#/components/schemas/AwsAccount'
          - description: The identifier of the Amazon Web Services account that owns the connection alias.
        Associations:
          allOf:
          - $ref: '#/components/schemas/ConnectionAliasAssociationList'
          - description: The association status of the connection alias.
      description: Describes a connection alias. Connection aliases are used for cross-Region redirection. For more information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html"> Cross-Region Redirection for Amazon WorkSpaces</a>.
    ConnectionAliasAssociationList:
      type: array
      items:
        $ref: '#/components/schemas/ConnectionAliasAssociation'
      minItems: 1
      maxItems: 25
    ConnectionAliasId:
      type: string
      pattern: ^wsca-[0-9a-z]{8,63}$
      minLength: 13
      maxLength: 68
    InvalidParameterValuesException: {}
    ConnectionString:
      type: string
      pattern: ^[.0-9a-zA-Z\-]{1,255}$
      minLength: 1
      maxLength: 255
    ConnectionAliasIdList:
      type: array
      items:
        $ref: '#/components/schemas/ConnectionAliasId'
      minItems: 1
      maxItems: 25
    ConnectionAliasList:
      type: array
      items:
        $ref: '#/components/schemas/ConnectionAlias'
      minItems: 1
      maxItems: 25
    AccessDeniedException: {}
    AssociationStatus:
      type: string
      enum:
      - NOT_ASSOCIATED
      - ASSOCIATED_WITH_OWNER_ACCOUNT
      - ASSOCIATED_WITH_SHARED_ACCOUNT
      - PENDING_ASSOCIATION
      - PENDING_DISASSOCIATION
    DescribeConnectionAliasesRequest:
      type: object
      title: DescribeConnectionAliasesRequest
      properties:
        AliasIds:
          allOf:
          - $ref: '#/components/schemas/ConnectionAliasIdList'
          - description: The identifiers of the connection aliases to describe.
        ResourceId:
          allOf:
          - $ref: '#/components/schemas/NonEmptyString'
          - description: The identifier of the directory associated with the connection alias.
        Limit:
          allOf:
          - $ref: '#/components/schemas/Limit'
          - description: The maximum number of connection aliases to return.
        NextToken:
          allOf:
          - $ref: '#/components/schemas/PaginationToken'
          - description: 'If you received a <code>NextToken</code> from a previous call that was paginated, provide this token to receive the next set of results. '
    OperationNotSupportedException: {}
    ConnectionAliasState:
      type: string
      enum:
      - CREATING
      - CREATED
      - DELETING
  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