AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Classes

NameDescription
Class AccessDeniedException

Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again.

Class Assessment

An entity that defines the scope of audit evidence collected by Audit Manager. An Audit Manager assessment is an implementation of an Audit Manager framework.

Class AssessmentControl

The control entity that represents a standard control or a custom control in an Audit Manager assessment.

Class AssessmentControlSet

Represents a set of controls in an Audit Manager assessment.

Class AssessmentEvidenceFolder

The folder where Audit Manager stores evidence for an assessment.

Class AssessmentFramework

The file used to structure and automate Audit Manager assessments for a given compliance standard.

Class AssessmentFrameworkMetadata

The metadata that's associated with a standard framework or a custom framework.

Class AssessmentFrameworkShareRequest

Represents a share request for a custom framework in Audit Manager.

Class AssessmentMetadata

The metadata that's associated with the specified assessment.

Class AssessmentMetadataItem

A metadata object that's associated with an assessment in Audit Manager.

Class AssessmentReport

A finalized document that's generated from an Audit Manager assessment. These reports summarize the relevant evidence that was collected for your audit, and link to the relevant evidence folders. These evidence folders are named and organized according to the controls that are specified in your assessment.

Class AssessmentReportEvidenceError

An error entity for assessment report evidence errors. This is used to provide more meaningful errors than a simple string message.

Class AssessmentReportMetadata

The metadata objects that are associated with the specified assessment report.

Class AssessmentReportsDestination

The location where Audit Manager saves assessment reports for the given assessment.

Class AssociateAssessmentReportEvidenceFolderRequest

Container for the parameters to the AssociateAssessmentReportEvidenceFolder operation. Associates an evidence folder to an assessment report in an Audit Manager assessment.

Class AssociateAssessmentReportEvidenceFolderResponse

This is the response object from the AssociateAssessmentReportEvidenceFolder operation.

Class AuditManagerPaginatorFactory

Paginators for the AuditManager service

Class AWSAccount

The wrapper of Amazon Web Services account details, such as account ID or email address.

Class AWSService

An Amazon Web Service such as Amazon S3 or CloudTrail.

For an example of how to find an Amazon Web Service name and how to define it in your assessment scope, see the following:

Class BatchAssociateAssessmentReportEvidenceRequest

Container for the parameters to the BatchAssociateAssessmentReportEvidence operation. Associates a list of evidence to an assessment report in an Audit Manager assessment.

Class BatchAssociateAssessmentReportEvidenceResponse

This is the response object from the BatchAssociateAssessmentReportEvidence operation.

Class BatchCreateDelegationByAssessmentError

An error entity for the BatchCreateDelegationByAssessment API. This is used to provide more meaningful errors than a simple string message.

Class BatchCreateDelegationByAssessmentRequest

Container for the parameters to the BatchCreateDelegationByAssessment operation. Creates a batch of delegations for an assessment in Audit Manager.

Class BatchCreateDelegationByAssessmentResponse

This is the response object from the BatchCreateDelegationByAssessment operation.

Class BatchDeleteDelegationByAssessmentError

An error entity for the BatchDeleteDelegationByAssessment API. This is used to provide more meaningful errors than a simple string message.

Class BatchDeleteDelegationByAssessmentRequest

Container for the parameters to the BatchDeleteDelegationByAssessment operation. Deletes a batch of delegations for an assessment in Audit Manager.

Class BatchDeleteDelegationByAssessmentResponse

This is the response object from the BatchDeleteDelegationByAssessment operation.

Class BatchDisassociateAssessmentReportEvidenceRequest

Container for the parameters to the BatchDisassociateAssessmentReportEvidence operation. Disassociates a list of evidence from an assessment report in Audit Manager.

Class BatchDisassociateAssessmentReportEvidenceResponse

This is the response object from the BatchDisassociateAssessmentReportEvidence operation.

Class BatchImportEvidenceToAssessmentControlError

An error entity for the BatchImportEvidenceToAssessmentControl API. This is used to provide more meaningful errors than a simple string message.

Class BatchImportEvidenceToAssessmentControlRequest

Container for the parameters to the BatchImportEvidenceToAssessmentControl operation. Adds one or more pieces of evidence to a control in an Audit Manager assessment.

You can import manual evidence from any S3 bucket by specifying the S3 URI of the object. You can also upload a file from your browser, or enter plain text in response to a risk assessment question.

The following restrictions apply to this action:

  • manualEvidence can be only one of the following: evidenceFileName, s3ResourcePath, or textResponse

  • Maximum size of an individual evidence file: 100 MB

  • Number of daily manual evidence uploads per control: 100

  • Supported file formats: See Supported file types for manual evidence in the Audit Manager User Guide

For more information about Audit Manager service restrictions, see Quotas and restrictions for Audit Manager.

Class BatchImportEvidenceToAssessmentControlResponse

This is the response object from the BatchImportEvidenceToAssessmentControl operation.

Class ChangeLog

The record of a change within Audit Manager. For example, this could be the status change of an assessment or the delegation of a control set.

Class Control

A control in Audit Manager.

Class ControlComment

A comment that's posted by a user on a control. This includes the author's name, the comment text, and a timestamp.

Class ControlDomainInsights

A summary of the latest analytics data for a specific control domain.

Control domain insights are grouped by control domain, and ranked by the highest total count of non-compliant evidence.

Class ControlInsightsMetadataByAssessmentItem

A summary of the latest analytics data for a specific control in a specific active assessment.

Control insights are grouped by control domain, and ranked by the highest total count of non-compliant evidence.

Class ControlInsightsMetadataItem

A summary of the latest analytics data for a specific control.

This data reflects the total counts for the specified control across all active assessments. Control insights are grouped by control domain, and ranked by the highest total count of non-compliant evidence.

Class ControlMappingSource

The data source that determines where Audit Manager collects evidence from for the control.

Class ControlMetadata

The metadata that's associated with the standard control or custom control.

Class ControlSet

A set of controls in Audit Manager.

Class CreateAssessmentFrameworkControl

The control entity attributes that uniquely identify an existing control to be added to a framework in Audit Manager.

Class CreateAssessmentFrameworkControlSet

A controlSet entity that represents a collection of controls in Audit Manager. This doesn't contain the control set ID.

Class CreateAssessmentFrameworkRequest

Container for the parameters to the CreateAssessmentFramework operation. Creates a custom framework in Audit Manager.

Class CreateAssessmentFrameworkResponse

This is the response object from the CreateAssessmentFramework operation.

Class CreateAssessmentReportRequest

Container for the parameters to the CreateAssessmentReport operation. Creates an assessment report for the specified assessment.

Class CreateAssessmentReportResponse

This is the response object from the CreateAssessmentReport operation.

Class CreateAssessmentRequest

Container for the parameters to the CreateAssessment operation. Creates an assessment in Audit Manager.

Class CreateAssessmentResponse

This is the response object from the CreateAssessment operation.

Class CreateControlMappingSource

The control mapping fields that represent the source for evidence collection, along with related parameters and metadata. This doesn't contain mappingID.

Class CreateControlRequest

Container for the parameters to the CreateControl operation. Creates a new custom control in Audit Manager.

Class CreateControlResponse

This is the response object from the CreateControl operation.

Class CreateDelegationRequest

A collection of attributes that's used to create a delegation for an assessment in Audit Manager.

Class DefaultExportDestination

The default s3 bucket where Audit Manager saves the files that you export from evidence finder.

Class Delegation

The assignment of a control set to a delegate for review.

Class DelegationMetadata

The metadata that's associated with the delegation.

Class DeleteAssessmentFrameworkRequest

Container for the parameters to the DeleteAssessmentFramework operation. Deletes a custom framework in Audit Manager.

Class DeleteAssessmentFrameworkResponse

This is the response object from the DeleteAssessmentFramework operation.

Class DeleteAssessmentFrameworkShareRequest

Container for the parameters to the DeleteAssessmentFrameworkShare operation. Deletes a share request for a custom framework in Audit Manager.

Class DeleteAssessmentFrameworkShareResponse

This is the response object from the DeleteAssessmentFrameworkShare operation.

Class DeleteAssessmentReportRequest

Container for the parameters to the DeleteAssessmentReport operation. Deletes an assessment report in Audit Manager.

When you run the DeleteAssessmentReport operation, Audit Manager attempts to delete the following data:

  1. The specified assessment report that’s stored in your S3 bucket

  2. The associated metadata that’s stored in Audit Manager

If Audit Manager can’t access the assessment report in your S3 bucket, the report isn’t deleted. In this event, the DeleteAssessmentReport operation doesn’t fail. Instead, it proceeds to delete the associated metadata only. You must then delete the assessment report from the S3 bucket yourself.

This scenario happens when Audit Manager receives a 403 (Forbidden) or 404 (Not Found) error from Amazon S3. To avoid this, make sure that your S3 bucket is available, and that you configured the correct permissions for Audit Manager to delete resources in your S3 bucket. For an example permissions policy that you can use, see Assessment report destination permissions in the Audit Manager User Guide. For information about the issues that could cause a 403 (Forbidden) or 404 (Not Found) error from Amazon S3, see List of Error Codes in the Amazon Simple Storage Service API Reference.

Class DeleteAssessmentReportResponse

This is the response object from the DeleteAssessmentReport operation.

Class DeleteAssessmentRequest

Container for the parameters to the DeleteAssessment operation. Deletes an assessment in Audit Manager.

Class DeleteAssessmentResponse

This is the response object from the DeleteAssessment operation.

Class DeleteControlRequest

Container for the parameters to the DeleteControl operation. Deletes a custom control in Audit Manager.

When you invoke this operation, the custom control is deleted from any frameworks or assessments that it’s currently part of. As a result, Audit Manager will stop collecting evidence for that custom control in all of your assessments. This includes assessments that you previously created before you deleted the custom control.

Class DeleteControlResponse

This is the response object from the DeleteControl operation.

Class DeregisterAccountRequest

Container for the parameters to the DeregisterAccount operation. Deregisters an account in Audit Manager.

Before you deregister, you can use the UpdateSettings API operation to set your preferred data retention policy. By default, Audit Manager retains your data. If you want to delete your data, you can use the DeregistrationPolicy attribute to request the deletion of your data.

For more information about data retention, see Data Protection in the Audit Manager User Guide.

Class DeregisterAccountResponse

This is the response object from the DeregisterAccount operation.

Class DeregisterOrganizationAdminAccountRequest

Container for the parameters to the DeregisterOrganizationAdminAccount operation. Removes the specified Amazon Web Services account as a delegated administrator for Audit Manager.

When you remove a delegated administrator from your Audit Manager settings, you continue to have access to the evidence that you previously collected under that account. This is also the case when you deregister a delegated administrator from Organizations. However, Audit Manager stops collecting and attaching evidence to that delegated administrator account moving forward.

Keep in mind the following cleanup task if you use evidence finder:

Before you use your management account to remove a delegated administrator, make sure that the current delegated administrator account signs in to Audit Manager and disables evidence finder first. Disabling evidence finder automatically deletes the event data store that was created in their account when they enabled evidence finder. If this task isn’t completed, the event data store remains in their account. In this case, we recommend that the original delegated administrator goes to CloudTrail Lake and manually deletes the event data store.

This cleanup task is necessary to ensure that you don't end up with multiple event data stores. Audit Manager ignores an unused event data store after you remove or change a delegated administrator account. However, the unused event data store continues to incur storage costs from CloudTrail Lake if you don't delete it.

When you deregister a delegated administrator account for Audit Manager, the data for that account isn’t deleted. If you want to delete resource data for a delegated administrator account, you must perform that task separately before you deregister the account. Either, you can do this in the Audit Manager console. Or, you can use one of the delete API operations that are provided by Audit Manager.

To delete your Audit Manager resource data, see the following instructions:

At this time, Audit Manager doesn't provide an option to delete evidence for a specific delegated administrator. Instead, when your management account deregisters Audit Manager, we perform a cleanup for the current delegated administrator account at the time of deregistration.

Class DeregisterOrganizationAdminAccountResponse

This is the response object from the DeregisterOrganizationAdminAccount operation.

Class DeregistrationPolicy

The deregistration policy for the data that's stored in Audit Manager. You can use this attribute to determine how your data is handled when you deregister Audit Manager.

By default, Audit Manager retains evidence data for two years from the time of its creation. Other Audit Manager resources (including assessments, custom controls, and custom frameworks) remain in Audit Manager indefinitely, and are available if you re-register Audit Manager in the future. For more information about data retention, see Data Protection in the Audit Manager User Guide.

If you choose to delete all data, this action permanently deletes all evidence data in your account within seven days. It also deletes all of the Audit Manager resources that you created, including assessments, custom controls, and custom frameworks. Your data will not be available if you re-register Audit Manager in the future.

Class DisassociateAssessmentReportEvidenceFolderRequest

Container for the parameters to the DisassociateAssessmentReportEvidenceFolder operation. Disassociates an evidence folder from the specified assessment report in Audit Manager.

Class DisassociateAssessmentReportEvidenceFolderResponse

This is the response object from the DisassociateAssessmentReportEvidenceFolder operation.

Class Evidence

A record that contains the information needed to demonstrate compliance with the requirements specified by a control. Examples of evidence include change activity invoked by a user, or a system configuration snapshot.

Class EvidenceFinderEnablement

The settings object that specifies whether evidence finder is enabled. This object also describes the related event data store, and the backfill status for populating the event data store with evidence data.

Class EvidenceInsights

A breakdown of the latest compliance check status for the evidence in your Audit Manager assessments.

Class Framework

The file that's used to structure and automate Audit Manager assessments for a given compliance standard.

Class FrameworkMetadata

The metadata of a framework, such as the name, ID, or description.

Class GetAccountStatusRequest

Container for the parameters to the GetAccountStatus operation. Gets the registration status of an account in Audit Manager.

Class GetAccountStatusResponse

This is the response object from the GetAccountStatus operation.

Class GetAssessmentFrameworkRequest

Container for the parameters to the GetAssessmentFramework operation. Gets information about a specified framework.

Class GetAssessmentFrameworkResponse

This is the response object from the GetAssessmentFramework operation.

Class GetAssessmentReportUrlRequest

Container for the parameters to the GetAssessmentReportUrl operation. Gets the URL of an assessment report in Audit Manager.

Class GetAssessmentReportUrlResponse

This is the response object from the GetAssessmentReportUrl operation.

Class GetAssessmentRequest

Container for the parameters to the GetAssessment operation. Gets information about a specified assessment.

Class GetAssessmentResponse

This is the response object from the GetAssessment operation.

Class GetChangeLogsRequest

Container for the parameters to the GetChangeLogs operation. Gets a list of changelogs from Audit Manager.

Class GetChangeLogsResponse

This is the response object from the GetChangeLogs operation.

Class GetControlRequest

Container for the parameters to the GetControl operation. Gets information about a specified control.

Class GetControlResponse

This is the response object from the GetControl operation.

Class GetDelegationsRequest

Container for the parameters to the GetDelegations operation. Gets a list of delegations from an audit owner to a delegate.

Class GetDelegationsResponse

This is the response object from the GetDelegations operation.

Class GetEvidenceByEvidenceFolderRequest

Container for the parameters to the GetEvidenceByEvidenceFolder operation. Gets all evidence from a specified evidence folder in Audit Manager.

Class GetEvidenceByEvidenceFolderResponse

This is the response object from the GetEvidenceByEvidenceFolder operation.

Class GetEvidenceFileUploadUrlRequest

Container for the parameters to the GetEvidenceFileUploadUrl operation. Creates a presigned Amazon S3 URL that can be used to upload a file as manual evidence. For instructions on how to use this operation, see Upload a file from your browser in the Audit Manager User Guide.

The following restrictions apply to this operation:

  • Maximum size of an individual evidence file: 100 MB

  • Number of daily manual evidence uploads per control: 100

  • Supported file formats: See Supported file types for manual evidence in the Audit Manager User Guide

For more information about Audit Manager service restrictions, see Quotas and restrictions for Audit Manager.

Class GetEvidenceFileUploadUrlResponse

This is the response object from the GetEvidenceFileUploadUrl operation.

Class GetEvidenceFolderRequest

Container for the parameters to the GetEvidenceFolder operation. Gets an evidence folder from a specified assessment in Audit Manager.

Class GetEvidenceFolderResponse

This is the response object from the GetEvidenceFolder operation.

Class GetEvidenceFoldersByAssessmentControlRequest

Container for the parameters to the GetEvidenceFoldersByAssessmentControl operation. Gets a list of evidence folders that are associated with a specified control in an Audit Manager assessment.

Class GetEvidenceFoldersByAssessmentControlResponse

This is the response object from the GetEvidenceFoldersByAssessmentControl operation.

Class GetEvidenceFoldersByAssessmentRequest

Container for the parameters to the GetEvidenceFoldersByAssessment operation. Gets the evidence folders from a specified assessment in Audit Manager.

Class GetEvidenceFoldersByAssessmentResponse

This is the response object from the GetEvidenceFoldersByAssessment operation.

Class GetEvidenceRequest

Container for the parameters to the GetEvidence operation. Gets information about a specified evidence item.

Class GetEvidenceResponse

This is the response object from the GetEvidence operation.

Class GetInsightsByAssessmentRequest

Container for the parameters to the GetInsightsByAssessment operation. Gets the latest analytics data for a specific active assessment.

Class GetInsightsByAssessmentResponse

This is the response object from the GetInsightsByAssessment operation.

Class GetInsightsRequest

Container for the parameters to the GetInsights operation. Gets the latest analytics data for all your current active assessments.

Class GetInsightsResponse

This is the response object from the GetInsights operation.

Class GetOrganizationAdminAccountRequest

Container for the parameters to the GetOrganizationAdminAccount operation. Gets the name of the delegated Amazon Web Services administrator account for a specified organization.

Class GetOrganizationAdminAccountResponse

This is the response object from the GetOrganizationAdminAccount operation.

Class GetServicesInScopeRequest

Container for the parameters to the GetServicesInScope operation. Gets a list of all of the Amazon Web Services that you can choose to include in your assessment. When you create an assessment, specify which of these services you want to include to narrow the assessment's scope.

Class GetServicesInScopeResponse

This is the response object from the GetServicesInScope operation.

Class GetSettingsRequest

Container for the parameters to the GetSettings operation. Gets the settings for a specified Amazon Web Services account.

Class GetSettingsResponse

This is the response object from the GetSettings operation.

Class Insights

A summary of the latest analytics data for all your active assessments.

This summary is a snapshot of the data that your active assessments collected on the lastUpdated date. It’s important to understand that the following totals are daily counts based on this date — they aren’t a total sum to date.

The Insights data is eventually consistent. This means that, when you read data from Insights, the response might not instantly reflect the results of a recently completed write or update operation. If you repeat your read request after a few hours, the response should return the latest data.

If you delete an assessment or change its status to inactive, InsightsByAssessment includes data for that assessment as follows.

  • Inactive assessments - If Audit Manager collected evidence for your assessment before you changed it inactive, that evidence is included in the InsightsByAssessment counts for that day.

  • Deleted assessments - If Audit Manager collected evidence for your assessment before you deleted it, that evidence isn't included in the InsightsByAssessment counts for that day.

Class InsightsByAssessment

A summary of the latest analytics data for a specific active assessment.

This summary is a snapshot of the data that was collected on the lastUpdated date. It’s important to understand that the totals in InsightsByAssessment are daily counts based on this date — they aren’t a total sum to date.

The InsightsByAssessment data is eventually consistent. This means that when you read data from InsightsByAssessment, the response might not instantly reflect the results of a recently completed write or update operation. If you repeat your read request after a few hours, the response returns the latest data.

If you delete an assessment or change its status to inactive, InsightsByAssessment includes data for that assessment as follows.

  • Inactive assessments - If Audit Manager collected evidence for your assessment before you changed it inactive, that evidence is included in the InsightsByAssessment counts for that day.

  • Deleted assessments - If Audit Manager collected evidence for your assessment before you deleted it, that evidence isn't included in the InsightsByAssessment counts for that day.

Class InternalServerException

An internal service error occurred during the processing of your request. Try again later.

Class ListAssessmentControlInsightsByControlDomainRequest

Container for the parameters to the ListAssessmentControlInsightsByControlDomain operation. Lists the latest analytics data for controls within a specific control domain and a specific active assessment.

Control insights are listed only if the control belongs to the control domain and assessment that was specified. Moreover, the control must have collected evidence on the lastUpdated date of controlInsightsByAssessment. If neither of these conditions are met, no data is listed for that control.

Class ListAssessmentControlInsightsByControlDomainResponse

This is the response object from the ListAssessmentControlInsightsByControlDomain operation.

Class ListAssessmentFrameworkShareRequestsRequest

Container for the parameters to the ListAssessmentFrameworkShareRequests operation. Returns a list of sent or received share requests for custom frameworks in Audit Manager.

Class ListAssessmentFrameworkShareRequestsResponse

This is the response object from the ListAssessmentFrameworkShareRequests operation.

Class ListAssessmentFrameworksRequest

Container for the parameters to the ListAssessmentFrameworks operation. Returns a list of the frameworks that are available in the Audit Manager framework library.

Class ListAssessmentFrameworksResponse

This is the response object from the ListAssessmentFrameworks operation.

Class ListAssessmentReportsRequest

Container for the parameters to the ListAssessmentReports operation. Returns a list of assessment reports created in Audit Manager.

Class ListAssessmentReportsResponse

This is the response object from the ListAssessmentReports operation.

Class ListAssessmentsRequest

Container for the parameters to the ListAssessments operation. Returns a list of current and past assessments from Audit Manager.

Class ListAssessmentsResponse

This is the response object from the ListAssessments operation.

Class ListControlDomainInsightsByAssessmentRequest

Container for the parameters to the ListControlDomainInsightsByAssessment operation. Lists analytics data for control domains within a specified active assessment.

A control domain is listed only if at least one of the controls within that domain collected evidence on the lastUpdated date of controlDomainInsights. If this condition isn’t met, no data is listed for that domain.

Class ListControlDomainInsightsByAssessmentResponse

This is the response object from the ListControlDomainInsightsByAssessment operation.

Class ListControlDomainInsightsRequest

Container for the parameters to the ListControlDomainInsights operation. Lists the latest analytics data for control domains across all of your active assessments.

A control domain is listed only if at least one of the controls within that domain collected evidence on the lastUpdated date of controlDomainInsights. If this condition isn’t met, no data is listed for that control domain.

Class ListControlDomainInsightsResponse

This is the response object from the ListControlDomainInsights operation.

Class ListControlInsightsByControlDomainRequest

Container for the parameters to the ListControlInsightsByControlDomain operation. Lists the latest analytics data for controls within a specific control domain across all active assessments.

Control insights are listed only if the control belongs to the control domain that was specified and the control collected evidence on the lastUpdated date of controlInsightsMetadata. If neither of these conditions are met, no data is listed for that control.

Class ListControlInsightsByControlDomainResponse

This is the response object from the ListControlInsightsByControlDomain operation.

Class ListControlsRequest

Container for the parameters to the ListControls operation. Returns a list of controls from Audit Manager.

Class ListControlsResponse

This is the response object from the ListControls operation.

Class ListKeywordsForDataSourceRequest

Container for the parameters to the ListKeywordsForDataSource operation. Returns a list of keywords that are pre-mapped to the specified control data source.

Class ListKeywordsForDataSourceResponse

This is the response object from the ListKeywordsForDataSource operation.

Class ListNotificationsRequest

Container for the parameters to the ListNotifications operation. Returns a list of all Audit Manager notifications.

Class ListNotificationsResponse

This is the response object from the ListNotifications operation.

Class ListTagsForResourceRequest

Container for the parameters to the ListTagsForResource operation. Returns a list of tags for the specified resource in Audit Manager.

Class ListTagsForResourceResponse

This is the response object from the ListTagsForResource operation.

Class ManualEvidence

Evidence that's manually added to a control in Audit Manager. manualEvidence can be one of the following: evidenceFileName, s3ResourcePath, or textResponse.

Class Notification

The notification that informs a user of an update in Audit Manager. For example, this includes the notification that's sent when a control set is delegated for review.

Class RegisterAccountRequest

Container for the parameters to the RegisterAccount operation. Enables Audit Manager for the specified Amazon Web Services account.

Class RegisterAccountResponse

This is the response object from the RegisterAccount operation.

Class RegisterOrganizationAdminAccountRequest

Container for the parameters to the RegisterOrganizationAdminAccount operation. Enables an Amazon Web Services account within the organization as the delegated administrator for Audit Manager.

Class RegisterOrganizationAdminAccountResponse

This is the response object from the RegisterOrganizationAdminAccount operation.

Class Resource

A system asset that's evaluated in an Audit Manager assessment.

Class ResourceNotFoundException

The resource that's specified in the request can't be found.

Class Role

The wrapper that contains the Audit Manager role information of the current user. This includes the role type and IAM Amazon Resource Name (ARN).

Class Scope

The wrapper that contains the Amazon Web Services accounts and services that are in scope for the assessment.

Class ServiceMetadata

The metadata that's associated with the Amazon Web Service.

Class ServiceQuotaExceededException

You've reached your account quota for this resource type. To perform the requested action, delete some existing resources or request a quota increase from the Service Quotas console. For a list of Audit Manager service quotas, see Quotas and restrictions for Audit Manager.

Class Settings

The settings object that holds all supported Audit Manager settings.

Class SourceKeyword

A keyword that relates to the control data source.

For manual evidence, this keyword indicates if the manual evidence is a file or text.

For automated evidence, this keyword identifies a specific CloudTrail event, Config rule, Security Hub control, or Amazon Web Services API name.

To learn more about the supported keywords that you can use when mapping a control data source, see the following pages in the Audit Manager User Guide:

Class StartAssessmentFrameworkShareRequest

Container for the parameters to the StartAssessmentFrameworkShare operation. Creates a share request for a custom framework in Audit Manager.

The share request specifies a recipient and notifies them that a custom framework is available. Recipients have 120 days to accept or decline the request. If no action is taken, the share request expires.

When you create a share request, Audit Manager stores a snapshot of your custom framework in the US East (N. Virginia) Amazon Web Services Region. Audit Manager also stores a backup of the same snapshot in the US West (Oregon) Amazon Web Services Region.

Audit Manager deletes the snapshot and the backup snapshot when one of the following events occurs:

  • The sender revokes the share request.

  • The recipient declines the share request.

  • The recipient encounters an error and doesn't successfully accept the share request.

  • The share request expires before the recipient responds to the request.

When a sender resends a share request, the snapshot is replaced with an updated version that corresponds with the latest version of the custom framework.

When a recipient accepts a share request, the snapshot is replicated into their Amazon Web Services account under the Amazon Web Services Region that was specified in the share request.

When you invoke the StartAssessmentFrameworkShare API, you are about to share a custom framework with another Amazon Web Services account. You may not share a custom framework that is derived from a standard framework if the standard framework is designated as not eligible for sharing by Amazon Web Services, unless you have obtained permission to do so from the owner of the standard framework. To learn more about which standard frameworks are eligible for sharing, see Framework sharing eligibility in the Audit Manager User Guide.

Class StartAssessmentFrameworkShareResponse

This is the response object from the StartAssessmentFrameworkShare operation.

Class TagResourceRequest

Container for the parameters to the TagResource operation. Tags the specified resource in Audit Manager.

Class TagResourceResponse

This is the response object from the TagResource operation.

Class ThrottlingException

The request was denied due to request throttling.

Class UntagResourceRequest

Container for the parameters to the UntagResource operation. Removes a tag from a resource in Audit Manager.

Class UntagResourceResponse

This is the response object from the UntagResource operation.

Class UpdateAssessmentControlRequest

Container for the parameters to the UpdateAssessmentControl operation. Updates a control within an assessment in Audit Manager.

Class UpdateAssessmentControlResponse

This is the response object from the UpdateAssessmentControl operation.

Class UpdateAssessmentControlSetStatusRequest

Container for the parameters to the UpdateAssessmentControlSetStatus operation. Updates the status of a control set in an Audit Manager assessment.

Class UpdateAssessmentControlSetStatusResponse

This is the response object from the UpdateAssessmentControlSetStatus operation.

Class UpdateAssessmentFrameworkControlSet

A controlSet entity that represents a collection of controls in Audit Manager. This doesn't contain the control set ID.

Class UpdateAssessmentFrameworkRequest

Container for the parameters to the UpdateAssessmentFramework operation. Updates a custom framework in Audit Manager.

Class UpdateAssessmentFrameworkResponse

This is the response object from the UpdateAssessmentFramework operation.

Class UpdateAssessmentFrameworkShareRequest

Container for the parameters to the UpdateAssessmentFrameworkShare operation. Updates a share request for a custom framework in Audit Manager.

Class UpdateAssessmentFrameworkShareResponse

This is the response object from the UpdateAssessmentFrameworkShare operation.

Class UpdateAssessmentRequest

Container for the parameters to the UpdateAssessment operation. Edits an Audit Manager assessment.

Class UpdateAssessmentResponse

This is the response object from the UpdateAssessment operation.

Class UpdateAssessmentStatusRequest

Container for the parameters to the UpdateAssessmentStatus operation. Updates the status of an assessment in Audit Manager.

Class UpdateAssessmentStatusResponse

This is the response object from the UpdateAssessmentStatus operation.

Class UpdateControlRequest

Container for the parameters to the UpdateControl operation. Updates a custom control in Audit Manager.

Class UpdateControlResponse

This is the response object from the UpdateControl operation.

Class UpdateSettingsRequest

Container for the parameters to the UpdateSettings operation. Updates Audit Manager settings for the current account.

Class UpdateSettingsResponse

This is the response object from the UpdateSettings operation.

Class URL

Short for uniform resource locator. A URL is used as a unique identifier to locate a resource on the internet.

Class ValidateAssessmentReportIntegrityRequest

Container for the parameters to the ValidateAssessmentReportIntegrity operation. Validates the integrity of an assessment report in Audit Manager.

Class ValidateAssessmentReportIntegrityResponse

This is the response object from the ValidateAssessmentReportIntegrity operation.

Class ValidationException

The request has invalid or missing parameters.

Class ValidationExceptionField

Indicates that the request has invalid or missing parameters for the field.

Interfaces

NameDescription
Interface IAuditManagerPaginatorFactory

Paginators for the AuditManager service

Interface IGetChangeLogsPaginator

Paginator for the GetChangeLogs operation

Interface IGetDelegationsPaginator

Paginator for the GetDelegations operation

Interface IGetEvidenceByEvidenceFolderPaginator

Paginator for the GetEvidenceByEvidenceFolder operation

Interface IGetEvidenceFoldersByAssessmentControlPaginator

Paginator for the GetEvidenceFoldersByAssessmentControl operation

Interface IGetEvidenceFoldersByAssessmentPaginator

Paginator for the GetEvidenceFoldersByAssessment operation

Interface IListAssessmentControlInsightsByControlDomainPaginator

Paginator for the ListAssessmentControlInsightsByControlDomain operation

Interface IListAssessmentFrameworkShareRequestsPaginator

Paginator for the ListAssessmentFrameworkShareRequests operation

Interface IListAssessmentFrameworksPaginator

Paginator for the ListAssessmentFrameworks operation

Interface IListAssessmentReportsPaginator

Paginator for the ListAssessmentReports operation

Interface IListAssessmentsPaginator

Paginator for the ListAssessments operation

Interface IListControlDomainInsightsByAssessmentPaginator

Paginator for the ListControlDomainInsightsByAssessment operation

Interface IListControlDomainInsightsPaginator

Paginator for the ListControlDomainInsights operation

Interface IListControlInsightsByControlDomainPaginator

Paginator for the ListControlInsightsByControlDomain operation

Interface IListControlsPaginator

Paginator for the ListControls operation

Interface IListKeywordsForDataSourcePaginator

Paginator for the ListKeywordsForDataSource operation

Interface IListNotificationsPaginator

Paginator for the ListNotifications operation