@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api AWS Audit Manager
@version 2017-07-25
@auth AWS SigV4
@endpoints 62
@hint download_for_search
@toc assessments(24), assessmentFrameworks(6), controls(5), assessmentFrameworkShareRequests(3), account(6), delegations(1), evidenceFileUploadUrl(1), insights(6), services(1), settings(2), assessmentReports(2), dataSourceKeywords(1), notifications(1), tags(3)

@group assessments
@endpoint PUT /assessments/{assessmentId}/associateToAssessmentReport
@desc Associates an evidence folder to an assessment report in an Audit Manager assessment.
@required {assessmentId: str, evidenceFolderId: str}

@endpoint PUT /assessments/{assessmentId}/batchAssociateToAssessmentReport
@desc Associates a list of evidence to an assessment report in an Audit Manager assessment.
@required {assessmentId: str, evidenceFolderId: str, evidenceIds: [str]}
@returns(200) {evidenceIds: [str]?, errors: [AssessmentReportEvidenceError]?}

@endpoint POST /assessments/{assessmentId}/delegations
@desc Creates a batch of delegations for an assessment in Audit Manager.
@required {assessmentId: str, createDelegationRequests: [CreateDelegationRequest]}
@returns(200) {delegations: [Delegation]?, errors: [BatchCreateDelegationByAssessmentError]?}

@endpoint PUT /assessments/{assessmentId}/delegations
@desc Deletes a batch of delegations for an assessment in Audit Manager.
@required {assessmentId: str, delegationIds: [str]}
@returns(200) {errors: [BatchDeleteDelegationByAssessmentError]?}

@endpoint PUT /assessments/{assessmentId}/batchDisassociateFromAssessmentReport
@desc Disassociates a list of evidence from an assessment report in Audit Manager.
@required {assessmentId: str, evidenceFolderId: str, evidenceIds: [str]}
@returns(200) {evidenceIds: [str]?, errors: [AssessmentReportEvidenceError]?}

@endpoint POST /assessments/{assessmentId}/controlSets/{controlSetId}/controls/{controlId}/evidence
@desc 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.
@required {assessmentId: str, controlSetId: str, controlId: str, manualEvidence: [ManualEvidence]}
@returns(200) {errors: [BatchImportEvidenceToAssessmentControlError]?}

@endpoint POST /assessments
@desc Creates an assessment in Audit Manager.
@required {name: str, assessmentReportsDestination: AssessmentReportsDestination, scope: Scope, roles: [Role], frameworkId: str}
@optional {description: str, tags: map<str,str>}
@returns(200) {assessment: Assessment?{arn: str?, awsAccount: AWSAccount?{id: str?, emailAddress: str?, name: str?}, metadata: AssessmentMetadata?{name: str?, id: str?, description: str?, complianceType: str?, status: str?, assessmentReportsDestination: AssessmentReportsDestination?{destinationType: str?, destination: str?}, scope: Scope?{awsAccounts: [AWSAccount]?, awsServices: [AWSService]?}, roles: [Role]?, delegations: [Delegation]?, creationTime: str(timestamp)?, lastUpdated: str(timestamp)?}, framework: AssessmentFramework?{id: str?, arn: str?, metadata: FrameworkMetadata?{name: str?, description: str?, logo: str?, complianceType: str?}, controlSets: [AssessmentControlSet]?}, tags: map<str,str>?}}

@endgroup

@group assessmentFrameworks
@endpoint POST /assessmentFrameworks
@desc Creates a custom framework in Audit Manager.
@required {name: str, controlSets: [CreateAssessmentFrameworkControlSet]}
@optional {description: str, complianceType: str, tags: map<str,str>}
@returns(200) {framework: Framework?{arn: str?, id: str?, name: str?, type: str?, complianceType: str?, description: str?, logo: str?, controlSources: str?, controlSets: [ControlSet]?, createdAt: str(timestamp)?, lastUpdatedAt: str(timestamp)?, createdBy: str?, lastUpdatedBy: str?, tags: map<str,str>?}}

@endgroup

@group assessments
@endpoint POST /assessments/{assessmentId}/reports
@desc Creates an assessment report for the specified assessment.
@required {assessmentId: str, name: str}
@optional {description: str, queryStatement: str}
@returns(200) {assessmentReport: AssessmentReport?{id: str?, name: str?, description: str?, awsAccountId: str?, assessmentId: str?, assessmentName: str?, author: str?, status: str?, creationTime: str(timestamp)?}}

@endgroup

@group controls
@endpoint POST /controls
@desc Creates a new custom control in Audit Manager.
@required {name: str, controlMappingSources: [CreateControlMappingSource]}
@optional {description: str, testingInformation: str, actionPlanTitle: str, actionPlanInstructions: str, tags: map<str,str>}
@returns(200) {control: Control?{arn: str?, id: str?, type: str?, name: str?, description: str?, testingInformation: str?, actionPlanTitle: str?, actionPlanInstructions: str?, controlSources: str?, controlMappingSources: [ControlMappingSource]?, createdAt: str(timestamp)?, lastUpdatedAt: str(timestamp)?, createdBy: str?, lastUpdatedBy: str?, tags: map<str,str>?, state: str?}}

@endgroup

@group assessments
@endpoint DELETE /assessments/{assessmentId}
@desc Deletes an assessment in Audit Manager.
@required {assessmentId: str}

@endgroup

@group assessmentFrameworks
@endpoint DELETE /assessmentFrameworks/{frameworkId}
@desc Deletes a custom framework in Audit Manager.
@required {frameworkId: str}

@endgroup

@group assessmentFrameworkShareRequests
@endpoint DELETE /assessmentFrameworkShareRequests/{requestId}
@desc Deletes a share request for a custom framework in Audit Manager.
@required {requestId: str, requestType: str}

@endgroup

@group assessments
@endpoint DELETE /assessments/{assessmentId}/reports/{assessmentReportId}
@desc Deletes an assessment report in Audit Manager.  When you run the DeleteAssessmentReport operation, Audit Manager attempts to delete the following data:   The specified assessment report that’s stored in your S3 bucket   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.
@required {assessmentId: str, assessmentReportId: str}

@endgroup

@group controls
@endpoint DELETE /controls/{controlId}
@desc 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.
@required {controlId: str}

@endgroup

@group account
@endpoint POST /account/deregisterAccount
@desc 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.
@returns(200) {status: str?}

@endpoint POST /account/deregisterOrganizationAdminAccount
@desc 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:     DeleteAssessment (see also: Deleting an assessment in the Audit Manager User Guide)    DeleteAssessmentFramework (see also: Deleting a custom framework in the Audit Manager User Guide)    DeleteAssessmentFrameworkShare (see also: Deleting a share request in the Audit Manager User Guide)    DeleteAssessmentReport (see also: Deleting an assessment report in the Audit Manager User Guide)    DeleteControl (see also: Deleting a custom control in the Audit Manager User Guide)   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.
@optional {adminAccountId: str}

@endgroup

@group assessments
@endpoint PUT /assessments/{assessmentId}/disassociateFromAssessmentReport
@desc Disassociates an evidence folder from the specified assessment report in Audit Manager.
@required {assessmentId: str, evidenceFolderId: str}

@endgroup

@group account
@endpoint GET /account/status
@desc Gets the registration status of an account in Audit Manager.
@returns(200) {status: str?}

@endgroup

@group assessments
@endpoint GET /assessments/{assessmentId}
@desc Gets information about a specified assessment.
@required {assessmentId: str}
@returns(200) {assessment: Assessment?{arn: str?, awsAccount: AWSAccount?{id: str?, emailAddress: str?, name: str?}, metadata: AssessmentMetadata?{name: str?, id: str?, description: str?, complianceType: str?, status: str?, assessmentReportsDestination: AssessmentReportsDestination?{destinationType: str?, destination: str?}, scope: Scope?{awsAccounts: [AWSAccount]?, awsServices: [AWSService]?}, roles: [Role]?, delegations: [Delegation]?, creationTime: str(timestamp)?, lastUpdated: str(timestamp)?}, framework: AssessmentFramework?{id: str?, arn: str?, metadata: FrameworkMetadata?{name: str?, description: str?, logo: str?, complianceType: str?}, controlSets: [AssessmentControlSet]?}, tags: map<str,str>?}, userRole: Role?{roleType: str, roleArn: str}}

@endgroup

@group assessmentFrameworks
@endpoint GET /assessmentFrameworks/{frameworkId}
@desc Gets information about a specified framework.
@required {frameworkId: str}
@returns(200) {framework: Framework?{arn: str?, id: str?, name: str?, type: str?, complianceType: str?, description: str?, logo: str?, controlSources: str?, controlSets: [ControlSet]?, createdAt: str(timestamp)?, lastUpdatedAt: str(timestamp)?, createdBy: str?, lastUpdatedBy: str?, tags: map<str,str>?}}

@endgroup

@group assessments
@endpoint GET /assessments/{assessmentId}/reports/{assessmentReportId}/url
@desc Gets the URL of an assessment report in Audit Manager.
@required {assessmentReportId: str, assessmentId: str}
@returns(200) {preSignedUrl: URL?{hyperlinkName: str?, link: str?}}

@endpoint GET /assessments/{assessmentId}/changelogs
@desc Gets a list of changelogs from Audit Manager.
@required {assessmentId: str}
@optional {controlSetId: str, controlId: str, nextToken: str, maxResults: int}
@returns(200) {changeLogs: [ChangeLog]?, nextToken: str?}

@endgroup

@group controls
@endpoint GET /controls/{controlId}
@desc Gets information about a specified control.
@required {controlId: str}
@returns(200) {control: Control?{arn: str?, id: str?, type: str?, name: str?, description: str?, testingInformation: str?, actionPlanTitle: str?, actionPlanInstructions: str?, controlSources: str?, controlMappingSources: [ControlMappingSource]?, createdAt: str(timestamp)?, lastUpdatedAt: str(timestamp)?, createdBy: str?, lastUpdatedBy: str?, tags: map<str,str>?, state: str?}}

@endgroup

@group delegations
@endpoint GET /delegations
@desc Gets a list of delegations from an audit owner to a delegate.
@optional {nextToken: str, maxResults: int}
@returns(200) {delegations: [DelegationMetadata]?, nextToken: str?}

@endgroup

@group assessments
@endpoint GET /assessments/{assessmentId}/controlSets/{controlSetId}/evidenceFolders/{evidenceFolderId}/evidence/{evidenceId}
@desc Gets information about a specified evidence item.
@required {assessmentId: str, controlSetId: str, evidenceFolderId: str, evidenceId: str}
@returns(200) {evidence: Evidence?{dataSource: str?, evidenceAwsAccountId: str?, time: str(timestamp)?, eventSource: str?, eventName: str?, evidenceByType: str?, resourcesIncluded: [Resource]?, attributes: map<str,str>?, iamId: str?, complianceCheck: str?, awsOrganization: str?, awsAccountId: str?, evidenceFolderId: str?, id: str?, assessmentReportSelection: str?}}

@endpoint GET /assessments/{assessmentId}/controlSets/{controlSetId}/evidenceFolders/{evidenceFolderId}/evidence
@desc Gets all evidence from a specified evidence folder in Audit Manager.
@required {assessmentId: str, controlSetId: str, evidenceFolderId: str}
@optional {nextToken: str, maxResults: int}
@returns(200) {evidence: [Evidence]?, nextToken: str?}

@endgroup

@group evidenceFileUploadUrl
@endpoint GET /evidenceFileUploadUrl
@desc 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.
@required {fileName: str}
@returns(200) {evidenceFileName: str?, uploadUrl: str?}

@endgroup

@group assessments
@endpoint GET /assessments/{assessmentId}/controlSets/{controlSetId}/evidenceFolders/{evidenceFolderId}
@desc Gets an evidence folder from a specified assessment in Audit Manager.
@required {assessmentId: str, controlSetId: str, evidenceFolderId: str}
@returns(200) {evidenceFolder: AssessmentEvidenceFolder?{name: str?, date: str(timestamp)?, assessmentId: str?, controlSetId: str?, controlId: str?, id: str?, dataSource: str?, author: str?, totalEvidence: int?, assessmentReportSelectionCount: int?, controlName: str?, evidenceResourcesIncludedCount: int?, evidenceByTypeConfigurationDataCount: int?, evidenceByTypeManualCount: int?, evidenceByTypeComplianceCheckCount: int?, evidenceByTypeComplianceCheckIssuesCount: int?, evidenceByTypeUserActivityCount: int?, evidenceAwsServiceSourceCount: int?}}

@endpoint GET /assessments/{assessmentId}/evidenceFolders
@desc Gets the evidence folders from a specified assessment in Audit Manager.
@required {assessmentId: str}
@optional {nextToken: str, maxResults: int}
@returns(200) {evidenceFolders: [AssessmentEvidenceFolder]?, nextToken: str?}

@endpoint GET /assessments/{assessmentId}/evidenceFolders-by-assessment-control/{controlSetId}/{controlId}
@desc Gets a list of evidence folders that are associated with a specified control in an Audit Manager assessment.
@required {assessmentId: str, controlSetId: str, controlId: str}
@optional {nextToken: str, maxResults: int}
@returns(200) {evidenceFolders: [AssessmentEvidenceFolder]?, nextToken: str?}

@endgroup

@group insights
@endpoint GET /insights
@desc Gets the latest analytics data for all your current active assessments.
@returns(200) {insights: Insights?{activeAssessmentsCount: int?, noncompliantEvidenceCount: int?, compliantEvidenceCount: int?, inconclusiveEvidenceCount: int?, assessmentControlsCountByNoncompliantEvidence: int?, totalAssessmentControlsCount: int?, lastUpdated: str(timestamp)?}}

@endpoint GET /insights/assessments/{assessmentId}
@desc Gets the latest analytics data for a specific active assessment.
@required {assessmentId: str}
@returns(200) {insights: InsightsByAssessment?{noncompliantEvidenceCount: int?, compliantEvidenceCount: int?, inconclusiveEvidenceCount: int?, assessmentControlsCountByNoncompliantEvidence: int?, totalAssessmentControlsCount: int?, lastUpdated: str(timestamp)?}}

@endgroup

@group account
@endpoint GET /account/organizationAdminAccount
@desc Gets the name of the delegated Amazon Web Services administrator account for a specified organization.
@returns(200) {adminAccountId: str?, organizationId: str?}

@endgroup

@group services
@endpoint GET /services
@desc Gets a list of the Amazon Web Services from which Audit Manager can collect evidence.  Audit Manager defines which Amazon Web Services are in scope for an assessment. Audit Manager infers this scope by examining the assessment’s controls and their data sources, and then mapping this information to one or more of the corresponding Amazon Web Services that are in this list.  For information about why it's no longer possible to specify services in scope manually, see I can't edit the services in scope for my assessment in the Troubleshooting section of the Audit Manager user guide.
@returns(200) {serviceMetadata: [ServiceMetadata]?}

@endgroup

@group settings
@endpoint GET /settings/{attribute}
@desc Gets the settings for a specified Amazon Web Services account.
@required {attribute: str}
@returns(200) {settings: Settings?{isAwsOrgEnabled: bool?, snsTopic: str?, defaultAssessmentReportsDestination: AssessmentReportsDestination?{destinationType: str?, destination: str?}, defaultProcessOwners: [Role]?, kmsKey: str?, evidenceFinderEnablement: EvidenceFinderEnablement?{eventDataStoreArn: str?, enablementStatus: str?, backfillStatus: str?, error: str?}, deregistrationPolicy: DeregistrationPolicy?{deleteResources: str?}, defaultExportDestination: DefaultExportDestination?{destinationType: str?, destination: str?}}}

@endgroup

@group insights
@endpoint GET /insights/controls-by-assessment
@desc 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.
@required {controlDomainId: str, assessmentId: str}
@optional {nextToken: str, maxResults: int}
@returns(200) {controlInsightsByAssessment: [ControlInsightsMetadataByAssessmentItem]?, nextToken: str?}

@endgroup

@group assessmentFrameworkShareRequests
@endpoint GET /assessmentFrameworkShareRequests
@desc Returns a list of sent or received share requests for custom frameworks in Audit Manager.
@required {requestType: str}
@optional {nextToken: str, maxResults: int}
@returns(200) {assessmentFrameworkShareRequests: [AssessmentFrameworkShareRequest]?, nextToken: str?}

@endgroup

@group assessmentFrameworks
@endpoint GET /assessmentFrameworks
@desc Returns a list of the frameworks that are available in the Audit Manager framework library.
@required {frameworkType: str}
@optional {nextToken: str, maxResults: int}
@returns(200) {frameworkMetadataList: [AssessmentFrameworkMetadata]?, nextToken: str?}

@endgroup

@group assessmentReports
@endpoint GET /assessmentReports
@desc Returns a list of assessment reports created in Audit Manager.
@optional {nextToken: str, maxResults: int}
@returns(200) {assessmentReports: [AssessmentReportMetadata]?, nextToken: str?}

@endgroup

@group assessments
@endpoint GET /assessments
@desc Returns a list of current and past assessments from Audit Manager.
@optional {status: str, nextToken: str, maxResults: int}
@returns(200) {assessmentMetadata: [AssessmentMetadataItem]?, nextToken: str?}

@endgroup

@group insights
@endpoint GET /insights/control-domains
@desc Lists the latest analytics data for control domains across all of your active assessments.  Audit Manager supports the control domains that are provided by Amazon Web Services Control Catalog. For information about how to find a list of available control domains, see  ListDomains  in the Amazon Web Services Control Catalog API Reference.  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.
@optional {nextToken: str, maxResults: int}
@returns(200) {controlDomainInsights: [ControlDomainInsights]?, nextToken: str?}

@endpoint GET /insights/control-domains-by-assessment
@desc Lists analytics data for control domains within a specified active assessment. Audit Manager supports the control domains that are provided by Amazon Web Services Control Catalog. For information about how to find a list of available control domains, see  ListDomains  in the Amazon Web Services Control Catalog API Reference.  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.
@required {assessmentId: str}
@optional {nextToken: str, maxResults: int}
@returns(200) {controlDomainInsights: [ControlDomainInsights]?, nextToken: str?}

@endpoint GET /insights/controls
@desc 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.
@required {controlDomainId: str}
@optional {nextToken: str, maxResults: int}
@returns(200) {controlInsightsMetadata: [ControlInsightsMetadataItem]?, nextToken: str?}

@endgroup

@group controls
@endpoint GET /controls
@desc Returns a list of controls from Audit Manager.
@required {controlType: str}
@optional {nextToken: str, maxResults: int, controlCatalogId: str}
@returns(200) {controlMetadataList: [ControlMetadata]?, nextToken: str?}

@endgroup

@group dataSourceKeywords
@endpoint GET /dataSourceKeywords
@desc Returns a list of keywords that are pre-mapped to the specified control data source.
@required {source: str}
@optional {nextToken: str, maxResults: int}
@returns(200) {keywords: [str]?, nextToken: str?}

@endgroup

@group notifications
@endpoint GET /notifications
@desc Returns a list of all Audit Manager notifications.
@optional {nextToken: str, maxResults: int}
@returns(200) {notifications: [Notification]?, nextToken: str?}

@endgroup

@group tags
@endpoint GET /tags/{resourceArn}
@desc Returns a list of tags for the specified resource in Audit Manager.
@required {resourceArn: str}
@returns(200) {tags: map<str,str>?}

@endgroup

@group account
@endpoint POST /account/registerAccount
@desc Enables Audit Manager for the specified Amazon Web Services account.
@optional {kmsKey: str, delegatedAdminAccount: str}
@returns(200) {status: str?}

@endpoint POST /account/registerOrganizationAdminAccount
@desc Enables an Amazon Web Services account within the organization as the delegated administrator for Audit Manager.
@required {adminAccountId: str}
@returns(200) {adminAccountId: str?, organizationId: str?}

@endgroup

@group assessmentFrameworks
@endpoint POST /assessmentFrameworks/{frameworkId}/shareRequests
@desc 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.
@required {frameworkId: str, destinationAccount: str, destinationRegion: str}
@optional {comment: str}
@returns(200) {assessmentFrameworkShareRequest: AssessmentFrameworkShareRequest?{id: str?, frameworkId: str?, frameworkName: str?, frameworkDescription: str?, status: str?, sourceAccount: str?, destinationAccount: str?, destinationRegion: str?, expirationTime: str(timestamp)?, creationTime: str(timestamp)?, lastUpdated: str(timestamp)?, comment: str?, standardControlsCount: int?, customControlsCount: int?, complianceType: str?}}

@endgroup

@group tags
@endpoint POST /tags/{resourceArn}
@desc Tags the specified resource in Audit Manager.
@required {resourceArn: str, tags: map<str,str>}

@endpoint DELETE /tags/{resourceArn}
@desc Removes a tag from a resource in Audit Manager.
@required {resourceArn: str, tagKeys: [str]}

@endgroup

@group assessments
@endpoint PUT /assessments/{assessmentId}
@desc Edits an Audit Manager assessment.
@required {assessmentId: str, scope: Scope}
@optional {assessmentName: str, assessmentDescription: str, assessmentReportsDestination: AssessmentReportsDestination, roles: [Role]}
@returns(200) {assessment: Assessment?{arn: str?, awsAccount: AWSAccount?{id: str?, emailAddress: str?, name: str?}, metadata: AssessmentMetadata?{name: str?, id: str?, description: str?, complianceType: str?, status: str?, assessmentReportsDestination: AssessmentReportsDestination?{destinationType: str?, destination: str?}, scope: Scope?{awsAccounts: [AWSAccount]?, awsServices: [AWSService]?}, roles: [Role]?, delegations: [Delegation]?, creationTime: str(timestamp)?, lastUpdated: str(timestamp)?}, framework: AssessmentFramework?{id: str?, arn: str?, metadata: FrameworkMetadata?{name: str?, description: str?, logo: str?, complianceType: str?}, controlSets: [AssessmentControlSet]?}, tags: map<str,str>?}}

@endpoint PUT /assessments/{assessmentId}/controlSets/{controlSetId}/controls/{controlId}
@desc Updates a control within an assessment in Audit Manager.
@required {assessmentId: str, controlSetId: str, controlId: str}
@optional {controlStatus: str, commentBody: str}
@returns(200) {control: AssessmentControl?{id: str?, name: str?, description: str?, status: str?, response: str?, comments: [ControlComment]?, evidenceSources: [str]?, evidenceCount: int?, assessmentReportEvidenceCount: int?}}

@endpoint PUT /assessments/{assessmentId}/controlSets/{controlSetId}/status
@desc Updates the status of a control set in an Audit Manager assessment.
@required {assessmentId: str, controlSetId: str, status: str, comment: str}
@returns(200) {controlSet: AssessmentControlSet?{id: str?, description: str?, status: str?, roles: [Role]?, controls: [AssessmentControl]?, delegations: [Delegation]?, systemEvidenceCount: int?, manualEvidenceCount: int?}}

@endgroup

@group assessmentFrameworks
@endpoint PUT /assessmentFrameworks/{frameworkId}
@desc Updates a custom framework in Audit Manager.
@required {frameworkId: str, name: str, controlSets: [UpdateAssessmentFrameworkControlSet]}
@optional {description: str, complianceType: str}
@returns(200) {framework: Framework?{arn: str?, id: str?, name: str?, type: str?, complianceType: str?, description: str?, logo: str?, controlSources: str?, controlSets: [ControlSet]?, createdAt: str(timestamp)?, lastUpdatedAt: str(timestamp)?, createdBy: str?, lastUpdatedBy: str?, tags: map<str,str>?}}

@endgroup

@group assessmentFrameworkShareRequests
@endpoint PUT /assessmentFrameworkShareRequests/{requestId}
@desc Updates a share request for a custom framework in Audit Manager.
@required {requestId: str, requestType: str, action: str}
@returns(200) {assessmentFrameworkShareRequest: AssessmentFrameworkShareRequest?{id: str?, frameworkId: str?, frameworkName: str?, frameworkDescription: str?, status: str?, sourceAccount: str?, destinationAccount: str?, destinationRegion: str?, expirationTime: str(timestamp)?, creationTime: str(timestamp)?, lastUpdated: str(timestamp)?, comment: str?, standardControlsCount: int?, customControlsCount: int?, complianceType: str?}}

@endgroup

@group assessments
@endpoint PUT /assessments/{assessmentId}/status
@desc Updates the status of an assessment in Audit Manager.
@required {assessmentId: str, status: str}
@returns(200) {assessment: Assessment?{arn: str?, awsAccount: AWSAccount?{id: str?, emailAddress: str?, name: str?}, metadata: AssessmentMetadata?{name: str?, id: str?, description: str?, complianceType: str?, status: str?, assessmentReportsDestination: AssessmentReportsDestination?{destinationType: str?, destination: str?}, scope: Scope?{awsAccounts: [AWSAccount]?, awsServices: [AWSService]?}, roles: [Role]?, delegations: [Delegation]?, creationTime: str(timestamp)?, lastUpdated: str(timestamp)?}, framework: AssessmentFramework?{id: str?, arn: str?, metadata: FrameworkMetadata?{name: str?, description: str?, logo: str?, complianceType: str?}, controlSets: [AssessmentControlSet]?}, tags: map<str,str>?}}

@endgroup

@group controls
@endpoint PUT /controls/{controlId}
@desc Updates a custom control in Audit Manager.
@required {controlId: str, name: str, controlMappingSources: [ControlMappingSource]}
@optional {description: str, testingInformation: str, actionPlanTitle: str, actionPlanInstructions: str}
@returns(200) {control: Control?{arn: str?, id: str?, type: str?, name: str?, description: str?, testingInformation: str?, actionPlanTitle: str?, actionPlanInstructions: str?, controlSources: str?, controlMappingSources: [ControlMappingSource]?, createdAt: str(timestamp)?, lastUpdatedAt: str(timestamp)?, createdBy: str?, lastUpdatedBy: str?, tags: map<str,str>?, state: str?}}

@endgroup

@group settings
@endpoint PUT /settings
@desc Updates Audit Manager settings for the current account.
@optional {snsTopic: str, defaultAssessmentReportsDestination: AssessmentReportsDestination, defaultProcessOwners: [Role], kmsKey: str, evidenceFinderEnabled: bool, deregistrationPolicy: DeregistrationPolicy, defaultExportDestination: DefaultExportDestination}
@returns(200) {settings: Settings?{isAwsOrgEnabled: bool?, snsTopic: str?, defaultAssessmentReportsDestination: AssessmentReportsDestination?{destinationType: str?, destination: str?}, defaultProcessOwners: [Role]?, kmsKey: str?, evidenceFinderEnablement: EvidenceFinderEnablement?{eventDataStoreArn: str?, enablementStatus: str?, backfillStatus: str?, error: str?}, deregistrationPolicy: DeregistrationPolicy?{deleteResources: str?}, defaultExportDestination: DefaultExportDestination?{destinationType: str?, destination: str?}}}

@endgroup

@group assessmentReports
@endpoint POST /assessmentReports/integrity
@desc Validates the integrity of an assessment report in Audit Manager.
@required {s3RelativePath: str}
@returns(200) {signatureValid: bool?, signatureAlgorithm: str?, signatureDateTime: str?, signatureKeyId: str?, validationErrors: [str]?}

@endgroup

@end