describe-assessment¶

Description¶

Returns the metadata and detailed results of a single assessment, including the framework that was evaluated, the overall assessment result, and a paginated list of individual control evaluation results.

To list available assessments before describing one, use the ListAssessments action.

Synopsis¶

  describe-assessment
--catalog <value>
--assessment-identifier <value>
[--starting-token <value>]
[--page-size <value>]
[--max-items <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]
[--cli-error-format <value>]

Options¶

--catalog (string) [required]

The catalog related to the request. Fixed value: AWSMarketplace

Constraints:

min: 1

max: 64

pattern: ^[a-zA-Z]+$

--assessment-identifier (string) [required]

The unique identifier of the assessment to describe. You can provide either the assessment ID (for example, assessment-12345 ) or the full assessment ARN (for example, arn:aws:aws-marketplace:us-east-1::AWSMarketplace/Assessment/assessment-12345 ).

Constraints:

min: 1

max: 2048

pattern: ^(assessment-[a-zA-Z0-9]+|arn:[a-zA-Z0-9-]+:[a-zA-Z0-9-]+:[a-zA-Z0-9-]*:[0-9]*:[a-zA-Z0-9-]+/Assessment/assessment-[a-zA-Z0-9]+)$

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

Constraints:

min: 1

max: 100

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--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
off

--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.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

legacy
json
yaml
text
table
enhanced

Output¶

AssessmentArn -> (string)

The ARN associated with the assessment.

Constraints:

min: 1

max: 2048

pattern: ^[a-zA-Z0-9:*/-]+$

AssessmentId -> (string)

The unique ID of the assessment.

Constraints:

min: 1

max: 255

pattern: ^[\w\-]+$

FrameworkId -> (string)

The identifier of the framework that was evaluated by this assessment, in the format frameworkId@version (for example, AMISecurity@1.0 ).

Constraints:

min: 1

max: 255

pattern: ^[\w\-@.]+$

AssessmentTargetSummary -> (structure)

Identifies the entity or change set that was assessed.

EntityId -> (string)

The unique ID of the entity that was assessed.

Constraints:

min: 1

max: 255

pattern: ^[\w\-]+$

ChangeSetId -> (string)

The unique ID of the change set that was assessed.

Constraints:

min: 1

max: 255

pattern: ^[\w\-]+$

FrameworkSummary -> (tagged union structure)

The framework-specific details of the assessed resource. The set member corresponds to the framework identified by FrameworkId .

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: AMISecuritySummary, ContainerSecuritySummary.

AMISecuritySummary -> (structure)

The details of the resource assessed under the AMI Security framework.

DeliveryOptionId -> (string)

The unique ID of the delivery option that was evaluated.

Constraints:

min: 1

max: 255

pattern: ^[\w\-]+$

ContainerSecuritySummary -> (structure)

The details of the resource assessed under the Container Security framework.

DeliveryOptionId -> (string)

The unique ID of the delivery option that was evaluated.

Constraints:

min: 1

max: 255

pattern: ^[\w\-]+$

AssessmentResult -> (string)

The overall result of the assessment.

Possible values:

PASS

FAIL

CreatedAt -> (string)

The date and time the assessment was created, in ISO 8601 format (2018-02-27T13:45:22Z ).

Constraints:

min: 20

max: 20

pattern: ^([\d]{4})\-(1[0-2]|0[1-9])\-(3[01]|0[1-9]|[12][\d])T(2[0-3]|[01][\d]):([0-5][\d]):([0-5][\d])Z$

ExpiresAt -> (string)

The date and time the assessment expires, in ISO 8601 format (2018-02-27T13:45:22Z ).

Constraints:

min: 20

max: 20

pattern: ^([\d]{4})\-(1[0-2]|0[1-9])\-(3[01]|0[1-9]|[12][\d])T(2[0-3]|[01][\d]):([0-5][\d]):([0-5][\d])Z$

ControlAssessments -> (list)

An array of ControlAssessment objects, each containing the result of an individual control evaluated as part of the assessment.

(structure)

The result of evaluating a single control as part of an assessment.

ControlId -> (string)

The unique ID of the control that was evaluated.

Constraints:

min: 1

max: 255

pattern: ^[\w\-]+$

ControlAssessmentResult -> (string)

The result of the control evaluation.

Possible values:

PASS

FAIL

NOT_EXECUTED

EXEMPTION_PASS

Errors -> (list)

An array of ControlError objects associated with the control evaluation.

(structure)

An error reported during the evaluation of a single control.

Code -> (string)

The error code that identifies the type of error.

Constraints:

min: 1

max: 256

pattern: ^[A-Z_]+$

Message -> (string)

The message for the error.

Constraints:

min: 1

max: 2048

Scope -> (list)

The list of name-value pairs that identify the resource or attribute that the error applies to.

(structure)

A name-value pair that identifies the resource or attribute that a ControlError applies to.

Name -> (string)

The name of the resource field the error applies to (for example, AMI_ID , FILE_PATH , or PACKAGE_NAME ).

Constraints:

min: 1

max: 50

Value -> (string)

The value of the resource field the error applies to.

Constraints:

min: 1

max: 1024

NextToken -> (string)

The value of the next token, if it exists. null if there are no more results.

Constraints:

min: 1

max: 4096

pattern: ^[\w+=.:@\-\/]+$

Table of Contents

Feedback

User Guide