[ aws . ds ]

describe-ad-assessment

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.

See also: AWS API Documentation

Synopsis

  describe-ad-assessment
--assessment-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--assessment-id (string)

The identifier of the directory assessment to describe.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table
• yaml
• yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

Assessment -> (structure)

Detailed information about the self-managed instance settings (IDs and DNS IPs).

AssessmentId -> (string)

The unique identifier of the directory assessment.

DirectoryId -> (string)

The identifier of the directory associated with this assessment.

DnsName -> (string)

The fully qualified domain name (FQDN) of the Active Directory domain being assessed.

StartTime -> (timestamp)

The date and time when the assessment was initiated.

LastUpdateDateTime -> (timestamp)

The date and time when the assessment status was last updated.

Status -> (string)

The current status of the assessment. Valid values include SUCCESS , FAILED , PENDING , and IN_PROGRESS .

StatusCode -> (string)

A detailed status code providing additional information about the assessment state.

StatusReason -> (string)

A human-readable description of the current assessment status, including any error details or progress information.

CustomerDnsIps -> (list)

The IP addresses of the DNS servers or domain controllers in your self-managed AD environment.

(string)

VpcId -> (string)

Contains Amazon VPC information for the StartADAssessment operation.

SubnetIds -> (list)

A list of subnet identifiers in the Amazon VPC in which the hybrid directory is created.

(string)

SecurityGroupIds -> (list)

The security groups identifiers attached to the network interfaces.

(string)

SelfManagedInstanceIds -> (list)

The identifiers of the self-managed AD instances used to perform the assessment.

(string)

ReportType -> (string)

The type of assessment report generated. Valid values are CUSTOMER and SYSTEM .

Version -> (string)

The version of the assessment framework used to evaluate your self-managed AD environment.

AssessmentReports -> (list)

A list of assessment reports containing validation results for each domain controller and test category. Each report includes specific validation details and outcomes.

(structure)

Contains the results of validation tests performed against a specific domain controller during a directory assessment.

DomainControllerIp -> (string)

The IP address of the domain controller that was tested during the assessment.

Validations -> (list)

A list of validation results for different test categories performed against this domain controller.

(structure)

Contains information about a specific validation test performed during a directory assessment.

Category -> (string)

The category of the validation test.

Name -> (string)

The name of the specific validation test performed within the category.

Status -> (string)

The result status of the validation test. Valid values include SUCCESS , FAILED , PENDING , and IN_PROGRESS .

StatusCode -> (string)

A detailed status code providing additional information about the validation result.

StatusReason -> (string)

A human-readable description of the validation result, including any error details or recommendations.

StartTime -> (timestamp)

The date and time when the validation test was started.

LastUpdateDateTime -> (timestamp)

The date and time when the validation test was completed or last updated.