AWS Marketplace Catalog Service

2026/08/18 - AWS Marketplace Catalog Service - 2 new api methods

Changes  Introducing two new APIs, DescribeAssessment and ListAssessments. These APIs expose validation issues on Marketplace resources. The validation issues are exposed via a newly created resource called Assessment.

DescribeAssessment (new) Link ¶

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.

See also: AWS API Documentation

Request Syntax

client.describe_assessment(
    Catalog='string',
    AssessmentIdentifier='string',
    MaxResults=123,
    NextToken='string'
)
type Catalog:

string

param Catalog:

[REQUIRED]

The catalog related to the request. Fixed value: AWSMarketplace

type AssessmentIdentifier:

string

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

type MaxResults:

integer

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

type NextToken:

string

param NextToken:

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

rtype:

dict

returns:

Response Syntax

{
    'AssessmentArn': 'string',
    'AssessmentId': 'string',
    'FrameworkId': 'string',
    'AssessmentTargetSummary': {
        'EntityId': 'string',
        'ChangeSetId': 'string'
    },
    'FrameworkSummary': {
        'AMISecuritySummary': {
            'DeliveryOptionId': 'string'
        },
        'ContainerSecuritySummary': {
            'DeliveryOptionId': 'string'
        }
    },
    'AssessmentResult': 'PASS'|'FAIL',
    'CreatedAt': 'string',
    'ExpiresAt': 'string',
    'ControlAssessments': [
        {
            'ControlId': 'string',
            'ControlAssessmentResult': 'PASS'|'FAIL'|'NOT_EXECUTED'|'EXEMPTION_PASS',
            'Errors': [
                {
                    'Code': 'string',
                    'Message': 'string',
                    'Scope': [
                        {
                            'Name': 'string',
                            'Value': 'string'
                        },
                    ]
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • AssessmentArn (string) --

      The ARN associated with the assessment.

    • AssessmentId (string) --

      The unique ID of the assessment.

    • FrameworkId (string) --

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

    • AssessmentTargetSummary (dict) --

      Identifies the entity or change set that was assessed.

      • EntityId (string) --

        The unique ID of the entity that was assessed.

      • ChangeSetId (string) --

        The unique ID of the change set that was assessed.

    • FrameworkSummary (dict) --

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

      • AMISecuritySummary (dict) --

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

        • DeliveryOptionId (string) --

          The unique ID of the delivery option that was evaluated.

      • ContainerSecuritySummary (dict) --

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

        • DeliveryOptionId (string) --

          The unique ID of the delivery option that was evaluated.

    • AssessmentResult (string) --

      The overall result of the assessment.

    • CreatedAt (string) --

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

    • ExpiresAt (string) --

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

    • ControlAssessments (list) --

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

      • (dict) --

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

        • ControlId (string) --

          The unique ID of the control that was evaluated.

        • ControlAssessmentResult (string) --

          The result of the control evaluation.

        • Errors (list) --

          An array of ControlError objects associated with the control evaluation.

          • (dict) --

            An error reported during the evaluation of a single control.

            • Code (string) --

              The error code that identifies the type of error.

            • Message (string) --

              The message for the error.

            • Scope (list) --

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

              • (dict) --

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

                • Value (string) --

                  The value of the resource field the error applies to.

    • NextToken (string) --

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

ListAssessments (new) Link ¶

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.

See also: AWS API Documentation

Request Syntax

client.list_assessments(
    Catalog='string',
    FrameworkId='string',
    AssessmentTargetFilter={
        'EntityId': 'string',
        'ChangeSetId': 'string'
    },
    FrameworkFilters={
        'AMISecurityFilters': {
            'DeliveryOptionId': 'string'
        },
        'ContainerSecurityFilters': {
            'DeliveryOptionId': 'string'
        }
    },
    MaxResults=123,
    NextToken='string'
)
type Catalog:

string

param Catalog:

[REQUIRED]

The catalog related to the request. Fixed value: AWSMarketplace

type FrameworkId:

string

param FrameworkId:

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

type AssessmentTargetFilter:

dict

param AssessmentTargetFilter:

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

  • EntityId (string) --

    The unique ID of the entity whose assessments you want to list.

  • ChangeSetId (string) --

    The unique ID of the change set that triggered the assessments you want to list.

type FrameworkFilters:

dict

param FrameworkFilters:

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

  • AMISecurityFilters (dict) --

    Filters that apply to assessments performed against the AMI Security framework.

    • DeliveryOptionId (string) --

      The unique ID of the delivery option whose AMI Security assessments you want to list.

  • ContainerSecurityFilters (dict) --

    Filters that apply to assessments performed against the Container Security framework.

    • DeliveryOptionId (string) --

      The unique ID of the delivery option whose Container Security assessments you want to list.

type MaxResults:

integer

param 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 NextToken:

string

param NextToken:

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

rtype:

dict

returns:

Response Syntax

{
    'AssessmentSummaryList': [
        {
            'AssessmentArn': 'string',
            'AssessmentId': 'string',
            'FrameworkId': 'string',
            'AssessmentTargetSummary': {
                'EntityId': 'string',
                'ChangeSetId': 'string'
            },
            'FrameworkSummary': {
                'AMISecuritySummary': {
                    'DeliveryOptionId': 'string'
                },
                'ContainerSecuritySummary': {
                    'DeliveryOptionId': 'string'
                }
            },
            'AssessmentResult': 'PASS'|'FAIL',
            'CreatedAt': 'string',
            'ExpiresAt': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • AssessmentSummaryList (list) --

      An array of AssessmentSummary objects.

      • (dict) --

        Summarized information about an assessment.

        • AssessmentArn (string) --

          The ARN associated with the assessment.

        • AssessmentId (string) --

          The unique ID of the assessment.

        • FrameworkId (string) --

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

        • AssessmentTargetSummary (dict) --

          Identifies the entity or change set that was assessed.

          • EntityId (string) --

            The unique ID of the entity that was assessed.

          • ChangeSetId (string) --

            The unique ID of the change set that was assessed.

        • FrameworkSummary (dict) --

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

          • AMISecuritySummary (dict) --

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

            • DeliveryOptionId (string) --

              The unique ID of the delivery option that was evaluated.

          • ContainerSecuritySummary (dict) --

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

            • DeliveryOptionId (string) --

              The unique ID of the delivery option that was evaluated.

        • AssessmentResult (string) --

          The overall result of the assessment.

        • CreatedAt (string) --

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

        • ExpiresAt (string) --

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

    • NextToken (string) --

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