Skip to content

Returns a paginated list of assessments associated with an entity or change set in AWS Marketplace

Description

Returns a paginated list of assessments associated with an entity or change set in AWS Marketplace. An assessment is the result of evaluating a product or change set against a framework, such as AMI Security or Container Security.

Use the AssessmentTargetFilter to scope results to a specific entity or change set, and use FrameworkFilters to scope results to a single framework. To retrieve detailed control-level results for an individual assessment, use the describe_assessment action.

Results are sorted by assessment creation time in descending order.

Usage

marketplacecatalog_list_assessments(Catalog, FrameworkId,
  AssessmentTargetFilter, FrameworkFilters, MaxResults, NextToken)

Arguments

  • Catalog

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

  • FrameworkId

    The unique identifier of a framework. When specified, only assessments performed against this framework are returned. For example, AMISecurity.

  • AssessmentTargetFilter

    Filters the list of assessments to those performed against a specific entity or change set.

  • FrameworkFilters

    Framework-specific filters. Set exactly one member to filter results to assessments performed against that framework.

  • MaxResults

    Specifies the upper limit of the elements on a single page. If a value isn't provided, the default value is 20. 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(
  AssessmentSummaryList = list(
    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"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_assessments(
  Catalog = "string",
  FrameworkId = "string",
  AssessmentTargetFilter = list(
    EntityId = "string",
    ChangeSetId = "string"
  ),
  FrameworkFilters = list(
    AMISecurityFilters = list(
      DeliveryOptionId = "string"
    ),
    ContainerSecurityFilters = list(
      DeliveryOptionId = "string"
    )
  ),
  MaxResults = 123,
  NextToken = "string"
)