Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListAssessments

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

Results are sorted by assessment creation time in descending order.

Request Syntax


POST /ListAssessments HTTP/1.1
Content-type: application/json

{
   "AssessmentTargetFilter": { 
      "ChangeSetId": "string",
      "EntityId": "string"
   },
   "Catalog": "string",
   "FrameworkFilters": { ... },
   "FrameworkId": "string",
   "MaxResults": number,
   "NextToken": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

Catalog

The catalog related to the request. Fixed value: AWSMarketplace

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

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

Required: Yes

AssessmentTargetFilter

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

Type: AssessmentTargetFilter object

Required: No

FrameworkFilters

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

Type: FrameworkFilters object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: No

FrameworkId

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^[\w\-@]+$

Required: No

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.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NextToken

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 4096.

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

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "AssessmentSummaryList": [ 
      { 
         "AssessmentArn": "string",
         "AssessmentId": "string",
         "AssessmentResult": "string",
         "AssessmentTargetSummary": { 
            "ChangeSetId": "string",
            "EntityId": "string"
         },
         "CreatedAt": "string",
         "ExpiresAt": "string",
         "FrameworkId": "string",
         "FrameworkSummary": { ... }
      }
   ],
   "NextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

AssessmentSummaryList

An array of AssessmentSummary objects.

Type: Array of AssessmentSummary objects

NextToken

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 4096.

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

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

Access is denied.

HTTP status code: 403

HTTP Status Code: 403

InternalServiceException

There was an internal service exception.

HTTP status code: 500

HTTP Status Code: 500

ThrottlingException

Too many requests.

HTTP status code: 429

HTTP Status Code: 429

ValidationException

An error occurred during validation.

HTTP status code: 422

HTTP Status Code: 422