MarketplaceCatalog / Client / describe_assessment

describe_assessment

MarketplaceCatalog.Client.describe_assessment(**kwargs)

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

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

Parameters:

• Catalog (string) –

  [REQUIRED]

  The catalog related to the request. Fixed value: AWSMarketplace

• AssessmentIdentifier (string) –

  [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 (integer) – 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 (string) – The value of the next token, if it exists. null if there are no more results.

Return type:

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.

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

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

Exceptions

• MarketplaceCatalog.Client.exceptions.InternalServiceException

• MarketplaceCatalog.Client.exceptions.AccessDeniedException

• MarketplaceCatalog.Client.exceptions.ValidationException

• MarketplaceCatalog.Client.exceptions.ResourceNotFoundException

• MarketplaceCatalog.Client.exceptions.ThrottlingException