AssessmentSummary - AWS Marketplace
Services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the AWS European Sovereign Cloud Region, see the AWS European Sovereign Cloud User Guide.

AssessmentSummary

Summarized information about an assessment.

Contents

Note

In the following list, the required parameters are described first.

AssessmentArn

The ARN associated with the assessment.

Type: String

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

Pattern: ^[a-zA-Z0-9:*/-]+$

Required: No

AssessmentId

The unique ID of the assessment.

Type: String

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

Pattern: ^[\w\-]+$

Required: No

AssessmentResult

The overall result of the assessment.

Type: String

Valid Values: PASS | FAIL

Required: No

AssessmentTargetSummary

Identifies the entity or change set that was assessed.

Type: AssessmentTargetSummary object

Required: No

CreatedAt

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

Type: String

Length Constraints: Fixed length of 20.

Pattern: ^([\d]{4})\-(1[0-2]|0[1-9])\-(3[01]|0[1-9]|[12][\d])T(2[0-3]|[01][\d]):([0-5][\d]):([0-5][\d])Z$

Required: No

ExpiresAt

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

Type: String

Length Constraints: Fixed length of 20.

Pattern: ^([\d]{4})\-(1[0-2]|0[1-9])\-(3[01]|0[1-9]|[12][\d])T(2[0-3]|[01][\d]):([0-5][\d]):([0-5][\d])Z$

Required: No

FrameworkId

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

Type: String

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

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

Required: No

FrameworkSummary

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

Type: FrameworkSummary object

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

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: