Amazon Directory Service #X Amz Target=DirectoryService 20150416.DescribeSharedDirectories API

openapi: 3.0.0
info:
  version: 2015-04-16
  x-release: v4
  title: 'AWS Directory Service #X Amz Target=DirectoryService 20150416.AcceptSharedDirectory #X Amz Target=DirectoryService 20150416.AcceptSharedDirectory #X Amz Target=DirectoryService 20150416.DescribeSharedDirectories API'
  description: <fullname>Directory Service</fullname> <p>Directory Service is a web service that makes it easy for you to setup and run directories in the Amazon Web Services cloud, or connect your Amazon Web Services resources with an existing self-managed Microsoft Active Directory. This guide provides detailed information about Directory Service operations, data types, parameters, and errors. For information about Directory Services features, see <a href="https://aws.amazon.com/directoryservice/">Directory Service</a> and the <a href="http://docs.aws.amazon.com/directoryservice/latest/admin-guide/what_is.html">Directory Service Administration Guide</a>.</p> <note> <p>Amazon Web Services provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to Directory Service and other Amazon Web Services services. For more information about the Amazon Web Services SDKs, including how to download and install them, see <a href="http://aws.amazon.com/tools/">Tools for Amazon Web Services</a>.</p> </note>
  x-logo:
    url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
    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: ds
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/ds-2015-04-16.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://ds.{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 Directory Service multi-region endpoint
- url: https://ds.{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 Directory Service multi-region endpoint
- url: http://ds.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Directory Service endpoint for China (Beijing) and China (Ningxia)
- url: https://ds.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Directory Service endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#X Amz Target=DirectoryService 20150416.DescribeSharedDirectories'
paths:
  /#X-Amz-Target=DirectoryService_20150416.DescribeSharedDirectories:
    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: DescribeSharedDirectories
      description: 'Returns the shared directories in your account. '
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeSharedDirectoriesResult'
        '480':
          description: EntityDoesNotExistException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityDoesNotExistException'
        '481':
          description: InvalidNextTokenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidNextTokenException'
        '482':
          description: InvalidParameterException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
        '483':
          description: UnsupportedOperationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnsupportedOperationException'
        '484':
          description: ClientException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientException'
        '485':
          description: ServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceException'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeSharedDirectoriesRequest'
      parameters:
      - name: Limit
        in: query
        schema:
          type: string
        description: Pagination limit
        required: false
      - name: NextToken
        in: query
        schema:
          type: string
        description: Pagination token
        required: false
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - DirectoryService_20150416.DescribeSharedDirectories
      tags:
      - '#X Amz Target=DirectoryService 20150416.DescribeSharedDirectories'
components:
  parameters:
    X-Amz-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
    X-Amz-Credential:
      name: X-Amz-Credential
      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-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
    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
  schemas:
    ClientException: {}
    DescribeSharedDirectoriesResult:
      type: object
      properties:
        SharedDirectories:
          allOf:
          - $ref: '#/components/schemas/SharedDirectories'
          - description: A list of all shared directories in your account.
        NextToken:
          allOf:
          - $ref: '#/components/schemas/NextToken'
          - description: If not null, token that indicates that more results are available. Pass this value for the <code>NextToken</code> parameter in a subsequent call to <a>DescribeSharedDirectories</a> to retrieve the next set of items.
    DirectoryId:
      type: string
      pattern: ^d-[0-9a-f]{10}$
    CustomerId:
      type: string
      pattern: ^(\d{12})$
    CreatedDateTime:
      type: string
      format: date-time
    ShareStatus:
      type: string
      enum:
      - Shared
      - PendingAcceptance
      - Rejected
      - Rejecting
      - RejectFailed
      - Sharing
      - ShareFailed
      - Deleted
      - Deleting
    DescribeSharedDirectoriesRequest:
      type: object
      required:
      - OwnerDirectoryId
      title: DescribeSharedDirectoriesRequest
      properties:
        OwnerDirectoryId:
          allOf:
          - $ref: '#/components/schemas/DirectoryId'
          - description: 'Returns the identifier of the directory in the directory owner account. '
        SharedDirectoryIds:
          allOf:
          - $ref: '#/components/schemas/DirectoryIds'
          - description: 'A list of identifiers of all shared directories in your account. '
        NextToken:
          allOf:
          - $ref: '#/components/schemas/NextToken'
          - description: 'The <code>DescribeSharedDirectoriesResult.NextToken</code> value from a previous call to <a>DescribeSharedDirectories</a>. Pass null if this is the first call. '
        Limit:
          allOf:
          - $ref: '#/components/schemas/Limit'
          - description: The number of shared directories to return in the response object.
    SharedDirectories:
      type: array
      items:
        $ref: '#/components/schemas/SharedDirectory'
    ShareMethod:
      type: string
      enum:
      - ORGANIZATIONS
      - HANDSHAKE
    SharedDirectory:
      type: object
      properties:
        OwnerAccountId:
          allOf:
          - $ref: '#/components/schemas/CustomerId'
          - description: Identifier of the directory owner account, which contains the directory that has been shared to the consumer account.
        OwnerDirectoryId:
          allOf:
          - $ref: '#/components/schemas/DirectoryId'
          - description: 'Identifier of the directory in the directory owner account. '
        ShareMethod:
          allOf:
          - $ref: '#/components/schemas/ShareMethod'
          - description: The method used when sharing a directory to determine whether the directory should be shared within your Amazon Web Services organization (<code>ORGANIZATIONS</code>) or with any Amazon Web Services account by sending a shared directory request (<code>HANDSHAKE</code>).
        SharedAccountId:
          allOf:
          - $ref: '#/components/schemas/CustomerId'
          - description: Identifier of the directory consumer account that has access to the shared directory (<code>OwnerDirectoryId</code>) in the directory owner account.
        SharedDirectoryId:
          allOf:
          - $ref: '#/components/schemas/DirectoryId'
          - description: Identifier of the shared directory in the directory consumer account. This identifier is different for each directory owner account.
        ShareStatus:
          allOf:
          - $ref: '#/components/schemas/ShareStatus'
          - description: Current directory status of the shared Managed Microsoft AD directory.
        ShareNotes:
          allOf:
          - $ref: '#/components/schemas/Notes'
          - description: A directory share request that is sent by the directory owner to the directory consumer. The request includes a typed message to help the directory consumer administrator determine whether to approve or reject the share invitation.
        CreatedDateTime:
          allOf:
          - $ref: '#/components/schemas/CreatedDateTime'
          - description: The date and time that the shared directory was created.
        LastUpdatedDateTime:
          allOf:
          - $ref: '#/components/schemas/LastUpdatedDateTime'
          - description: The date and time that the shared directory was last updated.
      description: Details about the shared directory in the directory owner account for which the share request in the directory consumer account has been accepted.
    UnsupportedOperationException: {}
    DirectoryIds:
      type: array
      description: A list of directory identifiers.
      items:
        $ref: '#/components/schemas/DirectoryId'
    NextToken:
      type: string
    Limit:
      type: integer
      minimum: 0
    ServiceException: {}
    EntityDoesNotExistException: {}
    LastUpdatedDateTime:
      type: string
      format: date-time
    InvalidParameterException: {}
    Notes:
      type: string
      maxLength: 1024
      format: password
    InvalidNextTokenException: {}
  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/ds/
x-hasEquivalentPaths: true