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¶

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

Usage¶

marketplacecatalog_describe_assessment(Catalog, AssessmentIdentifier,
  MaxResults, NextToken)

Arguments¶

• Catalog

  [required] The catalog related to the request. Fixed value: AWSMarketplace

• AssessmentIdentifier

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

• MaxResults

  Specifies the upper limit of ControlAssessment elements returned on a single page. If a value isn't provided, the default value is 50. Valid values range from 1 to 100.

• NextToken

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

Value¶

A list with the following syntax:

list(
  AssessmentArn = "string",
  AssessmentId = "string",
  FrameworkId = "string",
  AssessmentTargetSummary = list(
    EntityId = "string",
    ChangeSetId = "string"
  ),
  FrameworkSummary = list(
    AMISecuritySummary = list(
      DeliveryOptionId = "string"
    ),
    ContainerSecuritySummary = list(
      DeliveryOptionId = "string"
    )
  ),
  AssessmentResult = "PASS"|"FAIL",
  CreatedAt = "string",
  ExpiresAt = "string",
  ControlAssessments = list(
    list(
      ControlId = "string",
      ControlAssessmentResult = "PASS"|"FAIL"|"NOT_EXECUTED"|"EXEMPTION_PASS",
      Errors = list(
        list(
          Code = "string",
          Message = "string",
          Scope = list(
            list(
              Name = "string",
              Value = "string"
            )
          )
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$describe_assessment(
  Catalog = "string",
  AssessmentIdentifier = "string",
  MaxResults = 123,
  NextToken = "string"
)