String arn
The Amazon Resource Name (ARN) of the assessment.
AWSAccount awsAccount
The AWS account associated with the assessment.
AssessmentMetadata metadata
The metadata for the specified assessment.
AssessmentFramework framework
The framework from which the assessment was created.
Map<K,V> tags
The tags associated with the assessment.
String id
The identifier for the specified control.
String name
The name of the specified control.
String description
The description of the specified control.
String status
The status of the specified control.
String response
The response of the specified control.
List<E> comments
The list of comments attached to the specified control.
List<E> evidenceSources
The list of data sources for the specified evidence.
Integer evidenceCount
The amount of evidence generated for the control.
Integer assessmentReportEvidenceCount
The amount of evidence in the assessment report.
String id
The identifier of the control set in the assessment. This is the control set name in a plain string format.
String description
The description for the control set.
String status
Specifies the current status of the control set.
List<E> roles
The roles associated with the control set.
List<E> controls
The list of controls contained with the control set.
List<E> delegations
The delegations associated with the control set.
Integer systemEvidenceCount
The total number of evidence objects retrieved automatically for the control set.
Integer manualEvidenceCount
The total number of evidence objects uploaded manually to the control set.
String name
The name of the specified evidence folder.
Date date
The date when the first evidence was added to the evidence folder.
String assessmentId
The identifier for the specified assessment.
String controlSetId
The identifier for the control set.
String controlId
The unique identifier for the specified control.
String id
The identifier for the folder in which evidence is stored.
String dataSource
The AWS service from which the evidence was collected.
String author
The name of the user who created the evidence folder.
Integer totalEvidence
The total amount of evidence in the evidence folder.
Integer assessmentReportSelectionCount
The total count of evidence included in the assessment report.
String controlName
The name of the control.
Integer evidenceResourcesIncludedCount
The amount of evidence included in the evidence folder.
Integer evidenceByTypeConfigurationDataCount
The number of evidence that falls under the configuration data category. This evidence is collected from configuration snapshots of other AWS services such as Amazon EC2, Amazon S3, or IAM.
Integer evidenceByTypeManualCount
The number of evidence that falls under the manual category. This evidence is imported manually.
Integer evidenceByTypeComplianceCheckCount
The number of evidence that falls under the compliance check category. This evidence is collected from AWS Config or AWS Security Hub.
Integer evidenceByTypeComplianceCheckIssuesCount
The total number of issues that were reported directly from AWS Security Hub, AWS Config, or both.
Integer evidenceByTypeUserActivityCount
The number of evidence that falls under the user activity category. This evidence is collected from AWS CloudTrail logs.
Integer evidenceAwsServiceSourceCount
The total number of AWS resources assessed to generate the evidence.
String id
The unique identifier for the framework.
String arn
The Amazon Resource Name (ARN) of the specified framework.
FrameworkMetadata metadata
List<E> controlSets
The control sets associated with the framework.
String id
The unique identified for the specified framework.
String type
The framework type, such as standard or custom.
String name
The name of the specified framework.
String description
The description of the specified framework.
String logo
The logo associated with the framework.
String complianceType
The compliance type that the new custom framework supports, such as CIS or HIPAA.
Integer controlsCount
The number of controls associated with the specified framework.
Integer controlSetsCount
The number of control sets associated with the specified framework.
Date createdAt
Specifies when the framework was created.
Date lastUpdatedAt
Specifies when the framework was most recently updated.
String name
The name of the assessment.
String id
The unique identifier for the assessment.
String description
The description of the assessment.
String complianceType
The name of a compliance standard related to the assessment, such as PCI-DSS.
String status
The overall status of the assessment.
AssessmentReportsDestination assessmentReportsDestination
The destination in which evidence reports are stored for the specified assessment.
Scope scope
The wrapper of AWS accounts and services in scope for the assessment.
List<E> roles
The roles associated with the assessment.
List<E> delegations
The delegations associated with the assessment.
Date creationTime
Specifies when the assessment was created.
Date lastUpdated
The time of the most recent update.
String name
The name of the assessment.
String id
The unique identifier for the assessment.
String complianceType
The name of the compliance standard related to the assessment, such as PCI-DSS.
String status
The current status of the assessment.
List<E> roles
The roles associated with the assessment.
List<E> delegations
The delegations associated with the assessment.
Date creationTime
Specifies when the assessment was created.
Date lastUpdated
The time of the most recent update.
String id
The unique identifier for the specified assessment report.
String name
The name given to the assessment report.
String description
The description of the specified assessment report.
String awsAccountId
The identifier for the specified AWS account.
String assessmentId
The identifier for the specified assessment.
String assessmentName
The name of the associated assessment.
String author
The name of the user who created the assessment report.
String status
The current status of the specified assessment report.
Date creationTime
Specifies when the assessment report was created.
String id
The unique identifier for the assessment report.
String name
The name of the assessment report.
String description
The description of the specified assessment report.
String assessmentId
The unique identifier for the associated assessment.
String assessmentName
The name of the associated assessment.
String author
The name of the user who created the assessment report.
String status
The current status of the assessment report.
Date creationTime
Specifies when the assessment report was created.
String serviceName
The name of the AWS service.
CreateDelegationRequest createDelegationRequest
The API request to batch create delegations in AWS Audit Manager.
String errorCode
The error code returned by the BatchCreateDelegationByAssessment API.
String errorMessage
The error message returned by the BatchCreateDelegationByAssessment API.
ManualEvidence manualEvidence
Manual evidence that cannot be collected automatically by AWS Audit Manager.
String errorCode
The error code returned by the BatchImportEvidenceToAssessmentControl API.
String errorMessage
The error message returned by the BatchImportEvidenceToAssessmentControlError API.
String assessmentId
The identifier for the specified assessment.
String controlSetId
The identifier for the specified control set.
String controlId
The identifier for the specified control.
List<E> manualEvidence
The list of manual evidence objects.
String objectType
The changelog object type, such as an assessment, control, or control set.
String objectName
The name of the changelog object.
String action
The action performed.
Date createdAt
The time of creation for the changelog object.
String createdBy
The IAM user or role that performed the action.
String arn
The Amazon Resource Name (ARN) of the specified control.
String id
The unique identifier for the control.
String type
The type of control, such as custom or standard.
String name
The name of the specified control.
String description
The description of the specified control.
String testingInformation
The steps to follow to determine if the control has been satisfied.
String actionPlanTitle
The title of the action plan for remediating the control.
String actionPlanInstructions
The recommended actions to carry out if the control is not fulfilled.
String controlSources
The data mapping sources for the specified control.
List<E> controlMappingSources
The data mapping sources for the specified control.
Date createdAt
Specifies when the control was created.
Date lastUpdatedAt
Specifies when the control was most recently updated.
String createdBy
The IAM user or role that created the control.
String lastUpdatedBy
The IAM user or role that most recently updated the control.
Map<K,V> tags
The tags associated with the control.
String sourceId
The unique identifier for the specified source.
String sourceName
The name of the specified source.
String sourceDescription
The description of the specified source.
String sourceSetUpOption
The setup option for the data source, which reflects if the evidence collection is automated or manual.
String sourceType
Specifies one of the five types of data sources for evidence collection.
SourceKeyword sourceKeyword
String sourceFrequency
The frequency of evidence collection for the specified control mapping source.
String troubleshootingText
The instructions for troubleshooting the specified control.
String arn
The Amazon Resource Name (ARN) of the specified control.
String id
The unique identifier for the specified control.
String name
The name of the specified control.
String controlSources
The data source that determines from where AWS Audit Manager collects evidence for the control.
Date createdAt
Specifies when the control was created.
Date lastUpdatedAt
Specifies when the control was most recently updated.
String id
The unique identifier of the control.
String name
The name of the new custom framework.
String description
An optional description for the new custom framework.
String complianceType
The compliance type that the new custom framework supports, such as CIS or HIPAA.
List<E> controlSets
The control sets to be associated with the framework.
Framework framework
The name of the new framework returned by the CreateAssessmentFramework API.
AssessmentReport assessmentReport
The new assessment report returned by the CreateAssessmentReport API.
String name
The name of the assessment to be created.
String description
The optional description of the assessment to be created.
AssessmentReportsDestination assessmentReportsDestination
The assessment report storage destination for the specified assessment that is being created.
Scope scope
List<E> roles
The list of roles for the specified assessment.
String frameworkId
The identifier for the specified framework.
Map<K,V> tags
The tags associated with the assessment.
Assessment assessment
String sourceName
The name of the control mapping data source.
String sourceDescription
The description of the data source that determines from where AWS Audit Manager collects evidence for the control.
String sourceSetUpOption
The setup option for the data source, which reflects if the evidence collection is automated or manual.
String sourceType
Specifies one of the five types of data sources for evidence collection.
SourceKeyword sourceKeyword
String sourceFrequency
The frequency of evidence collection for the specified control mapping source.
String troubleshootingText
The instructions for troubleshooting the specified control.
String name
The name of the control.
String description
The description of the control.
String testingInformation
The steps to follow to determine if the control has been satisfied.
String actionPlanTitle
The title of the action plan for remediating the control.
String actionPlanInstructions
The recommended actions to carry out if the control is not fulfilled.
List<E> controlMappingSources
The data source that determines from where AWS Audit Manager collects evidence for the control.
Map<K,V> tags
The tags associated with the control.
Control control
The new control returned by the CreateControl API.
String comment
A comment related to the delegation request.
String controlSetId
The unique identifier for the control set.
String roleArn
The Amazon Resource Name (ARN) of the IAM role.
String roleType
The type of customer persona.
In CreateAssessment, roleType can only be PROCESS_OWNER.
In UpdateSettings, roleType can only be PROCESS_OWNER.
In BatchCreateDelegationByAssessment, roleType can only be RESOURCE_OWNER.
String id
The unique identifier for the delegation.
String assessmentName
The name of the associated assessment.
String assessmentId
The identifier for the associated assessment.
String status
The status of the delegation.
String roleArn
The Amazon Resource Name (ARN) of the IAM role.
String roleType
The type of customer persona.
In CreateAssessment, roleType can only be PROCESS_OWNER.
In UpdateSettings, roleType can only be PROCESS_OWNER.
In BatchCreateDelegationByAssessment, roleType can only be RESOURCE_OWNER.
Date creationTime
Specifies when the delegation was created.
Date lastUpdated
Specifies when the delegation was last updated.
String controlSetId
The identifier for the associated control set.
String comment
The comment related to the delegation.
String createdBy
The IAM user or role that created the delegation.
String id
The unique identifier for the delegation.
String assessmentName
The name of the associated assessment.
String assessmentId
The unique identifier for the specified assessment.
String status
The current status of the delgation.
String roleArn
The Amazon Resource Name (ARN) of the IAM role.
Date creationTime
Specifies when the delegation was created.
String controlSetName
Specifies the name of the control set delegated for review.
String frameworkId
The identifier for the specified framework.
String assessmentId
The identifier for the specified assessment.
String controlId
The identifier for the specified control.
String status
The registration status of the account.
String adminAccountId
The identifier for the specified administrator account.
String dataSource
The data source from which the specified evidence was collected.
String evidenceAwsAccountId
The identifier for the specified AWS account.
Date time
The timestamp that represents when the evidence was collected.
String eventSource
The AWS service from which the evidence is collected.
String eventName
The name of the specified evidence event.
String evidenceByType
The type of automated evidence.
List<E> resourcesIncluded
The list of resources assessed to generate the evidence.
Map<K,V> attributes
The names and values used by the evidence event, including an attribute name (such as
allowUsersToChangePassword) and value (such as true or false).
String iamId
The unique identifier for the IAM user or role associated with the evidence.
String complianceCheck
The evaluation status for evidence that falls under the compliance check category. For evidence collected from AWS Security Hub, a Pass or Fail result is shown. For evidence collected from AWS Config, a Compliant or Noncompliant result is shown.
String awsOrganization
The AWS account from which the evidence is collected, and its AWS organization path.
String awsAccountId
The identifier for the specified AWS account.
String evidenceFolderId
The identifier for the folder in which the evidence is stored.
String id
The identifier for the evidence.
String assessmentReportSelection
Specifies whether the evidence is inclded in the assessment report.
String arn
The Amazon Resource Name (ARN) of the specified framework.
String id
The unique identifier for the specified framework.
String name
The name of the specified framework.
String type
The framework type, such as custom or standard.
String complianceType
The compliance type that the new custom framework supports, such as CIS or HIPAA.
String description
The description of the specified framework.
String logo
The logo associated with the framework.
String controlSources
The sources from which AWS Audit Manager collects evidence for the control.
List<E> controlSets
The control sets associated with the framework.
Date createdAt
Specifies when the framework was created.
Date lastUpdatedAt
Specifies when the framework was most recently updated.
String createdBy
The IAM user or role that created the framework.
String lastUpdatedBy
The IAM user or role that most recently updated the framework.
String status
The status of the specified AWS account.
String frameworkId
The identifier for the specified framework.
Framework framework
The framework returned by the GetAssessmentFramework API.
URL preSignedUrl
String assessmentId
The identifier for the specified assessment.
Assessment assessment
String assessmentId
The identifier for the specified assessment.
String controlSetId
The identifier for the specified control set.
String controlId
The identifier for the specified control.
String nextToken
The pagination token used to fetch the next set of results.
Integer maxResults
Represents the maximum number of results per page, or per API request call.
String controlId
The identifier for the specified control.
Control control
The name of the control returned by the GetControl API.
String assessmentId
The identifier for the specified assessment.
String controlSetId
The identifier for the control set.
String evidenceFolderId
The unique identifier for the folder in which the evidence is stored.
String nextToken
The pagination token used to fetch the next set of results.
Integer maxResults
Represents the maximum number of results per page, or per API request call.
AssessmentEvidenceFolder evidenceFolder
The folder in which evidence is stored.
String assessmentId
The identifier for the specified assessment.
String controlSetId
The identifier for the specified control set.
String controlId
The identifier for the specified control.
String nextToken
The pagination token used to fetch the next set of results.
Integer maxResults
Represents the maximum number of results per page, or per API request call.
String assessmentId
The identifier for the specified assessment.
String controlSetId
The identifier for the specified control set.
String evidenceFolderId
The identifier for the folder in which the evidence is stored.
String evidenceId
The identifier for the evidence.
Evidence evidence
The evidence returned by the GetEvidenceResponse API.
String attribute
The list of SettingAttribute enum values.
Settings settings
The settings object that holds all supported AWS Audit Manager settings.
String resourceArn
The Amazon Resource Name (ARN) of the specified resource.
String s3ResourcePath
The Amazon S3 URL that points to a manual evidence object.
String id
The unique identifier for the notification.
String assessmentId
The identifier for the specified assessment.
String assessmentName
The name of the related assessment.
String controlSetId
The identifier for the specified control set.
String controlSetName
Specifies the name of the control set that the notification is about.
String description
The description of the notification.
Date eventTime
The time when the notification was sent.
String source
The sender of the notification.
String status
The status of the account registration request.
String adminAccountId
The identifier for the specified delegated administrator account.
String roleType
The type of customer persona.
In CreateAssessment, roleType can only be PROCESS_OWNER.
In UpdateSettings, roleType can only be PROCESS_OWNER.
In BatchCreateDelegationByAssessment, roleType can only be RESOURCE_OWNER.
String roleArn
The Amazon Resource Name (ARN) of the IAM role.
String name
The name of the AWS service.
String displayName
The display name of the AWS service.
String description
The description of the specified AWS service.
String category
The category in which the AWS service belongs, such as compute, storage, database, and so on.
Boolean isAwsOrgEnabled
Specifies whether AWS Organizations is enabled.
String snsTopic
The designated Amazon Simple Notification Service (Amazon SNS) topic.
AssessmentReportsDestination defaultAssessmentReportsDestination
The default storage destination for assessment reports.
List<E> defaultProcessOwners
The designated default audit owners.
String kmsKey
The AWS KMS key details.
String assessmentId
The identifier for the specified assessment.
String controlSetId
The identifier for the specified control set.
String controlId
The identifier for the specified control.
String controlStatus
The status of the specified control.
String commentBody
The comment body text for the specified control.
AssessmentControl control
The name of the updated control set returned by the UpdateAssessmentControl API.
AssessmentControlSet controlSet
The name of the updated control set returned by the UpdateAssessmentControlSetStatus API.
String frameworkId
The identifier for the specified framework.
String name
The name of the framework to be updated.
String description
The description of the framework that is to be updated.
String complianceType
The compliance type that the new custom framework supports, such as CIS or HIPAA.
List<E> controlSets
The control sets associated with the framework.
Framework framework
The name of the specified framework.
String assessmentId
The identifier for the specified assessment.
String assessmentName
The name of the specified assessment to be updated.
String assessmentDescription
The description of the specified assessment.
Scope scope
The scope of the specified assessment.
AssessmentReportsDestination assessmentReportsDestination
The assessment report storage destination for the specified assessment that is being updated.
List<E> roles
The list of roles for the specified assessment.
Assessment assessment
The response object (name of the updated assessment) for the UpdateAssessmentRequest API.
Assessment assessment
The name of the updated assessment returned by the UpdateAssessmentStatus API.
String controlId
The identifier for the specified control.
String name
The name of the control to be updated.
String description
The optional description of the control.
String testingInformation
The steps that to follow to determine if the control has been satisfied.
String actionPlanTitle
The title of the action plan for remediating the control.
String actionPlanInstructions
The recommended actions to carry out if the control is not fulfilled.
List<E> controlMappingSources
The data source that determines from where AWS Audit Manager collects evidence for the control.
Control control
The name of the updated control set returned by the UpdateControl API.
String snsTopic
The Amazon Simple Notification Service (Amazon SNS) topic to which AWS Audit Manager sends notifications.
AssessmentReportsDestination defaultAssessmentReportsDestination
The default storage destination for assessment reports.
List<E> defaultProcessOwners
A list of the default audit owners.
String kmsKey
The AWS KMS key details.
Settings settings
The current list of settings.
String s3RelativePath
The relative path of the specified Amazon S3 bucket in which the assessment report is stored.
Boolean signatureValid
Specifies whether the signature key is valid.
String signatureAlgorithm
The signature algorithm used to code sign the assessment report file.
String signatureDateTime
The date and time signature that specifies when the assessment report was created.
String signatureKeyId
The unique identifier for the validation signature key.
List<E> validationErrors
Represents any errors that occurred when validating the assessment report.
Copyright © 2021. All rights reserved.