MarketplaceCatalog / Client / list_assessments

list_assessments¶

MarketplaceCatalog.Client.list_assessments(**kwargs)¶

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

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

Parameters:

Catalog (string) –
[REQUIRED]

The catalog related to the request. Fixed value: AWSMarketplace
FrameworkId (string) – The unique identifier of a framework. When specified, only assessments performed against this framework are returned. For example, AMISecurity.
AssessmentTargetFilter (dict) –
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.
FrameworkFilters (dict) –
Framework-specific filters. Set exactly one member to filter results to assessments performed against that framework.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: AMISecurityFilters, ContainerSecurityFilters.
- 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.
MaxResults (integer) – 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 (string) – The value of the next token, if it exists. null if there are no more results.

Return type:

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.
      Note
      This is a Tagged Union structure. Only one of the following top level keys will be set: AMISecuritySummary, ContainerSecuritySummary. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - 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.

Exceptions

MarketplaceCatalog.Client.exceptions.InternalServiceException
MarketplaceCatalog.Client.exceptions.AccessDeniedException
MarketplaceCatalog.Client.exceptions.ValidationException
MarketplaceCatalog.Client.exceptions.ThrottlingException