Amazon WorkSpaces #X Amz Target=WorkspacesService.DescribeConnectionAliasPermissions API

openapi: 3.2.0
info:
  version: '2015-04-08'
  x-release: v4
  title: 'Amazon WorkSpaces #X Amz Target=WorkspacesService.DescribeCo…'
  description: 'Amazon WorkSpaces Service

    Amazon WorkSpaces enables you to provision virtual, cloud-based Microsoft Windows or Amazon Linux desktops for your users, known as WorkSpaces.'
  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.DescribeConnectionAliasPermissions'
paths:
  /#X-Amz-Target=WorkspacesService.DescribeConnectionAliasPermissions:
    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: DescribeConnectionAliasPermissions
      description: Describes the permissions that the owner of a connection alias has granted to another Amazon Web Services account for the specified connection alias. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeConnectionAliasPermissionsResult'
        '480':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '481':
          description: InvalidParameterValuesException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValuesException'
        '482':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '483':
          description: OperationNotSupportedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationNotSupportedException'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeConnectionAliasPermissionsRequest'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - WorkspacesService.DescribeConnectionAliasPermissions
      summary: Amazon WorkSpaces Describe Connection Alias Permissions
      tags:
      - '#X Amz Target=WorkspacesService.DescribeConnectionAliasPermissions'
components:
  parameters:
    X-Amz-Signature:
      name: X-Amz-Signature
      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-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      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-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
  schemas:
    BooleanObject:
      type: boolean
    ConnectionAliasPermissions:
      type: array
      items:
        $ref: '#/components/schemas/ConnectionAliasPermission'
      minItems: 1
      maxItems: 25
    ConnectionAliasId:
      type: string
      pattern: ^wsca-[0-9a-z]{8,63}$
      minLength: 13
      maxLength: 68
    PaginationToken:
      type: string
      minLength: 1
      maxLength: 2048
    OperationNotSupportedException: {}
    ResourceNotFoundException: {}
    InvalidParameterValuesException: {}
    ConnectionAliasPermission:
      type: object
      required:
      - SharedAccountId
      - AllowAssociation
      properties:
        SharedAccountId:
          allOf:
          - $ref: '#/components/schemas/AwsAccount'
          - description: The identifier of the Amazon Web Services account that the connection alias is shared with.
        AllowAssociation:
          allOf:
          - $ref: '#/components/schemas/BooleanObject'
          - description: Indicates whether the specified Amazon Web Services account is allowed to associate the connection alias with a directory.
      description: Describes the permissions for 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>.
    AccessDeniedException: {}
    DescribeConnectionAliasPermissionsRequest:
      type: object
      required:
      - AliasId
      title: DescribeConnectionAliasPermissionsRequest
      properties:
        AliasId:
          allOf:
          - $ref: '#/components/schemas/ConnectionAliasId'
          - description: The identifier of the connection alias.
        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. '
        MaxResults:
          allOf:
          - $ref: '#/components/schemas/Limit'
          - description: The maximum number of results to return.
    Limit:
      type: integer
      minimum: 1
      maximum: 25
    DescribeConnectionAliasPermissionsResult:
      type: object
      properties:
        AliasId:
          allOf:
          - $ref: '#/components/schemas/ConnectionAliasId'
          - description: The identifier of the connection alias.
        ConnectionAliasPermissions:
          allOf:
          - $ref: '#/components/schemas/ConnectionAliasPermissions'
          - description: The permissions associated with a connection alias.
        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}$
  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