Amazon Directory Service Directory Service Ad Assessment API

openapi: 3.2.0
info:
  title: AWS Directory Service Ad Assessment API
  version: '2015-04-16'
  description: Generated from AWS's published Smithy model for AWS Directory Service. 4 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://ds.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Ad Assessment
paths:
  /#DeleteADAssessment:
    post:
      operationId: DeleteADAssessment
      summary: Delete ADAssessment
      description: Deletes a directory assessment and all associated data. This operation permanently removes the assessment results, validation reports, and configuration information. You cannot delete system-initiated assessments. You can delete customer-created assessments even if they are in progress.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteADAssessmentResult'
        '400':
          description: ClientException; EntityDoesNotExistException; InvalidParameterException; UnsupportedOperationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ClientException'
        '500':
          description: ServiceException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ServiceException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - DirectoryService_20150416.DeleteADAssessment
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteADAssessmentRequest'
      tags:
      - Ad Assessment
  /#DescribeADAssessment:
    post:
      operationId: DescribeADAssessment
      summary: Describe ADAssessment
      description: Retrieves detailed information about a directory assessment, including its current status, validation results, and configuration details. Use this operation to monitor assessment progress and review results.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeADAssessmentResult'
        '400':
          description: ClientException; EntityDoesNotExistException; InvalidParameterException; UnsupportedOperationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ClientException'
        '500':
          description: ServiceException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ServiceException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - DirectoryService_20150416.DescribeADAssessment
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeADAssessmentRequest'
      tags:
      - Ad Assessment
  /#ListADAssessments:
    post:
      operationId: ListADAssessments
      summary: List ADAssessments
      description: Retrieves a list of directory assessments for the specified directory or all assessments in your account. Use this operation to monitor assessment status and manage multiple assessments.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListADAssessmentsResult'
        '400':
          description: ClientException; DirectoryDoesNotExistException; InvalidParameterException; UnsupportedOperationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ClientException'
        '500':
          description: ServiceException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ServiceException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - DirectoryService_20150416.ListADAssessments
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListADAssessmentsRequest'
      tags:
      - Ad Assessment
  /#StartADAssessment:
    post:
      operationId: StartADAssessment
      summary: Start ADAssessment
      description: 'Initiates a directory assessment to validate your self-managed AD environment for hybrid domain join. The assessment checks compatibility and connectivity of the self-managed AD environment. A directory assessment is automatically created when you create a hybrid directory. There are two types of assessments: CUSTOMER and SYSTEM. Your Amazon Web Services account has a limit of 100 CUSTOMER directory assessments. The assessment process typically takes 30 minutes or more to complete. The assessment process is asynchronous and you can monitor it with DescribeADAssessment. The InstanceIds must have a one-to-one correspondence with CustomerDnsIps, meaning that if the IP address for instance i-10243410 is 10.24.34.100 and the IP address for instance i-10243420 is 10.24.34.200, then the input arrays must maintain the same order relationship, either [10.24.34.100, 10.24.34.200] paired with [i-10243410, i-10243420] or [10.24.34.200, 10.24.34.100] paired with [i-10243420, i-10243410]. Note: You must provide exactly one DirectoryId or AssessmentConfiguration.'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/StartADAssessmentResult'
        '400':
          description: ADAssessmentLimitExceededException; ClientException; DirectoryDoesNotExistException; InvalidParameterException; UnsupportedOperationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ADAssessmentLimitExceededException'
        '500':
          description: ServiceException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ServiceException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - DirectoryService_20150416.StartADAssessment
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/StartADAssessmentRequest'
      tags:
      - Ad Assessment
components:
  schemas:
    Assessment:
      type: object
      properties:
        AssessmentId:
          type: string
          description: The unique identifier of the directory assessment.
        DirectoryId:
          type: string
          description: The identifier of the directory associated with this assessment.
        DnsName:
          type: string
          description: The fully qualified domain name (FQDN) of the Active Directory domain being assessed.
        StartTime:
          type: string
          format: date-time
          description: The date and time when the assessment was initiated.
        LastUpdateDateTime:
          type: string
          format: date-time
          description: The date and time when the assessment status was last updated.
        Status:
          type: string
          description: The current status of the assessment. Valid values include SUCCESS, FAILED, PENDING, and IN_PROGRESS.
        StatusCode:
          type: string
          description: A detailed status code providing additional information about the assessment state.
        StatusReason:
          type: string
          description: A human-readable description of the current assessment status, including any error details or progress information.
        CustomerDnsIps:
          type: array
          items:
            type: string
          description: The IP addresses of the DNS servers or domain controllers in your self-managed AD environment.
        VpcId:
          type: string
          description: Contains Amazon VPC information for the StartADAssessment operation.
        SubnetIds:
          type: array
          items:
            type: string
          description: A list of subnet identifiers in the Amazon VPC in which the hybrid directory is created.
        SecurityGroupIds:
          type: array
          items:
            type: string
          description: The security groups identifiers attached to the network interfaces.
        SelfManagedInstanceIds:
          type: array
          items:
            type: string
          description: The identifiers of the self-managed AD instances used to perform the assessment.
        ReportType:
          type: string
          description: The type of assessment report generated. Valid values are CUSTOMER and SYSTEM.
        Version:
          type: string
          description: The version of the assessment framework used to evaluate your self-managed AD environment.
    ListADAssessmentsRequest:
      type: object
      properties:
        DirectoryId:
          type: string
          description: The identifier of the directory for which to list assessments. If not specified, all assessments in your account are returned.
        NextToken:
          type: string
          description: The pagination token from a previous request to ListADAssessments. Pass null if this is the first request.
        Limit:
          type: integer
          description: The maximum number of assessment summaries to return.
    StartADAssessmentResult:
      type: object
      properties:
        AssessmentId:
          type: string
          description: The unique identifier of the newly started directory assessment. Use this identifier to monitor assessment progress and retrieve results.
    ADAssessmentLimitExceededException:
      type: object
      properties:
        Message:
          type: string
        RequestId:
          type: string
    AssessmentValidation:
      type: object
      properties:
        Category:
          type: string
          description: The category of the validation test.
        Name:
          type: string
          description: The name of the specific validation test performed within the category.
        Status:
          type: string
          description: The result status of the validation test. Valid values include SUCCESS, FAILED, PENDING, and IN_PROGRESS.
        StatusCode:
          type: string
          description: A detailed status code providing additional information about the validation result.
        StatusReason:
          type: string
          description: A human-readable description of the validation result, including any error details or recommendations.
        StartTime:
          type: string
          format: date-time
          description: The date and time when the validation test was started.
        LastUpdateDateTime:
          type: string
          format: date-time
          description: The date and time when the validation test was completed or last updated.
    AssessmentSummary:
      type: object
      properties:
        AssessmentId:
          type: string
          description: The unique identifier of the directory assessment.
        DirectoryId:
          type: string
          description: The identifier of the directory associated with this assessment.
        DnsName:
          type: string
          description: The fully qualified domain name (FQDN) of the Active Directory domain being assessed.
        StartTime:
          type: string
          format: date-time
          description: The date and time when the assessment was initiated.
        LastUpdateDateTime:
          type: string
          format: date-time
          description: The date and time when the assessment status was last updated.
        Status:
          type: string
          description: The current status of the assessment. Valid values include SUCCESS, FAILED, PENDING, and IN_PROGRESS.
        CustomerDnsIps:
          type: array
          items:
            type: string
          description: The IP addresses of the DNS servers or domain controllers in your self-managed AD environment.
        ReportType:
          type: string
          description: The type of assessment report generated. Valid values include CUSTOMER and SYSTEM.
    DirectoryVpcSettings:
      type: object
      properties:
        VpcId:
          type: string
          description: The identifier of the VPC in which to create the directory.
        SubnetIds:
          type: array
          items:
            type: string
          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.
      required:
      - VpcId
      - SubnetIds
    DescribeADAssessmentRequest:
      type: object
      properties:
        AssessmentId:
          type: string
          description: The identifier of the directory assessment to describe.
      required:
      - AssessmentId
    AssessmentReport:
      type: object
      properties:
        DomainControllerIp:
          type: string
          description: The IP address of the domain controller that was tested during the assessment.
        Validations:
          type: array
          items:
            $ref: '#/components/schemas/AssessmentValidation'
          description: A list of validation results for different test categories performed against this domain controller.
    ListADAssessmentsResult:
      type: object
      properties:
        Assessments:
          type: array
          items:
            $ref: '#/components/schemas/AssessmentSummary'
          description: A list of assessment summaries containing basic information about each directory assessment.
        NextToken:
          type: string
          description: If not null, more results are available. Pass this value for the NextToken parameter in a subsequent request to retrieve the next set of items.
    DeleteADAssessmentResult:
      type: object
      properties:
        AssessmentId:
          type: string
          description: The unique identifier of the deleted directory assessment.
    DeleteADAssessmentRequest:
      type: object
      properties:
        AssessmentId:
          type: string
          description: The unique identifier of the directory assessment to delete.
      required:
      - AssessmentId
    StartADAssessmentRequest:
      type: object
      properties:
        AssessmentConfiguration:
          $ref: '#/components/schemas/AssessmentConfiguration'
        DirectoryId:
          type: string
          description: The identifier of the directory for which to perform the assessment. This should be an existing directory. If the assessment is not for an existing directory, this parameter should be omitted.
    AssessmentConfiguration:
      type: object
      properties:
        CustomerDnsIps:
          type: array
          items:
            type: string
          description: A list of IP addresses for the DNS servers or domain controllers in your self-managed AD that are tested during the assessment.
        DnsName:
          type: string
          description: The fully qualified domain name (FQDN) of the self-managed AD domain to assess.
        VpcSettings:
          $ref: '#/components/schemas/DirectoryVpcSettings'
        InstanceIds:
          type: array
          items:
            type: string
          description: The identifiers of the self-managed instances with SSM that are used to perform connectivity and validation tests.
        SecurityGroupIds:
          type: array
          items:
            type: string
          description: By default, the service attaches a security group to allow network access to the self-managed nodes in your Amazon VPC. You can optionally supply your own security group that allows network traffic to and from your self-managed domain controllers outside of your Amazon VPC.
      required:
      - CustomerDnsIps
      - DnsName
      - VpcSettings
      - InstanceIds
    ServiceException:
      type: object
      properties:
        Message:
          type: string
        RequestId:
          type: string
    ClientException:
      type: object
      properties:
        Message:
          type: string
        RequestId:
          type: string
    DescribeADAssessmentResult:
      type: object
      properties:
        Assessment:
          $ref: '#/components/schemas/Assessment'
        AssessmentReports:
          type: array
          items:
            $ref: '#/components/schemas/AssessmentReport'
          description: A list of assessment reports containing validation results for each domain controller and test category. Each report includes specific validation details and outcomes.
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: ds
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/directory-service/service/2015-04-16/directory-service-2015-04-16.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)