NAME

Paws::AuditManager - Perl Interface to AWS AWS Audit Manager

SYNOPSIS

  use Paws;

  my $obj = Paws->service('AuditManager');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

DESCRIPTION

Welcome to the AWS Audit Manager API reference. This guide is for developers who need detailed information about the AWS Audit Manager API operations, data types, and errors.

AWS Audit Manager is a service that provides automated evidence collection so that you can continuously audit your AWS usage, and assess the effectiveness of your controls to better manage risk and simplify compliance.

AWS 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 AWS Audit Manager API:

  • Actions (https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_Operations.html): An alphabetical list of all AWS Audit Manager API operations.

  • Data types (https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_Types.html): An alphabetical list of all AWS Audit Manager data types.

  • Common parameters (https://docs.aws.amazon.com/audit-manager/latest/APIReference/CommonParameters.html): Parameters that all Query operations can use.

  • Common errors (https://docs.aws.amazon.com/audit-manager/latest/APIReference/CommonErrors.html): Client and server errors that all operations can return.

If you're new to AWS Audit Manager, we recommend that you review the AWS Audit Manager User Guide (https://docs.aws.amazon.com/audit-manager/latest/userguide/what-is.html).

For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25

METHODS

AssociateAssessmentReportEvidenceFolder

AssessmentId => Str
EvidenceFolderId => Str

Each argument is described in detail in: Paws::AuditManager::AssociateAssessmentReportEvidenceFolder

Returns: a Paws::AuditManager::AssociateAssessmentReportEvidenceFolderResponse instance

Associates an evidence folder to the specified assessment report in AWS Audit Manager.

BatchAssociateAssessmentReportEvidence

AssessmentId => Str
EvidenceFolderId => Str
EvidenceIds => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::AuditManager::BatchAssociateAssessmentReportEvidence

Returns: a Paws::AuditManager::BatchAssociateAssessmentReportEvidenceResponse instance

Associates a list of evidence to an assessment report in an AWS Audit Manager assessment.

BatchCreateDelegationByAssessment

AssessmentId => Str
CreateDelegationRequests => ArrayRef[Paws::AuditManager::CreateDelegationRequest]

Each argument is described in detail in: Paws::AuditManager::BatchCreateDelegationByAssessment

Returns: a Paws::AuditManager::BatchCreateDelegationByAssessmentResponse instance

Create a batch of delegations for a specified assessment in AWS Audit Manager.

BatchDeleteDelegationByAssessment

AssessmentId => Str
DelegationIds => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::AuditManager::BatchDeleteDelegationByAssessment

Returns: a Paws::AuditManager::BatchDeleteDelegationByAssessmentResponse instance

Deletes the delegations in the specified AWS Audit Manager assessment.

BatchDisassociateAssessmentReportEvidence

AssessmentId => Str
EvidenceFolderId => Str
EvidenceIds => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::AuditManager::BatchDisassociateAssessmentReportEvidence

Returns: a Paws::AuditManager::BatchDisassociateAssessmentReportEvidenceResponse instance

Disassociates a list of evidence from the specified assessment report in AWS Audit Manager.

BatchImportEvidenceToAssessmentControl

AssessmentId => Str
ControlId => Str
ControlSetId => Str
ManualEvidence => ArrayRef[Paws::AuditManager::ManualEvidence]

Each argument is described in detail in: Paws::AuditManager::BatchImportEvidenceToAssessmentControl

Returns: a Paws::AuditManager::BatchImportEvidenceToAssessmentControlResponse instance

Uploads one or more pieces of evidence to the specified control in the assessment in AWS Audit Manager.

CreateAssessment

AssessmentReportsDestination => Paws::AuditManager::AssessmentReportsDestination
FrameworkId => Str
Name => Str
Roles => ArrayRef[Paws::AuditManager::Role]
Scope => Paws::AuditManager::Scope
[Description => Str]
[Tags => Paws::AuditManager::TagMap]

Each argument is described in detail in: Paws::AuditManager::CreateAssessment

Returns: a Paws::AuditManager::CreateAssessmentResponse instance

Creates an assessment in AWS Audit Manager.

CreateAssessmentFramework

ControlSets => ArrayRef[Paws::AuditManager::CreateAssessmentFrameworkControlSet]
Name => Str
[ComplianceType => Str]
[Description => Str]
[Tags => Paws::AuditManager::TagMap]

Each argument is described in detail in: Paws::AuditManager::CreateAssessmentFramework

Returns: a Paws::AuditManager::CreateAssessmentFrameworkResponse instance

Creates a custom framework in AWS Audit Manager.

CreateAssessmentReport

AssessmentId => Str
Name => Str
[Description => Str]

Each argument is described in detail in: Paws::AuditManager::CreateAssessmentReport

Returns: a Paws::AuditManager::CreateAssessmentReportResponse instance

Creates an assessment report for the specified assessment.

CreateControl

ControlMappingSources => ArrayRef[Paws::AuditManager::CreateControlMappingSource]
Name => Str
[ActionPlanInstructions => Str]
[ActionPlanTitle => Str]
[Description => Str]
[Tags => Paws::AuditManager::TagMap]
[TestingInformation => Str]

Each argument is described in detail in: Paws::AuditManager::CreateControl

Returns: a Paws::AuditManager::CreateControlResponse instance

Creates a new custom control in AWS Audit Manager.

DeleteAssessment

AssessmentId => Str

Each argument is described in detail in: Paws::AuditManager::DeleteAssessment

Returns: a Paws::AuditManager::DeleteAssessmentResponse instance

Deletes an assessment in AWS Audit Manager.

DeleteAssessmentFramework

FrameworkId => Str

Each argument is described in detail in: Paws::AuditManager::DeleteAssessmentFramework

Returns: a Paws::AuditManager::DeleteAssessmentFrameworkResponse instance

Deletes a custom framework in AWS Audit Manager.

DeleteAssessmentReport

AssessmentId => Str
AssessmentReportId => Str

Each argument is described in detail in: Paws::AuditManager::DeleteAssessmentReport

Returns: a Paws::AuditManager::DeleteAssessmentReportResponse instance

Deletes an assessment report from an assessment in AWS Audit Manager.

DeleteControl

ControlId => Str

Each argument is described in detail in: Paws::AuditManager::DeleteControl

Returns: a Paws::AuditManager::DeleteControlResponse instance

Deletes a custom control in AWS Audit Manager.

DeregisterAccount

Each argument is described in detail in: Paws::AuditManager::DeregisterAccount

Returns: a Paws::AuditManager::DeregisterAccountResponse instance

Deregisters an account in AWS Audit Manager.

DeregisterOrganizationAdminAccount

[AdminAccountId => Str]

Each argument is described in detail in: Paws::AuditManager::DeregisterOrganizationAdminAccount

Returns: a Paws::AuditManager::DeregisterOrganizationAdminAccountResponse instance

Deregisters the delegated AWS administrator account from the AWS organization.

DisassociateAssessmentReportEvidenceFolder

AssessmentId => Str
EvidenceFolderId => Str

Each argument is described in detail in: Paws::AuditManager::DisassociateAssessmentReportEvidenceFolder

Returns: a Paws::AuditManager::DisassociateAssessmentReportEvidenceFolderResponse instance

Disassociates an evidence folder from the specified assessment report in AWS Audit Manager.

GetAccountStatus

Each argument is described in detail in: Paws::AuditManager::GetAccountStatus

Returns: a Paws::AuditManager::GetAccountStatusResponse instance

Returns the registration status of an account in AWS Audit Manager.

GetAssessment

AssessmentId => Str

Each argument is described in detail in: Paws::AuditManager::GetAssessment

Returns: a Paws::AuditManager::GetAssessmentResponse instance

Returns an assessment from AWS Audit Manager.

GetAssessmentFramework

FrameworkId => Str

Each argument is described in detail in: Paws::AuditManager::GetAssessmentFramework

Returns: a Paws::AuditManager::GetAssessmentFrameworkResponse instance

Returns a framework from AWS Audit Manager.

GetAssessmentReportUrl

AssessmentId => Str
AssessmentReportId => Str

Each argument is described in detail in: Paws::AuditManager::GetAssessmentReportUrl

Returns: a Paws::AuditManager::GetAssessmentReportUrlResponse instance

Returns the URL of a specified assessment report in AWS Audit Manager.

GetChangeLogs

AssessmentId => Str
[ControlId => Str]
[ControlSetId => Str]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::AuditManager::GetChangeLogs

Returns: a Paws::AuditManager::GetChangeLogsResponse instance

Returns a list of changelogs from AWS Audit Manager.

GetControl

ControlId => Str

Each argument is described in detail in: Paws::AuditManager::GetControl

Returns: a Paws::AuditManager::GetControlResponse instance

Returns a control from AWS Audit Manager.

GetDelegations

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::AuditManager::GetDelegations

Returns: a Paws::AuditManager::GetDelegationsResponse instance

Returns a list of delegations from an audit owner to a delegate.

GetEvidence

AssessmentId => Str
ControlSetId => Str
EvidenceFolderId => Str
EvidenceId => Str

Each argument is described in detail in: Paws::AuditManager::GetEvidence

Returns: a Paws::AuditManager::GetEvidenceResponse instance

Returns evidence from AWS Audit Manager.

GetEvidenceByEvidenceFolder

AssessmentId => Str
ControlSetId => Str
EvidenceFolderId => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::AuditManager::GetEvidenceByEvidenceFolder

Returns: a Paws::AuditManager::GetEvidenceByEvidenceFolderResponse instance

Returns all evidence from a specified evidence folder in AWS Audit Manager.

GetEvidenceFolder

AssessmentId => Str
ControlSetId => Str
EvidenceFolderId => Str

Each argument is described in detail in: Paws::AuditManager::GetEvidenceFolder

Returns: a Paws::AuditManager::GetEvidenceFolderResponse instance

Returns an evidence folder from the specified assessment in AWS Audit Manager.

GetEvidenceFoldersByAssessment

AssessmentId => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::AuditManager::GetEvidenceFoldersByAssessment

Returns: a Paws::AuditManager::GetEvidenceFoldersByAssessmentResponse instance

Returns the evidence folders from a specified assessment in AWS Audit Manager.

GetEvidenceFoldersByAssessmentControl

AssessmentId => Str
ControlId => Str
ControlSetId => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::AuditManager::GetEvidenceFoldersByAssessmentControl

Returns: a Paws::AuditManager::GetEvidenceFoldersByAssessmentControlResponse instance

Returns a list of evidence folders associated with a specified control of an assessment in AWS Audit Manager.

GetOrganizationAdminAccount

Each argument is described in detail in: Paws::AuditManager::GetOrganizationAdminAccount

Returns: a Paws::AuditManager::GetOrganizationAdminAccountResponse instance

Returns the name of the delegated AWS administrator account for the AWS organization.

GetServicesInScope

Each argument is described in detail in: Paws::AuditManager::GetServicesInScope

Returns: a Paws::AuditManager::GetServicesInScopeResponse instance

Returns a list of the in-scope AWS services for the specified assessment.

GetSettings

Attribute => Str

Each argument is described in detail in: Paws::AuditManager::GetSettings

Returns: a Paws::AuditManager::GetSettingsResponse instance

Returns the settings for the specified AWS account.

ListAssessmentFrameworks

FrameworkType => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::AuditManager::ListAssessmentFrameworks

Returns: a Paws::AuditManager::ListAssessmentFrameworksResponse instance

Returns a list of the frameworks available in the AWS Audit Manager framework library.

ListAssessmentReports

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::AuditManager::ListAssessmentReports

Returns: a Paws::AuditManager::ListAssessmentReportsResponse instance

Returns a list of assessment reports created in AWS Audit Manager.

ListAssessments

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::AuditManager::ListAssessments

Returns: a Paws::AuditManager::ListAssessmentsResponse instance

Returns a list of current and past assessments from AWS Audit Manager.

ListControls

ControlType => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::AuditManager::ListControls

Returns: a Paws::AuditManager::ListControlsResponse instance

Returns a list of controls from AWS Audit Manager.

ListKeywordsForDataSource

Source => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::AuditManager::ListKeywordsForDataSource

Returns: a Paws::AuditManager::ListKeywordsForDataSourceResponse instance

Returns a list of keywords that pre-mapped to the specified control data source.

ListNotifications

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::AuditManager::ListNotifications

Returns: a Paws::AuditManager::ListNotificationsResponse instance

Returns a list of all AWS Audit Manager notifications.

ListTagsForResource

ResourceArn => Str

Each argument is described in detail in: Paws::AuditManager::ListTagsForResource

Returns: a Paws::AuditManager::ListTagsForResourceResponse instance

Returns a list of tags for the specified resource in AWS Audit Manager.

RegisterAccount

[DelegatedAdminAccount => Str]
[KmsKey => Str]

Each argument is described in detail in: Paws::AuditManager::RegisterAccount

Returns: a Paws::AuditManager::RegisterAccountResponse instance

Enables AWS Audit Manager for the specified AWS account.

RegisterOrganizationAdminAccount

AdminAccountId => Str

Each argument is described in detail in: Paws::AuditManager::RegisterOrganizationAdminAccount

Returns: a Paws::AuditManager::RegisterOrganizationAdminAccountResponse instance

Enables an AWS account within the organization as the delegated administrator for AWS Audit Manager.

TagResource

ResourceArn => Str
Tags => Paws::AuditManager::TagMap

Each argument is described in detail in: Paws::AuditManager::TagResource

Returns: a Paws::AuditManager::TagResourceResponse instance

Tags the specified resource in AWS Audit Manager.

UntagResource

ResourceArn => Str
TagKeys => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::AuditManager::UntagResource

Returns: a Paws::AuditManager::UntagResourceResponse instance

Removes a tag from a resource in AWS Audit Manager.

UpdateAssessment

AssessmentId => Str
Scope => Paws::AuditManager::Scope
[AssessmentDescription => Str]
[AssessmentName => Str]
[AssessmentReportsDestination => Paws::AuditManager::AssessmentReportsDestination]
[Roles => ArrayRef[Paws::AuditManager::Role]]

Each argument is described in detail in: Paws::AuditManager::UpdateAssessment

Returns: a Paws::AuditManager::UpdateAssessmentResponse instance

Edits an AWS Audit Manager assessment.

UpdateAssessmentControl

AssessmentId => Str
ControlId => Str
ControlSetId => Str
[CommentBody => Str]
[ControlStatus => Str]

Each argument is described in detail in: Paws::AuditManager::UpdateAssessmentControl

Returns: a Paws::AuditManager::UpdateAssessmentControlResponse instance

Updates a control within an assessment in AWS Audit Manager.

UpdateAssessmentControlSetStatus

AssessmentId => Str
Comment => Str
ControlSetId => Str
Status => Str

Each argument is described in detail in: Paws::AuditManager::UpdateAssessmentControlSetStatus

Returns: a Paws::AuditManager::UpdateAssessmentControlSetStatusResponse instance

Updates the status of a control set in an AWS Audit Manager assessment.

UpdateAssessmentFramework

ControlSets => ArrayRef[Paws::AuditManager::UpdateAssessmentFrameworkControlSet]
FrameworkId => Str
Name => Str
[ComplianceType => Str]
[Description => Str]

Each argument is described in detail in: Paws::AuditManager::UpdateAssessmentFramework

Returns: a Paws::AuditManager::UpdateAssessmentFrameworkResponse instance

Updates a custom framework in AWS Audit Manager.

UpdateAssessmentStatus

AssessmentId => Str
Status => Str

Each argument is described in detail in: Paws::AuditManager::UpdateAssessmentStatus

Returns: a Paws::AuditManager::UpdateAssessmentStatusResponse instance

Updates the status of an assessment in AWS Audit Manager.

UpdateControl

ControlId => Str
ControlMappingSources => ArrayRef[Paws::AuditManager::ControlMappingSource]
Name => Str
[ActionPlanInstructions => Str]
[ActionPlanTitle => Str]
[Description => Str]
[TestingInformation => Str]

Each argument is described in detail in: Paws::AuditManager::UpdateControl

Returns: a Paws::AuditManager::UpdateControlResponse instance

Updates a custom control in AWS Audit Manager.

UpdateSettings

[DefaultAssessmentReportsDestination => Paws::AuditManager::AssessmentReportsDestination]
[DefaultProcessOwners => ArrayRef[Paws::AuditManager::Role]]
[KmsKey => Str]
[SnsTopic => Str]

Each argument is described in detail in: Paws::AuditManager::UpdateSettings

Returns: a Paws::AuditManager::UpdateSettingsResponse instance

Updates AWS Audit Manager settings for the current user account.

ValidateAssessmentReportIntegrity

S3RelativePath => Str

Each argument is described in detail in: Paws::AuditManager::ValidateAssessmentReportIntegrity

Returns: a Paws::AuditManager::ValidateAssessmentReportIntegrityResponse instance

Validates the integrity of an assessment report in AWS Audit Manager.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

SEE ALSO

This service class forms part of Paws

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues