openapi: 3.2.0 info: version: 2015-04-16 x-release: v4 title: AWS Directory Service API description: 'Directory Service 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.' 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: AWS Directory Service paths: /#X-Amz-Target=DirectoryService_20150416.AcceptSharedDirectory: 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: AcceptSharedDirectory description: Accepts a directory sharing request that was sent from the directory owner account. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/AcceptSharedDirectoryResult' '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '481': description: EntityDoesNotExistException content: application/json: schema: $ref: '#/components/schemas/EntityDoesNotExistException' '482': description: DirectoryAlreadySharedException content: application/json: schema: $ref: '#/components/schemas/DirectoryAlreadySharedException' '483': description: ClientException content: application/json: schema: $ref: '#/components/schemas/ClientException' '484': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AcceptSharedDirectoryRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - DirectoryService_20150416.AcceptSharedDirectory tags: - AWS Directory Service summary: Accept shared directory x-summary-source: derived /#X-Amz-Target=DirectoryService_20150416.AddIpRoutes: 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: AddIpRoutes description: 'If the DNS server for your self-managed domain uses a publicly addressable IP address, you must add a CIDR address block to correctly route traffic to and from your Microsoft AD on Amazon Web Services. AddIpRoutes adds this address block. You can also use AddIpRoutes to facilitate routing traffic that uses public IP ranges from your Microsoft AD on Amazon Web Services to a peer VPC. Before you call AddIpRoutes, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the AddIpRoutes operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/AddIpRoutesResult' '480': description: EntityDoesNotExistException content: application/json: schema: $ref: '#/components/schemas/EntityDoesNotExistException' '481': description: EntityAlreadyExistsException content: application/json: schema: $ref: '#/components/schemas/EntityAlreadyExistsException' '482': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '483': description: DirectoryUnavailableException content: application/json: schema: $ref: '#/components/schemas/DirectoryUnavailableException' '484': description: IpRouteLimitExceededException content: application/json: schema: $ref: '#/components/schemas/IpRouteLimitExceededException' '485': description: ClientException content: application/json: schema: $ref: '#/components/schemas/ClientException' '486': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AddIpRoutesRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - DirectoryService_20150416.AddIpRoutes tags: - AWS Directory Service summary: Add ip routes x-summary-source: derived /#X-Amz-Target=DirectoryService_20150416.AddRegion: 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: AddRegion description: Adds two domain controllers in the specified Region for the specified directory. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/AddRegionResult' '480': description: DirectoryUnavailableException content: application/json: schema: $ref: '#/components/schemas/DirectoryUnavailableException' '481': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '482': description: EntityDoesNotExistException content: application/json: schema: $ref: '#/components/schemas/EntityDoesNotExistException' '483': description: DirectoryAlreadyInRegionException content: application/json: schema: $ref: '#/components/schemas/DirectoryAlreadyInRegionException' '484': description: UnsupportedOperationException content: application/json: schema: $ref: '#/components/schemas/UnsupportedOperationException' '485': description: DirectoryDoesNotExistException content: application/json: schema: $ref: '#/components/schemas/DirectoryDoesNotExistException' '486': description: RegionLimitExceededException content: application/json: schema: $ref: '#/components/schemas/RegionLimitExceededException' '487': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '488': description: ClientException content: application/json: schema: $ref: '#/components/schemas/ClientException' '489': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AddRegionRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - DirectoryService_20150416.AddRegion tags: - AWS Directory Service summary: Add region x-summary-source: derived /#X-Amz-Target=DirectoryService_20150416.AddTagsToResource: 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: AddTagsToResource description: Adds or overwrites one or more tags for the specified directory. Each directory can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique to each resource. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/AddTagsToResourceResult' '480': description: EntityDoesNotExistException content: application/json: schema: $ref: '#/components/schemas/EntityDoesNotExistException' '481': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '482': description: TagLimitExceededException content: application/json: schema: $ref: '#/components/schemas/TagLimitExceededException' '483': description: ClientException content: application/json: schema: $ref: '#/components/schemas/ClientException' '484': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AddTagsToResourceRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - DirectoryService_20150416.AddTagsToResource tags: - AWS Directory Service summary: Add tags to resource x-summary-source: derived /#X-Amz-Target=DirectoryService_20150416.CancelSchemaExtension: 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: CancelSchemaExtension description: Cancels an in-progress schema extension to a Microsoft AD directory. Once a schema extension has started replicating to all domain controllers, the task can no longer be canceled. A schema extension can be canceled during any of the following states; Initializing, CreatingSnapshot, and UpdatingSchema. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CancelSchemaExtensionResult' '480': description: EntityDoesNotExistException content: application/json: schema: $ref: '#/components/schemas/EntityDoesNotExistException' '481': description: ClientException content: application/json: schema: $ref: '#/components/schemas/ClientException' '482': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CancelSchemaExtensionRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - DirectoryService_20150416.CancelSchemaExtension tags: - AWS Directory Service summary: Cancel schema extension x-summary-source: derived /#X-Amz-Target=DirectoryService_20150416.ConnectDirectory: 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: ConnectDirectory description: 'Creates an AD Connector to connect to a self-managed directory. Before you call ConnectDirectory, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the ConnectDirectory operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ConnectDirectoryResult' '480': description: DirectoryLimitExceededException content: application/json: schema: $ref: '#/components/schemas/DirectoryLimitExceededException' '481': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '482': description: ClientException content: application/json: schema: $ref: '#/components/schemas/ClientException' '483': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ConnectDirectoryRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - DirectoryService_20150416.ConnectDirectory tags: - AWS Directory Service summary: Connect directory x-summary-source: derived /#X-Amz-Target=DirectoryService_20150416.CreateAlias: 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: CreateAlias description: 'Creates an alias for a directory and assigns the alias to the directory. The alias is used to construct the access URL for the directory, such as http://.awsapps.com. After an alias has been created, it cannot be deleted or reused, so this operation should only be used when absolutely necessary.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateAliasResult' '480': description: EntityAlreadyExistsException content: application/json: schema: $ref: '#/components/schemas/EntityAlreadyExistsException' '481': description: EntityDoesNotExistException content: application/json: schema: $ref: '#/components/schemas/EntityDoesNotExistException' '482': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '483': description: ClientException content: application/json: schema: $ref: '#/components/schemas/ClientException' '484': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateAliasRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - DirectoryService_20150416.CreateAlias tags: - AWS Directory Service summary: Create alias x-summary-source: derived /#X-Amz-Target=DirectoryService_20150416.CreateComputer: 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: CreateComputer description: Creates an Active Directory computer object in the specified directory. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateComputerResult' '480': description: AuthenticationFailedException content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedException' '481': description: DirectoryUnavailableException content: application/json: schema: $ref: '#/components/schemas/DirectoryUnavailableException' '482': description: EntityAlreadyExistsException content: application/json: schema: $ref: '#/components/schemas/EntityAlreadyExistsException' '483': description: EntityDoesNotExistException content: application/json: schema: $ref: '#/components/schemas/EntityDoesNotExistException' '484': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '485': description: UnsupportedOperationException content: application/json: schema: $ref: '#/components/schemas/UnsupportedOperationException' '486': description: ClientException content: application/json: schema: $ref: '#/components/schemas/ClientException' '487': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateComputerRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - DirectoryService_20150416.CreateComputer tags: - AWS Directory Service summary: Create computer x-summary-source: derived /#X-Amz-Target=DirectoryService_20150416.CreateConditionalForwarder: 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: CreateConditionalForwarder description: Creates a conditional forwarder associated with your Amazon Web Services directory. Conditional forwarders are required in order to set up a trust relationship with another domain. The conditional forwarder points to the trusted domain. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateConditionalForwarderResult' '480': description: EntityAlreadyExistsException content: application/json: schema: $ref: '#/components/schemas/EntityAlreadyExistsException' '481': description: EntityDoesNotExistException content: application/json: schema: $ref: '#/components/schemas/EntityDoesNotExistException' '482': description: DirectoryUnavailableException content: application/json: schema: $ref: '#/components/schemas/DirectoryUnavailableException' '483': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '484': description: UnsupportedOperationException content: application/json: schema: $ref: '#/components/schemas/UnsupportedOperationException' '485': description: ClientException content: application/json: schema: $ref: '#/components/schemas/ClientException' '486': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateConditionalForwarderRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - DirectoryService_20150416.CreateConditionalForwarder tags: - AWS Directory Service summary: Create conditional forwarder x-summary-source: derived /#X-Amz-Target=DirectoryService_20150416.CreateDirectory: 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: CreateDirectory description: 'Creates a Simple AD directory. For more information, see Simple Active Directory in the Directory Service Admin Guide. Before you call CreateDirectory, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the CreateDirectory operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateDirectoryResult' '480': description: DirectoryLimitExceededException content: application/json: schema: $ref: '#/components/schemas/DirectoryLimitExceededException' '481': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '482': description: ClientException content: application/json: schema: $ref: '#/components/schemas/ClientException' '483': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateDirectoryRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - DirectoryService_20150416.CreateDirectory tags: - AWS Directory Service summary: Create directory x-summary-source: derived /#X-Amz-Target=DirectoryService_20150416.CreateLogSubscription: 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: CreateLogSubscription description: Creates a subscription to forward real-time Directory Service domain controller security logs to the specified Amazon CloudWatch log group in your Amazon Web Services account. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateLogSubscriptionResult' '480': description: EntityAlreadyExistsException content: application/json: schema: $ref: '#/components/schemas/EntityAlreadyExistsException' '481': description: EntityDoesNotExistException content: application/json: schema: $ref: '#/components/schemas/EntityDoesNotExistException' '482': description: UnsupportedOperationException content: application/json: schema: $ref: '#/components/schemas/UnsupportedOperationException' '483': description: InsufficientPermissionsException content: application/json: schema: $ref: '#/components/schemas/InsufficientPermissionsException' '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/CreateLogSubscriptionRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - DirectoryService_20150416.CreateLogSubscription tags: - AWS Directory Service summary: Create log subscription x-summary-source: derived /#X-Amz-Target=DirectoryService_20150416.CreateMicrosoftAD: 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: CreateMicrosoftAD description: 'Creates a Microsoft AD directory in the Amazon Web Services Cloud. For more information, see Managed Microsoft AD in the Directory Service Admin Guide. Before you call CreateMicrosoftAD, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the CreateMicrosoftAD operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateMicrosoftADResult' '480': description: DirectoryLimitExceededException content: application/json: schema: $ref: '#/components/schemas/DirectoryLimitExceededException' '481': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '482': description: ClientException content: application/json: schema: $ref: '#/components/schemas/ClientException' '483': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' '484': description: UnsupportedOperationException content: application/json: schema: $ref: '#/components/schemas/UnsupportedOperationException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateMicrosoftADRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - DirectoryService_20150416.CreateMicrosoftAD tags: - AWS Directory Service summary: Create microsoft AD x-summary-source: derived /#X-Amz-Target=DirectoryService_20150416.CreateSnapshot: 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: CreateSnapshot description: 'Creates a snapshot of a Simple AD or Microsoft AD directory in the Amazon Web Services cloud. You cannot take snapshots of AD Connector directories.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateSnapshotResult' '480': description: EntityDoesNotExistException content: application/json: schema: $ref: '#/components/schemas/EntityDoesNotExistException' '481': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '482': description: SnapshotLimitExceededException content: application/json: schema: $ref: '#/components/schemas/SnapshotLimitExceededException' '483': description: ClientException content: application/json: schema: $ref: '#/components/schemas/ClientException' '484': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateSnapshotRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - DirectoryService_20150416.CreateSnapshot tags: - AWS Directory Service summary: Create snapshot x-summary-source: derived /#X-Amz-Target=DirectoryService_20150416.CreateTrust: 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: CreateTrust description: 'Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example, you can establish a trust between your Managed Microsoft AD directory, and your existing self-managed Microsoft Active Directory. This would allow you to provide users and groups access to resources in either domain, with a single set of credentials. This action initiates the creation of the Amazon Web Services side of a trust relationship between an Managed Microsoft AD directory and an external domain. You can create either a forest trust or an external trust.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateTrustResult' '480': description: EntityAlreadyExistsException content: application/json: schema: $ref: '#/components/schemas/EntityAlreadyExistsException' '481': description: EntityDoesNotExistException content: application/json: schema: $ref: '#/components/schemas/EntityDoesNotExistException' '482': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '483': description: ClientException content: application/json: schema: $ref: '#/components/schemas/ClientException' '484': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' '485': description: UnsupportedOperationException content: application/json: schema: $ref: '#/components/schemas/UnsupportedOperationException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateTrustRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - DirectoryService_20150416.CreateTrust tags: - AWS Directory Service summary: Create trust x-summary-source: derived /#X-Amz-Target=DirectoryService_20150416.DeleteConditionalForwarder: 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: DeleteConditionalForwarder description: Deletes a conditional forwarder that has been set up for your Amazon Web Services directory. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteConditionalForwarderResult' '480': description: EntityDoesNotExistException content: application/json: schema: $ref: '#/components/schemas/EntityDoesNotExistException' '481': description: DirectoryUnavailableException content: application/json: schema: $ref: '#/components/schemas/DirectoryUnavailableException' '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/DeleteConditionalForwarderRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - DirectoryService_20150416.DeleteConditionalForwarder tags: - AWS Directory Service summary: Delete conditional forwarder x-summary-source: derived /#X-Amz-Target=DirectoryService_20150416.DeleteDirectory: 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: DeleteDirectory description: 'Deletes an Directory Service directory. Before you call DeleteDirectory, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the DeleteDirectory operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteDirectoryResult' '480': description: EntityDoesNotExistException content: application/json: schema: $ref: '#/components/schemas/EntityDoesNotExistException' '481': description: ClientException content: application/json: schema: $ref: '#/components/schemas/ClientException' '482': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DeleteDirectoryRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - DirectoryService_20150416.DeleteDirectory tags: - AWS Directory Service summary: Delete directory x-summary-source: derived /#X-Amz-Target=DirectoryService_20150416.DeleteLogSubscription: 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: DeleteLogSubscription description: Deletes the specified log subscription. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteLogSubscriptionResult' '480': description: EntityDoesNotExistException content: application/json: schema: $ref: '#/components/schemas/EntityDoesNotExistException' '481': description: UnsupportedOperationException content: application/json: schema: $ref: '#/components/schemas/UnsupportedOperationException' '482': description: ClientException content: application/json: schema: $ref: '#/components/schemas/ClientException' '483': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DeleteLogSubscriptionRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - DirectoryService_20150416.DeleteLogSubscription tags: - AWS Directory Service summary: Delete log subscription x-summary-source: derived /#X-Amz-Target=DirectoryService_20150416.DeleteSnapshot: 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: DeleteSnapshot description: Deletes a directory snapshot. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteSnapshotResult' '480': description: EntityDoesNotExistException content: application/json: schema: $ref: '#/components/schemas/EntityDoesNotExistException' '481': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '482': description: ClientException content: application/json: schema: $ref: '#/components/schemas/ClientException' '483': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DeleteSnapshotRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - DirectoryService_20150416.DeleteSnapshot tags: - AWS Directory Service summary: Delete snapshot x-summary-source: derived /#X-Amz-Target=DirectoryService_20150416.DeleteTrust: 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: DeleteTrust description: Deletes an existing trust relationship between your Managed Microsoft AD directory and an external domain. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteTrustResult' '480': description: EntityDoesNotExistException content: application/json: schema: $ref: '#/components/schemas/EntityDoesNotExistException' '481': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '482': description: ClientException content: application/json: schema: $ref: '#/components/schemas/ClientException' '483': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' '484': description: UnsupportedOperationException content: application/json: schema: $ref: '#/components/schemas/UnsupportedOperationException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DeleteTrustRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - DirectoryService_20150416.DeleteTrust tags: - AWS Directory Service summary: Delete trust x-summary-source: derived /#X-Amz-Target=DirectoryService_20150416.DeregisterCertificate: 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: DeregisterCertificate description: Deletes from the system the certificate that was registered for secure LDAP or client certificate authentication. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeregisterCertificateResult' '480': description: DirectoryUnavailableException content: application/json: schema: $ref: '#/components/schemas/DirectoryUnavailableException' '481': description: DirectoryDoesNotExistException content: application/json: schema: $ref: '#/components/schemas/DirectoryDoesNotExistException' '482': description: CertificateDoesNotExistException content: application/json: schema: $ref: '#/components/schemas/CertificateDoesNotExistException' '483': description: CertificateInUseException content: application/json: schema: $ref: '#/components/schemas/CertificateInUseException' '484': description: UnsupportedOperationException content: application/json: schema: $ref: '#/components/schemas/UnsupportedOperationException' '485': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '486': description: ClientException content: application/json: schema: $ref: '#/components/schemas/ClientException' '487': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DeregisterCertificateRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - DirectoryService_20150416.DeregisterCertificate tags: - AWS Directory Service summary: Deregister certificate x-summary-source: derived /#X-Amz-Target=DirectoryService_20150416.DeregisterEventTopic: 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: DeregisterEventTopic description: Removes the specified directory as a publisher to the specified Amazon SNS topic. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeregisterEventTopicResult' '480': description: EntityDoesNotExistException content: application/json: schema: $ref: '#/components/schemas/EntityDoesNotExistException' '481': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '482': description: ClientException content: application/json: schema: $ref: '#/components/schemas/ClientException' '483': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DeregisterEventTopicRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - DirectoryService_20150416.DeregisterEventTopic tags: - AWS Directory Service summary: Deregister event topic x-summary-source: derived /#X-Amz-Target=DirectoryService_20150416.DescribeCertificate: 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: DescribeCertificate description: Displays information about the certificate registered for secure LDAP or client certificate authentication. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeCertificateResult' '480': description: DirectoryDoesNotExistException content: application/json: schema: $ref: '#/components/schemas/DirectoryDoesNotExistException' '481': description: UnsupportedOperationException content: application/json: schema: $ref: '#/components/schemas/UnsupportedOperationException' '482': description: CertificateDoesNotExistException content: application/json: schema: $ref: '#/components/schemas/CertificateDoesNotExistException' '483': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '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/DescribeCertificateRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - DirectoryService_20150416.DescribeCertificate tags: - AWS Directory Service summary: Describe certificate x-summary-source: derived /#X-Amz-Target=DirectoryService_20150416.DescribeClientAuthenticationSettings: 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: DescribeClientAuthenticationSettings description: Retrieves information about the type of client authentication for the specified directory, if the type is specified. If no type is specified, information about all client authentication types that are supported for the specified directory is retrieved. Currently, only SmartCard is supported. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeClientAuthenticationSettingsResult' '480': description: DirectoryDoesNotExistException content: application/json: schema: $ref: '#/components/schemas/DirectoryDoesNotExistException' '481': description: UnsupportedOperationException content: application/json: schema: $ref: '#/components/schemas/UnsupportedOperationException' '482': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '483': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '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/DescribeClientAuthenticationSettingsRequest' 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.DescribeClientAuthenticationSettings tags: - AWS Directory Service summary: Describe client authentication settings x-summary-source: derived /#X-Amz-Target=DirectoryService_20150416.DescribeConditionalForwarders: 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: DescribeConditionalForwarders description: 'Obtains information about the conditional forwarders for this account. If no input parameters are provided for RemoteDomainNames, this request describes all conditional forwarders for the specified directory ID.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeConditionalForwardersResult' '480': description: EntityDoesNotExistException content: application/json: schema: $ref: '#/components/schemas/EntityDoesNotExistException' '481': description: DirectoryUnavailableException content: application/json: schema: $ref: '#/components/schemas/DirectoryUnavailableException' '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/DescribeConditionalForwardersRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - DirectoryService_20150416.DescribeConditionalForwarders tags: - AWS Directory Service summary: Describe conditional forwarders x-summary-source: derived /#X-Amz-Target=DirectoryService_20150416.DescribeDirectories: 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: DescribeDirectories description: 'Obtains information about the directories that belong to this account. You can retrieve information about specific directories by passing the directory identifiers in the DirectoryIds parameter. Otherwise, all directories that belong to the current account are returned. This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the DescribeDirectoriesResult.NextToken member contains a token that you pass in the next call to DescribeDirectories to retrieve the next set of items. You can also specify a maximum number of return results with the Limit parameter.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeDirectoriesResult' '480': description: EntityDoesNotExistException content: application/json: schema: $ref: '#/components/schemas/EntityDoesNotExistException' '481': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '482': description: InvalidNextTokenException content: application/json: schema: $ref: '#/components/schemas/InvalidNextTokenException' '483': description: ClientException content: application/json: schema: $ref: '#/components/schemas/ClientException' '484': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DescribeDirectoriesRequest' 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.DescribeDirectories tags: - AWS Directory Service summary: Describe directories x-summary-source: derived /#X-Amz-Target=DirectoryService_20150416.DescribeDomainControllers: 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: DescribeDomainControllers description: Provides information about any domain controllers in your directory. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeDomainControllersResult' '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: ClientException content: application/json: schema: $ref: '#/components/schemas/ClientException' '484': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' '485': description: UnsupportedOperationException content: application/json: schema: $ref: '#/components/schemas/UnsupportedOperationException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DescribeDomainControllersRequest' 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.DescribeDomainControllers tags: - AWS Directory Service summary: Describe domain controllers x-summary-source: derived /#X-Amz-Target=DirectoryService_20150416.DescribeEventTopics: 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: DescribeEventTopics description: 'Obtains information about which Amazon SNS topics receive status messages from the specified directory. If no input parameters are provided, such as DirectoryId or TopicName, this request describes all of the associations in the account.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeEventTopicsResult' '480': description: EntityDoesNotExistException content: application/json: schema: $ref: '#/components/schemas/EntityDoesNotExistException' '481': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '482': description: ClientException content: application/json: schema: $ref: '#/components/schemas/ClientException' '483': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DescribeEventTopicsRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - DirectoryService_20150416.DescribeEventTopics tags: - AWS Directory Service summary: Describe event topics x-summary-source: derived /#X-Amz-Target=DirectoryService_20150416.DescribeLDAPSSettings: 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: DescribeLDAPSSettings description: Describes the status of LDAP security for the specified directory. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeLDAPSSettingsResult' '480': description: DirectoryDoesNotExistException content: application/json: schema: $ref: '#/components/schemas/DirectoryDoesNotExistException' '481': description: UnsupportedOperationException content: application/json: schema: $ref: '#/components/schemas/UnsupportedOperationException' '482': description: InvalidNextTokenException content: application/json: schema: $ref: '#/components/schemas/InvalidNextTokenException' '483': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '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/DescribeLDAPSSettingsRequest' 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.DescribeLDAPSSettings tags: - AWS Directory Service summary: Describe LDAPS settings x-summary-source: derived /#X-Amz-Target=DirectoryService_20150416.DescribeRegions: 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: DescribeRegions description: Provides information about the Regions that are configured for multi-Region replication. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeRegionsResult' '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '481': description: DirectoryDoesNotExistException content: application/json: schema: $ref: '#/components/schemas/DirectoryDoesNotExistException' '482': description: UnsupportedOperationException content: application/json: schema: $ref: '#/components/schemas/UnsupportedOperationException' '483': description: InvalidNextTokenException content: application/json: schema: $ref: '#/components/schemas/InvalidNextTokenException' '484': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '485': description: ClientException content: application/json: schema: $ref: '#/components/schemas/ClientException' '486': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DescribeRegionsRequest' parameters: - 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.DescribeRegions tags: - AWS Directory Service summary: Describe regions x-summary-source: derived /#X-Amz-Target=DirectoryService_20150416.DescribeSettings: 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: DescribeSettings description: Retrieves information about the configurable settings for the specified directory. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeSettingsResult' '480': description: DirectoryDoesNotExistException content: application/json: schema: $ref: '#/components/schemas/DirectoryDoesNotExistException' '481': description: UnsupportedOperationException content: application/json: schema: $ref: '#/components/schemas/UnsupportedOperationException' '482': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '483': description: InvalidNextTokenException content: application/json: schema: $ref: '#/components/schemas/InvalidNextTokenException' '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/DescribeSettingsRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - DirectoryService_20150416.DescribeSettings tags: - AWS Directory Service summary: Describe settings x-summary-source: derived /#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: - AWS Directory Service summary: Describe shared directories x-summary-source: derived /#X-Amz-Target=DirectoryService_20150416.DescribeSnapshots: 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: DescribeSnapshots description: 'Obtains information about the directory snapshots that belong to this account. This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the DescribeSnapshots.NextToken member contains a token that you pass in the next call to DescribeSnapshots to retrieve the next set of items. You can also specify a maximum number of return results with the Limit parameter.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeSnapshotsResult' '480': description: EntityDoesNotExistException content: application/json: schema: $ref: '#/components/schemas/EntityDoesNotExistException' '481': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '482': description: InvalidNextTokenException content: application/json: schema: $ref: '#/components/schemas/InvalidNextTokenException' '483': description: ClientException content: application/json: schema: $ref: '#/components/schemas/ClientException' '484': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DescribeSnapshotsRequest' 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.DescribeSnapshots tags: - AWS Directory Service summary: Describe snapshots x-summary-source: derived /#X-Amz-Target=DirectoryService_20150416.DescribeTrusts: 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: DescribeTrusts description: 'Obtains information about the trust relationships for this account. If no input parameters are provided, such as DirectoryId or TrustIds, this request describes all the trust relationships belonging to the account.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeTrustsResult' '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: ClientException content: application/json: schema: $ref: '#/components/schemas/ClientException' '484': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' '485': description: UnsupportedOperationException content: application/json: schema: $ref: '#/components/schemas/UnsupportedOperationException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DescribeTrustsRequest' 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.DescribeTrusts tags: - AWS Directory Service summary: Describe trusts x-summary-source: derived /#X-Amz-Target=DirectoryService_20150416.DescribeUpdateDirectory: 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: DescribeUpdateDirectory description: Describes the updates of a directory for a particular update type. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeUpdateDirectoryResult' '480': description: DirectoryDoesNotExistException content: application/json: schema: $ref: '#/components/schemas/DirectoryDoesNotExistException' '481': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '482': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '483': description: ClientException content: application/json: schema: $ref: '#/components/schemas/ClientException' '484': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' '485': description: InvalidNextTokenException content: application/json: schema: $ref: '#/components/schemas/InvalidNextTokenException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DescribeUpdateDirectoryRequest' parameters: - 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.DescribeUpdateDirectory tags: - AWS Directory Service summary: Describe update directory x-summary-source: derived /#X-Amz-Target=DirectoryService_20150416.DisableClientAuthentication: 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: DisableClientAuthentication description: Disables alternative client authentication methods for the specified directory. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DisableClientAuthenticationResult' '480': description: DirectoryDoesNotExistException content: application/json: schema: $ref: '#/components/schemas/DirectoryDoesNotExistException' '481': description: UnsupportedOperationException content: application/json: schema: $ref: '#/components/schemas/UnsupportedOperationException' '482': description: InvalidClientAuthStatusException content: application/json: schema: $ref: '#/components/schemas/InvalidClientAuthStatusException' '483': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '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/DisableClientAuthenticationRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - DirectoryService_20150416.DisableClientAuthentication tags: - AWS Directory Service summary: Disable client authentication x-summary-source: derived /#X-Amz-Target=DirectoryService_20150416.DisableLDAPS: 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: DisableLDAPS description: Deactivates LDAP secure calls for the specified directory. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DisableLDAPSResult' '480': description: DirectoryUnavailableException content: application/json: schema: $ref: '#/components/schemas/DirectoryUnavailableException' '481': description: DirectoryDoesNotExistException content: application/json: schema: $ref: '#/components/schemas/DirectoryDoesNotExistException' '482': description: InvalidLDAPSStatusException content: application/json: schema: $ref: '#/components/schemas/InvalidLDAPSStatusException' '483': description: UnsupportedOperationException content: application/json: schema: $ref: '#/components/schemas/UnsupportedOperationException' '484': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '485': description: ClientException content: application/json: schema: $ref: '#/components/schemas/ClientException' '486': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DisableLDAPSRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - DirectoryService_20150416.DisableLDAPS tags: - AWS Directory Service summary: Disable LDAPS x-summary-source: derived /#X-Amz-Target=DirectoryService_20150416.DisableRadius: 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: DisableRadius description: Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DisableRadiusResult' '480': description: EntityDoesNotExistException content: application/json: schema: $ref: '#/components/schemas/EntityDoesNotExistException' '481': description: ClientException content: application/json: schema: $ref: '#/components/schemas/ClientException' '482': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DisableRadiusRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - DirectoryService_20150416.DisableRadius tags: - AWS Directory Service summary: Disable radius x-summary-source: derived /#X-Amz-Target=DirectoryService_20150416.DisableSso: 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: DisableSso description: Disables single-sign on for a directory. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DisableSsoResult' '480': description: EntityDoesNotExistException content: application/json: schema: $ref: '#/components/schemas/EntityDoesNotExistException' '481': description: InsufficientPermissionsException content: application/json: schema: $ref: '#/components/schemas/InsufficientPermissionsException' '482': description: AuthenticationFailedException content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedException' '483': description: ClientException content: application/json: schema: $ref: '#/components/schemas/ClientException' '484': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DisableSsoRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - DirectoryService_20150416.DisableSso tags: - AWS Directory Service summary: Disable sso x-summary-source: derived /#X-Amz-Target=DirectoryService_20150416.EnableClientAuthentication: 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: EnableClientAuthentication description: Enables alternative client authentication methods for the specified directory. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/EnableClientAuthenticationResult' '480': description: DirectoryDoesNotExistException content: application/json: schema: $ref: '#/components/schemas/DirectoryDoesNotExistException' '481': description: UnsupportedOperationException content: application/json: schema: $ref: '#/components/schemas/UnsupportedOperationException' '482': description: InvalidClientAuthStatusException content: application/json: schema: $ref: '#/components/schemas/InvalidClientAuthStatusException' '483': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '484': description: NoAvailableCertificateException content: application/json: schema: $ref: '#/components/schemas/NoAvailableCertificateException' '485': description: ClientException content: application/json: schema: $ref: '#/components/schemas/ClientException' '486': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/EnableClientAuthenticationRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - DirectoryService_20150416.EnableClientAuthentication tags: - AWS Directory Service summary: Enable client authentication x-summary-source: derived /#X-Amz-Target=DirectoryService_20150416.EnableLDAPS: 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: EnableLDAPS description: Activates the switch for the specific directory to always use LDAP secure calls. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/EnableLDAPSResult' '480': description: DirectoryUnavailableException content: application/json: schema: $ref: '#/components/schemas/DirectoryUnavailableException' '481': description: DirectoryDoesNotExistException content: application/json: schema: $ref: '#/components/schemas/DirectoryDoesNotExistException' '482': description: NoAvailableCertificateException content: application/json: schema: $ref: '#/components/schemas/NoAvailableCertificateException' '483': description: InvalidLDAPSStatusException content: application/json: schema: $ref: '#/components/schemas/InvalidLDAPSStatusException' '484': description: UnsupportedOperationException content: application/json: schema: $ref: '#/components/schemas/UnsupportedOperationException' '485': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '486': description: ClientException content: application/json: schema: $ref: '#/components/schemas/ClientException' '487': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/EnableLDAPSRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - DirectoryService_20150416.EnableLDAPS tags: - AWS Directory Service summary: Enable LDAPS x-summary-source: derived /#X-Amz-Target=DirectoryService_20150416.EnableRadius: 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: EnableRadius description: Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/EnableRadiusResult' '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '481': description: EntityAlreadyExistsException content: application/json: schema: $ref: '#/components/schemas/EntityAlreadyExistsException' '482': description: EntityDoesNotExistException content: application/json: schema: $ref: '#/components/schemas/EntityDoesNotExistException' '483': description: ClientException content: application/json: schema: $ref: '#/components/schemas/ClientException' '484': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/EnableRadiusRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - DirectoryService_20150416.EnableRadius tags: - AWS Directory Service summary: Enable radius x-summary-source: derived /#X-Amz-Target=DirectoryService_20150416.EnableSso: 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: EnableSso description: Enables single sign-on for a directory. Single sign-on allows users in your directory to access certain Amazon Web Services services from a computer joined to the directory without having to enter their credentials separately. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/EnableSsoResult' '480': description: EntityDoesNotExistException content: application/json: schema: $ref: '#/components/schemas/EntityDoesNotExistException' '481': description: InsufficientPermissionsException content: application/json: schema: $ref: '#/components/schemas/InsufficientPermissionsException' '482': description: AuthenticationFailedException content: application/json: schema: $ref: '#/components/schemas/AuthenticationFailedException' '483': description: ClientException content: application/json: schema: $ref: '#/components/schemas/ClientException' '484': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/EnableSsoRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - DirectoryService_20150416.EnableSso tags: - AWS Directory Service summary: Enable sso x-summary-source: derived /#X-Amz-Target=DirectoryService_20150416.GetDirectoryLimits: 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: GetDirectoryLimits description: Obtains directory limit information for the current Region. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetDirectoryLimitsResult' '480': description: EntityDoesNotExistException content: application/json: schema: $ref: '#/components/schemas/EntityDoesNotExistException' '481': description: ClientException content: application/json: schema: $ref: '#/components/schemas/ClientException' '482': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetDirectoryLimitsRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - DirectoryService_20150416.GetDirectoryLimits tags: - AWS Directory Service summary: Get directory limits x-summary-source: derived /#X-Amz-Target=DirectoryService_20150416.GetSnapshotLimits: 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: GetSnapshotLimits description: Obtains the manual snapshot limits for a directory. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetSnapshotLimitsResult' '480': description: EntityDoesNotExistException content: application/json: schema: $ref: '#/components/schemas/EntityDoesNotExistException' '481': description: ClientException content: application/json: schema: $ref: '#/components/schemas/ClientException' '482': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetSnapshotLimitsRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - DirectoryService_20150416.GetSnapshotLimits tags: - AWS Directory Service summary: Get snapshot limits x-summary-source: derived /#X-Amz-Target=DirectoryService_20150416.ListCertificates: 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: ListCertificates description: For the specified directory, lists all the certificates registered for a secure LDAP or client certificate authentication. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListCertificatesResult' '480': description: DirectoryDoesNotExistException content: application/json: schema: $ref: '#/components/schemas/DirectoryDoesNotExistException' '481': description: UnsupportedOperationException content: application/json: schema: $ref: '#/components/schemas/UnsupportedOperationException' '482': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '483': description: InvalidNextTokenException content: application/json: schema: $ref: '#/components/schemas/InvalidNextTokenException' '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/ListCertificatesRequest' 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.ListCertificates tags: - AWS Directory Service summary: List certificates x-summary-source: derived /#X-Amz-Target=DirectoryService_20150416.ListIpRoutes: 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: ListIpRoutes description: Lists the address blocks that you have added to a directory. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListIpRoutesResult' '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: ClientException content: application/json: schema: $ref: '#/components/schemas/ClientException' '484': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ListIpRoutesRequest' 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.ListIpRoutes tags: - AWS Directory Service summary: List ip routes x-summary-source: derived /#X-Amz-Target=DirectoryService_20150416.ListLogSubscriptions: 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: ListLogSubscriptions description: Lists the active log subscriptions for the Amazon Web Services account. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListLogSubscriptionsResult' '480': description: EntityDoesNotExistException content: application/json: schema: $ref: '#/components/schemas/EntityDoesNotExistException' '481': description: InvalidNextTokenException content: application/json: schema: $ref: '#/components/schemas/InvalidNextTokenException' '482': description: ClientException content: application/json: schema: $ref: '#/components/schemas/ClientException' '483': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ListLogSubscriptionsRequest' 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.ListLogSubscriptions tags: - AWS Directory Service summary: List log subscriptions x-summary-source: derived /#X-Amz-Target=DirectoryService_20150416.ListSchemaExtensions: 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: ListSchemaExtensions description: Lists all schema extensions applied to a Microsoft AD Directory. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListSchemaExtensionsResult' '480': description: InvalidNextTokenException content: application/json: schema: $ref: '#/components/schemas/InvalidNextTokenException' '481': description: EntityDoesNotExistException content: application/json: schema: $ref: '#/components/schemas/EntityDoesNotExistException' '482': description: ClientException content: application/json: schema: $ref: '#/components/schemas/ClientException' '483': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ListSchemaExtensionsRequest' 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.ListSchemaExtensions tags: - AWS Directory Service summary: List schema extensions x-summary-source: derived /#X-Amz-Target=DirectoryService_20150416.ListTagsForResource: 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: ListTagsForResource description: Lists all tags on a directory. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListTagsForResourceResult' '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: ClientException content: application/json: schema: $ref: '#/components/schemas/ClientException' '484': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ListTagsForResourceRequest' 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.ListTagsForResource tags: - AWS Directory Service summary: List tags for resource x-summary-source: derived /#X-Amz-Target=DirectoryService_20150416.RegisterCertificate: 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: RegisterCertificate description: Registers a certificate for a secure LDAP or client certificate authentication. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/RegisterCertificateResult' '480': description: DirectoryUnavailableException content: application/json: schema: $ref: '#/components/schemas/DirectoryUnavailableException' '481': description: DirectoryDoesNotExistException content: application/json: schema: $ref: '#/components/schemas/DirectoryDoesNotExistException' '482': description: InvalidCertificateException content: application/json: schema: $ref: '#/components/schemas/InvalidCertificateException' '483': description: CertificateLimitExceededException content: application/json: schema: $ref: '#/components/schemas/CertificateLimitExceededException' '484': description: CertificateAlreadyExistsException content: application/json: schema: $ref: '#/components/schemas/CertificateAlreadyExistsException' '485': description: UnsupportedOperationException content: application/json: schema: $ref: '#/components/schemas/UnsupportedOperationException' '486': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '487': description: ClientException content: application/json: schema: $ref: '#/components/schemas/ClientException' '488': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RegisterCertificateRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - DirectoryService_20150416.RegisterCertificate tags: - AWS Directory Service summary: Register certificate x-summary-source: derived /#X-Amz-Target=DirectoryService_20150416.RegisterEventTopic: 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: RegisterEventTopic description: Associates a directory with an Amazon SNS topic. This establishes the directory as a publisher to the specified Amazon SNS topic. You can then receive email or text (SMS) messages when the status of your directory changes. You get notified if your directory goes from an Active status to an Impaired or Inoperable status. You also receive a notification when the directory returns to an Active status. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/RegisterEventTopicResult' '480': description: EntityDoesNotExistException content: application/json: schema: $ref: '#/components/schemas/EntityDoesNotExistException' '481': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '482': description: ClientException content: application/json: schema: $ref: '#/components/schemas/ClientException' '483': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RegisterEventTopicRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - DirectoryService_20150416.RegisterEventTopic tags: - AWS Directory Service summary: Register event topic x-summary-source: derived /#X-Amz-Target=DirectoryService_20150416.RejectSharedDirectory: 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: RejectSharedDirectory description: Rejects a directory sharing request that was sent from the directory owner account. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/RejectSharedDirectoryResult' '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '481': description: EntityDoesNotExistException content: application/json: schema: $ref: '#/components/schemas/EntityDoesNotExistException' '482': description: DirectoryAlreadySharedException content: application/json: schema: $ref: '#/components/schemas/DirectoryAlreadySharedException' '483': description: ClientException content: application/json: schema: $ref: '#/components/schemas/ClientException' '484': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RejectSharedDirectoryRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - DirectoryService_20150416.RejectSharedDirectory tags: - AWS Directory Service summary: Reject shared directory x-summary-source: derived /#X-Amz-Target=DirectoryService_20150416.RemoveIpRoutes: 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: RemoveIpRoutes description: Removes IP address blocks from a directory. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/RemoveIpRoutesResult' '480': description: EntityDoesNotExistException content: application/json: schema: $ref: '#/components/schemas/EntityDoesNotExistException' '481': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '482': description: DirectoryUnavailableException content: application/json: schema: $ref: '#/components/schemas/DirectoryUnavailableException' '483': description: ClientException content: application/json: schema: $ref: '#/components/schemas/ClientException' '484': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RemoveIpRoutesRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - DirectoryService_20150416.RemoveIpRoutes tags: - AWS Directory Service summary: Remove ip routes x-summary-source: derived /#X-Amz-Target=DirectoryService_20150416.RemoveRegion: 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: RemoveRegion description: Stops all replication and removes the domain controllers from the specified Region. You cannot remove the primary Region with this operation. Instead, use the DeleteDirectory API. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/RemoveRegionResult' '480': description: DirectoryUnavailableException content: application/json: schema: $ref: '#/components/schemas/DirectoryUnavailableException' '481': description: DirectoryDoesNotExistException content: application/json: schema: $ref: '#/components/schemas/DirectoryDoesNotExistException' '482': description: UnsupportedOperationException content: application/json: schema: $ref: '#/components/schemas/UnsupportedOperationException' '483': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '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/RemoveRegionRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - DirectoryService_20150416.RemoveRegion tags: - AWS Directory Service summary: Remove region x-summary-source: derived /#X-Amz-Target=DirectoryService_20150416.RemoveTagsFromResource: 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: RemoveTagsFromResource description: Removes tags from a directory. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/RemoveTagsFromResourceResult' '480': description: EntityDoesNotExistException content: application/json: schema: $ref: '#/components/schemas/EntityDoesNotExistException' '481': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '482': description: ClientException content: application/json: schema: $ref: '#/components/schemas/ClientException' '483': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RemoveTagsFromResourceRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - DirectoryService_20150416.RemoveTagsFromResource tags: - AWS Directory Service summary: Remove tags from resource x-summary-source: derived /#X-Amz-Target=DirectoryService_20150416.ResetUserPassword: 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: ResetUserPassword description: 'Resets the password for any user in your Managed Microsoft AD or Simple AD directory. You can reset the password for any user in your directory with the following exceptions: For Simple AD, you cannot reset the password for any user that is a member of either the Domain Admins or Enterprise Admins group except for the administrator user. For Managed Microsoft AD, you can only reset the password for a user that is in an OU based off of the NetBIOS name that you typed when you created your directory. For example, you cannot reset the password for a user in the Amazon Web Services Reserved OU. For more information about the OU structure for an Managed Microsoft AD directory, see What Gets Created in the Directory Service Administration Guide.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ResetUserPasswordResult' '480': description: DirectoryUnavailableException content: application/json: schema: $ref: '#/components/schemas/DirectoryUnavailableException' '481': description: UserDoesNotExistException content: application/json: schema: $ref: '#/components/schemas/UserDoesNotExistException' '482': description: InvalidPasswordException content: application/json: schema: $ref: '#/components/schemas/InvalidPasswordException' '483': description: UnsupportedOperationException content: application/json: schema: $ref: '#/components/schemas/UnsupportedOperationException' '484': description: EntityDoesNotExistException content: application/json: schema: $ref: '#/components/schemas/EntityDoesNotExistException' '485': description: ClientException content: application/json: schema: $ref: '#/components/schemas/ClientException' '486': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ResetUserPasswordRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - DirectoryService_20150416.ResetUserPassword tags: - AWS Directory Service summary: Reset user password x-summary-source: derived /#X-Amz-Target=DirectoryService_20150416.RestoreFromSnapshot: 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: RestoreFromSnapshot description: 'Restores a directory using an existing directory snapshot. When you restore a directory from a snapshot, any changes made to the directory after the snapshot date are overwritten. This action returns as soon as the restore operation is initiated. You can monitor the progress of the restore operation by calling the DescribeDirectories operation with the directory identifier. When the DirectoryDescription.Stage value changes to Active, the restore operation is complete.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/RestoreFromSnapshotResult' '480': description: EntityDoesNotExistException content: application/json: schema: $ref: '#/components/schemas/EntityDoesNotExistException' '481': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '482': description: ClientException content: application/json: schema: $ref: '#/components/schemas/ClientException' '483': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RestoreFromSnapshotRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - DirectoryService_20150416.RestoreFromSnapshot tags: - AWS Directory Service summary: Restore from snapshot x-summary-source: derived /#X-Amz-Target=DirectoryService_20150416.ShareDirectory: 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: ShareDirectory description: 'Shares a specified directory (DirectoryId) in your Amazon Web Services account (directory owner) with another Amazon Web Services account (directory consumer). With this operation you can use your directory from any Amazon Web Services account and from any Amazon VPC within an Amazon Web Services Region. When you share your Managed Microsoft AD directory, Directory Service creates a shared directory in the directory consumer account. This shared directory contains the metadata to provide access to the directory within the directory owner account. The shared directory is visible in all VPCs in the directory consumer account. The ShareMethod parameter determines whether the specified directory can be shared between Amazon Web Services accounts inside the same Amazon Web Services organization (ORGANIZATIONS). It also determines whether you can share the directory with any other Amazon Web Services account either inside or outside of the organization (HANDSHAKE). The ShareNotes parameter is only used when HANDSHAKE is called, which sends a directory sharing request to the directory consumer.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ShareDirectoryResult' '480': description: DirectoryAlreadySharedException content: application/json: schema: $ref: '#/components/schemas/DirectoryAlreadySharedException' '481': description: EntityDoesNotExistException content: application/json: schema: $ref: '#/components/schemas/EntityDoesNotExistException' '482': description: InvalidTargetException content: application/json: schema: $ref: '#/components/schemas/InvalidTargetException' '483': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '484': description: ClientException content: application/json: schema: $ref: '#/components/schemas/ClientException' '485': description: ShareLimitExceededException content: application/json: schema: $ref: '#/components/schemas/ShareLimitExceededException' '486': description: OrganizationsException content: application/json: schema: $ref: '#/components/schemas/OrganizationsException' '487': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '488': description: UnsupportedOperationException content: application/json: schema: $ref: '#/components/schemas/UnsupportedOperationException' '489': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ShareDirectoryRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - DirectoryService_20150416.ShareDirectory tags: - AWS Directory Service summary: Share directory x-summary-source: derived /#X-Amz-Target=DirectoryService_20150416.StartSchemaExtension: 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: StartSchemaExtension description: Applies a schema extension to a Microsoft AD directory. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/StartSchemaExtensionResult' '480': description: DirectoryUnavailableException content: application/json: schema: $ref: '#/components/schemas/DirectoryUnavailableException' '481': description: EntityDoesNotExistException content: application/json: schema: $ref: '#/components/schemas/EntityDoesNotExistException' '482': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '483': description: SnapshotLimitExceededException content: application/json: schema: $ref: '#/components/schemas/SnapshotLimitExceededException' '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/StartSchemaExtensionRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - DirectoryService_20150416.StartSchemaExtension tags: - AWS Directory Service summary: Start schema extension x-summary-source: derived /#X-Amz-Target=DirectoryService_20150416.UnshareDirectory: 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: UnshareDirectory description: Stops the directory sharing between the directory owner and consumer accounts. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UnshareDirectoryResult' '480': description: EntityDoesNotExistException content: application/json: schema: $ref: '#/components/schemas/EntityDoesNotExistException' '481': description: InvalidTargetException content: application/json: schema: $ref: '#/components/schemas/InvalidTargetException' '482': description: DirectoryNotSharedException content: application/json: schema: $ref: '#/components/schemas/DirectoryNotSharedException' '483': description: ClientException content: application/json: schema: $ref: '#/components/schemas/ClientException' '484': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UnshareDirectoryRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - DirectoryService_20150416.UnshareDirectory tags: - AWS Directory Service summary: Unshare directory x-summary-source: derived /#X-Amz-Target=DirectoryService_20150416.UpdateConditionalForwarder: 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: UpdateConditionalForwarder description: Updates a conditional forwarder that has been set up for your Amazon Web Services directory. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateConditionalForwarderResult' '480': description: EntityDoesNotExistException content: application/json: schema: $ref: '#/components/schemas/EntityDoesNotExistException' '481': description: DirectoryUnavailableException content: application/json: schema: $ref: '#/components/schemas/DirectoryUnavailableException' '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/UpdateConditionalForwarderRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - DirectoryService_20150416.UpdateConditionalForwarder tags: - AWS Directory Service summary: Update conditional forwarder x-summary-source: derived /#X-Amz-Target=DirectoryService_20150416.UpdateDirectorySetup: 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: UpdateDirectorySetup description: Updates the directory for a particular update type. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateDirectorySetupResult' '480': description: UnsupportedOperationException content: application/json: schema: $ref: '#/components/schemas/UnsupportedOperationException' '481': description: DirectoryInDesiredStateException content: application/json: schema: $ref: '#/components/schemas/DirectoryInDesiredStateException' '482': description: DirectoryUnavailableException content: application/json: schema: $ref: '#/components/schemas/DirectoryUnavailableException' '483': description: SnapshotLimitExceededException content: application/json: schema: $ref: '#/components/schemas/SnapshotLimitExceededException' '484': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '485': description: DirectoryDoesNotExistException content: application/json: schema: $ref: '#/components/schemas/DirectoryDoesNotExistException' '486': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '487': description: ClientException content: application/json: schema: $ref: '#/components/schemas/ClientException' '488': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateDirectorySetupRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - DirectoryService_20150416.UpdateDirectorySetup tags: - AWS Directory Service summary: Update directory setup x-summary-source: derived /#X-Amz-Target=DirectoryService_20150416.UpdateNumberOfDomainControllers: 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: UpdateNumberOfDomainControllers description: Adds or removes domain controllers to or from the directory. Based on the difference between current value and new value (provided through this API call), domain controllers will be added or removed. It may take up to 45 minutes for any new domain controllers to become fully active once the requested number of domain controllers is updated. During this time, you cannot make another update request. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateNumberOfDomainControllersResult' '480': description: EntityDoesNotExistException content: application/json: schema: $ref: '#/components/schemas/EntityDoesNotExistException' '481': description: DirectoryUnavailableException content: application/json: schema: $ref: '#/components/schemas/DirectoryUnavailableException' '482': description: DomainControllerLimitExceededException content: application/json: schema: $ref: '#/components/schemas/DomainControllerLimitExceededException' '483': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '484': description: UnsupportedOperationException content: application/json: schema: $ref: '#/components/schemas/UnsupportedOperationException' '485': description: ClientException content: application/json: schema: $ref: '#/components/schemas/ClientException' '486': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateNumberOfDomainControllersRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - DirectoryService_20150416.UpdateNumberOfDomainControllers tags: - AWS Directory Service summary: Update number of domain controllers x-summary-source: derived /#X-Amz-Target=DirectoryService_20150416.UpdateRadius: 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: UpdateRadius description: Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector or Microsoft AD directory. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateRadiusResult' '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '481': description: EntityDoesNotExistException content: application/json: schema: $ref: '#/components/schemas/EntityDoesNotExistException' '482': description: ClientException content: application/json: schema: $ref: '#/components/schemas/ClientException' '483': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateRadiusRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - DirectoryService_20150416.UpdateRadius tags: - AWS Directory Service summary: Update radius x-summary-source: derived /#X-Amz-Target=DirectoryService_20150416.UpdateSettings: 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: UpdateSettings description: Updates the configurable settings for the specified directory. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateSettingsResult' '480': description: DirectoryDoesNotExistException content: application/json: schema: $ref: '#/components/schemas/DirectoryDoesNotExistException' '481': description: UnsupportedOperationException content: application/json: schema: $ref: '#/components/schemas/UnsupportedOperationException' '482': description: DirectoryUnavailableException content: application/json: schema: $ref: '#/components/schemas/DirectoryUnavailableException' '483': description: IncompatibleSettingsException content: application/json: schema: $ref: '#/components/schemas/IncompatibleSettingsException' '484': description: UnsupportedSettingsException content: application/json: schema: $ref: '#/components/schemas/UnsupportedSettingsException' '485': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '486': description: ClientException content: application/json: schema: $ref: '#/components/schemas/ClientException' '487': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateSettingsRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - DirectoryService_20150416.UpdateSettings tags: - AWS Directory Service summary: Update settings x-summary-source: derived /#X-Amz-Target=DirectoryService_20150416.UpdateTrust: 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: UpdateTrust description: Updates the trust that has been set up between your Managed Microsoft AD directory and an self-managed Active Directory. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateTrustResult' '480': description: EntityDoesNotExistException content: application/json: schema: $ref: '#/components/schemas/EntityDoesNotExistException' '481': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '482': description: ClientException content: application/json: schema: $ref: '#/components/schemas/ClientException' '483': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateTrustRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - DirectoryService_20150416.UpdateTrust tags: - AWS Directory Service summary: Update trust x-summary-source: derived /#X-Amz-Target=DirectoryService_20150416.VerifyTrust: 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: VerifyTrust description: 'Directory Service for Microsoft Active Directory allows you to configure and verify trust relationships. This action verifies a trust relationship between your Managed Microsoft AD directory and an external domain.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/VerifyTrustResult' '480': description: EntityDoesNotExistException content: application/json: schema: $ref: '#/components/schemas/EntityDoesNotExistException' '481': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '482': description: ClientException content: application/json: schema: $ref: '#/components/schemas/ClientException' '483': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' '484': description: UnsupportedOperationException content: application/json: schema: $ref: '#/components/schemas/UnsupportedOperationException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/VerifyTrustRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - DirectoryService_20150416.VerifyTrust tags: - AWS Directory Service summary: Verify trust x-summary-source: derived components: schemas: RemoveTagsFromResourceResult: type: object properties: {} TagKeys: type: array items: $ref: '#/components/schemas/TagKey' OCSPUrl: type: string pattern: ^(https?|ftp|file|ldaps?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;()]*[-a-zA-Z0-9+&@#/%=~_|()] minLength: 1 maxLength: 1024 RestoreFromSnapshotRequest: type: object required: - SnapshotId title: RestoreFromSnapshotRequest properties: SnapshotId: allOf: - $ref: '#/components/schemas/SnapshotId' - description: The identifier of the snapshot to restore from. description: An object representing the inputs for the RestoreFromSnapshot operation. SchemaExtensionsInfo: type: array items: $ref: '#/components/schemas/SchemaExtensionInfo' LDAPSType: type: string enum: - Client IpRoutesInfo: type: array items: $ref: '#/components/schemas/IpRouteInfo' Certificate: type: object properties: CertificateId: allOf: - $ref: '#/components/schemas/CertificateId' - description: The identifier of the certificate. State: allOf: - $ref: '#/components/schemas/CertificateState' - description: The state of the certificate. StateReason: allOf: - $ref: '#/components/schemas/CertificateStateReason' - description: Describes a state change for the certificate. CommonName: allOf: - $ref: '#/components/schemas/CertificateCN' - description: The common name for the certificate. RegisteredDateTime: allOf: - $ref: '#/components/schemas/CertificateRegisteredDateTime' - description: The date and time that the certificate was registered. ExpiryDateTime: allOf: - $ref: '#/components/schemas/CertificateExpiryDateTime' - description: The date and time when the certificate will expire. Type: allOf: - $ref: '#/components/schemas/CertificateType' - description: The function that the registered certificate performs. Valid values include ClientLDAPS or ClientCertAuth. The default value is ClientLDAPS. ClientCertAuthSettings: allOf: - $ref: '#/components/schemas/ClientCertAuthSettings' - description: A ClientCertAuthSettings object that contains client certificate authentication settings. description: Information about the certificate. DescribeConditionalForwardersResult: type: object properties: ConditionalForwarders: allOf: - $ref: '#/components/schemas/ConditionalForwarders' - description: The list of conditional forwarders that have been created. description: The result of a DescribeConditionalForwarder request. AuthenticationFailedException: {} ResetUserPasswordResult: type: object properties: {} DeleteConditionalForwarderRequest: type: object required: - DirectoryId - RemoteDomainName title: DeleteConditionalForwarderRequest properties: DirectoryId: allOf: - $ref: '#/components/schemas/DirectoryId' - description: The directory ID for which you are deleting the conditional forwarder. RemoteDomainName: allOf: - $ref: '#/components/schemas/RemoteDomainName' - description: The fully qualified domain name (FQDN) of the remote domain with which you are deleting the conditional forwarder. description: Deletes a conditional forwarder. ListTagsForResourceResult: type: object properties: Tags: allOf: - $ref: '#/components/schemas/Tags' - description: List of tags returned by the ListTagsForResource operation. NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: Reserved for future use. AddIpRoutesResult: type: object properties: {} TagValue: type: string pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$ minLength: 0 maxLength: 256 DeleteSnapshotResult: type: object properties: SnapshotId: allOf: - $ref: '#/components/schemas/SnapshotId' - description: The identifier of the directory snapshot that was deleted. description: Contains the results of the DeleteSnapshot operation. NextToken: type: string OwnerDirectoryDescription: type: object properties: DirectoryId: allOf: - $ref: '#/components/schemas/DirectoryId' - description: Identifier of the Managed Microsoft AD directory in the directory owner account. AccountId: allOf: - $ref: '#/components/schemas/CustomerId' - description: Identifier of the directory owner account. DnsIpAddrs: allOf: - $ref: '#/components/schemas/DnsIpAddrs' - description: IP address of the directory’s domain controllers. VpcSettings: allOf: - $ref: '#/components/schemas/DirectoryVpcSettingsDescription' - description: Information about the VPC settings for the directory. RadiusSettings: allOf: - $ref: '#/components/schemas/RadiusSettings' - description: A RadiusSettings object that contains information about the RADIUS server. RadiusStatus: allOf: - $ref: '#/components/schemas/RadiusStatus' - description: Information about the status of the RADIUS server. description: Describes the directory owner account details that have been shared to the directory consumer account. InsufficientPermissionsException: {} RegisterCertificateResult: type: object properties: CertificateId: allOf: - $ref: '#/components/schemas/CertificateId' - description: The identifier of the certificate. Setting: type: object required: - Name - Value properties: Name: allOf: - $ref: '#/components/schemas/DirectoryConfigurationSettingName' - description:

The name of the directory setting. For example:

TLS_1_0

Value: allOf: - $ref: '#/components/schemas/DirectoryConfigurationSettingValue' - description: 'The value of the directory setting for which to retrieve information. For example, for TLS_1_0, the valid values are: Enable and Disable.' description: Contains information about the configurable settings for a directory. OrganizationsException: {} AccessUrl: type: string minLength: 1 maxLength: 128 DomainController: type: object properties: DirectoryId: allOf: - $ref: '#/components/schemas/DirectoryId' - description: Identifier of the directory where the domain controller resides. DomainControllerId: allOf: - $ref: '#/components/schemas/DomainControllerId' - description: Identifies a specific domain controller in the directory. DnsIpAddr: allOf: - $ref: '#/components/schemas/IpAddr' - description: The IP address of the domain controller. VpcId: allOf: - $ref: '#/components/schemas/VpcId' - description: The identifier of the VPC that contains the domain controller. SubnetId: allOf: - $ref: '#/components/schemas/SubnetId' - description: Identifier of the subnet in the VPC that contains the domain controller. AvailabilityZone: allOf: - $ref: '#/components/schemas/AvailabilityZone' - description: The Availability Zone where the domain controller is located. Status: allOf: - $ref: '#/components/schemas/DomainControllerStatus' - description: The status of the domain controller. StatusReason: allOf: - $ref: '#/components/schemas/DomainControllerStatusReason' - description: A description of the domain controller state. LaunchTime: allOf: - $ref: '#/components/schemas/LaunchTime' - description: Specifies when the domain controller was created. StatusLastUpdatedDateTime: allOf: - $ref: '#/components/schemas/LastUpdatedDateTime' - description: The date and time that the status was last updated. description: Contains information about the domain controllers for a specified directory. AvailabilityZone: type: string DeleteDirectoryResult: type: object properties: DirectoryId: allOf: - $ref: '#/components/schemas/DirectoryId' - description: The directory identifier. description: Contains the results of the DeleteDirectory operation. DirectoryVpcSettings: type: object required: - VpcId - SubnetIds properties: VpcId: allOf: - $ref: '#/components/schemas/VpcId' - description: The identifier of the VPC in which to create the directory. SubnetIds: allOf: - $ref: '#/components/schemas/SubnetIds' - description: The identifiers of the subnets for the directory servers. The two subnets must be in different Availability Zones. Directory Service creates a directory server and a DNS server in each of these subnets. description: Contains VPC information for the CreateDirectory or CreateMicrosoftAD operation. ConditionalForwarder: type: object properties: RemoteDomainName: allOf: - $ref: '#/components/schemas/RemoteDomainName' - description: The fully qualified domain name (FQDN) of the remote domains pointed to by the conditional forwarder. DnsIpAddrs: allOf: - $ref: '#/components/schemas/DnsIpAddrs' - description: The IP addresses of the remote DNS server associated with RemoteDomainName. This is the IP address of the DNS server that your conditional forwarder points to. ReplicationScope: allOf: - $ref: '#/components/schemas/ReplicationScope' - description: The replication scope of the conditional forwarder. The only allowed value is Domain, which will replicate the conditional forwarder to all of the domain controllers for your Amazon Web Services directory. description: Points to a remote domain with which you are setting up a trust relationship. Conditional forwarders are required in order to set up a trust relationship with another domain. AcceptSharedDirectoryResult: type: object properties: SharedDirectory: allOf: - $ref: '#/components/schemas/SharedDirectory' - description: The shared directory in the directory consumer account. TargetType: type: string enum: - ACCOUNT DeleteConditionalForwarderResult: type: object properties: {} description: The result of a DeleteConditionalForwarder request. ClientAuthenticationSettingsInfo: type: array items: $ref: '#/components/schemas/ClientAuthenticationSettingInfo' Attributes: type: array items: $ref: '#/components/schemas/Attribute' CloudOnlyDirectoriesLimitReached: type: boolean DescribeDomainControllersRequest: type: object required: - DirectoryId title: DescribeDomainControllersRequest properties: DirectoryId: allOf: - $ref: '#/components/schemas/DirectoryId' - description: Identifier of the directory for which to retrieve the domain controller information. DomainControllerIds: allOf: - $ref: '#/components/schemas/DomainControllerIds' - description: A list of identifiers for the domain controllers whose information will be provided. NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: 'The DescribeDomainControllers.NextToken value from a previous call to DescribeDomainControllers. Pass null if this is the first call. ' Limit: allOf: - $ref: '#/components/schemas/Limit' - description: The maximum number of items to return. RemoteDomainName: type: string pattern: ^([a-zA-Z0-9]+[\\.-])+([a-zA-Z0-9])+[.]?$ GetDirectoryLimitsRequest: type: object title: GetDirectoryLimitsRequest properties: {} description: Contains the inputs for the GetDirectoryLimits operation. PortNumber: type: integer minimum: 1025 maximum: 65535 UpdateStatus: type: string enum: - Updated - Updating - UpdateFailed DescribeCertificateRequest: type: object required: - DirectoryId - CertificateId title: DescribeCertificateRequest properties: DirectoryId: allOf: - $ref: '#/components/schemas/DirectoryId' - description: The identifier of the directory. CertificateId: allOf: - $ref: '#/components/schemas/CertificateId' - description: The identifier of the certificate. TagLimitExceededException: {} SnapshotId: type: string pattern: ^s-[0-9a-f]{10}$ RegionsInfo: type: object properties: PrimaryRegion: allOf: - $ref: '#/components/schemas/RegionName' - description: The Region where the Managed Microsoft AD directory was originally created. AdditionalRegions: allOf: - $ref: '#/components/schemas/AdditionalRegions' - description: Lists the Regions where the directory has been replicated, excluding the primary Region. description: Provides information about the Regions that are configured for multi-Region replication. CertificateInfo: type: object properties: CertificateId: allOf: - $ref: '#/components/schemas/CertificateId' - description: The identifier of the certificate. CommonName: allOf: - $ref: '#/components/schemas/CertificateCN' - description: The common name for the certificate. State: allOf: - $ref: '#/components/schemas/CertificateState' - description: The state of the certificate. ExpiryDateTime: allOf: - $ref: '#/components/schemas/CertificateExpiryDateTime' - description: The date and time when the certificate will expire. Type: allOf: - $ref: '#/components/schemas/CertificateType' - description: The function that the registered certificate performs. Valid values include ClientLDAPS or ClientCertAuth. The default value is ClientLDAPS. description: Contains general information about a certificate. IpRouteStatusMsg: type: string enum: - Adding - Added - Removing - Removed - AddFailed - RemoveFailed ListCertificatesRequest: type: object required: - DirectoryId title: ListCertificatesRequest properties: DirectoryId: allOf: - $ref: '#/components/schemas/DirectoryId' - description: The identifier of the directory. NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: A token for requesting another page of certificates if the NextToken response element indicates that more certificates are available. Use the value of the returned NextToken element in your request until the token comes back as null. Pass null if this is the first call. Limit: allOf: - $ref: '#/components/schemas/PageLimit' - description: The number of items that should show up on one page DirectoryDescription: type: object properties: DirectoryId: allOf: - $ref: '#/components/schemas/DirectoryId' - description: The directory identifier. Name: allOf: - $ref: '#/components/schemas/DirectoryName' - description: The fully qualified name of the directory. ShortName: allOf: - $ref: '#/components/schemas/DirectoryShortName' - description: The short name of the directory. Size: allOf: - $ref: '#/components/schemas/DirectorySize' - description: The directory size. Edition: allOf: - $ref: '#/components/schemas/DirectoryEdition' - description: The edition associated with this directory. Alias: allOf: - $ref: '#/components/schemas/AliasName' - description: The alias for the directory. If no alias has been created for the directory, the alias is the directory identifier, such as d-XXXXXXXXXX. AccessUrl: allOf: - $ref: '#/components/schemas/AccessUrl' - description: The access URL for the directory, such as http://<alias>.awsapps.com. If no alias has been created for the directory, <alias> is the directory identifier, such as d-XXXXXXXXXX. Description: allOf: - $ref: '#/components/schemas/Description' - description: The description for the directory. DnsIpAddrs: allOf: - $ref: '#/components/schemas/DnsIpAddrs' - description: The IP addresses of the DNS servers for the directory. For a Simple AD or Microsoft AD directory, these are the IP addresses of the Simple AD or Microsoft AD directory servers. For an AD Connector directory, these are the IP addresses of the DNS servers or domain controllers in your self-managed directory to which the AD Connector is connected. Stage: allOf: - $ref: '#/components/schemas/DirectoryStage' - description: The current stage of the directory. ShareStatus: allOf: - $ref: '#/components/schemas/ShareStatus' - description: Current directory status of the shared Managed Microsoft AD directory. 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 (ORGANIZATIONS) or with any Amazon Web Services account by sending a shared directory request (HANDSHAKE). 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. LaunchTime: allOf: - $ref: '#/components/schemas/LaunchTime' - description: Specifies when the directory was created. StageLastUpdatedDateTime: allOf: - $ref: '#/components/schemas/LastUpdatedDateTime' - description: The date and time that the stage was last updated. Type: allOf: - $ref: '#/components/schemas/DirectoryType' - description: The directory size. VpcSettings: allOf: - $ref: '#/components/schemas/DirectoryVpcSettingsDescription' - description: A DirectoryVpcSettingsDescription object that contains additional information about a directory. This member is only present if the directory is a Simple AD or Managed Microsoft AD directory. ConnectSettings: allOf: - $ref: '#/components/schemas/DirectoryConnectSettingsDescription' - description: A DirectoryConnectSettingsDescription object that contains additional information about an AD Connector directory. This member is only present if the directory is an AD Connector directory. RadiusSettings: allOf: - $ref: '#/components/schemas/RadiusSettings' - description: A RadiusSettings object that contains information about the RADIUS server configured for this directory. RadiusStatus: allOf: - $ref: '#/components/schemas/RadiusStatus' - description: The status of the RADIUS MFA server connection. StageReason: allOf: - $ref: '#/components/schemas/StageReason' - description: Additional information about the directory stage. SsoEnabled: allOf: - $ref: '#/components/schemas/SsoEnabled' - description: Indicates if single sign-on is enabled for the directory. For more information, see EnableSso and DisableSso. DesiredNumberOfDomainControllers: allOf: - $ref: '#/components/schemas/DesiredNumberOfDomainControllers' - description: The desired number of domain controllers in the directory if the directory is Microsoft AD. OwnerDirectoryDescription: allOf: - $ref: '#/components/schemas/OwnerDirectoryDescription' - description: Describes the Managed Microsoft AD directory in the directory owner account. RegionsInfo: allOf: - $ref: '#/components/schemas/RegionsInfo' - description: Lists the Regions where the directory has replicated. OsVersion: allOf: - $ref: '#/components/schemas/OSVersion' - description: The operating system (OS) version of the directory. description: Contains information about an Directory Service directory. SecurityGroupId: type: string pattern: ^(sg-[0-9a-f]{8}|sg-[0-9a-f]{17})$ UpdateSecurityGroupForDirectoryControllers: type: boolean Password: type: string pattern: (?=^.{8,64}$)((?=.*\d)(?=.*[A-Z])(?=.*[a-z])|(?=.*\d)(?=.*[^A-Za-z0-9\s])(?=.*[a-z])|(?=.*[^A-Za-z0-9\s])(?=.*[A-Z])(?=.*[a-z])|(?=.*\d)(?=.*[A-Z])(?=.*[^A-Za-z0-9\s]))^.* format: password TrustId: type: string pattern: ^t-[0-9a-f]{10}$ CreateSnapshotBeforeSchemaExtension: type: boolean RequestId: type: string pattern: ^([A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12})$ description: The Amazon Web Services request identifier. TrustIds: type: array items: $ref: '#/components/schemas/TrustId' UnshareTarget: type: object required: - Id - Type properties: Id: allOf: - $ref: '#/components/schemas/TargetId' - description: Identifier of the directory consumer account. Type: allOf: - $ref: '#/components/schemas/TargetType' - description: Type of identifier to be used in the Id field. description: Identifier that contains details about the directory consumer account with whom the directory is being unshared. DirectoryConfigurationSettingName: type: string pattern: ^[a-zA-Z0-9-/. _]*$ minLength: 1 maxLength: 255 EnableLDAPSRequest: type: object required: - DirectoryId - Type title: EnableLDAPSRequest properties: DirectoryId: allOf: - $ref: '#/components/schemas/DirectoryId' - description: The identifier of the directory. Type: allOf: - $ref: '#/components/schemas/LDAPSType' - description: The type of LDAP security to enable. Currently only the value Client is supported. TopicNames: type: array items: $ref: '#/components/schemas/TopicName' SchemaExtensionInfo: type: object properties: DirectoryId: allOf: - $ref: '#/components/schemas/DirectoryId' - description: The identifier of the directory to which the schema extension is applied. SchemaExtensionId: allOf: - $ref: '#/components/schemas/SchemaExtensionId' - description: The identifier of the schema extension. Description: allOf: - $ref: '#/components/schemas/Description' - description: A description of the schema extension. SchemaExtensionStatus: allOf: - $ref: '#/components/schemas/SchemaExtensionStatus' - description: The current status of the schema extension. SchemaExtensionStatusReason: allOf: - $ref: '#/components/schemas/SchemaExtensionStatusReason' - description: The reason for the SchemaExtensionStatus. StartDateTime: allOf: - $ref: '#/components/schemas/StartDateTime' - description: The date and time that the schema extension started being applied to the directory. EndDateTime: allOf: - $ref: '#/components/schemas/EndDateTime' - description: The date and time that the schema extension was completed. description: Information about a schema extension. EnableRadiusResult: type: object properties: {} description: Contains the results of the EnableRadius operation. AcceptSharedDirectoryRequest: type: object required: - SharedDirectoryId title: AcceptSharedDirectoryRequest properties: 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. ' SchemaExtensionId: type: string pattern: ^e-[0-9a-f]{10}$ UpdateSettingsRequest: type: object required: - DirectoryId - Settings title: UpdateSettingsRequest properties: DirectoryId: allOf: - $ref: '#/components/schemas/DirectoryId' - description: The identifier of the directory for which to update settings. Settings: allOf: - $ref: '#/components/schemas/Settings' - description: The list of Setting objects. CertificateExpiryDateTime: type: string format: date-time UserDoesNotExistException: {} SettingEntry: type: object properties: Type: allOf: - $ref: '#/components/schemas/DirectoryConfigurationSettingType' - description: The type of directory setting. For example, Protocol or Cipher. Name: allOf: - $ref: '#/components/schemas/DirectoryConfigurationSettingName' - description:

The name of the directory setting. For example:

TLS_1_0

AllowedValues: allOf: - $ref: '#/components/schemas/DirectoryConfigurationSettingAllowedValues' - description: The valid range of values for the directory setting. AppliedValue: allOf: - $ref: '#/components/schemas/DirectoryConfigurationSettingValue' - description: The value of the directory setting that is applied to the directory. RequestedValue: allOf: - $ref: '#/components/schemas/DirectoryConfigurationSettingValue' - description: The value that was last requested for the directory setting. RequestStatus: allOf: - $ref: '#/components/schemas/DirectoryConfigurationStatus' - description: The overall status of the request to update the directory setting request. If the directory setting is deployed in more than one region, and the request fails in any region, the overall status is Failed. RequestDetailedStatus: allOf: - $ref: '#/components/schemas/DirectoryConfigurationSettingRequestDetailedStatus' - description: Details about the status of the request to update the directory setting. If the directory setting is deployed in more than one region, status is returned for the request in each region where the setting is deployed. RequestStatusMessage: allOf: - $ref: '#/components/schemas/DirectoryConfigurationSettingRequestStatusMessage' - description: The last status message for the directory status request. LastUpdatedDateTime: allOf: - $ref: '#/components/schemas/DirectoryConfigurationSettingLastUpdatedDateTime' - description: The date and time when the directory setting was last updated. LastRequestedDateTime: allOf: - $ref: '#/components/schemas/DirectoryConfigurationSettingLastRequestedDateTime' - description: The date and time when the request to update a directory setting was last submitted. description: Contains information about the specified configurable setting for a directory. DirectoryConfigurationSettingLastUpdatedDateTime: type: string format: date-time ListIpRoutesRequest: type: object required: - DirectoryId title: ListIpRoutesRequest properties: DirectoryId: allOf: - $ref: '#/components/schemas/DirectoryId' - description: Identifier (ID) of the directory for which you want to retrieve the IP addresses. NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: The ListIpRoutes.NextToken value from a previous call to ListIpRoutes. Pass null if this is the first call. Limit: allOf: - $ref: '#/components/schemas/Limit' - description: Maximum number of items to return. If this value is zero, the maximum number of items is specified by the limitations of the operation. LogSubscription: type: object properties: DirectoryId: allOf: - $ref: '#/components/schemas/DirectoryId' - description: Identifier (ID) of the directory that you want to associate with the log subscription. LogGroupName: allOf: - $ref: '#/components/schemas/LogGroupName' - description: The name of the log group. SubscriptionCreatedDateTime: allOf: - $ref: '#/components/schemas/SubscriptionCreatedDateTime' - description: The date and time that the log subscription was created. description: Represents a log subscription, which tracks real-time data from a chosen log group to a specified destination. SnapshotIds: type: array description: A list of directory snapshot identifiers. items: $ref: '#/components/schemas/SnapshotId' DisableSsoResult: type: object properties: {} description: Contains the results of the DisableSso operation. VerifyTrustRequest: type: object required: - TrustId title: VerifyTrustRequest properties: TrustId: allOf: - $ref: '#/components/schemas/TrustId' - description: The unique Trust ID of the trust relationship to verify. description: Initiates the verification of an existing trust relationship between an Managed Microsoft AD directory and an external domain. IpRouteInfo: type: object properties: DirectoryId: allOf: - $ref: '#/components/schemas/DirectoryId' - description: Identifier (ID) of the directory associated with the IP addresses. CidrIp: allOf: - $ref: '#/components/schemas/CidrIp' - description: IP address block in the IpRoute. IpRouteStatusMsg: allOf: - $ref: '#/components/schemas/IpRouteStatusMsg' - description: The status of the IP address block. AddedDateTime: allOf: - $ref: '#/components/schemas/AddedDateTime' - description: The date and time the address block was added to the directory. IpRouteStatusReason: allOf: - $ref: '#/components/schemas/IpRouteStatusReason' - description: The reason for the IpRouteStatusMsg. Description: allOf: - $ref: '#/components/schemas/Description' - description: Description of the IpRouteInfo. description: Information about one or more IP address blocks. CertificateAlreadyExistsException: {} ConnectDirectoryResult: type: object properties: DirectoryId: allOf: - $ref: '#/components/schemas/DirectoryId' - description: The identifier of the new directory. description: Contains the results of the ConnectDirectory operation. CustomerId: type: string pattern: ^(\d{12})$ VpcId: type: string pattern: ^(vpc-[0-9a-f]{8}|vpc-[0-9a-f]{17})$ AddTagsToResourceRequest: type: object required: - ResourceId - Tags title: AddTagsToResourceRequest properties: ResourceId: allOf: - $ref: '#/components/schemas/ResourceId' - description: Identifier (ID) for the directory to which to add the tag. Tags: allOf: - $ref: '#/components/schemas/Tags' - description: The tags to be assigned to the directory. Attribute: type: object properties: Name: allOf: - $ref: '#/components/schemas/AttributeName' - description: The name of the attribute. Value: allOf: - $ref: '#/components/schemas/AttributeValue' - description: The value of the attribute. description: Represents a named directory attribute. TopicName: type: string pattern: '[a-zA-Z0-9_-]+' minLength: 1 maxLength: 256 ManualSnapshotsLimitReached: type: boolean CancelSchemaExtensionRequest: type: object required: - DirectoryId - SchemaExtensionId title: CancelSchemaExtensionRequest properties: DirectoryId: allOf: - $ref: '#/components/schemas/DirectoryId' - description: The identifier of the directory whose schema extension will be canceled. SchemaExtensionId: allOf: - $ref: '#/components/schemas/SchemaExtensionId' - description: The identifier of the schema extension that will be canceled. ListLogSubscriptionsRequest: type: object title: ListLogSubscriptionsRequest properties: DirectoryId: allOf: - $ref: '#/components/schemas/DirectoryId' - description: If a DirectoryID is provided, lists only the log subscription associated with that directory. If no DirectoryId is provided, lists all log subscriptions associated with your Amazon Web Services account. If there are no log subscriptions for the Amazon Web Services account or the directory, an empty list will be returned. NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: The token for the next set of items to return. Limit: allOf: - $ref: '#/components/schemas/Limit' - description: The maximum number of items returned. AddIpRoutesRequest: type: object required: - DirectoryId - IpRoutes title: AddIpRoutesRequest properties: DirectoryId: allOf: - $ref: '#/components/schemas/DirectoryId' - description: Identifier (ID) of the directory to which to add the address block. IpRoutes: allOf: - $ref: '#/components/schemas/IpRoutes' - description: IP address blocks, using CIDR format, of the traffic to route. This is often the IP address block of the DNS server used for your self-managed domain. UpdateSecurityGroupForDirectoryControllers: allOf: - $ref: '#/components/schemas/UpdateSecurityGroupForDirectoryControllers' - description: '

If set to true, updates the inbound and outbound rules of the security group that has the description: "Amazon Web Services created security group for directory ID directory controllers." Following are the new rules:

Inbound:

Outbound:

These security rules impact an internal network interface that is not exposed publicly.

' StartDateTime: type: string format: date-time DescribeClientAuthenticationSettingsResult: type: object properties: ClientAuthenticationSettingsInfo: allOf: - $ref: '#/components/schemas/ClientAuthenticationSettingsInfo' - description: 'Information about the type of client authentication for the specified directory. The following information is retrieved: The date and time when the status of the client authentication type was last updated, whether the client authentication type is enabled or disabled, and the type of client authentication.' NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: The next token used to retrieve the client authentication settings if the number of setting types exceeds page limit and there is another page. ListSchemaExtensionsRequest: type: object required: - DirectoryId title: ListSchemaExtensionsRequest properties: DirectoryId: allOf: - $ref: '#/components/schemas/DirectoryId' - description: The identifier of the directory from which to retrieve the schema extension information. NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: The ListSchemaExtensions.NextToken value from a previous call to ListSchemaExtensions. Pass null if this is the first call. Limit: allOf: - $ref: '#/components/schemas/Limit' - description: The maximum number of items to return. CreateSnapshotRequest: type: object required: - DirectoryId title: CreateSnapshotRequest properties: DirectoryId: allOf: - $ref: '#/components/schemas/DirectoryId' - description: The identifier of the directory of which to take a snapshot. Name: allOf: - $ref: '#/components/schemas/SnapshotName' - description: The descriptive name to apply to the snapshot. description: Contains the inputs for the CreateSnapshot operation. SnapshotName: type: string pattern: ^([a-zA-Z0-9_])[\\a-zA-Z0-9_@#%*+=:?./!\s-]*$ minLength: 0 maxLength: 128 CertificateInUseException: {} IpRoutes: type: array items: $ref: '#/components/schemas/IpRoute' RemoveRegionResult: type: object properties: {} UpdateNumberOfDomainControllersResult: type: object properties: {} UpdateType: type: string enum: - OS UpdateNumberOfDomainControllersRequest: type: object required: - DirectoryId - DesiredNumber title: UpdateNumberOfDomainControllersRequest properties: DirectoryId: allOf: - $ref: '#/components/schemas/DirectoryId' - description: Identifier of the directory to which the domain controllers will be added or removed. DesiredNumber: allOf: - $ref: '#/components/schemas/DesiredNumberOfDomainControllers' - description: The number of domain controllers desired in the directory. DirectoryConfigurationStatus: type: string enum: - Requested - Updating - Updated - Failed - Default CreateSnapshotResult: type: object properties: SnapshotId: allOf: - $ref: '#/components/schemas/SnapshotId' - description: The identifier of the snapshot that was created. description: Contains the results of the CreateSnapshot operation. 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 DescribeSharedDirectoriesResult.NextToken value from a previous call to DescribeSharedDirectories. 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. ResourceId: type: string pattern: ^[d]-[0-9a-f]{10}$ DomainControllerIds: type: array items: $ref: '#/components/schemas/DomainControllerId' DescribeTrustsResult: type: object properties: Trusts: allOf: - $ref: '#/components/schemas/Trusts' - description:

The list of Trust objects that were retrieved.

It is possible that this list contains less than the number of items specified in the Limit member of the request. This occurs if there are less than the requested number of items left to retrieve, or if the limitations of the operation have been exceeded.

NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to DescribeTrusts to retrieve the next set of items. description: The result of a DescribeTrust request. IpRouteLimitExceededException: {} ConnectPassword: type: string minLength: 1 maxLength: 128 format: password DescribeRegionsRequest: type: object required: - DirectoryId title: DescribeRegionsRequest properties: DirectoryId: allOf: - $ref: '#/components/schemas/DirectoryId' - description: The identifier of the directory. RegionName: allOf: - $ref: '#/components/schemas/RegionName' - description: The name of the Region. For example, us-east-1. NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: The DescribeRegionsResult.NextToken value from a previous call to DescribeRegions. Pass null if this is the first call. DirectoryIds: type: array description: A list of directory identifiers. items: $ref: '#/components/schemas/DirectoryId' DescribeDirectoriesRequest: type: object title: DescribeDirectoriesRequest properties: DirectoryIds: allOf: - $ref: '#/components/schemas/DirectoryIds' - description:

A list of identifiers of the directories for which to obtain the information. If this member is null, all directories that belong to the current account are returned.

An empty list results in an InvalidParameterException being thrown.

NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: The DescribeDirectoriesResult.NextToken value from a previous call to DescribeDirectories. Pass null if this is the first call. Limit: allOf: - $ref: '#/components/schemas/Limit' - description: The maximum number of items to return. If this value is zero, the maximum number of items is specified by the limitations of the operation. description: Contains the inputs for the DescribeDirectories operation. DirectoryLimitExceededException: {} InvalidClientAuthStatusException: {} CertificateCN: type: string EventTopics: type: array items: $ref: '#/components/schemas/EventTopic' 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 NextToken parameter in a subsequent call to DescribeSharedDirectories to retrieve the next set of items. Tag: type: object required: - Key - Value properties: Key: allOf: - $ref: '#/components/schemas/TagKey' - description: 'Required name of the tag. The string value can be Unicode characters and cannot be prefixed with "aws:". The string can contain only the set of Unicode letters, digits, white-space, ''_'', ''.'', ''/'', ''='', ''+'', ''-'' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").' Value: allOf: - $ref: '#/components/schemas/TagValue' - description: 'The optional value of the tag. The string value can be Unicode characters. The string can contain only the set of Unicode letters, digits, white-space, ''_'', ''.'', ''/'', ''='', ''+'', ''-'' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").' description: Metadata assigned to a directory consisting of a key-value pair. Settings: type: array items: $ref: '#/components/schemas/Setting' SnapshotLimits: type: object properties: ManualSnapshotsLimit: allOf: - $ref: '#/components/schemas/Limit' - description: The maximum number of manual snapshots allowed. ManualSnapshotsCurrentCount: allOf: - $ref: '#/components/schemas/Limit' - description: The current number of manual snapshots of the directory. ManualSnapshotsLimitReached: allOf: - $ref: '#/components/schemas/ManualSnapshotsLimitReached' - description: Indicates if the manual snapshot limit has been reached. description: Contains manual snapshot limit information for a directory. CertificateId: type: string pattern: ^c-[0-9a-f]{10}$ AddRegionResult: type: object properties: {} SnapshotType: type: string enum: - Auto - Manual UpdateValue: type: object properties: OSUpdateSettings: allOf: - $ref: '#/components/schemas/OSUpdateSettings' - description: ' The OS update related settings. ' description: ' The value for a given type of UpdateSettings. ' CertificateStateReason: type: string CustomerUserName: type: string pattern: ^(?!.*\\|.*"|.*\/|.*\[|.*\]|.*:|.*;|.*\||.*=|.*,|.*\+|.*\*|.*\?|.*<|.*>|.*@).*$ minLength: 1 maxLength: 64 CreateDirectoryRequest: type: object required: - Name - Password - Size title: CreateDirectoryRequest properties: Name: allOf: - $ref: '#/components/schemas/DirectoryName' - description: The fully qualified name for the directory, such as corp.example.com. ShortName: allOf: - $ref: '#/components/schemas/DirectoryShortName' - description: The NetBIOS name of the directory, such as CORP. Password: allOf: - $ref: '#/components/schemas/Password' - description:

The password for the directory administrator. The directory creation process creates a directory administrator account with the user name Administrator and this password.

If you need to change the password for the administrator account, you can use the ResetUserPassword API call.

The regex pattern for this string is made up of the following conditions:

AND any 3 of the following password complexity rules required by Active Directory:

For additional information about how Active Directory passwords are enforced, see Password must meet complexity requirements on the Microsoft website.

Description: allOf: - $ref: '#/components/schemas/Description' - description: A description for the directory. Size: allOf: - $ref: '#/components/schemas/DirectorySize' - description: The size of the directory. VpcSettings: allOf: - $ref: '#/components/schemas/DirectoryVpcSettings' - description: A DirectoryVpcSettings object that contains additional information for the operation. Tags: allOf: - $ref: '#/components/schemas/Tags' - description: The tags to be assigned to the Simple AD directory. description: 'Contains the inputs for the CreateDirectory operation. ' CreateLogSubscriptionResult: type: object properties: {} LDAPSSettingsInfo: type: array items: $ref: '#/components/schemas/LDAPSSettingInfo' EnableClientAuthenticationResult: type: object properties: {} CertificateState: type: string enum: - Registering - Registered - RegisterFailed - Deregistering - Deregistered - DeregisterFailed CreateSnapshotBeforeUpdate: type: boolean LogSubscriptions: type: array items: $ref: '#/components/schemas/LogSubscription' DescribeUpdateDirectoryResult: type: object properties: UpdateActivities: allOf: - $ref: '#/components/schemas/UpdateActivities' - description: ' The list of update activities on a directory for the requested update type. ' NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: ' If not null, more results are available. Pass this value for the NextToken parameter. ' UnsupportedSettingsException: {} DeleteLogSubscriptionRequest: type: object required: - DirectoryId title: DeleteLogSubscriptionRequest properties: DirectoryId: allOf: - $ref: '#/components/schemas/DirectoryId' - description: Identifier of the directory whose log subscription you want to delete. CreateComputerResult: type: object properties: Computer: allOf: - $ref: '#/components/schemas/Computer' - description: A Computer object that represents the computer account. description: Contains the results for the CreateComputer operation. RejectSharedDirectoryResult: type: object properties: SharedDirectoryId: allOf: - $ref: '#/components/schemas/DirectoryId' - description: Identifier of the shared directory in the directory consumer account. ClientAuthenticationSettingInfo: type: object properties: Type: allOf: - $ref: '#/components/schemas/ClientAuthenticationType' - description: 'The type of client authentication for the specified directory. If no type is specified, a list of all client authentication types that are supported for the directory is retrieved. ' Status: allOf: - $ref: '#/components/schemas/ClientAuthenticationStatus' - description: Whether the client authentication type is enabled or disabled for the specified directory. LastUpdatedDateTime: allOf: - $ref: '#/components/schemas/LastUpdatedDateTime' - description: The date and time when the status of the client authentication type was last updated. description: Contains information about a client authentication method for a directory. CidrIps: type: array items: $ref: '#/components/schemas/CidrIp' RestoreFromSnapshotResult: type: object properties: {} description: Contains the results of the RestoreFromSnapshot operation. DirectoryConfigurationSettingRequestDetailedStatus: type: object additionalProperties: $ref: '#/components/schemas/DirectoryConfigurationStatus' LastUpdatedDateTime: type: string format: date-time DirectoryShortName: type: string pattern: ^[^\\/:*?"<>|.]+[^\\/:*?"<>|]*$ CreateDirectoryResult: type: object properties: DirectoryId: allOf: - $ref: '#/components/schemas/DirectoryId' - description: The identifier of the directory that was created. description: Contains the results of the CreateDirectory operation. DirectoryAlreadyInRegionException: {} DescribeUpdateDirectoryRequest: type: object required: - DirectoryId - UpdateType title: DescribeUpdateDirectoryRequest properties: DirectoryId: allOf: - $ref: '#/components/schemas/DirectoryId' - description: ' The unique identifier of the directory. ' UpdateType: allOf: - $ref: '#/components/schemas/UpdateType' - description: ' The type of updates you want to describe for the directory. ' RegionName: allOf: - $ref: '#/components/schemas/RegionName' - description: ' The name of the Region. ' NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: ' The DescribeUpdateDirectoryResult. NextToken value from a previous call to DescribeUpdateDirectory. Pass null if this is the first call. ' DeleteAssociatedConditionalForwarder: type: boolean Tags: type: array items: $ref: '#/components/schemas/Tag' DescribeDomainControllersResult: type: object properties: DomainControllers: allOf: - $ref: '#/components/schemas/DomainControllers' - description: List of the DomainController objects that were retrieved. NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to DescribeDomainControllers retrieve the next set of items. DirectoryConfigurationSettingAllowedValues: type: string TrustType: type: string enum: - Forest - External DirectoryNotSharedException: {} InitiatedBy: type: string CertificateLimitExceededException: {} DescribeConditionalForwardersRequest: type: object required: - DirectoryId title: DescribeConditionalForwardersRequest properties: DirectoryId: allOf: - $ref: '#/components/schemas/DirectoryId' - description: The directory ID for which to get the list of associated conditional forwarders. RemoteDomainNames: allOf: - $ref: '#/components/schemas/RemoteDomainNames' - description: The fully qualified domain names (FQDN) of the remote domains for which to get the list of associated conditional forwarders. If this member is null, all conditional forwarders are returned. description: Describes a conditional forwarder. DescribeSettingsRequest: type: object required: - DirectoryId title: DescribeSettingsRequest properties: DirectoryId: allOf: - $ref: '#/components/schemas/DirectoryId' - description: The identifier of the directory for which to retrieve information. Status: allOf: - $ref: '#/components/schemas/DirectoryConfigurationStatus' - description: The status of the directory settings for which to retrieve information. NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: The DescribeSettingsResult.NextToken value from a previous call to DescribeSettings. Pass null if this is the first call. DirectoryConnectSettings: type: object required: - VpcId - SubnetIds - CustomerDnsIps - CustomerUserName properties: VpcId: allOf: - $ref: '#/components/schemas/VpcId' - description: The identifier of the VPC in which the AD Connector is created. SubnetIds: allOf: - $ref: '#/components/schemas/SubnetIds' - description: A list of subnet identifiers in the VPC in which the AD Connector is created. CustomerDnsIps: allOf: - $ref: '#/components/schemas/DnsIpAddrs' - description: A list of one or more IP addresses of DNS servers or domain controllers in your self-managed directory. CustomerUserName: allOf: - $ref: '#/components/schemas/UserName' - description:

The user name of an account in your self-managed directory that is used to connect to the directory. This account must have the following permissions:

description: Contains information for the ConnectDirectory operation when an AD Connector directory is being created. EnableSsoResult: type: object properties: {} description: Contains the results of the EnableSso operation. UpdateDirectorySetupRequest: type: object required: - DirectoryId - UpdateType title: UpdateDirectorySetupRequest properties: DirectoryId: allOf: - $ref: '#/components/schemas/DirectoryId' - description: ' The identifier of the directory on which you want to perform the update. ' UpdateType: allOf: - $ref: '#/components/schemas/UpdateType' - description: ' The type of update that needs to be performed on the directory. For example, OS. ' OSUpdateSettings: allOf: - $ref: '#/components/schemas/OSUpdateSettings' - description: ' The settings for the OS update that needs to be performed on the directory. ' CreateSnapshotBeforeUpdate: allOf: - $ref: '#/components/schemas/CreateSnapshotBeforeUpdate' - description: ' The boolean that specifies if a snapshot for the directory needs to be taken before updating the directory. ' DomainControllerStatusReason: type: string DirectoryConfigurationSettingLastRequestedDateTime: type: string format: date-time SchemaExtensionStatusReason: type: string ClientException: {} DirectoryConfigurationSettingRequestStatusMessage: type: string SubnetId: type: string pattern: ^(subnet-[0-9a-f]{8}|subnet-[0-9a-f]{17})$ SettingEntries: type: array items: $ref: '#/components/schemas/SettingEntry' AliasName: type: string pattern: ^(?!D-|d-)([\da-zA-Z]+)([-]*[\da-zA-Z])* minLength: 1 maxLength: 62 ListLogSubscriptionsResult: type: object properties: LogSubscriptions: allOf: - $ref: '#/components/schemas/LogSubscriptions' - description: A list of active LogSubscription objects for calling the Amazon Web Services account. NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: The token for the next set of items to return. DisableClientAuthenticationResult: type: object properties: {} CreateConditionalForwarderRequest: type: object required: - DirectoryId - RemoteDomainName - DnsIpAddrs title: CreateConditionalForwarderRequest properties: DirectoryId: allOf: - $ref: '#/components/schemas/DirectoryId' - description: The directory ID of the Amazon Web Services directory for which you are creating the conditional forwarder. RemoteDomainName: allOf: - $ref: '#/components/schemas/RemoteDomainName' - description: The fully qualified domain name (FQDN) of the remote domain with which you will set up a trust relationship. DnsIpAddrs: allOf: - $ref: '#/components/schemas/DnsIpAddrs' - description: The IP addresses of the remote DNS server associated with RemoteDomainName. description: Initiates the creation of a conditional forwarder for your Directory Service for Microsoft Active Directory. Conditional forwarders are required in order to set up a trust relationship with another domain. EnableClientAuthenticationRequest: type: object required: - DirectoryId - Type title: EnableClientAuthenticationRequest properties: DirectoryId: allOf: - $ref: '#/components/schemas/DirectoryId' - description: 'The identifier of the specified directory. ' Type: allOf: - $ref: '#/components/schemas/ClientAuthenticationType' - description: 'The type of client authentication to enable. Currently only the value SmartCard is supported. Smart card authentication in AD Connector requires that you enable Kerberos Constrained Delegation for the Service User to the LDAP service in your self-managed AD. ' DirectoryConnectSettingsDescription: type: object properties: VpcId: allOf: - $ref: '#/components/schemas/VpcId' - description: The identifier of the VPC that the AD Connector is in. SubnetIds: allOf: - $ref: '#/components/schemas/SubnetIds' - description: A list of subnet identifiers in the VPC that the AD Connector is in. CustomerUserName: allOf: - $ref: '#/components/schemas/UserName' - description: The user name of the service account in your self-managed directory. SecurityGroupId: allOf: - $ref: '#/components/schemas/SecurityGroupId' - description: The security group identifier for the AD Connector directory. AvailabilityZones: allOf: - $ref: '#/components/schemas/AvailabilityZones' - description: A list of the Availability Zones that the directory is in. ConnectIps: allOf: - $ref: '#/components/schemas/IpAddrs' - description: The IP addresses of the AD Connector servers. description: Contains information about an AD Connector directory. CertificateDoesNotExistException: {} LDAPSStatusReason: type: string IncompatibleSettingsException: {} DirectoryType: type: string enum: - SimpleAD - ADConnector - MicrosoftAD - SharedMicrosoftAD SelectiveAuth: type: string enum: - Enabled - Disabled SnapshotStatus: type: string enum: - Creating - Completed - Failed RejectSharedDirectoryRequest: type: object required: - SharedDirectoryId title: RejectSharedDirectoryRequest properties: 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. CertificateData: type: string minLength: 1 maxLength: 8192 ListSchemaExtensionsResult: type: object properties: SchemaExtensionsInfo: allOf: - $ref: '#/components/schemas/SchemaExtensionsInfo' - description: Information about the schema extensions applied to the directory. NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to ListSchemaExtensions to retrieve the next set of items. DescribeSnapshotsRequest: type: object title: DescribeSnapshotsRequest properties: DirectoryId: allOf: - $ref: '#/components/schemas/DirectoryId' - description: The identifier of the directory for which to retrieve snapshot information. SnapshotIds: allOf: - $ref: '#/components/schemas/SnapshotIds' - description: A list of identifiers of the snapshots to obtain the information for. If this member is null or empty, all snapshots are returned using the Limit and NextToken members. NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: The DescribeSnapshotsResult.NextToken value from a previous call to DescribeSnapshots. Pass null if this is the first call. Limit: allOf: - $ref: '#/components/schemas/Limit' - description: The maximum number of objects to return. description: Contains the inputs for the DescribeSnapshots operation. ShareMethod: type: string enum: - ORGANIZATIONS - HANDSHAKE ReplicationScope: type: string enum: - Domain DescribeCertificateResult: type: object properties: Certificate: allOf: - $ref: '#/components/schemas/Certificate' - description: Information about the certificate, including registered date time, certificate state, the reason for the state, expiration date time, and certificate common name. UpdateConditionalForwarderResult: type: object properties: {} description: The result of an UpdateConditionalForwarder request. RadiusTimeout: type: integer minimum: 1 maximum: 20 GetDirectoryLimitsResult: type: object properties: DirectoryLimits: allOf: - $ref: '#/components/schemas/DirectoryLimits' - description: A DirectoryLimits object that contains the directory limits for the current Region. description: Contains the results of the GetDirectoryLimits operation. EventTopic: type: object properties: DirectoryId: allOf: - $ref: '#/components/schemas/DirectoryId' - description: The Directory ID of an Directory Service directory that will publish status messages to an Amazon SNS topic. TopicName: allOf: - $ref: '#/components/schemas/TopicName' - description: The name of an Amazon SNS topic the receives status messages from the directory. TopicArn: allOf: - $ref: '#/components/schemas/TopicArn' - description: The Amazon SNS topic ARN (Amazon Resource Name). CreatedDateTime: allOf: - $ref: '#/components/schemas/CreatedDateTime' - description: The date and time of when you associated your directory with the Amazon SNS topic. Status: allOf: - $ref: '#/components/schemas/TopicStatus' - description: The topic registration status. description: Information about Amazon SNS topic and Directory Service directory associations. DeregisterEventTopicResult: type: object properties: {} description: The result of a DeregisterEventTopic request. GetSnapshotLimitsRequest: type: object required: - DirectoryId title: GetSnapshotLimitsRequest properties: DirectoryId: allOf: - $ref: '#/components/schemas/DirectoryId' - description: Contains the identifier of the directory to obtain the limits for. description: Contains the inputs for the GetSnapshotLimits operation. CancelSchemaExtensionResult: type: object properties: {} IpAddrs: type: array items: $ref: '#/components/schemas/IpAddr' IpRoute: type: object properties: CidrIp: allOf: - $ref: '#/components/schemas/CidrIp' - description: IP address block using CIDR format, for example 10.0.0.0/24. This is often the address block of the DNS server used for your self-managed domain. For a single IP address use a CIDR address block with /32. For example 10.0.0.0/32. Description: allOf: - $ref: '#/components/schemas/Description' - description: Description of the address block. description: 'IP address block. This is often the address block of the DNS server used for your self-managed domain. ' DesiredNumberOfDomainControllers: type: integer minimum: 2 CreateMicrosoftADRequest: type: object required: - Name - Password - VpcSettings title: CreateMicrosoftADRequest properties: Name: allOf: - $ref: '#/components/schemas/DirectoryName' - description: The fully qualified domain name for the Managed Microsoft AD directory, such as corp.example.com. This name will resolve inside your VPC only. It does not need to be publicly resolvable. ShortName: allOf: - $ref: '#/components/schemas/DirectoryShortName' - description: 'The NetBIOS name for your domain, such as CORP. If you don''t specify a NetBIOS name, it will default to the first part of your directory DNS. For example, CORP for the directory DNS corp.example.com. ' Password: allOf: - $ref: '#/components/schemas/Password' - description:

The password for the default administrative user named Admin.

If you need to change the password for the administrator account, you can use the ResetUserPassword API call.

Description: allOf: - $ref: '#/components/schemas/Description' - description: A description for the directory. This label will appear on the Amazon Web Services console Directory Details page after the directory is created. VpcSettings: allOf: - $ref: '#/components/schemas/DirectoryVpcSettings' - description: Contains VPC information for the CreateDirectory or CreateMicrosoftAD operation. Edition: allOf: - $ref: '#/components/schemas/DirectoryEdition' - description: 'Managed Microsoft AD is available in two editions: Standard and Enterprise. Enterprise is the default.' Tags: allOf: - $ref: '#/components/schemas/Tags' - description: The tags to be assigned to the Managed Microsoft AD directory. description: Creates an Managed Microsoft AD directory. EntityDoesNotExistException: {} Trusts: type: array items: $ref: '#/components/schemas/Trust' CreateComputerRequest: type: object required: - DirectoryId - ComputerName - Password title: CreateComputerRequest properties: DirectoryId: allOf: - $ref: '#/components/schemas/DirectoryId' - description: The identifier of the directory in which to create the computer account. ComputerName: allOf: - $ref: '#/components/schemas/ComputerName' - description: The name of the computer account. Password: allOf: - $ref: '#/components/schemas/ComputerPassword' - description: A one-time password that is used to join the computer to the directory. You should generate a random, strong password to use for this parameter. OrganizationalUnitDistinguishedName: allOf: - $ref: '#/components/schemas/OrganizationalUnitDN' - description: The fully-qualified distinguished name of the organizational unit to place the computer account in. ComputerAttributes: allOf: - $ref: '#/components/schemas/Attributes' - description: An array of Attribute objects that contain any LDAP attributes to apply to the computer account. description: Contains the inputs for the CreateComputer operation. CertificatesInfo: type: array items: $ref: '#/components/schemas/CertificateInfo' OrganizationalUnitDN: type: string minLength: 1 maxLength: 2000 DescribeClientAuthenticationSettingsRequest: type: object required: - DirectoryId title: DescribeClientAuthenticationSettingsRequest properties: DirectoryId: allOf: - $ref: '#/components/schemas/DirectoryId' - description: The identifier of the directory for which to retrieve information. Type: allOf: - $ref: '#/components/schemas/ClientAuthenticationType' - description: The type of client authentication for which to retrieve information. If no type is specified, a list of all client authentication types that are supported for the specified directory is retrieved. NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: The DescribeClientAuthenticationSettingsResult.NextToken value from a previous call to DescribeClientAuthenticationSettings. Pass null if this is the first call. Limit: allOf: - $ref: '#/components/schemas/PageLimit' - description: 'The maximum number of items to return. If this value is zero, the maximum number of items is specified by the limitations of the operation. ' DirectoryInDesiredStateException: {} UpdateDirectorySetupResult: type: object properties: {} UpdateStatusReason: type: string CreateTrustRequest: type: object required: - DirectoryId - RemoteDomainName - TrustPassword - TrustDirection title: CreateTrustRequest properties: DirectoryId: allOf: - $ref: '#/components/schemas/DirectoryId' - description: The Directory ID of the Managed Microsoft AD directory for which to establish the trust relationship. RemoteDomainName: allOf: - $ref: '#/components/schemas/RemoteDomainName' - description: The Fully Qualified Domain Name (FQDN) of the external domain for which to create the trust relationship. TrustPassword: allOf: - $ref: '#/components/schemas/TrustPassword' - description: The trust password. The must be the same password that was used when creating the trust relationship on the external domain. TrustDirection: allOf: - $ref: '#/components/schemas/TrustDirection' - description: The direction of the trust relationship. TrustType: allOf: - $ref: '#/components/schemas/TrustType' - description: The trust relationship type. Forest is the default. ConditionalForwarderIpAddrs: allOf: - $ref: '#/components/schemas/DnsIpAddrs' - description: The IP addresses of the remote DNS server associated with RemoteDomainName. SelectiveAuth: allOf: - $ref: '#/components/schemas/SelectiveAuth' - description: Optional parameter to enable selective authentication for the trust. description:

Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example, you can establish a trust between your Managed Microsoft AD directory, and your existing self-managed Microsoft Active Directory. This would allow you to provide users and groups access to resources in either domain, with a single set of credentials.

This action initiates the creation of the Amazon Web Services side of a trust relationship between an Managed Microsoft AD directory and an external domain.

RadiusSettings: type: object properties: RadiusServers: allOf: - $ref: '#/components/schemas/Servers' - description: An array of strings that contains the fully qualified domain name (FQDN) or IP addresses of the RADIUS server endpoints, or the FQDN or IP addresses of your RADIUS server load balancer. RadiusPort: allOf: - $ref: '#/components/schemas/PortNumber' - description: The port that your RADIUS server is using for communications. Your self-managed network must allow inbound traffic over this port from the Directory Service servers. RadiusTimeout: allOf: - $ref: '#/components/schemas/RadiusTimeout' - description: The amount of time, in seconds, to wait for the RADIUS server to respond. RadiusRetries: allOf: - $ref: '#/components/schemas/RadiusRetries' - description: The maximum number of times that communication with the RADIUS server is attempted. SharedSecret: allOf: - $ref: '#/components/schemas/RadiusSharedSecret' - description: Required for enabling RADIUS on the directory. AuthenticationProtocol: allOf: - $ref: '#/components/schemas/RadiusAuthenticationProtocol' - description: The protocol specified for your RADIUS endpoints. DisplayLabel: allOf: - $ref: '#/components/schemas/RadiusDisplayLabel' - description: Not currently used. UseSameUsername: allOf: - $ref: '#/components/schemas/UseSameUsername' - description: Not currently used. description: Contains information about a Remote Authentication Dial In User Service (RADIUS) server. DirectoryConfigurationSettingType: type: string DeleteTrustResult: type: object properties: TrustId: allOf: - $ref: '#/components/schemas/TrustId' - description: The Trust ID of the trust relationship that was deleted. description: The result of a DeleteTrust request. InvalidPasswordException: {} RadiusAuthenticationProtocol: type: string enum: - PAP - CHAP - MS-CHAPv1 - MS-CHAPv2 ConnectedDirectoriesLimitReached: type: boolean InvalidTargetException: {} InvalidCertificateException: {} DescribeSettingsResult: type: object properties: DirectoryId: allOf: - $ref: '#/components/schemas/DirectoryId' - description: The identifier of the directory. SettingEntries: allOf: - $ref: '#/components/schemas/SettingEntries' - description:

The list of SettingEntry objects that were retrieved.

It is possible that this list contains less than the number of items specified in the Limit member of the request. This occurs if there are less than the requested number of items left to retrieve, or if the limitations of the operation have been exceeded.

NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: 'If not null, token that indicates that more results are available. Pass this value for the NextToken parameter in a subsequent call to DescribeSettings to retrieve the next set of items. ' LogGroupName: type: string pattern: '[-._/#A-Za-z0-9]+' minLength: 1 maxLength: 512 RadiusSharedSecret: type: string pattern: ^(\p{LD}|\p{Punct}| )+$ minLength: 8 maxLength: 512 format: password UpdateActivities: type: array items: $ref: '#/components/schemas/UpdateInfoEntry' 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 (ORGANIZATIONS) or with any Amazon Web Services account by sending a shared directory request (HANDSHAKE). SharedAccountId: allOf: - $ref: '#/components/schemas/CustomerId' - description: Identifier of the directory consumer account that has access to the shared directory (OwnerDirectoryId) 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. SubnetIds: type: array items: $ref: '#/components/schemas/SubnetId' CreateAliasResult: type: object properties: DirectoryId: allOf: - $ref: '#/components/schemas/DirectoryId' - description: The identifier of the directory. Alias: allOf: - $ref: '#/components/schemas/AliasName' - description: The alias for the directory. description: Contains the results of the CreateAlias operation. UseSameUsername: type: boolean SchemaExtensionStatus: type: string enum: - Initializing - CreatingSnapshot - UpdatingSchema - Replicating - CancelInProgress - RollbackInProgress - Cancelled - Failed - Completed DirectoryAlreadySharedException: {} ListTagsForResourceRequest: type: object required: - ResourceId title: ListTagsForResourceRequest properties: ResourceId: allOf: - $ref: '#/components/schemas/ResourceId' - description: Identifier (ID) of the directory for which you want to retrieve tags. NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: Reserved for future use. Limit: allOf: - $ref: '#/components/schemas/Limit' - description: Reserved for future use. AttributeName: type: string minLength: 1 StartSchemaExtensionRequest: type: object required: - DirectoryId - CreateSnapshotBeforeSchemaExtension - LdifContent - Description title: StartSchemaExtensionRequest properties: DirectoryId: allOf: - $ref: '#/components/schemas/DirectoryId' - description: The identifier of the directory for which the schema extension will be applied to. CreateSnapshotBeforeSchemaExtension: allOf: - $ref: '#/components/schemas/CreateSnapshotBeforeSchemaExtension' - description: If true, creates a snapshot of the directory before applying the schema extension. LdifContent: allOf: - $ref: '#/components/schemas/LdifContent' - description: The LDIF file represented as a string. To construct the LdifContent string, precede each line as it would be formatted in an ldif file with \n. See the example request below for more details. The file size can be no larger than 1MB. Description: allOf: - $ref: '#/components/schemas/Description' - description: A description of the schema extension. RegisterEventTopicResult: type: object properties: {} description: The result of a RegisterEventTopic request. AddRegionRequest: type: object required: - DirectoryId - RegionName - VPCSettings title: AddRegionRequest properties: DirectoryId: allOf: - $ref: '#/components/schemas/DirectoryId' - description: The identifier of the directory to which you want to add Region replication. RegionName: allOf: - $ref: '#/components/schemas/RegionName' - description: The name of the Region where you want to add domain controllers for replication. For example, us-east-1. VPCSettings: $ref: '#/components/schemas/DirectoryVpcSettings' CidrIp: type: string pattern: ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\/([1-9]|[1-2][0-9]|3[0-2]))$ DescribeDirectoriesResult: type: object properties: DirectoryDescriptions: allOf: - $ref: '#/components/schemas/DirectoryDescriptions' - description:

The list of DirectoryDescription objects that were retrieved.

It is possible that this list contains less than the number of items specified in the Limit member of the request. This occurs if there are less than the requested number of items left to retrieve, or if the limitations of the operation have been exceeded.

NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to DescribeDirectories to retrieve the next set of items. description: Contains the results of the DescribeDirectories operation. StartTime: type: string format: date-time DisableClientAuthenticationRequest: type: object required: - DirectoryId - Type title: DisableClientAuthenticationRequest properties: DirectoryId: allOf: - $ref: '#/components/schemas/DirectoryId' - description: 'The identifier of the directory ' Type: allOf: - $ref: '#/components/schemas/ClientAuthenticationType' - description: The type of client authentication to disable. Currently, only the parameter, SmartCard is supported. InvalidParameterException: {} SID: type: string pattern: '[&\w+-.@]+' minLength: 1 maxLength: 256 RegionDescription: type: object properties: DirectoryId: allOf: - $ref: '#/components/schemas/DirectoryId' - description: The identifier of the directory. RegionName: allOf: - $ref: '#/components/schemas/RegionName' - description: The name of the Region. For example, us-east-1. RegionType: allOf: - $ref: '#/components/schemas/RegionType' - description: Specifies whether the Region is the primary Region or an additional Region. Status: allOf: - $ref: '#/components/schemas/DirectoryStage' - description: The status of the replication process for the specified Region. VpcSettings: $ref: '#/components/schemas/DirectoryVpcSettings' DesiredNumberOfDomainControllers: allOf: - $ref: '#/components/schemas/DesiredNumberOfDomainControllers' - description: The desired number of domain controllers in the specified Region for the specified directory. LaunchTime: allOf: - $ref: '#/components/schemas/LaunchTime' - description: Specifies when the Region replication began. StatusLastUpdatedDateTime: allOf: - $ref: '#/components/schemas/StateLastUpdatedDateTime' - description: The date and time that the Region status was last updated. LastUpdatedDateTime: allOf: - $ref: '#/components/schemas/LastUpdatedDateTime' - description: The date and time that the Region description was last updated. description: The replicated Region information for a directory. CreateMicrosoftADResult: type: object properties: DirectoryId: allOf: - $ref: '#/components/schemas/DirectoryId' - description: The identifier of the directory that was created. description: Result of a CreateMicrosoftAD request. DirectoryVpcSettingsDescription: type: object properties: VpcId: allOf: - $ref: '#/components/schemas/VpcId' - description: The identifier of the VPC that the directory is in. SubnetIds: allOf: - $ref: '#/components/schemas/SubnetIds' - description: The identifiers of the subnets for the directory servers. SecurityGroupId: allOf: - $ref: '#/components/schemas/SecurityGroupId' - description: The domain controller security group identifier for the directory. AvailabilityZones: allOf: - $ref: '#/components/schemas/AvailabilityZones' - description: The list of Availability Zones that the directory is in. description: Contains information about the directory. Trust: type: object properties: DirectoryId: allOf: - $ref: '#/components/schemas/DirectoryId' - description: The Directory ID of the Amazon Web Services directory involved in the trust relationship. TrustId: allOf: - $ref: '#/components/schemas/TrustId' - description: The unique ID of the trust relationship. RemoteDomainName: allOf: - $ref: '#/components/schemas/RemoteDomainName' - description: The Fully Qualified Domain Name (FQDN) of the external domain involved in the trust relationship. TrustType: allOf: - $ref: '#/components/schemas/TrustType' - description: The trust relationship type. Forest is the default. TrustDirection: allOf: - $ref: '#/components/schemas/TrustDirection' - description: The trust relationship direction. TrustState: allOf: - $ref: '#/components/schemas/TrustState' - description: The trust relationship state. CreatedDateTime: allOf: - $ref: '#/components/schemas/CreatedDateTime' - description: The date and time that the trust relationship was created. LastUpdatedDateTime: allOf: - $ref: '#/components/schemas/LastUpdatedDateTime' - description: The date and time that the trust relationship was last updated. StateLastUpdatedDateTime: allOf: - $ref: '#/components/schemas/StateLastUpdatedDateTime' - description: The date and time that the TrustState was last updated. TrustStateReason: allOf: - $ref: '#/components/schemas/TrustStateReason' - description: The reason for the TrustState. SelectiveAuth: allOf: - $ref: '#/components/schemas/SelectiveAuth' - description: Current state of selective authentication for the trust. description: Describes a trust relationship between an Managed Microsoft AD directory and an external domain. Notes: type: string maxLength: 1024 format: password InvalidLDAPSStatusException: {} DeleteSnapshotRequest: type: object required: - SnapshotId title: DeleteSnapshotRequest properties: SnapshotId: allOf: - $ref: '#/components/schemas/SnapshotId' - description: The identifier of the directory snapshot to be deleted. description: Contains the inputs for the DeleteSnapshot operation. ComputerPassword: type: string pattern: '[\u0020-\u00FF]+' minLength: 8 maxLength: 64 format: password GetSnapshotLimitsResult: type: object properties: SnapshotLimits: allOf: - $ref: '#/components/schemas/SnapshotLimits' - description: A SnapshotLimits object that contains the manual snapshot limits for the specified directory. description: Contains the results of the GetSnapshotLimits operation. UnsupportedOperationException: {} SsoEnabled: type: boolean CreatedDateTime: type: string format: date-time SubscriptionCreatedDateTime: type: string format: date-time ComputerName: type: string minLength: 1 maxLength: 15 UnshareDirectoryRequest: type: object required: - DirectoryId - UnshareTarget title: UnshareDirectoryRequest properties: DirectoryId: allOf: - $ref: '#/components/schemas/DirectoryId' - description: The identifier of the Managed Microsoft AD directory that you want to stop sharing. UnshareTarget: allOf: - $ref: '#/components/schemas/UnshareTarget' - description: Identifier for the directory consumer account with whom the directory has to be unshared. DescribeEventTopicsResult: type: object properties: EventTopics: allOf: - $ref: '#/components/schemas/EventTopics' - description: A list of Amazon SNS topic names that receive status messages from the specified Directory ID. description: The result of a DescribeEventTopic request. UserName: type: string pattern: '[a-zA-Z0-9._-]+' minLength: 1 OSUpdateSettings: type: object properties: OSVersion: allOf: - $ref: '#/components/schemas/OSVersion' - description: ' OS version that the directory needs to be updated to. ' description: ' OS version that the directory needs to be updated to. ' RegionName: type: string minLength: 8 maxLength: 32 OSVersion: type: string enum: - SERVER_2012 - SERVER_2019 TargetId: type: string minLength: 1 maxLength: 64 ShareLimitExceededException: {} SharedDirectories: type: array items: $ref: '#/components/schemas/SharedDirectory' LDAPSStatus: type: string enum: - Enabling - Enabled - EnableFailed - Disabled DirectoryDescriptions: type: array description: A list of directory descriptions. items: $ref: '#/components/schemas/DirectoryDescription' IpRouteStatusReason: type: string Limit: type: integer minimum: 0 LdifContent: type: string minLength: 1 maxLength: 500000 ConditionalForwarders: type: array items: $ref: '#/components/schemas/ConditionalForwarder' UpdateTrustRequest: type: object required: - TrustId title: UpdateTrustRequest properties: TrustId: allOf: - $ref: '#/components/schemas/TrustId' - description: Identifier of the trust relationship. SelectiveAuth: allOf: - $ref: '#/components/schemas/SelectiveAuth' - description: Updates selective authentication for the trust. LaunchTime: type: string format: date-time ServiceException: {} SnapshotLimitExceededException: {} RegisterEventTopicRequest: type: object required: - DirectoryId - TopicName title: RegisterEventTopicRequest properties: DirectoryId: allOf: - $ref: '#/components/schemas/DirectoryId' - description: The Directory ID that will publish status messages to the Amazon SNS topic. TopicName: allOf: - $ref: '#/components/schemas/TopicName' - description: The Amazon SNS topic name to which the directory will publish status messages. This Amazon SNS topic must be in the same region as the specified Directory ID. description: Registers a new event topic. Server: type: string minLength: 1 maxLength: 256 ResetUserPasswordRequest: type: object required: - DirectoryId - UserName - NewPassword title: ResetUserPasswordRequest properties: DirectoryId: allOf: - $ref: '#/components/schemas/DirectoryId' - description: Identifier of the Managed Microsoft AD or Simple AD directory in which the user resides. UserName: allOf: - $ref: '#/components/schemas/CustomerUserName' - description: The user name of the user whose password will be reset. NewPassword: allOf: - $ref: '#/components/schemas/UserPassword' - description: The new password that will be reset. TrustStateReason: type: string UpdateRadiusRequest: type: object required: - DirectoryId - RadiusSettings title: UpdateRadiusRequest properties: DirectoryId: allOf: - $ref: '#/components/schemas/DirectoryId' - description: The identifier of the directory for which to update the RADIUS server information. RadiusSettings: allOf: - $ref: '#/components/schemas/RadiusSettings' - description: A RadiusSettings object that contains information about the RADIUS server. description: Contains the inputs for the UpdateRadius operation. DeleteLogSubscriptionResult: type: object properties: {} DirectoryLimits: type: object properties: CloudOnlyDirectoriesLimit: allOf: - $ref: '#/components/schemas/Limit' - description: The maximum number of cloud directories allowed in the Region. CloudOnlyDirectoriesCurrentCount: allOf: - $ref: '#/components/schemas/Limit' - description: The current number of cloud directories in the Region. CloudOnlyDirectoriesLimitReached: allOf: - $ref: '#/components/schemas/CloudOnlyDirectoriesLimitReached' - description: Indicates if the cloud directory limit has been reached. CloudOnlyMicrosoftADLimit: allOf: - $ref: '#/components/schemas/Limit' - description: The maximum number of Managed Microsoft AD directories allowed in the region. CloudOnlyMicrosoftADCurrentCount: allOf: - $ref: '#/components/schemas/Limit' - description: The current number of Managed Microsoft AD directories in the region. CloudOnlyMicrosoftADLimitReached: allOf: - $ref: '#/components/schemas/CloudOnlyDirectoriesLimitReached' - description: Indicates if the Managed Microsoft AD directory limit has been reached. ConnectedDirectoriesLimit: allOf: - $ref: '#/components/schemas/Limit' - description: The maximum number of connected directories allowed in the Region. ConnectedDirectoriesCurrentCount: allOf: - $ref: '#/components/schemas/Limit' - description: The current number of connected directories in the Region. ConnectedDirectoriesLimitReached: allOf: - $ref: '#/components/schemas/ConnectedDirectoriesLimitReached' - description: Indicates if the connected directory limit has been reached. description: Contains directory limit information for a Region. DescribeTrustsRequest: type: object title: DescribeTrustsRequest properties: DirectoryId: allOf: - $ref: '#/components/schemas/DirectoryId' - description: The Directory ID of the Amazon Web Services directory that is a part of the requested trust relationship. TrustIds: allOf: - $ref: '#/components/schemas/TrustIds' - description:

A list of identifiers of the trust relationships for which to obtain the information. If this member is null, all trust relationships that belong to the current account are returned.

An empty list results in an InvalidParameterException being thrown.

NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: The DescribeTrustsResult.NextToken value from a previous call to DescribeTrusts. Pass null if this is the first call. Limit: allOf: - $ref: '#/components/schemas/Limit' - description: The maximum number of objects to return. description: Describes the trust relationships for a particular Managed Microsoft AD directory. If no input parameters are provided, such as directory ID or trust ID, this request describes all the trust relationships. StateLastUpdatedDateTime: type: string format: date-time DirectoryId: type: string pattern: ^d-[0-9a-f]{10}$ DisableLDAPSResult: type: object properties: {} TopicStatus: type: string enum: - Registered - Topic not found - Failed - Deleted DeregisterCertificateResult: type: object properties: {} Computer: type: object properties: ComputerId: allOf: - $ref: '#/components/schemas/SID' - description: The identifier of the computer. ComputerName: allOf: - $ref: '#/components/schemas/ComputerName' - description: The computer name. ComputerAttributes: allOf: - $ref: '#/components/schemas/Attributes' - description: An array of Attribute objects containing the LDAP attributes that belong to the computer account. description: Contains information about a computer account in a directory. ClientCertAuthSettings: type: object properties: OCSPUrl: allOf: - $ref: '#/components/schemas/OCSPUrl' - description: Specifies the URL of the default OCSP server used to check for revocation status. A secondary value to any OCSP address found in the AIA extension of the user certificate. description: 'Contains information about the client certificate authentication settings for the RegisterCertificate and DescribeCertificate operations. ' UserPassword: type: string minLength: 1 maxLength: 127 format: password ClientAuthenticationType: type: string enum: - SmartCard - SmartCardOrPassword DeregisterCertificateRequest: type: object required: - DirectoryId - CertificateId title: DeregisterCertificateRequest properties: DirectoryId: allOf: - $ref: '#/components/schemas/DirectoryId' - description: The identifier of the directory. CertificateId: allOf: - $ref: '#/components/schemas/CertificateId' - description: The identifier of the certificate. ShareDirectoryResult: type: object properties: SharedDirectoryId: allOf: - $ref: '#/components/schemas/DirectoryId' - description: Identifier of the directory that is stored in the directory consumer account that is shared from the specified directory (DirectoryId). EntityAlreadyExistsException: {} DomainControllerLimitExceededException: {} UpdateInfoEntry: type: object properties: Region: allOf: - $ref: '#/components/schemas/RegionName' - description: ' The name of the Region. ' Status: allOf: - $ref: '#/components/schemas/UpdateStatus' - description: ' The status of the update performed on the directory. ' StatusReason: allOf: - $ref: '#/components/schemas/UpdateStatusReason' - description: ' The reason for the current status of the update type activity. ' InitiatedBy: allOf: - $ref: '#/components/schemas/InitiatedBy' - description: ' This specifies if the update was initiated by the customer or by the service team. ' NewValue: allOf: - $ref: '#/components/schemas/UpdateValue' - description: ' The new value of the target setting. ' PreviousValue: allOf: - $ref: '#/components/schemas/UpdateValue' - description: ' The old value of the target setting. ' StartTime: allOf: - $ref: '#/components/schemas/StartDateTime' - description: ' The start time of the UpdateDirectorySetup for the particular type. ' LastUpdatedDateTime: allOf: - $ref: '#/components/schemas/LastUpdatedDateTime' - description: ' The last updated date and time of a particular directory setting. ' description: ' An entry of update information related to a requested update type. ' DescribeRegionsResult: type: object properties: RegionsDescription: allOf: - $ref: '#/components/schemas/RegionsDescription' - description: List of Region information related to the directory for each replicated Region. NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to DescribeRegions to retrieve the next set of items. ListCertificatesResult: type: object properties: NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: Indicates whether another page of certificates is available when the number of available certificates exceeds the page limit. CertificatesInfo: allOf: - $ref: '#/components/schemas/CertificatesInfo' - description: A list of certificates with basic details including certificate ID, certificate common name, certificate state. AddedDateTime: type: string format: date-time DomainControllerId: type: string pattern: ^dc-[0-9a-f]{10}$ DirectoryEdition: type: string enum: - Enterprise - Standard DescribeLDAPSSettingsRequest: type: object required: - DirectoryId title: DescribeLDAPSSettingsRequest properties: DirectoryId: allOf: - $ref: '#/components/schemas/DirectoryId' - description: The identifier of the directory. Type: allOf: - $ref: '#/components/schemas/LDAPSType' - description: The type of LDAP security to enable. Currently only the value Client is supported. NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: The type of next token used for pagination. Limit: allOf: - $ref: '#/components/schemas/PageLimit' - description: Specifies the number of items that should be displayed on one page. RemoteDomainNames: type: array items: $ref: '#/components/schemas/RemoteDomainName' Snapshots: type: array description: A list of descriptions of directory snapshots. items: $ref: '#/components/schemas/Snapshot' LDAPSSettingInfo: type: object properties: LDAPSStatus: allOf: - $ref: '#/components/schemas/LDAPSStatus' - description: The state of the LDAPS settings. LDAPSStatusReason: allOf: - $ref: '#/components/schemas/LDAPSStatusReason' - description: Describes a state change for LDAPS. LastUpdatedDateTime: allOf: - $ref: '#/components/schemas/LastUpdatedDateTime' - description: The date and time when the LDAPS settings were last updated. description: Contains general information about the LDAPS settings. DisableSsoRequest: type: object required: - DirectoryId title: DisableSsoRequest properties: DirectoryId: allOf: - $ref: '#/components/schemas/DirectoryId' - description: The identifier of the directory for which to disable single-sign on. UserName: allOf: - $ref: '#/components/schemas/UserName' - description:

The username of an alternate account to use to disable single-sign on. This is only used for AD Connector directories. This account must have privileges to remove a service principal name.

If the AD Connector service account does not have privileges to remove a service principal name, you can specify an alternate account with the UserName and Password parameters. These credentials are only used to disable single sign-on and are not stored by the service. The AD Connector service account is not changed.

Password: allOf: - $ref: '#/components/schemas/ConnectPassword' - description: The password of an alternate account to use to disable single-sign on. This is only used for AD Connector directories. For more information, see the UserName parameter. description: Contains the inputs for the DisableSso operation. RadiusDisplayLabel: type: string minLength: 1 maxLength: 64 RegionType: type: string enum: - Primary - Additional NoAvailableCertificateException: {} DescribeSnapshotsResult: type: object properties: Snapshots: allOf: - $ref: '#/components/schemas/Snapshots' - description:

The list of Snapshot objects that were retrieved.

It is possible that this list contains less than the number of items specified in the Limit member of the request. This occurs if there are less than the requested number of items left to retrieve, or if the limitations of the operation have been exceeded.

NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: If not null, more results are available. Pass this value in the NextToken member of a subsequent call to DescribeSnapshots. description: Contains the results of the DescribeSnapshots operation. CreateLogSubscriptionRequest: type: object required: - DirectoryId - LogGroupName title: CreateLogSubscriptionRequest properties: DirectoryId: allOf: - $ref: '#/components/schemas/DirectoryId' - description: Identifier of the directory to which you want to subscribe and receive real-time logs to your specified CloudWatch log group. LogGroupName: allOf: - $ref: '#/components/schemas/LogGroupName' - description: The name of the CloudWatch log group where the real-time domain controller logs are forwarded. StageReason: type: string CreateConditionalForwarderResult: type: object properties: {} description: The result of a CreateConditinalForwarder request. PageLimit: type: integer minimum: 1 maximum: 50 RemoveIpRoutesResult: type: object properties: {} Description: type: string pattern: ^([a-zA-Z0-9_])[\\a-zA-Z0-9_@#%*+=:?./!\s-]*$ minLength: 0 maxLength: 128 UnshareDirectoryResult: type: object properties: SharedDirectoryId: allOf: - $ref: '#/components/schemas/DirectoryId' - description: Identifier of the directory stored in the directory consumer account that is to be unshared from the specified directory (DirectoryId). DescribeLDAPSSettingsResult: type: object properties: LDAPSSettingsInfo: allOf: - $ref: '#/components/schemas/LDAPSSettingsInfo' - description: Information about LDAP security for the specified directory, including status of enablement, state last updated date time, and the reason for the state. NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: The next token used to retrieve the LDAPS settings if the number of setting types exceeds page limit and there is another page. RegionsDescription: type: array items: $ref: '#/components/schemas/RegionDescription' AddTagsToResourceResult: type: object properties: {} DisableRadiusResult: type: object properties: {} description: Contains the results of the DisableRadius operation. RegisterCertificateRequest: type: object required: - DirectoryId - CertificateData title: RegisterCertificateRequest properties: DirectoryId: allOf: - $ref: '#/components/schemas/DirectoryId' - description: The identifier of the directory. CertificateData: allOf: - $ref: '#/components/schemas/CertificateData' - description: The certificate PEM string that needs to be registered. Type: allOf: - $ref: '#/components/schemas/CertificateType' - description: The function that the registered certificate performs. Valid values include ClientLDAPS or ClientCertAuth. The default value is ClientLDAPS. ClientCertAuthSettings: allOf: - $ref: '#/components/schemas/ClientCertAuthSettings' - description: A ClientCertAuthSettings object that contains client certificate authentication settings. EndDateTime: type: string format: date-time DomainControllers: type: array items: $ref: '#/components/schemas/DomainController' TagKey: type: string pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$ minLength: 1 maxLength: 128 InvalidNextTokenException: {} RegionLimitExceededException: {} DomainControllerStatus: type: string enum: - Creating - Active - Impaired - Restoring - Deleting - Deleted - Failed DeregisterEventTopicRequest: type: object required: - DirectoryId - TopicName title: DeregisterEventTopicRequest properties: DirectoryId: allOf: - $ref: '#/components/schemas/DirectoryId' - description: The Directory ID to remove as a publisher. This directory will no longer send messages to the specified Amazon SNS topic. TopicName: allOf: - $ref: '#/components/schemas/TopicName' - description: The name of the Amazon SNS topic from which to remove the directory as a publisher. description: Removes the specified directory as a publisher to the specified Amazon SNS topic. CertificateRegisteredDateTime: type: string format: date-time TopicArn: type: string AccessDeniedException: {} DirectoryDoesNotExistException: {} VerifyTrustResult: type: object properties: TrustId: allOf: - $ref: '#/components/schemas/TrustId' - description: The unique Trust ID of the trust relationship that was verified. description: Result of a VerifyTrust request. DisableLDAPSRequest: type: object required: - DirectoryId - Type title: DisableLDAPSRequest properties: DirectoryId: allOf: - $ref: '#/components/schemas/DirectoryId' - description: The identifier of the directory. Type: allOf: - $ref: '#/components/schemas/LDAPSType' - description: The type of LDAP security to enable. Currently only the value Client is supported. CertificateType: type: string enum: - ClientCertAuth - ClientLDAPS ConnectDirectoryRequest: type: object required: - Name - Password - Size - ConnectSettings title: ConnectDirectoryRequest properties: Name: allOf: - $ref: '#/components/schemas/DirectoryName' - description: The fully qualified name of your self-managed directory, such as corp.example.com. ShortName: allOf: - $ref: '#/components/schemas/DirectoryShortName' - description: The NetBIOS name of your self-managed directory, such as CORP. Password: allOf: - $ref: '#/components/schemas/ConnectPassword' - description: The password for your self-managed user account. Description: allOf: - $ref: '#/components/schemas/Description' - description: A description for the directory. Size: allOf: - $ref: '#/components/schemas/DirectorySize' - description: The size of the directory. ConnectSettings: allOf: - $ref: '#/components/schemas/DirectoryConnectSettings' - description: A DirectoryConnectSettings object that contains additional information for the operation. Tags: allOf: - $ref: '#/components/schemas/Tags' - description: The tags to be assigned to AD Connector. description: Contains the inputs for the ConnectDirectory operation. AttributeValue: type: string ClientAuthenticationStatus: type: string enum: - Enabled - Disabled Servers: type: array items: $ref: '#/components/schemas/Server' TrustDirection: type: string enum: - 'One-Way: Outgoing' - 'One-Way: Incoming' - Two-Way DirectoryUnavailableException: {} DeleteDirectoryRequest: type: object required: - DirectoryId title: DeleteDirectoryRequest properties: DirectoryId: allOf: - $ref: '#/components/schemas/DirectoryId' - description: The identifier of the directory to delete. description: Contains the inputs for the DeleteDirectory operation. UpdateSettingsResult: type: object properties: DirectoryId: allOf: - $ref: '#/components/schemas/DirectoryId' - description: The identifier of the directory. DescribeEventTopicsRequest: type: object title: DescribeEventTopicsRequest properties: DirectoryId: allOf: - $ref: '#/components/schemas/DirectoryId' - description: The Directory ID for which to get the list of associated Amazon SNS topics. If this member is null, associations for all Directory IDs are returned. TopicNames: allOf: - $ref: '#/components/schemas/TopicNames' - description:

A list of Amazon SNS topic names for which to obtain the information. If this member is null, all associations for the specified Directory ID are returned.

An empty list results in an InvalidParameterException being thrown.

description: Describes event topics. DirectorySize: type: string enum: - Small - Large ShareTarget: type: object required: - Id - Type properties: Id: allOf: - $ref: '#/components/schemas/TargetId' - description: Identifier of the directory consumer account. Type: allOf: - $ref: '#/components/schemas/TargetType' - description: Type of identifier to be used in the Id field. description: Identifier that contains details about the directory consumer account. DirectoryConfigurationSettingValue: type: string pattern: ^[a-zA-Z0-9]*$ minLength: 1 maxLength: 255 ShareDirectoryRequest: type: object required: - DirectoryId - ShareTarget - ShareMethod title: ShareDirectoryRequest properties: DirectoryId: allOf: - $ref: '#/components/schemas/DirectoryId' - description: Identifier of the Managed Microsoft AD directory that you want to share with other Amazon Web Services accounts. 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. ShareTarget: allOf: - $ref: '#/components/schemas/ShareTarget' - description: Identifier for the directory consumer account with whom the directory is to be shared. 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 (ORGANIZATIONS) or with any Amazon Web Services account by sending a directory sharing request (HANDSHAKE). DisableRadiusRequest: type: object required: - DirectoryId title: DisableRadiusRequest properties: DirectoryId: allOf: - $ref: '#/components/schemas/DirectoryId' - description: The identifier of the directory for which to disable MFA. description: Contains the inputs for the DisableRadius operation. EnableSsoRequest: type: object required: - DirectoryId title: EnableSsoRequest properties: DirectoryId: allOf: - $ref: '#/components/schemas/DirectoryId' - description: The identifier of the directory for which to enable single-sign on. UserName: allOf: - $ref: '#/components/schemas/UserName' - description:

The username of an alternate account to use to enable single-sign on. This is only used for AD Connector directories. This account must have privileges to add a service principal name.

If the AD Connector service account does not have privileges to add a service principal name, you can specify an alternate account with the UserName and Password parameters. These credentials are only used to enable single sign-on and are not stored by the service. The AD Connector service account is not changed.

Password: allOf: - $ref: '#/components/schemas/ConnectPassword' - description: The password of an alternate account to use to enable single-sign on. This is only used for AD Connector directories. For more information, see the UserName parameter. description: Contains the inputs for the EnableSso operation. EnableLDAPSResult: type: object properties: {} AvailabilityZones: type: array items: $ref: '#/components/schemas/AvailabilityZone' ListIpRoutesResult: type: object properties: IpRoutesInfo: allOf: - $ref: '#/components/schemas/IpRoutesInfo' - description: A list of IpRoutes. NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to ListIpRoutes to retrieve the next set of items. DirectoryName: type: string pattern: ^([a-zA-Z0-9]+[\\.-])+([a-zA-Z0-9])+$ DirectoryStage: type: string enum: - Requested - Creating - Created - Active - Inoperable - Impaired - Restoring - RestoreFailed - Deleting - Deleted - Failed ShareStatus: type: string enum: - Shared - PendingAcceptance - Rejected - Rejecting - RejectFailed - Sharing - ShareFailed - Deleted - Deleting Snapshot: type: object properties: DirectoryId: allOf: - $ref: '#/components/schemas/DirectoryId' - description: The directory identifier. SnapshotId: allOf: - $ref: '#/components/schemas/SnapshotId' - description: The snapshot identifier. Type: allOf: - $ref: '#/components/schemas/SnapshotType' - description: The snapshot type. Name: allOf: - $ref: '#/components/schemas/SnapshotName' - description: The descriptive name of the snapshot. Status: allOf: - $ref: '#/components/schemas/SnapshotStatus' - description: The snapshot status. StartTime: allOf: - $ref: '#/components/schemas/StartTime' - description: The date and time that the snapshot was taken. description: Describes a directory snapshot. UpdateConditionalForwarderRequest: type: object required: - DirectoryId - RemoteDomainName - DnsIpAddrs title: UpdateConditionalForwarderRequest properties: DirectoryId: allOf: - $ref: '#/components/schemas/DirectoryId' - description: The directory ID of the Amazon Web Services directory for which to update the conditional forwarder. RemoteDomainName: allOf: - $ref: '#/components/schemas/RemoteDomainName' - description: The fully qualified domain name (FQDN) of the remote domain with which you will set up a trust relationship. DnsIpAddrs: allOf: - $ref: '#/components/schemas/DnsIpAddrs' - description: The updated IP addresses of the remote DNS server associated with the conditional forwarder. description: Updates a conditional forwarder. EnableRadiusRequest: type: object required: - DirectoryId - RadiusSettings title: EnableRadiusRequest properties: DirectoryId: allOf: - $ref: '#/components/schemas/DirectoryId' - description: The identifier of the directory for which to enable MFA. RadiusSettings: allOf: - $ref: '#/components/schemas/RadiusSettings' - description: A RadiusSettings object that contains information about the RADIUS server. description: Contains the inputs for the EnableRadius operation. TrustState: type: string enum: - Creating - Created - Verifying - VerifyFailed - Verified - Updating - UpdateFailed - Updated - Deleting - Deleted - Failed CreateTrustResult: type: object properties: TrustId: allOf: - $ref: '#/components/schemas/TrustId' - description: A unique identifier for the trust relationship that was created. description: The result of a CreateTrust request. StartSchemaExtensionResult: type: object properties: SchemaExtensionId: allOf: - $ref: '#/components/schemas/SchemaExtensionId' - description: The identifier of the schema extension that will be applied. UpdateTrustResult: type: object properties: RequestId: $ref: '#/components/schemas/RequestId' TrustId: allOf: - $ref: '#/components/schemas/TrustId' - description: Identifier of the trust relationship. DnsIpAddrs: type: array items: $ref: '#/components/schemas/IpAddr' UpdateRadiusResult: type: object properties: {} description: Contains the results of the UpdateRadius operation. IpAddr: type: string pattern: ^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$ RemoveIpRoutesRequest: type: object required: - DirectoryId - CidrIps title: RemoveIpRoutesRequest properties: DirectoryId: allOf: - $ref: '#/components/schemas/DirectoryId' - description: Identifier (ID) of the directory from which you want to remove the IP addresses. CidrIps: allOf: - $ref: '#/components/schemas/CidrIps' - description: IP address blocks that you want to remove. CreateAliasRequest: type: object required: - DirectoryId - Alias title: CreateAliasRequest properties: DirectoryId: allOf: - $ref: '#/components/schemas/DirectoryId' - description: The identifier of the directory for which to create the alias. Alias: allOf: - $ref: '#/components/schemas/AliasName' - description:

The requested alias.

The alias must be unique amongst all aliases in Amazon Web Services. This operation throws an EntityAlreadyExistsException error if the alias already exists.

description: Contains the inputs for the CreateAlias operation. RemoveRegionRequest: type: object required: - DirectoryId title: RemoveRegionRequest properties: DirectoryId: allOf: - $ref: '#/components/schemas/DirectoryId' - description: The identifier of the directory for which you want to remove Region replication. TrustPassword: type: string pattern: ^(\p{LD}|\p{Punct}| )+$ minLength: 1 maxLength: 128 format: password RemoveTagsFromResourceRequest: type: object required: - ResourceId - TagKeys title: RemoveTagsFromResourceRequest properties: ResourceId: allOf: - $ref: '#/components/schemas/ResourceId' - description: Identifier (ID) of the directory from which to remove the tag. TagKeys: allOf: - $ref: '#/components/schemas/TagKeys' - description: The tag key (name) of the tag to be removed. DeleteTrustRequest: type: object required: - TrustId title: DeleteTrustRequest properties: TrustId: allOf: - $ref: '#/components/schemas/TrustId' - description: The Trust ID of the trust relationship to be deleted. DeleteAssociatedConditionalForwarder: allOf: - $ref: '#/components/schemas/DeleteAssociatedConditionalForwarder' - description: Delete a conditional forwarder as part of a DeleteTrustRequest. description: Deletes the local side of an existing trust relationship between the Managed Microsoft AD directory and the external domain. RadiusStatus: type: string enum: - Creating - Completed - Failed RadiusRetries: type: integer minimum: 0 maximum: 10 AdditionalRegions: type: array items: $ref: '#/components/schemas/RegionName' parameters: X-Amz-SignedHeaders: name: X-Amz-SignedHeaders in: header schema: type: string required: false X-Amz-Algorithm: name: X-Amz-Algorithm 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-Signature: name: X-Amz-Signature in: header schema: type: string required: false X-Amz-Date: name: X-Amz-Date in: header schema: type: string required: false X-Amz-Security-Token: name: X-Amz-Security-Token in: header schema: type: string required: false 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