Associates an evidence folder to the specified assessment report in Audit Manager.
" + "documentation":"Associates an evidence folder to an assessment report in a Audit Manager assessment.
" }, "BatchAssociateAssessmentReportEvidence":{ "name":"BatchAssociateAssessmentReportEvidence", @@ -58,7 +58,7 @@ {"shape":"ValidationException"}, {"shape":"InternalServerException"} ], - "documentation":"Create a batch of delegations for a specified assessment in Audit Manager.
" + "documentation":"Creates a batch of delegations for an assessment in Audit Manager.
" }, "BatchDeleteDelegationByAssessment":{ "name":"BatchDeleteDelegationByAssessment", @@ -74,7 +74,7 @@ {"shape":"ValidationException"}, {"shape":"InternalServerException"} ], - "documentation":"Deletes the delegations in the specified Audit Manager assessment.
" + "documentation":"Deletes a batch of delegations for an assessment in Audit Manager.
" }, "BatchDisassociateAssessmentReportEvidence":{ "name":"BatchDisassociateAssessmentReportEvidence", @@ -90,7 +90,7 @@ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"Disassociates a list of evidence from the specified assessment report in Audit Manager.
" + "documentation":"Disassociates a list of evidence from an assessment report in Audit Manager.
" }, "BatchImportEvidenceToAssessmentControl":{ "name":"BatchImportEvidenceToAssessmentControl", @@ -106,7 +106,7 @@ {"shape":"ValidationException"}, {"shape":"InternalServerException"} ], - "documentation":"Uploads one or more pieces of evidence to the specified control in the assessment in Audit Manager.
" + "documentation":"Uploads one or more pieces of evidence to a control in an Audit Manager assessment.
" }, "CreateAssessment":{ "name":"CreateAssessment", @@ -204,6 +204,22 @@ ], "documentation":"Deletes a custom framework in Audit Manager.
" }, + "DeleteAssessmentFrameworkShare":{ + "name":"DeleteAssessmentFrameworkShare", + "http":{ + "method":"DELETE", + "requestUri":"/assessmentFrameworkShareRequests/{requestId}" + }, + "input":{"shape":"DeleteAssessmentFrameworkShareRequest"}, + "output":{"shape":"DeleteAssessmentFrameworkShareResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Deletes a share request for a custom framework in Audit Manager.
" + }, "DeleteAssessmentReport":{ "name":"DeleteAssessmentReport", "http":{ @@ -266,7 +282,7 @@ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"Removes the specified member Amazon Web Services account as a delegated administrator for Audit Manager.
When you remove a delegated administrator from your Audit Manager settings, or when you deregister a delegated administrator from Organizations, you continue to have access to the evidence that you previously collected under that account. However, Audit Manager will stop collecting and attaching evidence to that delegated administrator account moving forward.
Removes the specified member 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 Audit Manager. However, Audit Manager will stop collecting and attaching evidence to that delegated administrator account moving forward.
Returns the URL of a specified assessment report in Audit Manager.
" + "documentation":"Returns the URL of an assessment report in Audit Manager.
" }, "GetChangeLogs":{ "name":"GetChangeLogs", @@ -470,7 +486,7 @@ {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ], - "documentation":"Returns a list of evidence folders associated with a specified control of an assessment in Audit Manager.
" + "documentation":"Returns a list of evidence folders that are associated with a specified control of an assessment in Audit Manager.
" }, "GetOrganizationAdminAccount":{ "name":"GetOrganizationAdminAccount", @@ -517,6 +533,21 @@ ], "documentation":"Returns the settings for the specified Amazon Web Services account.
" }, + "ListAssessmentFrameworkShareRequests":{ + "name":"ListAssessmentFrameworkShareRequests", + "http":{ + "method":"GET", + "requestUri":"/assessmentFrameworkShareRequests" + }, + "input":{"shape":"ListAssessmentFrameworkShareRequestsRequest"}, + "output":{"shape":"ListAssessmentFrameworkShareRequestsResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Returns a list of sent or received share requests for custom frameworks in Audit Manager.
" + }, "ListAssessmentFrameworks":{ "name":"ListAssessmentFrameworks", "http":{ @@ -530,7 +561,7 @@ {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ], - "documentation":"Returns a list of the frameworks available in the Audit Manager framework library.
" + "documentation":"Returns a list of the frameworks that are available in the Audit Manager framework library.
" }, "ListAssessmentReports":{ "name":"ListAssessmentReports", @@ -590,7 +621,7 @@ {"shape":"ValidationException"}, {"shape":"InternalServerException"} ], - "documentation":"Returns a list of keywords that pre-mapped to the specified control data source.
" + "documentation":"Returns a list of keywords that are pre-mapped to the specified control data source.
" }, "ListNotifications":{ "name":"ListNotifications", @@ -654,6 +685,22 @@ ], "documentation":"Enables an Amazon Web Services account within the organization as the delegated administrator for Audit Manager.
" }, + "StartAssessmentFrameworkShare":{ + "name":"StartAssessmentFrameworkShare", + "http":{ + "method":"POST", + "requestUri":"/assessmentFrameworks/{frameworkId}/shareRequests" + }, + "input":{"shape":"StartAssessmentFrameworkShareRequest"}, + "output":{"shape":"StartAssessmentFrameworkShareResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"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 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.
Updates a custom framework in Audit Manager.
" }, + "UpdateAssessmentFrameworkShare":{ + "name":"UpdateAssessmentFrameworkShare", + "http":{ + "method":"PUT", + "requestUri":"/assessmentFrameworkShareRequests/{requestId}" + }, + "input":{"shape":"UpdateAssessmentFrameworkShareRequest"}, + "output":{"shape":"UpdateAssessmentFrameworkShareResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Updates a share request for a custom framework in Audit Manager.
" + }, "UpdateAssessmentStatus":{ "name":"UpdateAssessmentStatus", "http":{ @@ -818,18 +881,18 @@ "members":{ "id":{ "shape":"AccountId", - "documentation":"The identifier for the specified Amazon Web Services account.
" + "documentation":"The identifier for the Amazon Web Services account.
" }, "emailAddress":{ "shape":"EmailAddress", - "documentation":"The email address associated with the specified Amazon Web Services account.
" + "documentation":"The email address that's associated with the Amazon Web Services account.
" }, "name":{ "shape":"AccountName", - "documentation":"The name of the specified Amazon Web Services account.
" + "documentation":"The name of the Amazon Web Services account.
" } }, - "documentation":"The wrapper of Amazon Web Services account details, such as account ID, email address, and so on.
" + "documentation":"The wrapper of Amazon Web Services account details, such as account ID or email address.
" }, "AWSAccounts":{ "type":"list", @@ -843,7 +906,7 @@ "documentation":"The name of the Amazon Web Service.
" } }, - "documentation":"An Amazon Web Service such as Amazon S3, CloudTrail, and so on.
" + "documentation":"An Amazon Web Service such as Amazon S3 or CloudTrail.
" }, "AWSServiceName":{ "type":"string", @@ -861,7 +924,7 @@ "members":{ "message":{"shape":"String"} }, - "documentation":"Your account is not registered with Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again.
", + "documentation":"Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again.
", "error":{"httpStatusCode":403}, "exception":true }, @@ -917,19 +980,19 @@ }, "awsAccount":{ "shape":"AWSAccount", - "documentation":"The Amazon Web Services account associated with the assessment.
" + "documentation":"The Amazon Web Services account that's associated with the assessment.
" }, "metadata":{ "shape":"AssessmentMetadata", - "documentation":"The metadata for the specified assessment.
" + "documentation":"The metadata for the assessment.
" }, "framework":{ "shape":"AssessmentFramework", - "documentation":"The framework from which the assessment was created.
" + "documentation":"The framework that the assessment was created from.
" }, "tags":{ "shape":"TagMap", - "documentation":"The tags associated with the assessment.
" + "documentation":"The tags that are associated with the assessment.
" } }, "documentation":"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.
" @@ -939,42 +1002,42 @@ "members":{ "id":{ "shape":"UUID", - "documentation":"The identifier for the specified control.
" + "documentation":"The identifier for the control.
" }, "name":{ "shape":"ControlName", - "documentation":"The name of the specified control.
" + "documentation":"The name of the control.
" }, "description":{ "shape":"ControlDescription", - "documentation":"The description of the specified control.
" + "documentation":"The description of the control.
" }, "status":{ "shape":"ControlStatus", - "documentation":"The status of the specified control.
" + "documentation":"The status of the control.
" }, "response":{ "shape":"ControlResponse", - "documentation":"The response of the specified control.
" + "documentation":"The response of the control.
" }, "comments":{ "shape":"ControlComments", - "documentation":"The list of comments attached to the specified control.
" + "documentation":"The list of comments that's attached to the control.
" }, "evidenceSources":{ "shape":"EvidenceSources", - "documentation":"The list of data sources for the specified evidence.
" + "documentation":"The list of data sources for the evidence.
" }, "evidenceCount":{ "shape":"Integer", - "documentation":"The amount of evidence generated for the control.
" + "documentation":"The amount of evidence that's generated for the control.
" }, "assessmentReportEvidenceCount":{ "shape":"Integer", "documentation":"The amount of evidence in the assessment report.
" } }, - "documentation":"The control entity that represents a standard or custom control used in an Audit Manager assessment.
" + "documentation":"The control entity that represents a standard control or a custom control in an Audit Manager assessment.
" }, "AssessmentControlSet":{ "type":"structure", @@ -993,23 +1056,23 @@ }, "roles":{ "shape":"Roles", - "documentation":"The roles associated with the control set.
" + "documentation":"The roles that are associated with the control set.
" }, "controls":{ "shape":"AssessmentControls", - "documentation":"The list of controls contained with the control set.
" + "documentation":"The list of controls that's contained with the control set.
" }, "delegations":{ "shape":"Delegations", - "documentation":"The delegations associated with the control set.
" + "documentation":"The delegations that are associated with the control set.
" }, "systemEvidenceCount":{ "shape":"Integer", - "documentation":"The total number of evidence objects retrieved automatically for the control set.
" + "documentation":"The total number of evidence objects that are retrieved automatically for the control set.
" }, "manualEvidenceCount":{ "shape":"Integer", - "documentation":"The total number of evidence objects uploaded manually to the control set.
" + "documentation":"The total number of evidence objects that are uploaded manually to the control set.
" } }, "documentation":"Represents a set of controls in an Audit Manager assessment.
" @@ -1032,7 +1095,7 @@ "members":{ "name":{ "shape":"AssessmentEvidenceFolderName", - "documentation":"The name of the specified evidence folder.
" + "documentation":"The name of the evidence folder.
" }, "date":{ "shape":"Timestamp", @@ -1040,7 +1103,7 @@ }, "assessmentId":{ "shape":"UUID", - "documentation":"The identifier for the specified assessment.
" + "documentation":"The identifier for the assessment.
" }, "controlSetId":{ "shape":"ControlSetId", @@ -1048,15 +1111,15 @@ }, "controlId":{ "shape":"UUID", - "documentation":"The unique identifier for the specified control.
" + "documentation":"The unique identifier for the control.
" }, "id":{ "shape":"UUID", - "documentation":"The identifier for the folder in which evidence is stored.
" + "documentation":"The identifier for the folder that the evidence is stored in.
" }, "dataSource":{ "shape":"String", - "documentation":"The Amazon Web Service from which the evidence was collected.
" + "documentation":"The Amazon Web Service that the evidence was collected from.
" }, "author":{ "shape":"String", @@ -1068,7 +1131,7 @@ }, "assessmentReportSelectionCount":{ "shape":"Integer", - "documentation":"The total count of evidence included in the assessment report.
" + "documentation":"The total count of evidence that's included in the assessment report.
" }, "controlName":{ "shape":"ControlName", @@ -1076,7 +1139,7 @@ }, "evidenceResourcesIncludedCount":{ "shape":"Integer", - "documentation":"The amount of evidence included in the evidence folder.
" + "documentation":"The amount of evidence that's included in the evidence folder.
" }, "evidenceByTypeConfigurationDataCount":{ "shape":"Integer", @@ -1100,10 +1163,10 @@ }, "evidenceAwsServiceSourceCount":{ "shape":"Integer", - "documentation":"The total number of Amazon Web Services resources assessed to generate the evidence.
" + "documentation":"The total number of Amazon Web Services resources that were assessed to generate the evidence.
" } }, - "documentation":"The folder in which Audit Manager stores evidence for an assessment.
" + "documentation":"The folder where Audit Manager stores evidence for an assessment.
" }, "AssessmentEvidenceFolderName":{ "type":"string", @@ -1124,12 +1187,12 @@ }, "arn":{ "shape":"AuditManagerArn", - "documentation":"The Amazon Resource Name (ARN) of the specified framework.
" + "documentation":"The Amazon Resource Name (ARN) of the framework.
" }, "metadata":{"shape":"FrameworkMetadata"}, "controlSets":{ "shape":"AssessmentControlSets", - "documentation":"The control sets associated with the framework.
" + "documentation":"The control sets that are associated with the framework.
" } }, "documentation":"The file used to structure and automate Audit Manager assessments for a given compliance standard.
" @@ -1149,23 +1212,23 @@ }, "id":{ "shape":"UUID", - "documentation":"The unique identified for the specified framework.
" + "documentation":"The unique identifier for the framework.
" }, "type":{ "shape":"FrameworkType", - "documentation":"The framework type, such as standard or custom.
" + "documentation":"The framework type, such as a standard framework or a custom framework.
" }, "name":{ "shape":"FrameworkName", - "documentation":"The name of the specified framework.
" + "documentation":"The name of the framework.
" }, "description":{ "shape":"FrameworkDescription", - "documentation":"The description of the specified framework.
" + "documentation":"The description of the framework.
" }, "logo":{ "shape":"Filename", - "documentation":"The logo associated with the framework.
" + "documentation":"The logo that's associated with the framework.
" }, "complianceType":{ "shape":"ComplianceType", @@ -1173,11 +1236,11 @@ }, "controlsCount":{ "shape":"ControlsCount", - "documentation":"The number of controls associated with the specified framework.
" + "documentation":"The number of controls that are associated with the framework.
" }, "controlSetsCount":{ "shape":"ControlSetsCount", - "documentation":"The number of control sets associated with the specified framework.
" + "documentation":"The number of control sets that are associated with the framework.
" }, "createdAt":{ "shape":"Timestamp", @@ -1188,7 +1251,77 @@ "documentation":"Specifies when the framework was most recently updated.
" } }, - "documentation":"The metadata associated with a standard or custom framework.
" + "documentation":"The metadata that's associated with a standard framework or a custom framework.
" + }, + "AssessmentFrameworkShareRequest":{ + "type":"structure", + "members":{ + "id":{ + "shape":"UUID", + "documentation":"The unique identifier for the share request.
" + }, + "frameworkId":{ + "shape":"UUID", + "documentation":"The unique identifier for the shared custom framework.
" + }, + "frameworkName":{ + "shape":"FrameworkName", + "documentation":"The name of the custom framework that the share request is for.
" + }, + "frameworkDescription":{ + "shape":"FrameworkDescription", + "documentation":"The description of the shared custom framework.
" + }, + "status":{ + "shape":"ShareRequestStatus", + "documentation":"The status of the share request.
" + }, + "sourceAccount":{ + "shape":"AccountId", + "documentation":"The Amazon Web Services account of the sender.
" + }, + "destinationAccount":{ + "shape":"AccountId", + "documentation":"The Amazon Web Services account of the recipient.
" + }, + "destinationRegion":{ + "shape":"Region", + "documentation":"The Amazon Web Services Region of the recipient.
" + }, + "expirationTime":{ + "shape":"Timestamp", + "documentation":"The time when the share request expires.
" + }, + "creationTime":{ + "shape":"Timestamp", + "documentation":"The time when the share request was created.
" + }, + "lastUpdated":{ + "shape":"Timestamp", + "documentation":"Specifies when the share request was last updated.
" + }, + "comment":{ + "shape":"ShareRequestComment", + "documentation":"An optional comment from the sender about the share request.
" + }, + "standardControlsCount":{ + "shape":"NullableInteger", + "documentation":"The number of standard controls that are part of the shared custom framework.
" + }, + "customControlsCount":{ + "shape":"NullableInteger", + "documentation":"The number of custom controls that are part of the shared custom framework.
" + }, + "complianceType":{ + "shape":"ComplianceType", + "documentation":"The compliance type that the shared custom framework supports, such as CIS or HIPAA.
" + } + }, + "documentation":"Represents a share request for a custom framework in Audit Manager.
" + }, + "AssessmentFrameworkShareRequestList":{ + "type":"list", + "member":{"shape":"AssessmentFrameworkShareRequest"} }, "AssessmentMetadata":{ "type":"structure", @@ -1207,7 +1340,7 @@ }, "complianceType":{ "shape":"ComplianceType", - "documentation":"The name of a compliance standard related to the assessment, such as PCI-DSS.
" + "documentation":"The name of the compliance standard that's related to the assessment, such as PCI-DSS.
" }, "status":{ "shape":"AssessmentStatus", @@ -1215,19 +1348,19 @@ }, "assessmentReportsDestination":{ "shape":"AssessmentReportsDestination", - "documentation":"The destination in which evidence reports are stored for the specified assessment.
" + "documentation":"The destination that evidence reports are stored in for the assessment.
" }, "scope":{ "shape":"Scope", - "documentation":"The wrapper of Amazon Web Services accounts and services in scope for the assessment.
" + "documentation":"The wrapper of Amazon Web Services accounts and services that are in scope for the assessment.
" }, "roles":{ "shape":"Roles", - "documentation":"The roles associated with the assessment.
" + "documentation":"The roles that are associated with the assessment.
" }, "delegations":{ "shape":"Delegations", - "documentation":"The delegations associated with the assessment.
" + "documentation":"The delegations that are associated with the assessment.
" }, "creationTime":{ "shape":"Timestamp", @@ -1238,7 +1371,7 @@ "documentation":"The time of the most recent update.
" } }, - "documentation":"The metadata associated with the specified assessment.
" + "documentation":"The metadata that's associated with the specified assessment.
" }, "AssessmentMetadataItem":{ "type":"structure", @@ -1253,7 +1386,7 @@ }, "complianceType":{ "shape":"ComplianceType", - "documentation":"The name of the compliance standard related to the assessment, such as PCI-DSS.
" + "documentation":"The name of the compliance standard that's related to the assessment, such as PCI-DSS.
" }, "status":{ "shape":"AssessmentStatus", @@ -1261,11 +1394,11 @@ }, "roles":{ "shape":"Roles", - "documentation":"The roles associated with the assessment.
" + "documentation":"The roles that are associated with the assessment.
" }, "delegations":{ "shape":"Delegations", - "documentation":"The delegations associated with the assessment.
" + "documentation":"The delegations that are associated with the assessment.
" }, "creationTime":{ "shape":"Timestamp", @@ -1276,7 +1409,7 @@ "documentation":"The time of the most recent update.
" } }, - "documentation":"A metadata object associated with an assessment in Audit Manager.
" + "documentation":"A metadata object that's associated with an assessment in Audit Manager.
" }, "AssessmentName":{ "type":"string", @@ -1289,11 +1422,11 @@ "members":{ "id":{ "shape":"UUID", - "documentation":"The unique identifier for the specified assessment report.
" + "documentation":"The unique identifier for the assessment report.
" }, "name":{ "shape":"AssessmentReportName", - "documentation":"The name given to the assessment report.
" + "documentation":"The name that's given to the assessment report.
" }, "description":{ "shape":"AssessmentReportDescription", @@ -1324,7 +1457,7 @@ "documentation":"Specifies when the assessment report was created.
" } }, - "documentation":"A finalized document generated from an Audit Manager assessment. These reports summarize the relevant evidence collected for your audit, and link to the relevant evidence folders which are named and organized according to the controls specified in your assessment.
" + "documentation":"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.
" }, "AssessmentReportDescription":{ "type":"string", @@ -1344,11 +1477,11 @@ }, "errorCode":{ "shape":"ErrorCode", - "documentation":" The error code returned by the AssessmentReportEvidence API.
The error code that the AssessmentReportEvidence API returned.
The error message returned by the AssessmentReportEvidence API.
The error message that the AssessmentReportEvidence API returned.
An error entity for the AssessmentReportEvidence API. This is used to provide more meaningful errors than a simple string message.
The description of the specified assessment report.
" + "documentation":"The description of the assessment report.
" }, "assessmentId":{ "shape":"UUID", @@ -1393,7 +1526,7 @@ "documentation":"Specifies when the assessment report was created.
" } }, - "documentation":"The metadata objects associated with the specified assessment report.
" + "documentation":"The metadata objects that are associated with the specified assessment report.
" }, "AssessmentReportName":{ "type":"string", @@ -1421,7 +1554,7 @@ "documentation":"The destination of the assessment report.
" } }, - "documentation":"The location in which Audit Manager saves assessment reports for the given assessment.
" + "documentation":"The location where Audit Manager saves assessment reports for the given assessment.
" }, "AssessmentReportsMetadata":{ "type":"list", @@ -1443,13 +1576,13 @@ "members":{ "assessmentId":{ "shape":"UUID", - "documentation":"The identifier for the specified assessment.
", + "documentation":"The identifier for the assessment.
", "location":"uri", "locationName":"assessmentId" }, "evidenceFolderId":{ "shape":"UUID", - "documentation":"The identifier for the folder in which evidence is stored.
" + "documentation":"The identifier for the folder that the evidence is stored in.
" } } }, @@ -1474,13 +1607,13 @@ "members":{ "assessmentId":{ "shape":"UUID", - "documentation":"The unique identifier for the specified assessment.
", + "documentation":"The identifier for the assessment.
", "location":"uri", "locationName":"assessmentId" }, "evidenceFolderId":{ "shape":"UUID", - "documentation":"The identifier for the folder in which the evidence is stored.
" + "documentation":"The identifier for the folder that the evidence is stored in.
" }, "evidenceIds":{ "shape":"EvidenceIds", @@ -1493,11 +1626,11 @@ "members":{ "evidenceIds":{ "shape":"EvidenceIds", - "documentation":"The identifier for the evidence.
" + "documentation":"The list of evidence identifiers.
" }, "errors":{ "shape":"AssessmentReportEvidenceErrors", - "documentation":" A list of errors returned by the BatchAssociateAssessmentReportEvidence API.
A list of errors that the BatchAssociateAssessmentReportEvidence API returned.
The error code returned by the BatchCreateDelegationByAssessment API.
The error code that the BatchCreateDelegationByAssessment API returned.
The error message returned by the BatchCreateDelegationByAssessment API.
The error message that the BatchCreateDelegationByAssessment API returned.
An error entity for the BatchCreateDelegationByAssessment API. This is used to provide more meaningful errors than a simple string message.
The identifier for the specified assessment.
", + "documentation":"The identifier for the assessment.
", "location":"uri", "locationName":"assessmentId" } @@ -1547,11 +1680,11 @@ "members":{ "delegations":{ "shape":"Delegations", - "documentation":"The delegations associated with the assessment.
" + "documentation":"The delegations that are associated with the assessment.
" }, "errors":{ "shape":"BatchCreateDelegationByAssessmentErrors", - "documentation":" A list of errors returned by the BatchCreateDelegationByAssessment API.
A list of errors that the BatchCreateDelegationByAssessment API returned.
The identifier for the specified delegation.
" + "documentation":"The identifier for the delegation.
" }, "errorCode":{ "shape":"ErrorCode", - "documentation":" The error code returned by the BatchDeleteDelegationByAssessment API.
The error code that the BatchDeleteDelegationByAssessment API returned.
The error message returned by the BatchDeleteDelegationByAssessment API.
The error message that the BatchDeleteDelegationByAssessment API returned.
An error entity for the BatchDeleteDelegationByAssessment API. This is used to provide more meaningful errors than a simple string message.
The identifiers for the specified delegations.
" + "documentation":"The identifiers for the delegations.
" }, "assessmentId":{ "shape":"UUID", - "documentation":"The identifier for the specified assessment.
", + "documentation":"The identifier for the assessment.
", "location":"uri", "locationName":"assessmentId" } @@ -1601,7 +1734,7 @@ "members":{ "errors":{ "shape":"BatchDeleteDelegationByAssessmentErrors", - "documentation":" A list of errors returned by the BatchDeleteDelegationByAssessment API.
A list of errors that the BatchDeleteDelegationByAssessment API returned.
The identifier for the specified assessment.
", + "documentation":"The identifier for the assessment.
", "location":"uri", "locationName":"assessmentId" }, "evidenceFolderId":{ "shape":"UUID", - "documentation":"The identifier for the folder in which evidence is stored.
" + "documentation":"The identifier for the folder that the evidence is stored in.
" }, "evidenceIds":{ "shape":"EvidenceIds", @@ -1638,7 +1771,7 @@ }, "errors":{ "shape":"AssessmentReportEvidenceErrors", - "documentation":" A list of errors returned by the BatchDisassociateAssessmentReportEvidence API.
A list of errors that the BatchDisassociateAssessmentReportEvidence API returned.
Manual evidence that cannot be collected automatically by Audit Manager.
" + "documentation":"Manual evidence that can't be collected automatically by Audit Manager.
" }, "errorCode":{ "shape":"ErrorCode", - "documentation":" The error code returned by the BatchImportEvidenceToAssessmentControl API.
The error code that the BatchImportEvidenceToAssessmentControl API returned.
The error message returned by the BatchImportEvidenceToAssessmentControl API.
The error message that the BatchImportEvidenceToAssessmentControl API returned.
An error entity for the BatchImportEvidenceToAssessmentControl API. This is used to provide more meaningful errors than a simple string message.
The identifier for the specified assessment.
", + "documentation":"The identifier for the assessment.
", "location":"uri", "locationName":"assessmentId" }, "controlSetId":{ "shape":"ControlSetId", - "documentation":"The identifier for the specified control set.
", + "documentation":"The identifier for the control set.
", "location":"uri", "locationName":"controlSetId" }, "controlId":{ "shape":"UUID", - "documentation":"The identifier for the specified control.
", + "documentation":"The identifier for the control.
", "location":"uri", "locationName":"controlId" }, @@ -1702,7 +1835,7 @@ "members":{ "errors":{ "shape":"BatchImportEvidenceToAssessmentControlErrors", - "documentation":" A list of errors returned by the BatchImportEvidenceToAssessmentControl API.
A list of errors that the BatchImportEvidenceToAssessmentControl API returned.
The changelog object type, such as an assessment, control, or control set.
" + "documentation":"The object that was changed, such as an assessment, control, or control set.
" }, "objectName":{ "shape":"NonEmptyString", - "documentation":"The name of the changelog object.
" + "documentation":"The name of the object that changed. This could be the name of an assessment, control, or control set.
" }, "action":{ "shape":"ActionEnum", - "documentation":"The action performed.
" + "documentation":"The action that was performed.
" }, "createdAt":{ "shape":"Timestamp", - "documentation":"The time of creation for the changelog object.
" + "documentation":"The time when the action was performed and the changelog record was created.
" }, "createdBy":{ "shape":"IamArn", "documentation":"The IAM user or role that performed the action.
" } }, - "documentation":"The record of a change within Audit Manager, such as a modified assessment, a delegated control set, and so on.
" + "documentation":"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.
" }, "ChangeLogs":{ "type":"list", @@ -1747,7 +1880,7 @@ "members":{ "arn":{ "shape":"AuditManagerArn", - "documentation":"The Amazon Resource Name (ARN) of the specified control.
" + "documentation":"The Amazon Resource Name (ARN) of the control.
" }, "id":{ "shape":"UUID", @@ -1755,19 +1888,19 @@ }, "type":{ "shape":"ControlType", - "documentation":"The type of control, such as custom or standard.
" + "documentation":"The type of control, such as a custom control or a standard control.
" }, "name":{ "shape":"ControlName", - "documentation":"The name of the specified control.
" + "documentation":"The name of the control.
" }, "description":{ "shape":"ControlDescription", - "documentation":"The description of the specified control.
" + "documentation":"The description of the control.
" }, "testingInformation":{ "shape":"TestingInformation", - "documentation":"The steps to follow to determine if the control has been satisfied.
" + "documentation":"The steps that you should follow to determine if the control has been satisfied.
" }, "actionPlanTitle":{ "shape":"ActionPlanTitle", @@ -1775,15 +1908,15 @@ }, "actionPlanInstructions":{ "shape":"ActionPlanInstructions", - "documentation":"The recommended actions to carry out if the control is not fulfilled.
" + "documentation":"The recommended actions to carry out if the control isn't fulfilled.
" }, "controlSources":{ "shape":"ControlSources", - "documentation":"The data source that determines from where Audit Manager collects evidence for the control.
" + "documentation":"The data source that determines where Audit Manager collects evidence from for the control.
" }, "controlMappingSources":{ "shape":"ControlMappingSources", - "documentation":"The data mapping sources for the specified control.
" + "documentation":"The data mapping sources for the control.
" }, "createdAt":{ "shape":"Timestamp", @@ -1824,7 +1957,7 @@ "documentation":"The time when the comment was posted.
" } }, - "documentation":"A comment posted by a user on a control. This includes the author's name, the comment text, and a timestamp.
" + "documentation":"A comment that's posted by a user on a control. This includes the author's name, the comment text, and a timestamp.
" }, "ControlCommentBody":{ "type":"string", @@ -1845,19 +1978,19 @@ "members":{ "sourceId":{ "shape":"UUID", - "documentation":"The unique identifier for the specified source.
" + "documentation":"The unique identifier for the source.
" }, "sourceName":{ "shape":"SourceName", - "documentation":"The name of the specified source.
" + "documentation":"The name of the source.
" }, "sourceDescription":{ "shape":"SourceDescription", - "documentation":"The description of the specified source.
" + "documentation":"The description of the source.
" }, "sourceSetUpOption":{ "shape":"SourceSetUpOption", - "documentation":"The setup option for the data source, which reflects if the evidence collection is automated or manual.
" + "documentation":"The setup option for the data source. This option reflects if the evidence collection is automated or manual.
" }, "sourceType":{ "shape":"SourceType", @@ -1866,14 +1999,14 @@ "sourceKeyword":{"shape":"SourceKeyword"}, "sourceFrequency":{ "shape":"SourceFrequency", - "documentation":"The frequency of evidence collection for the specified control mapping source.
" + "documentation":"The frequency of evidence collection for the control mapping source.
" }, "troubleshootingText":{ "shape":"TroubleshootingText", - "documentation":"The instructions for troubleshooting the specified control.
" + "documentation":"The instructions for troubleshooting the control.
" } }, - "documentation":"The data source that determines from where Audit Manager collects evidence for the control.
" + "documentation":"The data source that determines where Audit Manager collects evidence from for the control.
" }, "ControlMappingSources":{ "type":"list", @@ -1885,19 +2018,19 @@ "members":{ "arn":{ "shape":"AuditManagerArn", - "documentation":"The Amazon Resource Name (ARN) of the specified control.
" + "documentation":"The Amazon Resource Name (ARN) of the control.
" }, "id":{ "shape":"UUID", - "documentation":"The unique identifier for the specified control.
" + "documentation":"The unique identifier for the control.
" }, "name":{ "shape":"ControlName", - "documentation":"The name of the specified control.
" + "documentation":"The name of the control.
" }, "controlSources":{ "shape":"ControlSources", - "documentation":"The data source that determines from where Audit Manager collects evidence for the control.
" + "documentation":"The data source that determines where Audit Manager collects evidence from for the control.
" }, "createdAt":{ "shape":"Timestamp", @@ -1908,7 +2041,7 @@ "documentation":"Specifies when the control was most recently updated.
" } }, - "documentation":"The metadata associated with the specified standard or custom control.
" + "documentation":"The metadata that's associated with the standard control or custom control.
" }, "ControlMetadataList":{ "type":"list", @@ -2008,7 +2141,7 @@ "documentation":"The unique identifier of the control.
" } }, - "documentation":"Control entity attributes that uniquely identify an existing control to be added to a framework in Audit Manager.
" + "documentation":"The control entity attributes that uniquely identify an existing control to be added to a framework in Audit Manager.
" }, "CreateAssessmentFrameworkControlSet":{ "type":"structure", @@ -2016,14 +2149,14 @@ "members":{ "name":{ "shape":"ControlSetName", - "documentation":"The name of the specified control set.
" + "documentation":"The name of the control set.
" }, "controls":{ "shape":"CreateAssessmentFrameworkControls", - "documentation":"The list of controls within the control set. This does not contain the control set ID.
" + "documentation":"The list of controls within the control set. This doesn't contain the control set ID.
" } }, - "documentation":" A controlSet entity that represents a collection of controls in Audit Manager. This does not contain the control set ID.
A controlSet entity that represents a collection of controls in Audit Manager. This doesn't contain the control set ID.
The control sets to be associated with the framework.
" + "documentation":"The control sets that are associated with the framework.
" }, "tags":{ "shape":"TagMap", - "documentation":"The tags associated with the framework.
" + "documentation":"The tags that are associated with the framework.
" } } }, @@ -2069,7 +2202,7 @@ "members":{ "framework":{ "shape":"Framework", - "documentation":" The name of the new framework returned by the CreateAssessmentFramework API.
The name of the new framework that the CreateAssessmentFramework API returned.
The identifier for the specified assessment.
", + "documentation":"The identifier for the assessment.
", "location":"uri", "locationName":"assessmentId" } @@ -2101,7 +2234,7 @@ "members":{ "assessmentReport":{ "shape":"AssessmentReport", - "documentation":" The new assessment report returned by the CreateAssessmentReport API.
The new assessment report that the CreateAssessmentReport API returned.
The assessment report storage destination for the specified assessment that is being created.
" + "documentation":"The assessment report storage destination for the assessment that's being created.
" }, "scope":{"shape":"Scope"}, "roles":{ "shape":"Roles", - "documentation":"The list of roles for the specified assessment.
" + "documentation":"The list of roles for the assessment.
" }, "frameworkId":{ "shape":"UUID", - "documentation":"The identifier for the specified framework.
" + "documentation":"The identifier for the framework that the assessment will be created from.
" }, "tags":{ "shape":"TagMap", - "documentation":"The tags associated with the assessment.
" + "documentation":"The tags that are associated with the assessment.
" } } }, @@ -2157,7 +2290,7 @@ }, "sourceDescription":{ "shape":"SourceDescription", - "documentation":"The description of the data source that determines from where Audit Manager collects evidence for the control.
" + "documentation":"The description of the data source that determines where Audit Manager collects evidence from for the control.
" }, "sourceSetUpOption":{ "shape":"SourceSetUpOption", @@ -2170,14 +2303,14 @@ "sourceKeyword":{"shape":"SourceKeyword"}, "sourceFrequency":{ "shape":"SourceFrequency", - "documentation":"The frequency of evidence collection for the specified control mapping source.
" + "documentation":"The frequency of evidence collection for the control mapping source.
" }, "troubleshootingText":{ "shape":"TroubleshootingText", - "documentation":"The instructions for troubleshooting the specified control.
" + "documentation":"The instructions for troubleshooting the control.
" } }, - "documentation":" Control mapping fields that represent the source for evidence collection, along with related parameters and metadata. This does not contain mappingID.
The control mapping fields that represent the source for evidence collection, along with related parameters and metadata. This doesn't contain mappingID.
The steps to follow to determine if the control has been satisfied.
" + "documentation":"The steps to follow to determine if the control is satisfied.
" }, "actionPlanTitle":{ "shape":"ActionPlanTitle", @@ -2209,15 +2342,15 @@ }, "actionPlanInstructions":{ "shape":"ActionPlanInstructions", - "documentation":"The recommended actions to carry out if the control is not fulfilled.
" + "documentation":"The recommended actions to carry out if the control isn't fulfilled.
" }, "controlMappingSources":{ "shape":"CreateControlMappingSources", - "documentation":"The data mapping sources for the specified control.
" + "documentation":"The data mapping sources for the control.
" }, "tags":{ "shape":"TagMap", - "documentation":"The tags associated with the control.
" + "documentation":"The tags that are associated with the control.
" } } }, @@ -2226,7 +2359,7 @@ "members":{ "control":{ "shape":"Control", - "documentation":" The new control returned by the CreateControl API.
The new control that the CreateControl API returned.
A comment related to the delegation request.
" + "documentation":"A comment that's related to the delegation request.
" }, "controlSetId":{ "shape":"ControlSetId", @@ -2250,7 +2383,7 @@ "documentation":"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.
A collection of attributes used to create a delegation for an assessment in Audit Manager.
" + "documentation":"A collection of attributes that's used to create a delegation for an assessment in Audit Manager.
" }, "CreateDelegationRequests":{ "type":"list", @@ -2273,11 +2406,11 @@ }, "assessmentName":{ "shape":"AssessmentName", - "documentation":"The name of the associated assessment.
" + "documentation":"The name of the assessment that's associated with the delegation.
" }, "assessmentId":{ "shape":"UUID", - "documentation":"The identifier for the associated assessment.
" + "documentation":"The identifier for the assessment that's associated with the delegation.
" }, "status":{ "shape":"DelegationStatus", @@ -2301,11 +2434,11 @@ }, "controlSetId":{ "shape":"ControlSetId", - "documentation":"The identifier for the associated control set.
" + "documentation":"The identifier for the control set that's associated with the delegation.
" }, "comment":{ "shape":"DelegationComment", - "documentation":"The comment related to the delegation.
" + "documentation":"The comment that's related to the delegation.
" }, "createdBy":{ "shape":"CreatedBy", @@ -2338,11 +2471,11 @@ }, "assessmentId":{ "shape":"UUID", - "documentation":"The unique identifier for the specified assessment.
" + "documentation":"The unique identifier for the assessment.
" }, "status":{ "shape":"DelegationStatus", - "documentation":"The current status of the delgation.
" + "documentation":"The current status of the delegation.
" }, "roleArn":{ "shape":"IamArn", @@ -2354,10 +2487,10 @@ }, "controlSetName":{ "shape":"NonEmptyString", - "documentation":"Specifies the name of the control set delegated for review.
" + "documentation":"Specifies the name of the control set that was delegated for review.
" } }, - "documentation":"The metadata associated with the specified delegation.
" + "documentation":"The metadata that's associated with the delegation.
" }, "DelegationMetadataList":{ "type":"list", @@ -2381,7 +2514,7 @@ "members":{ "frameworkId":{ "shape":"UUID", - "documentation":"The identifier for the specified framework.
", + "documentation":"The identifier for the framework.
", "location":"uri", "locationName":"frameworkId" } @@ -2392,6 +2525,32 @@ "members":{ } }, + "DeleteAssessmentFrameworkShareRequest":{ + "type":"structure", + "required":[ + "requestId", + "requestType" + ], + "members":{ + "requestId":{ + "shape":"UUID", + "documentation":"The unique identifier for the share request to be deleted.
", + "location":"uri", + "locationName":"requestId" + }, + "requestType":{ + "shape":"ShareRequestType", + "documentation":"Specifies whether the share request is a sent request or a received request.
", + "location":"querystring", + "locationName":"requestType" + } + } + }, + "DeleteAssessmentFrameworkShareResponse":{ + "type":"structure", + "members":{ + } + }, "DeleteAssessmentReportRequest":{ "type":"structure", "required":[ @@ -2401,7 +2560,7 @@ "members":{ "assessmentId":{ "shape":"UUID", - "documentation":"The identifier for the specified assessment.
", + "documentation":"The identifier for the assessment.
", "location":"uri", "locationName":"assessmentId" }, @@ -2424,7 +2583,7 @@ "members":{ "assessmentId":{ "shape":"UUID", - "documentation":"The identifier for the specified assessment.
", + "documentation":"The identifier for the assessment.
", "location":"uri", "locationName":"assessmentId" } @@ -2441,7 +2600,7 @@ "members":{ "controlId":{ "shape":"UUID", - "documentation":"The identifier for the specified control.
", + "documentation":"The identifier for the control.
", "location":"uri", "locationName":"controlId" } @@ -2471,7 +2630,7 @@ "members":{ "adminAccountId":{ "shape":"AccountId", - "documentation":"The identifier for the specified administrator account.
" + "documentation":"The identifier for the administrator account.
" } } }, @@ -2489,7 +2648,7 @@ "members":{ "assessmentId":{ "shape":"UUID", - "documentation":"The identifier for the specified assessment.
", + "documentation":"The identifier for the assessment.
", "location":"uri", "locationName":"assessmentId" }, @@ -2531,11 +2690,11 @@ "members":{ "dataSource":{ "shape":"String", - "documentation":"The data source from which the specified evidence was collected.
" + "documentation":"The data source where the evidence was collected from.
" }, "evidenceAwsAccountId":{ "shape":"AccountId", - "documentation":"The identifier for the specified Amazon Web Services account.
" + "documentation":"The identifier for the Amazon Web Services account.
" }, "time":{ "shape":"Timestamp", @@ -2543,11 +2702,11 @@ }, "eventSource":{ "shape":"AWSServiceName", - "documentation":"The Amazon Web Service from which the evidence is collected.
" + "documentation":"The Amazon Web Service that the evidence is collected from.
" }, "eventName":{ "shape":"EventName", - "documentation":"The name of the specified evidence event.
" + "documentation":"The name of the evidence event.
" }, "evidenceByType":{ "shape":"String", @@ -2555,15 +2714,15 @@ }, "resourcesIncluded":{ "shape":"Resources", - "documentation":"The list of resources assessed to generate the evidence.
" + "documentation":"The list of resources that are assessed to generate the evidence.
" }, "attributes":{ "shape":"EvidenceAttributes", - "documentation":" The names and values used by the evidence event, including an attribute name (such as allowUsersToChangePassword) and value (such as true or false).
The names and values that are used by the evidence event. This includes an attribute name (such as allowUsersToChangePassword) and value (such as true or false).
The unique identifier for the IAM user or role associated with the evidence.
" + "documentation":"The unique identifier for the IAM user or role that's associated with the evidence.
" }, "complianceCheck":{ "shape":"String", @@ -2571,15 +2730,15 @@ }, "awsOrganization":{ "shape":"String", - "documentation":"The Amazon Web Services account from which the evidence is collected, and its organization path.
" + "documentation":"The Amazon Web Services account that the evidence is collected from, and its organization path.
" }, "awsAccountId":{ "shape":"AccountId", - "documentation":"The identifier for the specified Amazon Web Services account.
" + "documentation":"The identifier for the Amazon Web Services account.
" }, "evidenceFolderId":{ "shape":"UUID", - "documentation":"The identifier for the folder in which the evidence is stored.
" + "documentation":"The identifier for the folder that the evidence is stored in.
" }, "id":{ "shape":"UUID", @@ -2632,19 +2791,19 @@ "members":{ "arn":{ "shape":"AuditManagerArn", - "documentation":"The Amazon Resource Name (ARN) of the specified framework.
" + "documentation":"The Amazon Resource Name (ARN) of the framework.
" }, "id":{ "shape":"UUID", - "documentation":"The unique identifier for the specified framework.
" + "documentation":"The unique identifier for the framework.
" }, "name":{ "shape":"FrameworkName", - "documentation":"The name of the specified framework.
" + "documentation":"The name of the framework.
" }, "type":{ "shape":"FrameworkType", - "documentation":"The framework type, such as custom or standard.
" + "documentation":"The framework type, such as a custom framework or a standard framework.
" }, "complianceType":{ "shape":"ComplianceType", @@ -2652,19 +2811,19 @@ }, "description":{ "shape":"FrameworkDescription", - "documentation":"The description of the specified framework.
" + "documentation":"The description of the framework.
" }, "logo":{ "shape":"Filename", - "documentation":"The logo associated with the framework.
" + "documentation":"The logo that's associated with the framework.
" }, "controlSources":{ "shape":"ControlSources", - "documentation":"The sources from which Audit Manager collects evidence for the control.
" + "documentation":"The sources that Audit Manager collects evidence from for the control.
" }, "controlSets":{ "shape":"ControlSets", - "documentation":"The control sets associated with the framework.
" + "documentation":"The control sets that are associated with the framework.
" }, "createdAt":{ "shape":"Timestamp", @@ -2684,10 +2843,10 @@ }, "tags":{ "shape":"TagMap", - "documentation":"The tags associated with the framework.
" + "documentation":"The tags that are associated with the framework.
" } }, - "documentation":"The file used to structure and automate Audit Manager assessments for a given compliance standard.
" + "documentation":"The file that's used to structure and automate Audit Manager assessments for a given compliance standard.
" }, "FrameworkDescription":{ "type":"string", @@ -2708,14 +2867,14 @@ }, "logo":{ "shape":"Filename", - "documentation":"The logo associated with the framework.
" + "documentation":"The logo that's associated with the framework.
" }, "complianceType":{ "shape":"ComplianceType", - "documentation":"The compliance standard associated with the framework, such as PCI-DSS or HIPAA.
" + "documentation":"The compliance standard that's associated with the framework. For example, this could be PCI DSS or HIPAA.
" } }, - "documentation":"The metadata of a framework, such as the name, ID, description, and so on.
" + "documentation":"The metadata of a framework, such as the name, ID, or description.
" }, "FrameworkMetadataList":{ "type":"list", @@ -2750,7 +2909,7 @@ "members":{ "status":{ "shape":"AccountStatus", - "documentation":"The status of the specified Amazon Web Services account.
" + "documentation":"The status of the Amazon Web Services account.
" } } }, @@ -2760,7 +2919,7 @@ "members":{ "frameworkId":{ "shape":"UUID", - "documentation":"The identifier for the specified framework.
", + "documentation":"The identifier for the framework.
", "location":"uri", "locationName":"frameworkId" } @@ -2771,7 +2930,7 @@ "members":{ "framework":{ "shape":"Framework", - "documentation":" The framework returned by the GetAssessmentFramework API.
The framework that the GetAssessmentFramework API returned.
The identifier for the specified assessment.
", + "documentation":"The identifier for the assessment.
", "location":"uri", "locationName":"assessmentId" } @@ -2808,7 +2967,7 @@ "members":{ "assessmentId":{ "shape":"UUID", - "documentation":"The identifier for the specified assessment.
", + "documentation":"The identifier for the assessment.
", "location":"uri", "locationName":"assessmentId" } @@ -2827,31 +2986,31 @@ "members":{ "assessmentId":{ "shape":"UUID", - "documentation":"The identifier for the specified assessment.
", + "documentation":"The identifier for the assessment.
", "location":"uri", "locationName":"assessmentId" }, "controlSetId":{ "shape":"ControlSetId", - "documentation":"The identifier for the specified control set.
", + "documentation":"The identifier for the control set.
", "location":"querystring", "locationName":"controlSetId" }, "controlId":{ "shape":"UUID", - "documentation":"The identifier for the specified control.
", + "documentation":"The identifier for the control.
", "location":"querystring", "locationName":"controlId" }, "nextToken":{ "shape":"Token", - "documentation":"The pagination token used to fetch the next set of results.
", + "documentation":"The pagination token that's used to fetch the next set of results.
", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", - "documentation":"Represents the maximum number of results per page, or per API request call.
", + "documentation":"Represents the maximum number of results on a page or for an API request call.
", "location":"querystring", "locationName":"maxResults" } @@ -2866,7 +3025,7 @@ }, "nextToken":{ "shape":"Token", - "documentation":"The pagination token used to fetch the next set of results.
" + "documentation":"The pagination token that's used to fetch the next set of results.
" } } }, @@ -2876,7 +3035,7 @@ "members":{ "controlId":{ "shape":"UUID", - "documentation":"The identifier for the specified control.
", + "documentation":"The identifier for the control.
", "location":"uri", "locationName":"controlId" } @@ -2887,7 +3046,7 @@ "members":{ "control":{ "shape":"Control", - "documentation":" The name of the control returned by the GetControl API.
The name of the control that the GetControl API returned.
The pagination token used to fetch the next set of results.
", + "documentation":"The pagination token that's used to fetch the next set of results.
", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", - "documentation":"Represents the maximum number of results per page, or per API request call.
", + "documentation":"Represents the maximum number of results on a page or for an API request call.
", "location":"querystring", "locationName":"maxResults" } @@ -2913,11 +3072,11 @@ "members":{ "delegations":{ "shape":"DelegationMetadataList", - "documentation":" The list of delegations returned by the GetDelegations API.
The list of delegations that the GetDelegations API returned.
The pagination token used to fetch the next set of results.
" + "documentation":"The pagination token that's used to fetch the next set of results.
" } } }, @@ -2931,7 +3090,7 @@ "members":{ "assessmentId":{ "shape":"UUID", - "documentation":"The identifier for the specified assessment.
", + "documentation":"The identifier for the assessment.
", "location":"uri", "locationName":"assessmentId" }, @@ -2943,19 +3102,19 @@ }, "evidenceFolderId":{ "shape":"UUID", - "documentation":"The unique identifier for the folder in which the evidence is stored.
", + "documentation":"The unique identifier for the folder that the evidence is stored in.
", "location":"uri", "locationName":"evidenceFolderId" }, "nextToken":{ "shape":"Token", - "documentation":"The pagination token used to fetch the next set of results.
", + "documentation":"The pagination token that's used to fetch the next set of results.
", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", - "documentation":"Represents the maximum number of results per page, or per API request call.
", + "documentation":"Represents the maximum number of results on a page or for an API request call.
", "location":"querystring", "locationName":"maxResults" } @@ -2966,11 +3125,11 @@ "members":{ "evidence":{ "shape":"EvidenceList", - "documentation":" The list of evidence returned by the GetEvidenceByEvidenceFolder API.
The list of evidence that the GetEvidenceByEvidenceFolder API returned.
The pagination token used to fetch the next set of results.
" + "documentation":"The pagination token that's used to fetch the next set of results.
" } } }, @@ -2984,19 +3143,19 @@ "members":{ "assessmentId":{ "shape":"UUID", - "documentation":"The identifier for the specified assessment.
", + "documentation":"The identifier for the assessment.
", "location":"uri", "locationName":"assessmentId" }, "controlSetId":{ "shape":"ControlSetId", - "documentation":"The identifier for the specified control set.
", + "documentation":"The identifier for the control set.
", "location":"uri", "locationName":"controlSetId" }, "evidenceFolderId":{ "shape":"UUID", - "documentation":"The identifier for the folder in which the evidence is stored.
", + "documentation":"The identifier for the folder that the evidence is stored in.
", "location":"uri", "locationName":"evidenceFolderId" } @@ -3007,7 +3166,7 @@ "members":{ "evidenceFolder":{ "shape":"AssessmentEvidenceFolder", - "documentation":"The folder in which evidence is stored.
" + "documentation":"The folder that the evidence is stored in.
" } } }, @@ -3021,31 +3180,31 @@ "members":{ "assessmentId":{ "shape":"UUID", - "documentation":"The identifier for the specified assessment.
", + "documentation":"The identifier for the assessment.
", "location":"uri", "locationName":"assessmentId" }, "controlSetId":{ "shape":"ControlSetId", - "documentation":"The identifier for the specified control set.
", + "documentation":"The identifier for the control set.
", "location":"uri", "locationName":"controlSetId" }, "controlId":{ "shape":"UUID", - "documentation":"The identifier for the specified control.
", + "documentation":"The identifier for the control.
", "location":"uri", "locationName":"controlId" }, "nextToken":{ "shape":"Token", - "documentation":"The pagination token used to fetch the next set of results.
", + "documentation":"The pagination token that's used to fetch the next set of results.
", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", - "documentation":"Represents the maximum number of results per page, or per API request call.
", + "documentation":"Represents the maximum number of results on a page or for an API request call.
", "location":"querystring", "locationName":"maxResults" } @@ -3056,11 +3215,11 @@ "members":{ "evidenceFolders":{ "shape":"AssessmentEvidenceFolders", - "documentation":" The list of evidence folders returned by the GetEvidenceFoldersByAssessmentControl API.
The list of evidence folders that the GetEvidenceFoldersByAssessmentControl API returned.
The pagination token used to fetch the next set of results.
" + "documentation":"The pagination token that's used to fetch the next set of results.
" } } }, @@ -3070,19 +3229,19 @@ "members":{ "assessmentId":{ "shape":"UUID", - "documentation":"The identifier for the specified assessment.
", + "documentation":"The identifier for the assessment.
", "location":"uri", "locationName":"assessmentId" }, "nextToken":{ "shape":"Token", - "documentation":"The pagination token used to fetch the next set of results.
", + "documentation":"The pagination token that's used to fetch the next set of results.
", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", - "documentation":"Represents the maximum number of results per page, or per API request call.
", + "documentation":"Represents the maximum number of results on a page or for an API request call.
", "location":"querystring", "locationName":"maxResults" } @@ -3093,11 +3252,11 @@ "members":{ "evidenceFolders":{ "shape":"AssessmentEvidenceFolders", - "documentation":" The list of evidence folders returned by the GetEvidenceFoldersByAssessment API.
The list of evidence folders that the GetEvidenceFoldersByAssessment API returned.
The pagination token used to fetch the next set of results.
" + "documentation":"The pagination token that's used to fetch the next set of results.
" } } }, @@ -3112,19 +3271,19 @@ "members":{ "assessmentId":{ "shape":"UUID", - "documentation":"The identifier for the specified assessment.
", + "documentation":"The identifier for the assessment.
", "location":"uri", "locationName":"assessmentId" }, "controlSetId":{ "shape":"ControlSetId", - "documentation":"The identifier for the specified control set.
", + "documentation":"The identifier for the control set.
", "location":"uri", "locationName":"controlSetId" }, "evidenceFolderId":{ "shape":"UUID", - "documentation":"The identifier for the folder in which the evidence is stored.
", + "documentation":"The identifier for the folder that the evidence is stored in.
", "location":"uri", "locationName":"evidenceFolderId" }, @@ -3141,7 +3300,7 @@ "members":{ "evidence":{ "shape":"Evidence", - "documentation":" The evidence returned by the GetEvidenceResponse API.
The evidence that the GetEvidenceResponse API returned.
The identifier for the specified administrator account.
" + "documentation":"The identifier for the administrator account.
" }, "organizationId":{ "shape":"organizationId", - "documentation":"The identifier for the specified organization.
" + "documentation":"The identifier for the organization.
" } } }, @@ -3173,7 +3332,7 @@ "members":{ "serviceMetadata":{ "shape":"ServiceMetadataList", - "documentation":"The metadata associated with the Amazon Web Service.
" + "documentation":"The metadata that's associated with the Amazon Web Service.
" } } }, @@ -3248,25 +3407,62 @@ "min":1, "pattern":"^[a-zA-Z0-9\\s-_()\\[\\]]+$" }, + "ListAssessmentFrameworkShareRequestsRequest":{ + "type":"structure", + "required":["requestType"], + "members":{ + "requestType":{ + "shape":"ShareRequestType", + "documentation":"Specifies whether the share request is a sent request or a received request.
", + "location":"querystring", + "locationName":"requestType" + }, + "nextToken":{ + "shape":"Token", + "documentation":"The pagination token that's used to fetch the next set of results.
", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"Represents the maximum number of results on a page or for an API request call.
", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListAssessmentFrameworkShareRequestsResponse":{ + "type":"structure", + "members":{ + "assessmentFrameworkShareRequests":{ + "shape":"AssessmentFrameworkShareRequestList", + "documentation":" The list of share requests that the ListAssessmentFrameworkShareRequests API returned.
The pagination token that's used to fetch the next set of results.
" + } + } + }, "ListAssessmentFrameworksRequest":{ "type":"structure", "required":["frameworkType"], "members":{ "frameworkType":{ "shape":"FrameworkType", - "documentation":"The type of framework, such as standard or custom.
", + "documentation":"The type of framework, such as a standard framework or a custom framework.
", "location":"querystring", "locationName":"frameworkType" }, "nextToken":{ "shape":"Token", - "documentation":"The pagination token used to fetch the next set of results.
", + "documentation":"The pagination token that's used to fetch the next set of results.
", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", - "documentation":"Represents the maximum number of results per page, or per API request call.
", + "documentation":"Represents the maximum number of results on a page or for an API request call.
", "location":"querystring", "locationName":"maxResults" } @@ -3277,11 +3473,11 @@ "members":{ "frameworkMetadataList":{ "shape":"FrameworkMetadataList", - "documentation":"The list of metadata objects for the specified framework.
" + "documentation":"The list of metadata objects for the framework.
" }, "nextToken":{ "shape":"Token", - "documentation":"The pagination token used to fetch the next set of results.
" + "documentation":"The pagination token that's used to fetch the next set of results.
" } } }, @@ -3294,13 +3490,13 @@ "members":{ "nextToken":{ "shape":"Token", - "documentation":"The pagination token used to fetch the next set of results.
", + "documentation":"The pagination token that's used to fetch the next set of results.
", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", - "documentation":"Represents the maximum number of results per page, or per API request call.
", + "documentation":"Represents the maximum number of results on a page or for an API request call.
", "location":"querystring", "locationName":"maxResults" } @@ -3311,11 +3507,11 @@ "members":{ "assessmentReports":{ "shape":"AssessmentReportsMetadata", - "documentation":" The list of assessment reports returned by the ListAssessmentReports API.
The list of assessment reports that the ListAssessmentReports API returned.
The pagination token used to fetch the next set of results.
" + "documentation":"The pagination token that's used to fetch the next set of results.
" } } }, @@ -3324,13 +3520,13 @@ "members":{ "nextToken":{ "shape":"Token", - "documentation":"The pagination token used to fetch the next set of results.
", + "documentation":"The pagination token that's used to fetch the next set of results.
", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", - "documentation":"Represents the maximum number of results per page, or per API request call.
", + "documentation":"Represents the maximum number of results on a page or for an API request call.
", "location":"querystring", "locationName":"maxResults" } @@ -3341,11 +3537,11 @@ "members":{ "assessmentMetadata":{ "shape":"ListAssessmentMetadata", - "documentation":"The metadata associated with the assessment.
" + "documentation":"The metadata that's associated with the assessment.
" }, "nextToken":{ "shape":"Token", - "documentation":"The pagination token used to fetch the next set of results.
" + "documentation":"The pagination token that's used to fetch the next set of results.
" } } }, @@ -3355,19 +3551,19 @@ "members":{ "controlType":{ "shape":"ControlType", - "documentation":"The type of control, such as standard or custom.
", + "documentation":"The type of control, such as a standard control or a custom control.
", "location":"querystring", "locationName":"controlType" }, "nextToken":{ "shape":"Token", - "documentation":"The pagination token used to fetch the next set of results.
", + "documentation":"The pagination token that's used to fetch the next set of results.
", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", - "documentation":"Represents the maximum number of results per page, or per API request call.
", + "documentation":"Represents the maximum number of results on a page or for an API request call.
", "location":"querystring", "locationName":"maxResults" } @@ -3378,11 +3574,11 @@ "members":{ "controlMetadataList":{ "shape":"ControlMetadataList", - "documentation":" The list of control metadata objects returned by the ListControls API.
The list of control metadata objects that the ListControls API returned.
The pagination token used to fetch the next set of results.
" + "documentation":"The pagination token that's used to fetch the next set of results.
" } } }, @@ -3392,19 +3588,19 @@ "members":{ "source":{ "shape":"SourceType", - "documentation":"The control mapping data source to which the keywords apply.
", + "documentation":"The control mapping data source that the keywords apply to.
", "location":"querystring", "locationName":"source" }, "nextToken":{ "shape":"Token", - "documentation":"The pagination token used to fetch the next set of results.
", + "documentation":"The pagination token that's used to fetch the next set of results.
", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", - "documentation":"Represents the maximum number of results per page, or per API request call.
", + "documentation":"Represents the maximum number of results on a page or for an API request call.
", "location":"querystring", "locationName":"maxResults" } @@ -3415,11 +3611,11 @@ "members":{ "keywords":{ "shape":"Keywords", - "documentation":"The list of keywords for the specified event mapping source.
" + "documentation":"The list of keywords for the event mapping source.
" }, "nextToken":{ "shape":"Token", - "documentation":"The pagination token used to fetch the next set of results.
" + "documentation":"The pagination token that's used to fetch the next set of results.
" } } }, @@ -3428,13 +3624,13 @@ "members":{ "nextToken":{ "shape":"Token", - "documentation":"The pagination token used to fetch the next set of results.
", + "documentation":"The pagination token that's used to fetch the next set of results.
", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", - "documentation":"Represents the maximum number of results per page, or per API request call.
", + "documentation":"Represents the maximum number of results on a page or for an API request call.
", "location":"querystring", "locationName":"maxResults" } @@ -3449,7 +3645,7 @@ }, "nextToken":{ "shape":"Token", - "documentation":"The pagination token used to fetch the next set of results.
" + "documentation":"The pagination token that's used to fetch the next set of results.
" } } }, @@ -3459,7 +3655,7 @@ "members":{ "resourceArn":{ "shape":"AuditManagerArn", - "documentation":"The Amazon Resource Name (ARN) of the specified resource.
", + "documentation":"The Amazon Resource Name (ARN) of the resource.
", "location":"uri", "locationName":"resourceArn" } @@ -3470,7 +3666,7 @@ "members":{ "tags":{ "shape":"TagMap", - "documentation":" The list of tags returned by the ListTagsForResource API.
The list of tags that the ListTagsForResource API returned.
The Amazon S3 URL that points to a manual evidence object.
" } }, - "documentation":"Evidence that is uploaded to Audit Manager manually.
" + "documentation":"Evidence that's uploaded to Audit Manager manually.
" }, "ManualEvidenceList":{ "type":"list", @@ -3511,7 +3707,7 @@ }, "assessmentId":{ "shape":"UUID", - "documentation":"The identifier for the specified assessment.
" + "documentation":"The identifier for the assessment.
" }, "assessmentName":{ "shape":"AssessmentName", @@ -3519,7 +3715,7 @@ }, "controlSetId":{ "shape":"ControlSetId", - "documentation":"The identifier for the specified control set.
" + "documentation":"The identifier for the control set.
" }, "controlSetName":{ "shape":"NonEmptyString", @@ -3538,12 +3734,13 @@ "documentation":"The sender of the notification.
" } }, - "documentation":"The notification used to inform a user of an update in Audit Manager. For example, this includes the notification that is sent when a control set is delegated for review.
" + "documentation":"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.
" }, "Notifications":{ "type":"list", "member":{"shape":"Notification"} }, + "NullableInteger":{"type":"integer"}, "ObjectTypeEnum":{ "type":"string", "enum":[ @@ -3554,6 +3751,10 @@ "ASSESSMENT_REPORT" ] }, + "Region":{ + "type":"string", + "pattern":"^[a-z]{2}-[a-z]+-[0-9]{1}$" + }, "RegisterAccountRequest":{ "type":"structure", "members":{ @@ -3582,7 +3783,7 @@ "members":{ "adminAccountId":{ "shape":"AccountId", - "documentation":"The identifier for the specified delegated administrator account.
" + "documentation":"The identifier for the delegated administrator account.
" } } }, @@ -3591,11 +3792,11 @@ "members":{ "adminAccountId":{ "shape":"AccountId", - "documentation":"The identifier for the specified delegated administrator account.
" + "documentation":"The identifier for the delegated administrator account.
" }, "organizationId":{ "shape":"organizationId", - "documentation":"The identifier for the specified organization.
" + "documentation":"The identifier for the organization.
" } } }, @@ -3604,14 +3805,14 @@ "members":{ "arn":{ "shape":"GenericArn", - "documentation":"The Amazon Resource Name (ARN) for the specified resource.
" + "documentation":"The Amazon Resource Name (ARN) for the resource.
" }, "value":{ "shape":"String", - "documentation":"The value of the specified resource.
" + "documentation":"The value of the resource.
" } }, - "documentation":"A system asset that is evaluated in an Audit Manager assessment.
" + "documentation":"A system asset that's evaluated in an Audit Manager assessment.
" }, "ResourceNotFoundException":{ "type":"structure", @@ -3624,14 +3825,14 @@ "message":{"shape":"String"}, "resourceId":{ "shape":"String", - "documentation":"The unique identifier for the specified resource.
" + "documentation":"The unique identifier for the resource.
" }, "resourceType":{ "shape":"String", - "documentation":"The type of resource affected by the error.
" + "documentation":"The type of resource that's affected by the error.
" } }, - "documentation":"The resource specified in the request cannot be found.
", + "documentation":"The resource that's specified in the request can't be found.
", "error":{"httpStatusCode":404}, "exception":true }, @@ -3651,7 +3852,7 @@ "documentation":"The Amazon Resource Name (ARN) of the IAM role.
" } }, - "documentation":"The wrapper that contains the Audit Manager role information of the current user, such as the role type and IAM Amazon Resource Name (ARN).
" + "documentation":"The wrapper that contains the Audit Manager role information of the current user. This includes the role type and IAM Amazon Resource Name (ARN).
" }, "RoleType":{ "type":"string", @@ -3681,14 +3882,14 @@ "members":{ "awsAccounts":{ "shape":"AWSAccounts", - "documentation":"The Amazon Web Services accounts included in the scope of the assessment.
" + "documentation":"The Amazon Web Services accounts that are included in the scope of the assessment.
" }, "awsServices":{ "shape":"AWSServices", - "documentation":"The Amazon Web Services services included in the scope of the assessment.
" + "documentation":"The Amazon Web Services services that are included in the scope of the assessment.
" } }, - "documentation":"The wrapper that contains the Amazon Web Services accounts and services in scope for the assessment.
" + "documentation":"The wrapper that contains the Amazon Web Services accounts and services that are in scope for the assessment.
" }, "ServiceMetadata":{ "type":"structure", @@ -3703,14 +3904,14 @@ }, "description":{ "shape":"NonEmptyString", - "documentation":"The description of the specified Amazon Web Service.
" + "documentation":"The description of the Amazon Web Service.
" }, "category":{ "shape":"NonEmptyString", - "documentation":"The category in which the Amazon Web Service belongs, such as compute, storage, database, and so on.
" + "documentation":"The category that the Amazon Web Service belongs to, such as compute, storage, or database.
" } }, - "documentation":"The metadata associated with the specified Amazon Web Service.
" + "documentation":"The metadata that's associated with the Amazon Web Service.
" }, "ServiceMetadataList":{ "type":"list", @@ -3752,6 +3953,39 @@ }, "documentation":"The settings object that holds all supported Audit Manager settings.
" }, + "ShareRequestAction":{ + "type":"string", + "enum":[ + "ACCEPT", + "DECLINE", + "REVOKE" + ] + }, + "ShareRequestComment":{ + "type":"string", + "max":500, + "pattern":"^[\\w\\W\\s\\S]*$" + }, + "ShareRequestStatus":{ + "type":"string", + "enum":[ + "ACTIVE", + "REPLICATING", + "SHARED", + "EXPIRING", + "FAILED", + "EXPIRED", + "DECLINED", + "REVOKED" + ] + }, + "ShareRequestType":{ + "type":"string", + "enum":[ + "SENT", + "RECEIVED" + ] + }, "SnsArn":{ "type":"string", "max":2048, @@ -3776,11 +4010,11 @@ "members":{ "keywordInputType":{ "shape":"KeywordInputType", - "documentation":"The method of input for the specified keyword.
" + "documentation":"The method of input for the keyword.
" }, "keywordValue":{ "shape":"KeywordValue", - "documentation":"The value of the keyword used to search CloudTrail logs, Config rules, Security Hub checks, and Amazon Web Services API names when mapping a control data source.
" + "documentation":"The value of the keyword that's used to search CloudTrail logs, Config rules, Security Hub checks, and Amazon Web Services API names when mapping a control data source.
" } }, "documentation":"The keyword to search for in CloudTrail logs, Config rules, Security Hub checks, and Amazon Web Services API names.
" @@ -3807,6 +4041,43 @@ "MANUAL" ] }, + "StartAssessmentFrameworkShareRequest":{ + "type":"structure", + "required":[ + "frameworkId", + "destinationAccount", + "destinationRegion" + ], + "members":{ + "frameworkId":{ + "shape":"UUID", + "documentation":"The unique identifier for the custom framework to be shared.
", + "location":"uri", + "locationName":"frameworkId" + }, + "destinationAccount":{ + "shape":"AccountId", + "documentation":"The Amazon Web Services account of the recipient.
" + }, + "destinationRegion":{ + "shape":"Region", + "documentation":"The Amazon Web Services Region of the recipient.
" + }, + "comment":{ + "shape":"ShareRequestComment", + "documentation":"An optional comment from the sender about the share request.
" + } + } + }, + "StartAssessmentFrameworkShareResponse":{ + "type":"structure", + "members":{ + "assessmentFrameworkShareRequest":{ + "shape":"AssessmentFrameworkShareRequest", + "documentation":" The share request that's created by the StartAssessmentFrameworkShare API.
The Amazon Resource Name (ARN) of the specified resource.
", + "documentation":"The Amazon Resource Name (ARN) of the resource.
", "location":"uri", "locationName":"resourceArn" }, "tags":{ "shape":"TagMap", - "documentation":"The tags to be associated with the resource.
" + "documentation":"The tags that are associated with the resource.
" } } }, @@ -3890,14 +4161,14 @@ "members":{ "hyperlinkName":{ "shape":"HyperlinkName", - "documentation":"The name or word used as a hyperlink to the URL.
" + "documentation":"The name or word that's used as a hyperlink to the URL.
" }, "link":{ "shape":"UrlLink", "documentation":"The unique identifier for the internet resource.
" } }, - "documentation":"A uniform resource locator, used as a unique identifier to locate a resource on the internet.
" + "documentation":"Short for uniform resource locator. A URL is used as a unique identifier to locate a resource on the internet.
" }, "UUID":{ "type":"string", @@ -3941,29 +4212,29 @@ "members":{ "assessmentId":{ "shape":"UUID", - "documentation":"The identifier for the specified assessment.
", + "documentation":"The identifier for the assessment.
", "location":"uri", "locationName":"assessmentId" }, "controlSetId":{ "shape":"ControlSetId", - "documentation":"The identifier for the specified control set.
", + "documentation":"The identifier for the control set.
", "location":"uri", "locationName":"controlSetId" }, "controlId":{ "shape":"UUID", - "documentation":"The identifier for the specified control.
", + "documentation":"The identifier for the control.
", "location":"uri", "locationName":"controlId" }, "controlStatus":{ "shape":"ControlStatus", - "documentation":"The status of the specified control.
" + "documentation":"The status of the control.
" }, "commentBody":{ "shape":"ControlCommentBody", - "documentation":"The comment body text for the specified control.
" + "documentation":"The comment body text for the control.
" } } }, @@ -3972,7 +4243,7 @@ "members":{ "control":{ "shape":"AssessmentControl", - "documentation":" The name of the updated control set returned by the UpdateAssessmentControl API.
The name of the updated control set that the UpdateAssessmentControl API returned.
The identifier for the specified assessment.
", + "documentation":"The identifier for the assessment.
", "location":"uri", "locationName":"assessmentId" }, "controlSetId":{ "shape":"String", - "documentation":"The identifier for the specified control set.
", + "documentation":"The identifier for the control set.
", "location":"uri", "locationName":"controlSetId" }, "status":{ "shape":"ControlSetStatus", - "documentation":"The status of the control set that is being updated.
" + "documentation":"The status of the control set that's being updated.
" }, "comment":{ "shape":"DelegationComment", - "documentation":"The comment related to the status update.
" + "documentation":"The comment that's related to the status update.
" } } }, @@ -4012,7 +4283,7 @@ "members":{ "controlSet":{ "shape":"AssessmentControlSet", - "documentation":" The name of the updated control set returned by the UpdateAssessmentControlSetStatus API.
The name of the updated control set that the UpdateAssessmentControlSetStatus API returned.
The list of controls contained within the control set.
" + "documentation":"The list of controls that are contained within the control set.
" } }, - "documentation":" A controlSet entity that represents a collection of controls in Audit Manager. This does not contain the control set ID.
A controlSet entity that represents a collection of controls in Audit Manager. This doesn't contain the control set ID.
The identifier for the specified framework.
", + "documentation":"The identifier for the framework.
", "location":"uri", "locationName":"frameworkId" }, @@ -4059,7 +4330,7 @@ }, "description":{ "shape":"FrameworkDescription", - "documentation":"The description of the framework that is to be updated.
" + "documentation":"The description of the updated framework.
" }, "complianceType":{ "shape":"ComplianceType", @@ -4067,7 +4338,7 @@ }, "controlSets":{ "shape":"UpdateAssessmentFrameworkControlSets", - "documentation":"The control sets associated with the framework.
" + "documentation":"The control sets that are associated with the framework.
" } } }, @@ -4076,7 +4347,40 @@ "members":{ "framework":{ "shape":"Framework", - "documentation":"The name of the specified framework.
" + "documentation":"The name of the framework.
" + } + } + }, + "UpdateAssessmentFrameworkShareRequest":{ + "type":"structure", + "required":[ + "requestId", + "requestType", + "action" + ], + "members":{ + "requestId":{ + "shape":"UUID", + "documentation":"The unique identifier for the share request.
", + "location":"uri", + "locationName":"requestId" + }, + "requestType":{ + "shape":"ShareRequestType", + "documentation":"Specifies whether the share request is a sent request or a received request.
" + }, + "action":{ + "shape":"ShareRequestAction", + "documentation":"Specifies the update action for the share request.
" + } + } + }, + "UpdateAssessmentFrameworkShareResponse":{ + "type":"structure", + "members":{ + "assessmentFrameworkShareRequest":{ + "shape":"AssessmentFrameworkShareRequest", + "documentation":" The updated share request that's returned by the UpdateAssessmentFrameworkShare operation.
The identifier for the specified assessment.
", + "documentation":"The identifier for the assessment.
", "location":"uri", "locationName":"assessmentId" }, "assessmentName":{ "shape":"AssessmentName", - "documentation":"The name of the specified assessment to be updated.
" + "documentation":"The name of the assessment to be updated.
" }, "assessmentDescription":{ "shape":"AssessmentDescription", - "documentation":"The description of the specified assessment.
" + "documentation":"The description of the assessment.
" }, "scope":{ "shape":"Scope", - "documentation":"The scope of the specified assessment.
" + "documentation":"The scope of the assessment.
" }, "assessmentReportsDestination":{ "shape":"AssessmentReportsDestination", - "documentation":"The assessment report storage destination for the specified assessment that is being updated.
" + "documentation":"The assessment report storage destination for the assessment that's being updated.
" }, "roles":{ "shape":"Roles", - "documentation":"The list of roles for the specified assessment.
" + "documentation":"The list of roles for the assessment.
" } } }, @@ -4120,7 +4424,7 @@ "members":{ "assessment":{ "shape":"Assessment", - "documentation":" The response object (name of the updated assessment) for the UpdateAssessmentRequest API.
The response object for the UpdateAssessmentRequest API. This is the name of the updated assessment.
The identifier for the specified assessment.
", + "documentation":"The identifier for the assessment.
", "location":"uri", "locationName":"assessmentId" }, "status":{ "shape":"AssessmentStatus", - "documentation":"The current status of the specified assessment.
" + "documentation":"The current status of the assessment.
" } } }, @@ -4148,7 +4452,7 @@ "members":{ "assessment":{ "shape":"Assessment", - "documentation":" The name of the updated assessment returned by the UpdateAssessmentStatus API.
The name of the updated assessment that the UpdateAssessmentStatus API returned.
The identifier for the specified control.
", + "documentation":"The identifier for the control.
", "location":"uri", "locationName":"controlId" }, "name":{ "shape":"ControlName", - "documentation":"The name of the control to be updated.
" + "documentation":"The name of the updated control.
" }, "description":{ "shape":"ControlDescription", @@ -4176,7 +4480,7 @@ }, "testingInformation":{ "shape":"TestingInformation", - "documentation":"The steps that to follow to determine if the control has been satisfied.
" + "documentation":"The steps that you should follow to determine if the control is met.
" }, "actionPlanTitle":{ "shape":"ActionPlanTitle", @@ -4184,11 +4488,11 @@ }, "actionPlanInstructions":{ "shape":"ActionPlanInstructions", - "documentation":"The recommended actions to carry out if the control is not fulfilled.
" + "documentation":"The recommended actions to carry out if the control isn't fulfilled.
" }, "controlMappingSources":{ "shape":"ControlMappingSources", - "documentation":"The data mapping sources for the specified control.
" + "documentation":"The data mapping sources for the control.
" } } }, @@ -4197,7 +4501,7 @@ "members":{ "control":{ "shape":"Control", - "documentation":" The name of the updated control set returned by the UpdateControl API.
The name of the updated control set that the UpdateControl API returned.
The Amazon Simple Notification Service (Amazon SNS) topic to which Audit Manager sends notifications.
" + "documentation":"The Amazon Simple Notification Service (Amazon SNS) topic that Audit Manager sends notifications to.
" }, "defaultAssessmentReportsDestination":{ "shape":"AssessmentReportsDestination", @@ -4249,7 +4553,7 @@ "members":{ "s3RelativePath":{ "shape":"S3Url", - "documentation":"The relative path of the specified Amazon S3 bucket in which the assessment report is stored.
" + "documentation":"The relative path of the Amazon S3 bucket that the assessment report is stored in.
" } } }, @@ -4262,7 +4566,7 @@ }, "signatureAlgorithm":{ "shape":"String", - "documentation":"The signature algorithm used to code sign the assessment report file.
" + "documentation":"The signature algorithm that's used to code sign the assessment report file.
" }, "signatureDateTime":{ "shape":"String", @@ -4316,7 +4620,7 @@ "documentation":"The body of the error message.
" } }, - "documentation":"Indicates that the request has invalid or missing parameters for the specified field.
" + "documentation":"Indicates that the request has invalid or missing parameters for the field.
" }, "ValidationExceptionFieldList":{ "type":"list", @@ -4338,5 +4642,5 @@ "pattern":"o-[a-z0-9]{10,32}" } }, - "documentation":"Welcome to the Audit Manager API reference. This guide is for developers who need detailed information about the Audit Manager API operations, data types, and errors.
Audit Manager is a service that provides automated evidence collection so that you can continuously audit your Amazon Web Services usage, and assess the effectiveness of your controls to better manage risk and simplify compliance.
Audit Manager provides pre-built frameworks that structure and automate assessments for a given compliance standard. Frameworks include a pre-built collection of controls with descriptions and testing procedures, which are grouped according to the requirements of the specified compliance standard or regulation. You can also customize frameworks and controls to support internal audits with unique requirements.
Use the following links to get started with the Audit Manager API:
Actions: An alphabetical list of all Audit Manager API operations.
Data types: An alphabetical list of all Audit Manager data types.
Common parameters: Parameters that all Query operations can use.
Common errors: Client and server errors that all operations can return.
If you're new to Audit Manager, we recommend that you review the Audit Manager User Guide.
" + "documentation":"Welcome to the Audit Manager API reference. This guide is for developers who need detailed information about the Audit Manager API operations, data types, and errors.
Audit Manager is a service that provides automated evidence collection so that you can continually audit your Amazon Web Services usage. You can use it to assess the effectiveness of your controls, manage risk, and simplify compliance.
Audit Manager provides prebuilt frameworks that structure and automate assessments for a given compliance standard. Frameworks include a prebuilt collection of controls with descriptions and testing procedures. These controls are grouped according to the requirements of the specified compliance standard or regulation. You can also customize frameworks and controls to support internal audits with specific requirements.
Use the following links to get started with the Audit Manager API:
Actions: An alphabetical list of all Audit Manager API operations.
Data types: An alphabetical list of all Audit Manager data types.
Common parameters: Parameters that all Query operations can use.
Common errors: Client and server errors that all operations can return.
If you're new to Audit Manager, we recommend that you review the Audit Manager User Guide.
" }