You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.AuditManager

Inherits:
AWS.Service show all
Identifier:
auditmanager
API Version:
2017-07-25
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

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.

Sending a Request Using AuditManager

var auditmanager = new AWS.AuditManager();
auditmanager.associateAssessmentReportEvidenceFolder(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the AuditManager object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var auditmanager = new AWS.AuditManager({apiVersion: '2017-07-25'});

You can also set the API version globally in AWS.config.apiVersions using the auditmanager service identifier:

AWS.config.apiVersions = {
  auditmanager: '2017-07-25',
  // other service API versions
};

var auditmanager = new AWS.AuditManager();

Version:

  • 2017-07-25

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.AuditManager(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a AuditManager object

var auditmanager = new AWS.AuditManager({apiVersion: '2017-07-25'});

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.AuditManager.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.AuditManager.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.AuditManager.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean)

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined)

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

  • useFipsEndpoint (Boolean)

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean)

    Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

endpointAWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

associateAssessmentReportEvidenceFolder(params = {}, callback) ⇒ AWS.Request

Associates an evidence folder to an assessment report in a Audit Manager assessment.

Examples:

Calling the associateAssessmentReportEvidenceFolder operation

var params = {
  assessmentId: 'STRING_VALUE', /* required */
  evidenceFolderId: 'STRING_VALUE' /* required */
};
auditmanager.associateAssessmentReportEvidenceFolder(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • assessmentId — (String)

      The identifier for the assessment.

    • evidenceFolderId — (String)

      The identifier for the folder that the evidence is stored in.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

batchAssociateAssessmentReportEvidence(params = {}, callback) ⇒ AWS.Request

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

Examples:

Calling the batchAssociateAssessmentReportEvidence operation

var params = {
  assessmentId: 'STRING_VALUE', /* required */
  evidenceFolderId: 'STRING_VALUE', /* required */
  evidenceIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
auditmanager.batchAssociateAssessmentReportEvidence(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • assessmentId — (String)

      The identifier for the assessment.

    • evidenceFolderId — (String)

      The identifier for the folder that the evidence is stored in.

    • evidenceIds — (Array<String>)

      The list of evidence identifiers.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • evidenceIds — (Array<String>)

        The list of evidence identifiers.

      • errors — (Array<map>)

        A list of errors that the BatchAssociateAssessmentReportEvidence API returned.

        • evidenceId — (String)

          The identifier for the evidence.

        • errorCode — (String)

          The error code that the AssessmentReportEvidence API returned.

        • errorMessage — (String)

          The error message that the AssessmentReportEvidence API returned.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

batchCreateDelegationByAssessment(params = {}, callback) ⇒ AWS.Request

Creates a batch of delegations for an assessment in Audit Manager.

Examples:

Calling the batchCreateDelegationByAssessment operation

var params = {
  assessmentId: 'STRING_VALUE', /* required */
  createDelegationRequests: [ /* required */
    {
      comment: 'STRING_VALUE',
      controlSetId: 'STRING_VALUE',
      roleArn: 'STRING_VALUE',
      roleType: PROCESS_OWNER | RESOURCE_OWNER
    },
    /* more items */
  ]
};
auditmanager.batchCreateDelegationByAssessment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • createDelegationRequests — (Array<map>)

      The API request to batch create delegations in Audit Manager.

      • comment — (String)

        A comment that's related to the delegation request.

      • controlSetId — (String)

        The unique identifier for the control set.

      • roleArn — (String)

        The Amazon Resource Name (ARN) of the IAM role.

      • roleType — (String)

        The type of customer persona.

        Note: In CreateAssessment, roleType can only be PROCESS_OWNER. In UpdateSettings, roleType can only be PROCESS_OWNER. In BatchCreateDelegationByAssessment, roleType can only be RESOURCE_OWNER.
        Possible values include:
        • "PROCESS_OWNER"
        • "RESOURCE_OWNER"
    • assessmentId — (String)

      The identifier for the assessment.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • delegations — (Array<map>)

        The delegations that are associated with the assessment.

        • id — (String)

          The unique identifier for the delegation.

        • assessmentName — (String)

          The name of the assessment that's associated with the delegation.

        • assessmentId — (String)

          The identifier for the assessment that's associated with the delegation.

        • status — (String)

          The status of the delegation.

          Possible values include:
          • "IN_PROGRESS"
          • "UNDER_REVIEW"
          • "COMPLETE"
        • roleArn — (String)

          The Amazon Resource Name (ARN) of the IAM role.

        • roleType — (String)

          The type of customer persona.

          Note: In CreateAssessment, roleType can only be PROCESS_OWNER. In UpdateSettings, roleType can only be PROCESS_OWNER. In BatchCreateDelegationByAssessment, roleType can only be RESOURCE_OWNER.
          Possible values include:
          • "PROCESS_OWNER"
          • "RESOURCE_OWNER"
        • creationTime — (Date)

          Specifies when the delegation was created.

        • lastUpdated — (Date)

          Specifies when the delegation was last updated.

        • controlSetId — (String)

          The identifier for the control set that's associated with the delegation.

        • comment — (String)

          The comment that's related to the delegation.

        • createdBy — (String)

          The IAM user or role that created the delegation.

      • errors — (Array<map>)

        A list of errors that the BatchCreateDelegationByAssessment API returned.

        • createDelegationRequest — (map)

          The API request to batch create delegations in Audit Manager.

          • comment — (String)

            A comment that's related to the delegation request.

          • controlSetId — (String)

            The unique identifier for the control set.

          • roleArn — (String)

            The Amazon Resource Name (ARN) of the IAM role.

          • roleType — (String)

            The type of customer persona.

            Note: In CreateAssessment, roleType can only be PROCESS_OWNER. In UpdateSettings, roleType can only be PROCESS_OWNER. In BatchCreateDelegationByAssessment, roleType can only be RESOURCE_OWNER.
            Possible values include:
            • "PROCESS_OWNER"
            • "RESOURCE_OWNER"
        • errorCode — (String)

          The error code that the BatchCreateDelegationByAssessment API returned.

        • errorMessage — (String)

          The error message that the BatchCreateDelegationByAssessment API returned.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

batchDeleteDelegationByAssessment(params = {}, callback) ⇒ AWS.Request

Deletes a batch of delegations for an assessment in Audit Manager.

Examples:

Calling the batchDeleteDelegationByAssessment operation

var params = {
  assessmentId: 'STRING_VALUE', /* required */
  delegationIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
auditmanager.batchDeleteDelegationByAssessment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • delegationIds — (Array<String>)

      The identifiers for the delegations.

    • assessmentId — (String)

      The identifier for the assessment.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • errors — (Array<map>)

        A list of errors that the BatchDeleteDelegationByAssessment API returned.

        • delegationId — (String)

          The identifier for the delegation.

        • errorCode — (String)

          The error code that the BatchDeleteDelegationByAssessment API returned.

        • errorMessage — (String)

          The error message that the BatchDeleteDelegationByAssessment API returned.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

batchDisassociateAssessmentReportEvidence(params = {}, callback) ⇒ AWS.Request

Disassociates a list of evidence from an assessment report in Audit Manager.

Examples:

Calling the batchDisassociateAssessmentReportEvidence operation

var params = {
  assessmentId: 'STRING_VALUE', /* required */
  evidenceFolderId: 'STRING_VALUE', /* required */
  evidenceIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
auditmanager.batchDisassociateAssessmentReportEvidence(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • assessmentId — (String)

      The identifier for the assessment.

    • evidenceFolderId — (String)

      The identifier for the folder that the evidence is stored in.

    • evidenceIds — (Array<String>)

      The list of evidence identifiers.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • evidenceIds — (Array<String>)

        The identifier for the evidence.

      • errors — (Array<map>)

        A list of errors that the BatchDisassociateAssessmentReportEvidence API returned.

        • evidenceId — (String)

          The identifier for the evidence.

        • errorCode — (String)

          The error code that the AssessmentReportEvidence API returned.

        • errorMessage — (String)

          The error message that the AssessmentReportEvidence API returned.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

batchImportEvidenceToAssessmentControl(params = {}, callback) ⇒ AWS.Request

Uploads one or more pieces of evidence to a control in an Audit Manager assessment.

Examples:

Calling the batchImportEvidenceToAssessmentControl operation

var params = {
  assessmentId: 'STRING_VALUE', /* required */
  controlId: 'STRING_VALUE', /* required */
  controlSetId: 'STRING_VALUE', /* required */
  manualEvidence: [ /* required */
    {
      s3ResourcePath: 'STRING_VALUE'
    },
    /* more items */
  ]
};
auditmanager.batchImportEvidenceToAssessmentControl(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • assessmentId — (String)

      The identifier for the assessment.

    • controlSetId — (String)

      The identifier for the control set.

    • controlId — (String)

      The identifier for the control.

    • manualEvidence — (Array<map>)

      The list of manual evidence objects.

      • s3ResourcePath — (String)

        The Amazon S3 URL that points to a manual evidence object.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • errors — (Array<map>)

        A list of errors that the BatchImportEvidenceToAssessmentControl API returned.

        • manualEvidence — (map)

          Manual evidence that can't be collected automatically by Audit Manager.

          • s3ResourcePath — (String)

            The Amazon S3 URL that points to a manual evidence object.

        • errorCode — (String)

          The error code that the BatchImportEvidenceToAssessmentControl API returned.

        • errorMessage — (String)

          The error message that the BatchImportEvidenceToAssessmentControl API returned.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createAssessment(params = {}, callback) ⇒ AWS.Request

Creates an assessment in Audit Manager.

Service Reference:

Examples:

Calling the createAssessment operation

var params = {
  assessmentReportsDestination: { /* required */
    destination: 'STRING_VALUE',
    destinationType: S3
  },
  frameworkId: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  roles: [ /* required */
    {
      roleArn: 'STRING_VALUE',
      roleType: PROCESS_OWNER | RESOURCE_OWNER
    },
    /* more items */
  ],
  scope: { /* required */
    awsAccounts: [
      {
        emailAddress: 'STRING_VALUE',
        id: 'STRING_VALUE',
        name: 'STRING_VALUE'
      },
      /* more items */
    ],
    awsServices: [
      {
        serviceName: 'STRING_VALUE'
      },
      /* more items */
    ]
  },
  description: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
auditmanager.createAssessment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • name — (String)

      The name of the assessment to be created.

    • description — (String)

      The optional description of the assessment to be created.

    • assessmentReportsDestination — (map)

      The assessment report storage destination for the assessment that's being created.

      • destinationType — (String)

        The destination type, such as Amazon S3.

        Possible values include:
        • "S3"
      • destination — (String)

        The destination of the assessment report.

    • scope — (map)

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

      • awsAccounts — (Array<map>)

        The Amazon Web Services accounts that are included in the scope of the assessment.

        • id — (String)

          The identifier for the Amazon Web Services account.

        • emailAddress — (String)

          The email address that's associated with the Amazon Web Services account.

        • name — (String)

          The name of the Amazon Web Services account.

      • awsServices — (Array<map>)

        The Amazon Web Services services that are included in the scope of the assessment.

        • serviceName — (String)

          The name of the Amazon Web Service.

    • roles — (Array<map>)

      The list of roles for the assessment.

      • roleType — (String)

        The type of customer persona.

        Note: In CreateAssessment, roleType can only be PROCESS_OWNER. In UpdateSettings, roleType can only be PROCESS_OWNER. In BatchCreateDelegationByAssessment, roleType can only be RESOURCE_OWNER.
        Possible values include:
        • "PROCESS_OWNER"
        • "RESOURCE_OWNER"
      • roleArn — (String)

        The Amazon Resource Name (ARN) of the IAM role.

    • frameworkId — (String)

      The identifier for the framework that the assessment will be created from.

    • tags — (map<String>)

      The tags that are associated with the assessment.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • assessment — (map)

        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.

        • arn — (String)

          The Amazon Resource Name (ARN) of the assessment.

        • awsAccount — (map)

          The Amazon Web Services account that's associated with the assessment.

          • id — (String)

            The identifier for the Amazon Web Services account.

          • emailAddress — (String)

            The email address that's associated with the Amazon Web Services account.

          • name — (String)

            The name of the Amazon Web Services account.

        • metadata — (map)

          The metadata for the assessment.

          • name — (String)

            The name of the assessment.

          • id — (String)

            The unique identifier for the assessment.

          • description — (String)

            The description of the assessment.

          • complianceType — (String)

            The name of the compliance standard that's related to the assessment, such as PCI-DSS.

          • status — (String)

            The overall status of the assessment.

            Possible values include:
            • "ACTIVE"
            • "INACTIVE"
          • assessmentReportsDestination — (map)

            The destination that evidence reports are stored in for the assessment.

            • destinationType — (String)

              The destination type, such as Amazon S3.

              Possible values include:
              • "S3"
            • destination — (String)

              The destination of the assessment report.

          • scope — (map)

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

            • awsAccounts — (Array<map>)

              The Amazon Web Services accounts that are included in the scope of the assessment.

              • id — (String)

                The identifier for the Amazon Web Services account.

              • emailAddress — (String)

                The email address that's associated with the Amazon Web Services account.

              • name — (String)

                The name of the Amazon Web Services account.

            • awsServices — (Array<map>)

              The Amazon Web Services services that are included in the scope of the assessment.

              • serviceName — (String)

                The name of the Amazon Web Service.

          • roles — (Array<map>)

            The roles that are associated with the assessment.

            • roleType — (String)

              The type of customer persona.

              Note: In CreateAssessment, roleType can only be PROCESS_OWNER. In UpdateSettings, roleType can only be PROCESS_OWNER. In BatchCreateDelegationByAssessment, roleType can only be RESOURCE_OWNER.
              Possible values include:
              • "PROCESS_OWNER"
              • "RESOURCE_OWNER"
            • roleArn — (String)

              The Amazon Resource Name (ARN) of the IAM role.

          • delegations — (Array<map>)

            The delegations that are associated with the assessment.

            • id — (String)

              The unique identifier for the delegation.

            • assessmentName — (String)

              The name of the assessment that's associated with the delegation.

            • assessmentId — (String)

              The identifier for the assessment that's associated with the delegation.

            • status — (String)

              The status of the delegation.

              Possible values include:
              • "IN_PROGRESS"
              • "UNDER_REVIEW"
              • "COMPLETE"
            • roleArn — (String)

              The Amazon Resource Name (ARN) of the IAM role.

            • roleType — (String)

              The type of customer persona.

              Note: In CreateAssessment, roleType can only be PROCESS_OWNER. In UpdateSettings, roleType can only be PROCESS_OWNER. In BatchCreateDelegationByAssessment, roleType can only be RESOURCE_OWNER.
              Possible values include:
              • "PROCESS_OWNER"
              • "RESOURCE_OWNER"
            • creationTime — (Date)

              Specifies when the delegation was created.

            • lastUpdated — (Date)

              Specifies when the delegation was last updated.

            • controlSetId — (String)

              The identifier for the control set that's associated with the delegation.

            • comment — (String)

              The comment that's related to the delegation.

            • createdBy — (String)

              The IAM user or role that created the delegation.

          • creationTime — (Date)

            Specifies when the assessment was created.

          • lastUpdated — (Date)

            The time of the most recent update.

        • framework — (map)

          The framework that the assessment was created from.

          • id — (String)

            The unique identifier for the framework.

          • arn — (String)

            The Amazon Resource Name (ARN) of the framework.

          • metadata — (map)

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

            • name — (String)

              The name of the framework.

            • description — (String)

              The description of the framework.

            • logo — (String)

              The logo that's associated with the framework.

            • complianceType — (String)

              The compliance standard that's associated with the framework. For example, this could be PCI DSS or HIPAA.

          • controlSets — (Array<map>)

            The control sets that are associated with the framework.

            • id — (String)

              The identifier of the control set in the assessment. This is the control set name in a plain string format.

            • description — (String)

              The description for the control set.

            • status — (String)

              Specifies the current status of the control set.

              Possible values include:
              • "ACTIVE"
              • "UNDER_REVIEW"
              • "REVIEWED"
            • roles — (Array<map>)

              The roles that are associated with the control set.

              • roleType — (String)

                The type of customer persona.

                Note: In CreateAssessment, roleType can only be PROCESS_OWNER. In UpdateSettings, roleType can only be PROCESS_OWNER. In BatchCreateDelegationByAssessment, roleType can only be RESOURCE_OWNER.
                Possible values include:
                • "PROCESS_OWNER"
                • "RESOURCE_OWNER"
              • roleArn — (String)

                The Amazon Resource Name (ARN) of the IAM role.

            • controls — (Array<map>)

              The list of controls that's contained with the control set.

              • id — (String)

                The identifier for the control.

              • name — (String)

                The name of the control.

              • description — (String)

                The description of the control.

              • status — (String)

                The status of the control.

                Possible values include:
                • "UNDER_REVIEW"
                • "REVIEWED"
                • "INACTIVE"
              • response — (String)

                The response of the control.

                Possible values include:
                • "MANUAL"
                • "AUTOMATE"
                • "DEFER"
                • "IGNORE"
              • comments — (Array<map>)

                The list of comments that's attached to the control.

                • authorName — (String)

                  The name of the user who authored the comment.

                • commentBody — (String)

                  The body text of a control comment.

                • postedDate — (Date)

                  The time when the comment was posted.

              • evidenceSources — (Array<String>)

                The list of data sources for the evidence.

              • evidenceCount — (Integer)

                The amount of evidence that's generated for the control.

              • assessmentReportEvidenceCount — (Integer)

                The amount of evidence in the assessment report.

            • delegations — (Array<map>)

              The delegations that are associated with the control set.

              • id — (String)

                The unique identifier for the delegation.

              • assessmentName — (String)

                The name of the assessment that's associated with the delegation.

              • assessmentId — (String)

                The identifier for the assessment that's associated with the delegation.

              • status — (String)

                The status of the delegation.

                Possible values include:
                • "IN_PROGRESS"
                • "UNDER_REVIEW"
                • "COMPLETE"
              • roleArn — (String)

                The Amazon Resource Name (ARN) of the IAM role.

              • roleType — (String)

                The type of customer persona.

                Note: In CreateAssessment, roleType can only be PROCESS_OWNER. In UpdateSettings, roleType can only be PROCESS_OWNER. In BatchCreateDelegationByAssessment, roleType can only be RESOURCE_OWNER.
                Possible values include:
                • "PROCESS_OWNER"
                • "RESOURCE_OWNER"
              • creationTime — (Date)

                Specifies when the delegation was created.

              • lastUpdated — (Date)

                Specifies when the delegation was last updated.

              • controlSetId — (String)

                The identifier for the control set that's associated with the delegation.

              • comment — (String)

                The comment that's related to the delegation.

              • createdBy — (String)

                The IAM user or role that created the delegation.

            • systemEvidenceCount — (Integer)

              The total number of evidence objects that are retrieved automatically for the control set.

            • manualEvidenceCount — (Integer)

              The total number of evidence objects that are uploaded manually to the control set.

        • tags — (map<String>)

          The tags that are associated with the assessment.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createAssessmentFramework(params = {}, callback) ⇒ AWS.Request

Creates a custom framework in Audit Manager.

Service Reference:

Examples:

Calling the createAssessmentFramework operation

var params = {
  controlSets: [ /* required */
    {
      name: 'STRING_VALUE', /* required */
      controls: [
        {
          id: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ],
  name: 'STRING_VALUE', /* required */
  complianceType: 'STRING_VALUE',
  description: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
auditmanager.createAssessmentFramework(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • name — (String)

      The name of the new custom framework.

    • description — (String)

      An optional description for the new custom framework.

    • complianceType — (String)

      The compliance type that the new custom framework supports, such as CIS or HIPAA.

    • controlSets — (Array<map>)

      The control sets that are associated with the framework.

      • namerequired — (String)

        The name of the control set.

      • controls — (Array<map>)

        The list of controls within the control set. This doesn't contain the control set ID.

        • id — (String)

          The unique identifier of the control.

    • tags — (map<String>)

      The tags that are associated with the framework.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • framework — (map)

        The name of the new framework that the CreateAssessmentFramework API returned.

        • arn — (String)

          The Amazon Resource Name (ARN) of the framework.

        • id — (String)

          The unique identifier for the framework.

        • name — (String)

          The name of the framework.

        • type — (String)

          The framework type, such as a custom framework or a standard framework.

          Possible values include:
          • "Standard"
          • "Custom"
        • complianceType — (String)

          The compliance type that the new custom framework supports, such as CIS or HIPAA.

        • description — (String)

          The description of the framework.

        • logo — (String)

          The logo that's associated with the framework.

        • controlSources — (String)

          The sources that Audit Manager collects evidence from for the control.

        • controlSets — (Array<map>)

          The control sets that are associated with the framework.

          • id — (String)

            The identifier of the control set in the assessment. This is the control set name in a plain string format.

          • name — (String)

            The name of the control set.

          • controls — (Array<map>)

            The list of controls within the control set.

            • arn — (String)

              The Amazon Resource Name (ARN) of the control.

            • id — (String)

              The unique identifier for the control.

            • type — (String)

              The type of control, such as a custom control or a standard control.

              Possible values include:
              • "Standard"
              • "Custom"
            • name — (String)

              The name of the control.

            • description — (String)

              The description of the control.

            • testingInformation — (String)

              The steps that you should follow to determine if the control has been satisfied.

            • actionPlanTitle — (String)

              The title of the action plan for remediating the control.

            • actionPlanInstructions — (String)

              The recommended actions to carry out if the control isn't fulfilled.

            • controlSources — (String)

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

            • controlMappingSources — (Array<map>)

              The data mapping sources for the control.

              • sourceId — (String)

                The unique identifier for the source.

              • sourceName — (String)

                The name of the source.

              • sourceDescription — (String)

                The description of the source.

              • sourceSetUpOption — (String)

                The setup option for the data source. This option reflects if the evidence collection is automated or manual.

                Possible values include:
                • "System_Controls_Mapping"
                • "Procedural_Controls_Mapping"
              • sourceType — (String)

                Specifies one of the five types of data sources for evidence collection.

                Possible values include:
                • "AWS_Cloudtrail"
                • "AWS_Config"
                • "AWS_Security_Hub"
                • "AWS_API_Call"
                • "MANUAL"
              • sourceKeyword — (map)

                The keyword to search for in CloudTrail logs, Config rules, Security Hub checks, and Amazon Web Services API names.

                • keywordInputType — (String)

                  The method of input for the keyword.

                  Possible values include:
                  • "SELECT_FROM_LIST"
                • keywordValue — (String)

                  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.

              • sourceFrequency — (String)

                The frequency of evidence collection for the control mapping source.

                Possible values include:
                • "DAILY"
                • "WEEKLY"
                • "MONTHLY"
              • troubleshootingText — (String)

                The instructions for troubleshooting the control.

            • createdAt — (Date)

              Specifies when the control was created.

            • lastUpdatedAt — (Date)

              Specifies when the control was most recently updated.

            • createdBy — (String)

              The IAM user or role that created the control.

            • lastUpdatedBy — (String)

              The IAM user or role that most recently updated the control.

            • tags — (map<String>)

              The tags associated with the control.

        • createdAt — (Date)

          Specifies when the framework was created.

        • lastUpdatedAt — (Date)

          Specifies when the framework was most recently updated.

        • createdBy — (String)

          The IAM user or role that created the framework.

        • lastUpdatedBy — (String)

          The IAM user or role that most recently updated the framework.

        • tags — (map<String>)

          The tags that are associated with the framework.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createAssessmentReport(params = {}, callback) ⇒ AWS.Request

Creates an assessment report for the specified assessment.

Service Reference:

Examples:

Calling the createAssessmentReport operation

var params = {
  assessmentId: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE'
};
auditmanager.createAssessmentReport(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • name — (String)

      The name of the new assessment report.

    • description — (String)

      The description of the assessment report.

    • assessmentId — (String)

      The identifier for the assessment.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • assessmentReport — (map)

        The new assessment report that the CreateAssessmentReport API returned.

        • id — (String)

          The unique identifier for the assessment report.

        • name — (String)

          The name that's given to the assessment report.

        • description — (String)

          The description of the specified assessment report.

        • awsAccountId — (String)

          The identifier for the specified Amazon Web Services account.

        • assessmentId — (String)

          The identifier for the specified assessment.

        • assessmentName — (String)

          The name of the associated assessment.

        • author — (String)

          The name of the user who created the assessment report.

        • status — (String)

          The current status of the specified assessment report.

          Possible values include:
          • "COMPLETE"
          • "IN_PROGRESS"
          • "FAILED"
        • creationTime — (Date)

          Specifies when the assessment report was created.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createControl(params = {}, callback) ⇒ AWS.Request

Creates a new custom control in Audit Manager.

Service Reference:

Examples:

Calling the createControl operation

var params = {
  controlMappingSources: [ /* required */
    {
      sourceDescription: 'STRING_VALUE',
      sourceFrequency: DAILY | WEEKLY | MONTHLY,
      sourceKeyword: {
        keywordInputType: SELECT_FROM_LIST,
        keywordValue: 'STRING_VALUE'
      },
      sourceName: 'STRING_VALUE',
      sourceSetUpOption: System_Controls_Mapping | Procedural_Controls_Mapping,
      sourceType: AWS_Cloudtrail | AWS_Config | AWS_Security_Hub | AWS_API_Call | MANUAL,
      troubleshootingText: 'STRING_VALUE'
    },
    /* more items */
  ],
  name: 'STRING_VALUE', /* required */
  actionPlanInstructions: 'STRING_VALUE',
  actionPlanTitle: 'STRING_VALUE',
  description: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  testingInformation: 'STRING_VALUE'
};
auditmanager.createControl(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • name — (String)

      The name of the control.

    • description — (String)

      The description of the control.

    • testingInformation — (String)

      The steps to follow to determine if the control is satisfied.

    • actionPlanTitle — (String)

      The title of the action plan for remediating the control.

    • actionPlanInstructions — (String)

      The recommended actions to carry out if the control isn't fulfilled.

    • controlMappingSources — (Array<map>)

      The data mapping sources for the control.

      • sourceName — (String)

        The name of the control mapping data source.

      • sourceDescription — (String)

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

      • sourceSetUpOption — (String)

        The setup option for the data source, which reflects if the evidence collection is automated or manual.

        Possible values include:
        • "System_Controls_Mapping"
        • "Procedural_Controls_Mapping"
      • sourceType — (String)

        Specifies one of the five types of data sources for evidence collection.

        Possible values include:
        • "AWS_Cloudtrail"
        • "AWS_Config"
        • "AWS_Security_Hub"
        • "AWS_API_Call"
        • "MANUAL"
      • sourceKeyword — (map)

        The keyword to search for in CloudTrail logs, Config rules, Security Hub checks, and Amazon Web Services API names.

        • keywordInputType — (String)

          The method of input for the keyword.

          Possible values include:
          • "SELECT_FROM_LIST"
        • keywordValue — (String)

          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.

      • sourceFrequency — (String)

        The frequency of evidence collection for the control mapping source.

        Possible values include:
        • "DAILY"
        • "WEEKLY"
        • "MONTHLY"
      • troubleshootingText — (String)

        The instructions for troubleshooting the control.

    • tags — (map<String>)

      The tags that are associated with the control.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • control — (map)

        The new control that the CreateControl API returned.

        • arn — (String)

          The Amazon Resource Name (ARN) of the control.

        • id — (String)

          The unique identifier for the control.

        • type — (String)

          The type of control, such as a custom control or a standard control.

          Possible values include:
          • "Standard"
          • "Custom"
        • name — (String)

          The name of the control.

        • description — (String)

          The description of the control.

        • testingInformation — (String)

          The steps that you should follow to determine if the control has been satisfied.

        • actionPlanTitle — (String)

          The title of the action plan for remediating the control.

        • actionPlanInstructions — (String)

          The recommended actions to carry out if the control isn't fulfilled.

        • controlSources — (String)

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

        • controlMappingSources — (Array<map>)

          The data mapping sources for the control.

          • sourceId — (String)

            The unique identifier for the source.

          • sourceName — (String)

            The name of the source.

          • sourceDescription — (String)

            The description of the source.

          • sourceSetUpOption — (String)

            The setup option for the data source. This option reflects if the evidence collection is automated or manual.

            Possible values include:
            • "System_Controls_Mapping"
            • "Procedural_Controls_Mapping"
          • sourceType — (String)

            Specifies one of the five types of data sources for evidence collection.

            Possible values include:
            • "AWS_Cloudtrail"
            • "AWS_Config"
            • "AWS_Security_Hub"
            • "AWS_API_Call"
            • "MANUAL"
          • sourceKeyword — (map)

            The keyword to search for in CloudTrail logs, Config rules, Security Hub checks, and Amazon Web Services API names.

            • keywordInputType — (String)

              The method of input for the keyword.

              Possible values include:
              • "SELECT_FROM_LIST"
            • keywordValue — (String)

              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.

          • sourceFrequency — (String)

            The frequency of evidence collection for the control mapping source.

            Possible values include:
            • "DAILY"
            • "WEEKLY"
            • "MONTHLY"
          • troubleshootingText — (String)

            The instructions for troubleshooting the control.

        • createdAt — (Date)

          Specifies when the control was created.

        • lastUpdatedAt — (Date)

          Specifies when the control was most recently updated.

        • createdBy — (String)

          The IAM user or role that created the control.

        • lastUpdatedBy — (String)

          The IAM user or role that most recently updated the control.

        • tags — (map<String>)

          The tags associated with the control.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteAssessment(params = {}, callback) ⇒ AWS.Request

Deletes an assessment in Audit Manager.

Service Reference:

Examples:

Calling the deleteAssessment operation

var params = {
  assessmentId: 'STRING_VALUE' /* required */
};
auditmanager.deleteAssessment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • assessmentId — (String)

      The identifier for the assessment.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteAssessmentFramework(params = {}, callback) ⇒ AWS.Request

Deletes a custom framework in Audit Manager.

Service Reference:

Examples:

Calling the deleteAssessmentFramework operation

var params = {
  frameworkId: 'STRING_VALUE' /* required */
};
auditmanager.deleteAssessmentFramework(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • frameworkId — (String)

      The identifier for the custom framework.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteAssessmentFrameworkShare(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the deleteAssessmentFrameworkShare operation

var params = {
  requestId: 'STRING_VALUE', /* required */
  requestType: SENT | RECEIVED /* required */
};
auditmanager.deleteAssessmentFrameworkShare(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • requestId — (String)

      The unique identifier for the share request to be deleted.

    • requestType — (String)

      Specifies whether the share request is a sent request or a received request.

      Possible values include:
      • "SENT"
      • "RECEIVED"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteAssessmentReport(params = {}, callback) ⇒ AWS.Request

Deletes an assessment report from an assessment in Audit Manager.

Service Reference:

Examples:

Calling the deleteAssessmentReport operation

var params = {
  assessmentId: 'STRING_VALUE', /* required */
  assessmentReportId: 'STRING_VALUE' /* required */
};
auditmanager.deleteAssessmentReport(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • assessmentId — (String)

      The unique identifier for the assessment.

    • assessmentReportId — (String)

      The unique identifier for the assessment report.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteControl(params = {}, callback) ⇒ AWS.Request

Deletes a custom control in Audit Manager.

Service Reference:

Examples:

Calling the deleteControl operation

var params = {
  controlId: 'STRING_VALUE' /* required */
};
auditmanager.deleteControl(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • controlId — (String)

      The unique identifier for the control.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deregisterAccount(params = {}, callback) ⇒ AWS.Request

Deregisters an account in Audit Manager.

Service Reference:

Examples:

Calling the deregisterAccount operation

var params = {
};
auditmanager.deregisterAccount(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • status — (String)

        The registration status of the account.

        Possible values include:
        • "ACTIVE"
        • "INACTIVE"
        • "PENDING_ACTIVATION"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deregisterOrganizationAdminAccount(params = {}, callback) ⇒ AWS.Request

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.

Examples:

Calling the deregisterOrganizationAdminAccount operation

var params = {
  adminAccountId: 'STRING_VALUE'
};
auditmanager.deregisterOrganizationAdminAccount(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • adminAccountId — (String)

      The identifier for the administrator account.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

disassociateAssessmentReportEvidenceFolder(params = {}, callback) ⇒ AWS.Request

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

Examples:

Calling the disassociateAssessmentReportEvidenceFolder operation

var params = {
  assessmentId: 'STRING_VALUE', /* required */
  evidenceFolderId: 'STRING_VALUE' /* required */
};
auditmanager.disassociateAssessmentReportEvidenceFolder(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • assessmentId — (String)

      The unique identifier for the assessment.

    • evidenceFolderId — (String)

      The unique identifier for the folder that the evidence is stored in.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getAccountStatus(params = {}, callback) ⇒ AWS.Request

Returns the registration status of an account in Audit Manager.

Service Reference:

Examples:

Calling the getAccountStatus operation

var params = {
};
auditmanager.getAccountStatus(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • status — (String)

        The status of the Amazon Web Services account.

        Possible values include:
        • "ACTIVE"
        • "INACTIVE"
        • "PENDING_ACTIVATION"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getAssessment(params = {}, callback) ⇒ AWS.Request

Returns an assessment from Audit Manager.

Service Reference:

Examples:

Calling the getAssessment operation

var params = {
  assessmentId: 'STRING_VALUE' /* required */
};
auditmanager.getAssessment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • assessmentId — (String)

      The unique identifier for the assessment.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • assessment — (map)

        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.

        • arn — (String)

          The Amazon Resource Name (ARN) of the assessment.

        • awsAccount — (map)

          The Amazon Web Services account that's associated with the assessment.

          • id — (String)

            The identifier for the Amazon Web Services account.

          • emailAddress — (String)

            The email address that's associated with the Amazon Web Services account.

          • name — (String)

            The name of the Amazon Web Services account.

        • metadata — (map)

          The metadata for the assessment.

          • name — (String)

            The name of the assessment.

          • id — (String)

            The unique identifier for the assessment.

          • description — (String)

            The description of the assessment.

          • complianceType — (String)

            The name of the compliance standard that's related to the assessment, such as PCI-DSS.

          • status — (String)

            The overall status of the assessment.

            Possible values include:
            • "ACTIVE"
            • "INACTIVE"
          • assessmentReportsDestination — (map)

            The destination that evidence reports are stored in for the assessment.

            • destinationType — (String)

              The destination type, such as Amazon S3.

              Possible values include:
              • "S3"
            • destination — (String)

              The destination of the assessment report.

          • scope — (map)

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

            • awsAccounts — (Array<map>)

              The Amazon Web Services accounts that are included in the scope of the assessment.

              • id — (String)

                The identifier for the Amazon Web Services account.

              • emailAddress — (String)

                The email address that's associated with the Amazon Web Services account.

              • name — (String)

                The name of the Amazon Web Services account.

            • awsServices — (Array<map>)

              The Amazon Web Services services that are included in the scope of the assessment.

              • serviceName — (String)

                The name of the Amazon Web Service.

          • roles — (Array<map>)

            The roles that are associated with the assessment.

            • roleType — (String)

              The type of customer persona.

              Note: In CreateAssessment, roleType can only be PROCESS_OWNER. In UpdateSettings, roleType can only be PROCESS_OWNER. In BatchCreateDelegationByAssessment, roleType can only be RESOURCE_OWNER.
              Possible values include:
              • "PROCESS_OWNER"
              • "RESOURCE_OWNER"
            • roleArn — (String)

              The Amazon Resource Name (ARN) of the IAM role.

          • delegations — (Array<map>)

            The delegations that are associated with the assessment.

            • id — (String)

              The unique identifier for the delegation.

            • assessmentName — (String)

              The name of the assessment that's associated with the delegation.

            • assessmentId — (String)

              The identifier for the assessment that's associated with the delegation.

            • status — (String)

              The status of the delegation.

              Possible values include:
              • "IN_PROGRESS"
              • "UNDER_REVIEW"
              • "COMPLETE"
            • roleArn — (String)

              The Amazon Resource Name (ARN) of the IAM role.

            • roleType — (String)

              The type of customer persona.

              Note: In CreateAssessment, roleType can only be PROCESS_OWNER. In UpdateSettings, roleType can only be PROCESS_OWNER. In BatchCreateDelegationByAssessment, roleType can only be RESOURCE_OWNER.
              Possible values include:
              • "PROCESS_OWNER"
              • "RESOURCE_OWNER"
            • creationTime — (Date)

              Specifies when the delegation was created.

            • lastUpdated — (Date)

              Specifies when the delegation was last updated.

            • controlSetId — (String)

              The identifier for the control set that's associated with the delegation.

            • comment — (String)

              The comment that's related to the delegation.

            • createdBy — (String)

              The IAM user or role that created the delegation.

          • creationTime — (Date)

            Specifies when the assessment was created.

          • lastUpdated — (Date)

            The time of the most recent update.

        • framework — (map)

          The framework that the assessment was created from.

          • id — (String)

            The unique identifier for the framework.

          • arn — (String)

            The Amazon Resource Name (ARN) of the framework.

          • metadata — (map)

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

            • name — (String)

              The name of the framework.

            • description — (String)

              The description of the framework.

            • logo — (String)

              The logo that's associated with the framework.

            • complianceType — (String)

              The compliance standard that's associated with the framework. For example, this could be PCI DSS or HIPAA.

          • controlSets — (Array<map>)

            The control sets that are associated with the framework.

            • id — (String)

              The identifier of the control set in the assessment. This is the control set name in a plain string format.

            • description — (String)

              The description for the control set.

            • status — (String)

              Specifies the current status of the control set.

              Possible values include:
              • "ACTIVE"
              • "UNDER_REVIEW"
              • "REVIEWED"
            • roles — (Array<map>)

              The roles that are associated with the control set.

              • roleType — (String)

                The type of customer persona.

                Note: In CreateAssessment, roleType can only be PROCESS_OWNER. In UpdateSettings, roleType can only be PROCESS_OWNER. In BatchCreateDelegationByAssessment, roleType can only be RESOURCE_OWNER.
                Possible values include:
                • "PROCESS_OWNER"
                • "RESOURCE_OWNER"
              • roleArn — (String)

                The Amazon Resource Name (ARN) of the IAM role.

            • controls — (Array<map>)

              The list of controls that's contained with the control set.

              • id — (String)

                The identifier for the control.

              • name — (String)

                The name of the control.

              • description — (String)

                The description of the control.

              • status — (String)

                The status of the control.

                Possible values include:
                • "UNDER_REVIEW"
                • "REVIEWED"
                • "INACTIVE"
              • response — (String)

                The response of the control.

                Possible values include:
                • "MANUAL"
                • "AUTOMATE"
                • "DEFER"
                • "IGNORE"
              • comments — (Array<map>)

                The list of comments that's attached to the control.

                • authorName — (String)

                  The name of the user who authored the comment.

                • commentBody — (String)

                  The body text of a control comment.

                • postedDate — (Date)

                  The time when the comment was posted.

              • evidenceSources — (Array<String>)

                The list of data sources for the evidence.

              • evidenceCount — (Integer)

                The amount of evidence that's generated for the control.

              • assessmentReportEvidenceCount — (Integer)

                The amount of evidence in the assessment report.

            • delegations — (Array<map>)

              The delegations that are associated with the control set.

              • id — (String)

                The unique identifier for the delegation.

              • assessmentName — (String)

                The name of the assessment that's associated with the delegation.

              • assessmentId — (String)

                The identifier for the assessment that's associated with the delegation.

              • status — (String)

                The status of the delegation.

                Possible values include:
                • "IN_PROGRESS"
                • "UNDER_REVIEW"
                • "COMPLETE"
              • roleArn — (String)

                The Amazon Resource Name (ARN) of the IAM role.

              • roleType — (String)

                The type of customer persona.

                Note: In CreateAssessment, roleType can only be PROCESS_OWNER. In UpdateSettings, roleType can only be PROCESS_OWNER. In BatchCreateDelegationByAssessment, roleType can only be RESOURCE_OWNER.
                Possible values include:
                • "PROCESS_OWNER"
                • "RESOURCE_OWNER"
              • creationTime — (Date)

                Specifies when the delegation was created.

              • lastUpdated — (Date)

                Specifies when the delegation was last updated.

              • controlSetId — (String)

                The identifier for the control set that's associated with the delegation.

              • comment — (String)

                The comment that's related to the delegation.

              • createdBy — (String)

                The IAM user or role that created the delegation.

            • systemEvidenceCount — (Integer)

              The total number of evidence objects that are retrieved automatically for the control set.

            • manualEvidenceCount — (Integer)

              The total number of evidence objects that are uploaded manually to the control set.

        • tags — (map<String>)

          The tags that are associated with the assessment.

      • userRole — (map)

        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 — (String)

          The type of customer persona.

          Note: In CreateAssessment, roleType can only be PROCESS_OWNER. In UpdateSettings, roleType can only be PROCESS_OWNER. In BatchCreateDelegationByAssessment, roleType can only be RESOURCE_OWNER.
          Possible values include:
          • "PROCESS_OWNER"
          • "RESOURCE_OWNER"
        • roleArn — (String)

          The Amazon Resource Name (ARN) of the IAM role.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getAssessmentFramework(params = {}, callback) ⇒ AWS.Request

Returns a framework from Audit Manager.

Service Reference:

Examples:

Calling the getAssessmentFramework operation

var params = {
  frameworkId: 'STRING_VALUE' /* required */
};
auditmanager.getAssessmentFramework(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • frameworkId — (String)

      The identifier for the framework.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • framework — (map)

        The framework that the GetAssessmentFramework API returned.

        • arn — (String)

          The Amazon Resource Name (ARN) of the framework.

        • id — (String)

          The unique identifier for the framework.

        • name — (String)

          The name of the framework.

        • type — (String)

          The framework type, such as a custom framework or a standard framework.

          Possible values include:
          • "Standard"
          • "Custom"
        • complianceType — (String)

          The compliance type that the new custom framework supports, such as CIS or HIPAA.

        • description — (String)

          The description of the framework.

        • logo — (String)

          The logo that's associated with the framework.

        • controlSources — (String)

          The sources that Audit Manager collects evidence from for the control.

        • controlSets — (Array<map>)

          The control sets that are associated with the framework.

          • id — (String)

            The identifier of the control set in the assessment. This is the control set name in a plain string format.

          • name — (String)

            The name of the control set.

          • controls — (Array<map>)

            The list of controls within the control set.

            • arn — (String)

              The Amazon Resource Name (ARN) of the control.

            • id — (String)

              The unique identifier for the control.

            • type — (String)

              The type of control, such as a custom control or a standard control.

              Possible values include:
              • "Standard"
              • "Custom"
            • name — (String)

              The name of the control.

            • description — (String)

              The description of the control.

            • testingInformation — (String)

              The steps that you should follow to determine if the control has been satisfied.

            • actionPlanTitle — (String)

              The title of the action plan for remediating the control.

            • actionPlanInstructions — (String)

              The recommended actions to carry out if the control isn't fulfilled.

            • controlSources — (String)

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

            • controlMappingSources — (Array<map>)

              The data mapping sources for the control.

              • sourceId — (String)

                The unique identifier for the source.

              • sourceName — (String)

                The name of the source.

              • sourceDescription — (String)

                The description of the source.

              • sourceSetUpOption — (String)

                The setup option for the data source. This option reflects if the evidence collection is automated or manual.

                Possible values include:
                • "System_Controls_Mapping"
                • "Procedural_Controls_Mapping"
              • sourceType — (String)

                Specifies one of the five types of data sources for evidence collection.

                Possible values include:
                • "AWS_Cloudtrail"
                • "AWS_Config"
                • "AWS_Security_Hub"
                • "AWS_API_Call"
                • "MANUAL"
              • sourceKeyword — (map)

                The keyword to search for in CloudTrail logs, Config rules, Security Hub checks, and Amazon Web Services API names.

                • keywordInputType — (String)

                  The method of input for the keyword.

                  Possible values include:
                  • "SELECT_FROM_LIST"
                • keywordValue — (String)

                  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.

              • sourceFrequency — (String)

                The frequency of evidence collection for the control mapping source.

                Possible values include:
                • "DAILY"
                • "WEEKLY"
                • "MONTHLY"
              • troubleshootingText — (String)

                The instructions for troubleshooting the control.

            • createdAt — (Date)

              Specifies when the control was created.

            • lastUpdatedAt — (Date)

              Specifies when the control was most recently updated.

            • createdBy — (String)

              The IAM user or role that created the control.

            • lastUpdatedBy — (String)

              The IAM user or role that most recently updated the control.

            • tags — (map<String>)

              The tags associated with the control.

        • createdAt — (Date)

          Specifies when the framework was created.

        • lastUpdatedAt — (Date)

          Specifies when the framework was most recently updated.

        • createdBy — (String)

          The IAM user or role that created the framework.

        • lastUpdatedBy — (String)

          The IAM user or role that most recently updated the framework.

        • tags — (map<String>)

          The tags that are associated with the framework.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getAssessmentReportUrl(params = {}, callback) ⇒ AWS.Request

Returns the URL of an assessment report in Audit Manager.

Service Reference:

Examples:

Calling the getAssessmentReportUrl operation

var params = {
  assessmentId: 'STRING_VALUE', /* required */
  assessmentReportId: 'STRING_VALUE' /* required */
};
auditmanager.getAssessmentReportUrl(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • assessmentReportId — (String)

      The unique identifier for the assessment report.

    • assessmentId — (String)

      The unique identifier for the assessment.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • preSignedUrl — (map)

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

        • hyperlinkName — (String)

          The name or word that's used as a hyperlink to the URL.

        • link — (String)

          The unique identifier for the internet resource.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getChangeLogs(params = {}, callback) ⇒ AWS.Request

Returns a list of changelogs from Audit Manager.

Service Reference:

Examples:

Calling the getChangeLogs operation

var params = {
  assessmentId: 'STRING_VALUE', /* required */
  controlId: 'STRING_VALUE',
  controlSetId: 'STRING_VALUE',
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
auditmanager.getChangeLogs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • assessmentId — (String)

      The unique identifier for the assessment.

    • controlSetId — (String)

      The unique identifier for the control set.

    • controlId — (String)

      The unique identifier for the control.

    • nextToken — (String)

      The pagination token that's used to fetch the next set of results.

    • maxResults — (Integer)

      Represents the maximum number of results on a page or for an API request call.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • changeLogs — (Array<map>)

        The list of user activity for the control.

        • objectType — (String)

          The object that was changed, such as an assessment, control, or control set.

          Possible values include:
          • "ASSESSMENT"
          • "CONTROL_SET"
          • "CONTROL"
          • "DELEGATION"
          • "ASSESSMENT_REPORT"
        • objectName — (String)

          The name of the object that changed. This could be the name of an assessment, control, or control set.

        • action — (String)

          The action that was performed.

          Possible values include:
          • "CREATE"
          • "UPDATE_METADATA"
          • "ACTIVE"
          • "INACTIVE"
          • "DELETE"
          • "UNDER_REVIEW"
          • "REVIEWED"
          • "IMPORT_EVIDENCE"
        • createdAt — (Date)

          The time when the action was performed and the changelog record was created.

        • createdBy — (String)

          The IAM user or role that performed the action.

      • nextToken — (String)

        The pagination token that's used to fetch the next set of results.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getControl(params = {}, callback) ⇒ AWS.Request

Returns a control from Audit Manager.

Service Reference:

Examples:

Calling the getControl operation

var params = {
  controlId: 'STRING_VALUE' /* required */
};
auditmanager.getControl(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • controlId — (String)

      The identifier for the control.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • control — (map)

        The name of the control that the GetControl API returned.

        • arn — (String)

          The Amazon Resource Name (ARN) of the control.

        • id — (String)

          The unique identifier for the control.

        • type — (String)

          The type of control, such as a custom control or a standard control.

          Possible values include:
          • "Standard"
          • "Custom"
        • name — (String)

          The name of the control.

        • description — (String)

          The description of the control.

        • testingInformation — (String)

          The steps that you should follow to determine if the control has been satisfied.

        • actionPlanTitle — (String)

          The title of the action plan for remediating the control.

        • actionPlanInstructions — (String)

          The recommended actions to carry out if the control isn't fulfilled.

        • controlSources — (String)

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

        • controlMappingSources — (Array<map>)

          The data mapping sources for the control.

          • sourceId — (String)

            The unique identifier for the source.

          • sourceName — (String)

            The name of the source.

          • sourceDescription — (String)

            The description of the source.

          • sourceSetUpOption — (String)

            The setup option for the data source. This option reflects if the evidence collection is automated or manual.

            Possible values include:
            • "System_Controls_Mapping"
            • "Procedural_Controls_Mapping"
          • sourceType — (String)

            Specifies one of the five types of data sources for evidence collection.

            Possible values include:
            • "AWS_Cloudtrail"
            • "AWS_Config"
            • "AWS_Security_Hub"
            • "AWS_API_Call"
            • "MANUAL"
          • sourceKeyword — (map)

            The keyword to search for in CloudTrail logs, Config rules, Security Hub checks, and Amazon Web Services API names.

            • keywordInputType — (String)

              The method of input for the keyword.

              Possible values include:
              • "SELECT_FROM_LIST"
            • keywordValue — (String)

              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.

          • sourceFrequency — (String)

            The frequency of evidence collection for the control mapping source.

            Possible values include:
            • "DAILY"
            • "WEEKLY"
            • "MONTHLY"
          • troubleshootingText — (String)

            The instructions for troubleshooting the control.

        • createdAt — (Date)

          Specifies when the control was created.

        • lastUpdatedAt — (Date)

          Specifies when the control was most recently updated.

        • createdBy — (String)

          The IAM user or role that created the control.

        • lastUpdatedBy — (String)

          The IAM user or role that most recently updated the control.

        • tags — (map<String>)

          The tags associated with the control.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getDelegations(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the getDelegations operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
auditmanager.getDelegations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • nextToken — (String)

      The pagination token that's used to fetch the next set of results.

    • maxResults — (Integer)

      Represents the maximum number of results on a page or for an API request call.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • delegations — (Array<map>)

        The list of delegations that the GetDelegations API returned.

        • id — (String)

          The unique identifier for the delegation.

        • assessmentName — (String)

          The name of the associated assessment.

        • assessmentId — (String)

          The unique identifier for the assessment.

        • status — (String)

          The current status of the delegation.

          Possible values include:
          • "IN_PROGRESS"
          • "UNDER_REVIEW"
          • "COMPLETE"
        • roleArn — (String)

          The Amazon Resource Name (ARN) of the IAM role.

        • creationTime — (Date)

          Specifies when the delegation was created.

        • controlSetName — (String)

          Specifies the name of the control set that was delegated for review.

      • nextToken — (String)

        The pagination token that's used to fetch the next set of results.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getEvidence(params = {}, callback) ⇒ AWS.Request

Returns evidence from Audit Manager.

Service Reference:

Examples:

Calling the getEvidence operation

var params = {
  assessmentId: 'STRING_VALUE', /* required */
  controlSetId: 'STRING_VALUE', /* required */
  evidenceFolderId: 'STRING_VALUE', /* required */
  evidenceId: 'STRING_VALUE' /* required */
};
auditmanager.getEvidence(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • assessmentId — (String)

      The unique identifier for the assessment.

    • controlSetId — (String)

      The unique identifier for the control set.

    • evidenceFolderId — (String)

      The unique identifier for the folder that the evidence is stored in.

    • evidenceId — (String)

      The unique identifier for the evidence.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • evidence — (map)

        The evidence that the GetEvidenceResponse API returned.

        • dataSource — (String)

          The data source where the evidence was collected from.

        • evidenceAwsAccountId — (String)

          The identifier for the Amazon Web Services account.

        • time — (Date)

          The timestamp that represents when the evidence was collected.

        • eventSource — (String)

          The Amazon Web Service that the evidence is collected from.

        • eventName — (String)

          The name of the evidence event.

        • evidenceByType — (String)

          The type of automated evidence.

        • resourcesIncluded — (Array<map>)

          The list of resources that are assessed to generate the evidence.

          • arn — (String)

            The Amazon Resource Name (ARN) for the resource.

          • value — (String)

            The value of the resource.

        • attributes — (map<String>)

          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).

        • iamId — (String)

          The unique identifier for the IAM user or role that's associated with the evidence.

        • complianceCheck — (String)

          The evaluation status for evidence that falls under the compliance check category. For evidence collected from Security Hub, a Pass or Fail result is shown. For evidence collected from Config, a Compliant or Noncompliant result is shown.

        • awsOrganization — (String)

          The Amazon Web Services account that the evidence is collected from, and its organization path.

        • awsAccountId — (String)

          The identifier for the Amazon Web Services account.

        • evidenceFolderId — (String)

          The identifier for the folder that the evidence is stored in.

        • id — (String)

          The identifier for the evidence.

        • assessmentReportSelection — (String)

          Specifies whether the evidence is included in the assessment report.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getEvidenceByEvidenceFolder(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the getEvidenceByEvidenceFolder operation

var params = {
  assessmentId: 'STRING_VALUE', /* required */
  controlSetId: 'STRING_VALUE', /* required */
  evidenceFolderId: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
auditmanager.getEvidenceByEvidenceFolder(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • assessmentId — (String)

      The identifier for the assessment.

    • controlSetId — (String)

      The identifier for the control set.

    • evidenceFolderId — (String)

      The unique identifier for the folder that the evidence is stored in.

    • nextToken — (String)

      The pagination token that's used to fetch the next set of results.

    • maxResults — (Integer)

      Represents the maximum number of results on a page or for an API request call.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • evidence — (Array<map>)

        The list of evidence that the GetEvidenceByEvidenceFolder API returned.

        • dataSource — (String)

          The data source where the evidence was collected from.

        • evidenceAwsAccountId — (String)

          The identifier for the Amazon Web Services account.

        • time — (Date)

          The timestamp that represents when the evidence was collected.

        • eventSource — (String)

          The Amazon Web Service that the evidence is collected from.

        • eventName — (String)

          The name of the evidence event.

        • evidenceByType — (String)

          The type of automated evidence.

        • resourcesIncluded — (Array<map>)

          The list of resources that are assessed to generate the evidence.

          • arn — (String)

            The Amazon Resource Name (ARN) for the resource.

          • value — (String)

            The value of the resource.

        • attributes — (map<String>)

          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).

        • iamId — (String)

          The unique identifier for the IAM user or role that's associated with the evidence.

        • complianceCheck — (String)

          The evaluation status for evidence that falls under the compliance check category. For evidence collected from Security Hub, a Pass or Fail result is shown. For evidence collected from Config, a Compliant or Noncompliant result is shown.

        • awsOrganization — (String)

          The Amazon Web Services account that the evidence is collected from, and its organization path.

        • awsAccountId — (String)

          The identifier for the Amazon Web Services account.

        • evidenceFolderId — (String)

          The identifier for the folder that the evidence is stored in.

        • id — (String)

          The identifier for the evidence.

        • assessmentReportSelection — (String)

          Specifies whether the evidence is included in the assessment report.

      • nextToken — (String)

        The pagination token that's used to fetch the next set of results.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getEvidenceFolder(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the getEvidenceFolder operation

var params = {
  assessmentId: 'STRING_VALUE', /* required */
  controlSetId: 'STRING_VALUE', /* required */
  evidenceFolderId: 'STRING_VALUE' /* required */
};
auditmanager.getEvidenceFolder(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • assessmentId — (String)

      The unique identifier for the assessment.

    • controlSetId — (String)

      The unique identifier for the control set.

    • evidenceFolderId — (String)

      The unique identifier for the folder that the evidence is stored in.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • evidenceFolder — (map)

        The folder that the evidence is stored in.

        • name — (String)

          The name of the evidence folder.

        • date — (Date)

          The date when the first evidence was added to the evidence folder.

        • assessmentId — (String)

          The identifier for the assessment.

        • controlSetId — (String)

          The identifier for the control set.

        • controlId — (String)

          The unique identifier for the control.

        • id — (String)

          The identifier for the folder that the evidence is stored in.

        • dataSource — (String)

          The Amazon Web Service that the evidence was collected from.

        • author — (String)

          The name of the user who created the evidence folder.

        • totalEvidence — (Integer)

          The total amount of evidence in the evidence folder.

        • assessmentReportSelectionCount — (Integer)

          The total count of evidence that's included in the assessment report.

        • controlName — (String)

          The name of the control.

        • evidenceResourcesIncludedCount — (Integer)

          The amount of evidence that's included in the evidence folder.

        • evidenceByTypeConfigurationDataCount — (Integer)

          The number of evidence that falls under the configuration data category. This evidence is collected from configuration snapshots of other Amazon Web Services services such as Amazon EC2, Amazon S3, or IAM.

        • evidenceByTypeManualCount — (Integer)

          The number of evidence that falls under the manual category. This evidence is imported manually.

        • evidenceByTypeComplianceCheckCount — (Integer)

          The number of evidence that falls under the compliance check category. This evidence is collected from Config or Security Hub.

        • evidenceByTypeComplianceCheckIssuesCount — (Integer)

          The total number of issues that were reported directly from Security Hub, Config, or both.

        • evidenceByTypeUserActivityCount — (Integer)

          The number of evidence that falls under the user activity category. This evidence is collected from CloudTrail logs.

        • evidenceAwsServiceSourceCount — (Integer)

          The total number of Amazon Web Services resources that were assessed to generate the evidence.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getEvidenceFoldersByAssessment(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the getEvidenceFoldersByAssessment operation

var params = {
  assessmentId: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
auditmanager.getEvidenceFoldersByAssessment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • assessmentId — (String)

      The unique identifier for the assessment.

    • nextToken — (String)

      The pagination token that's used to fetch the next set of results.

    • maxResults — (Integer)

      Represents the maximum number of results on a page or for an API request call.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • evidenceFolders — (Array<map>)

        The list of evidence folders that the GetEvidenceFoldersByAssessment API returned.

        • name — (String)

          The name of the evidence folder.

        • date — (Date)

          The date when the first evidence was added to the evidence folder.

        • assessmentId — (String)

          The identifier for the assessment.

        • controlSetId — (String)

          The identifier for the control set.

        • controlId — (String)

          The unique identifier for the control.

        • id — (String)

          The identifier for the folder that the evidence is stored in.

        • dataSource — (String)

          The Amazon Web Service that the evidence was collected from.

        • author — (String)

          The name of the user who created the evidence folder.

        • totalEvidence — (Integer)

          The total amount of evidence in the evidence folder.

        • assessmentReportSelectionCount — (Integer)

          The total count of evidence that's included in the assessment report.

        • controlName — (String)

          The name of the control.

        • evidenceResourcesIncludedCount — (Integer)

          The amount of evidence that's included in the evidence folder.

        • evidenceByTypeConfigurationDataCount — (Integer)

          The number of evidence that falls under the configuration data category. This evidence is collected from configuration snapshots of other Amazon Web Services services such as Amazon EC2, Amazon S3, or IAM.

        • evidenceByTypeManualCount — (Integer)

          The number of evidence that falls under the manual category. This evidence is imported manually.

        • evidenceByTypeComplianceCheckCount — (Integer)

          The number of evidence that falls under the compliance check category. This evidence is collected from Config or Security Hub.

        • evidenceByTypeComplianceCheckIssuesCount — (Integer)

          The total number of issues that were reported directly from Security Hub, Config, or both.

        • evidenceByTypeUserActivityCount — (Integer)

          The number of evidence that falls under the user activity category. This evidence is collected from CloudTrail logs.

        • evidenceAwsServiceSourceCount — (Integer)

          The total number of Amazon Web Services resources that were assessed to generate the evidence.

      • nextToken — (String)

        The pagination token that's used to fetch the next set of results.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getEvidenceFoldersByAssessmentControl(params = {}, callback) ⇒ AWS.Request

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

Examples:

Calling the getEvidenceFoldersByAssessmentControl operation

var params = {
  assessmentId: 'STRING_VALUE', /* required */
  controlId: 'STRING_VALUE', /* required */
  controlSetId: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
auditmanager.getEvidenceFoldersByAssessmentControl(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • assessmentId — (String)

      The identifier for the assessment.

    • controlSetId — (String)

      The identifier for the control set.

    • controlId — (String)

      The identifier for the control.

    • nextToken — (String)

      The pagination token that's used to fetch the next set of results.

    • maxResults — (Integer)

      Represents the maximum number of results on a page or for an API request call.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • evidenceFolders — (Array<map>)

        The list of evidence folders that the GetEvidenceFoldersByAssessmentControl API returned.

        • name — (String)

          The name of the evidence folder.

        • date — (Date)

          The date when the first evidence was added to the evidence folder.

        • assessmentId — (String)

          The identifier for the assessment.

        • controlSetId — (String)

          The identifier for the control set.

        • controlId — (String)

          The unique identifier for the control.

        • id — (String)

          The identifier for the folder that the evidence is stored in.

        • dataSource — (String)

          The Amazon Web Service that the evidence was collected from.

        • author — (String)

          The name of the user who created the evidence folder.

        • totalEvidence — (Integer)

          The total amount of evidence in the evidence folder.

        • assessmentReportSelectionCount — (Integer)

          The total count of evidence that's included in the assessment report.

        • controlName — (String)

          The name of the control.

        • evidenceResourcesIncludedCount — (Integer)

          The amount of evidence that's included in the evidence folder.

        • evidenceByTypeConfigurationDataCount — (Integer)

          The number of evidence that falls under the configuration data category. This evidence is collected from configuration snapshots of other Amazon Web Services services such as Amazon EC2, Amazon S3, or IAM.

        • evidenceByTypeManualCount — (Integer)

          The number of evidence that falls under the manual category. This evidence is imported manually.

        • evidenceByTypeComplianceCheckCount — (Integer)

          The number of evidence that falls under the compliance check category. This evidence is collected from Config or Security Hub.

        • evidenceByTypeComplianceCheckIssuesCount — (Integer)

          The total number of issues that were reported directly from Security Hub, Config, or both.

        • evidenceByTypeUserActivityCount — (Integer)

          The number of evidence that falls under the user activity category. This evidence is collected from CloudTrail logs.

        • evidenceAwsServiceSourceCount — (Integer)

          The total number of Amazon Web Services resources that were assessed to generate the evidence.

      • nextToken — (String)

        The pagination token that's used to fetch the next set of results.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getInsights(params = {}, callback) ⇒ AWS.Request

Gets the latest analytics data for all your current active assessments.

Service Reference:

Examples:

Calling the getInsights operation

var params = {
};
auditmanager.getInsights(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • insights — (map)

        The analytics data that the GetInsights API returned.

        • activeAssessmentsCount — (Integer)

          The number of active assessments in Audit Manager.

        • noncompliantEvidenceCount — (Integer)

          The number of compliance check evidence that Audit Manager classified as non-compliant on the lastUpdated date. This includes evidence that was collected from Security Hub with a Fail ruling, or collected from Config with a Non-compliant ruling.

        • compliantEvidenceCount — (Integer)

          The number of compliance check evidence that Audit Manager classified as compliant on the lastUpdated date. This includes evidence that was collected from Security Hub with a Pass ruling, or collected from Config with a Compliant ruling.

        • inconclusiveEvidenceCount — (Integer)

          The number of evidence without a compliance check ruling. Evidence is inconclusive when the associated control uses Security Hub or Config as a data source but you didn't enable those services. This is also the case when a control uses a data source that doesn’t support compliance checks (for example: manual evidence, API calls, or CloudTrail).

          Note: If evidence has a compliance check status of not applicable, it's classed as inconclusive in Insights data.
        • assessmentControlsCountByNoncompliantEvidence — (Integer)

          The number of assessment controls that collected non-compliant evidence on the lastUpdated date.

        • totalAssessmentControlsCount — (Integer)

          The total number of controls across all active assessments.

        • lastUpdated — (Date)

          The time when the cross-assessment insights were last updated.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getInsightsByAssessment(params = {}, callback) ⇒ AWS.Request

Gets the latest analytics data for a specific active assessment.

Service Reference:

Examples:

Calling the getInsightsByAssessment operation

var params = {
  assessmentId: 'STRING_VALUE' /* required */
};
auditmanager.getInsightsByAssessment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • assessmentId — (String)

      The unique identifier for the assessment.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • insights — (map)

        The assessment analytics data that the GetInsightsByAssessment API returned.

        • noncompliantEvidenceCount — (Integer)

          The number of compliance check evidence that Audit Manager classified as non-compliant. This includes evidence that was collected from Security Hub with a Fail ruling, or collected from Config with a Non-compliant ruling.

        • compliantEvidenceCount — (Integer)

          The number of compliance check evidence that Audit Manager classified as compliant. This includes evidence that was collected from Security Hub with a Pass ruling, or collected from Config with a Compliant ruling.

        • inconclusiveEvidenceCount — (Integer)

          The amount of evidence without a compliance check ruling. Evidence is inconclusive if the associated control uses Security Hub or Config as a data source and you didn't enable those services. This is also the case if a control uses a data source that doesn’t support compliance checks (for example, manual evidence, API calls, or CloudTrail).

          Note: If evidence has a compliance check status of not applicable, it's classified as inconclusive in InsightsByAssessment data.
        • assessmentControlsCountByNoncompliantEvidence — (Integer)

          The number of assessment controls that collected non-compliant evidence on the lastUpdated date.

        • totalAssessmentControlsCount — (Integer)

          The total number of controls in the assessment.

        • lastUpdated — (Date)

          The time when the assessment insights were last updated.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getOrganizationAdminAccount(params = {}, callback) ⇒ AWS.Request

Returns the name of the delegated Amazon Web Services administrator account for the organization.

Service Reference:

Examples:

Calling the getOrganizationAdminAccount operation

var params = {
};
auditmanager.getOrganizationAdminAccount(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • adminAccountId — (String)

        The identifier for the administrator account.

      • organizationId — (String)

        The identifier for the organization.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getServicesInScope(params = {}, callback) ⇒ AWS.Request

Returns a list of the in-scope Amazon Web Services services for the specified assessment.

Service Reference:

Examples:

Calling the getServicesInScope operation

var params = {
};
auditmanager.getServicesInScope(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • serviceMetadata — (Array<map>)

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

        • name — (String)

          The name of the Amazon Web Service.

        • displayName — (String)

          The display name of the Amazon Web Service.

        • description — (String)

          The description of the Amazon Web Service.

        • category — (String)

          The category that the Amazon Web Service belongs to, such as compute, storage, or database.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getSettings(params = {}, callback) ⇒ AWS.Request

Returns the settings for the specified Amazon Web Services account.

Service Reference:

Examples:

Calling the getSettings operation

var params = {
  attribute: ALL | IS_AWS_ORG_ENABLED | SNS_TOPIC | DEFAULT_ASSESSMENT_REPORTS_DESTINATION | DEFAULT_PROCESS_OWNERS /* required */
};
auditmanager.getSettings(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • attribute — (String)

      The list of SettingAttribute enum values.

      Possible values include:
      • "ALL"
      • "IS_AWS_ORG_ENABLED"
      • "SNS_TOPIC"
      • "DEFAULT_ASSESSMENT_REPORTS_DESTINATION"
      • "DEFAULT_PROCESS_OWNERS"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • settings — (map)

        The settings object that holds all supported Audit Manager settings.

        • isAwsOrgEnabled — (Boolean)

          Specifies whether Organizations is enabled.

        • snsTopic — (String)

          The designated Amazon Simple Notification Service (Amazon SNS) topic.

        • defaultAssessmentReportsDestination — (map)

          The default storage destination for assessment reports.

          • destinationType — (String)

            The destination type, such as Amazon S3.

            Possible values include:
            • "S3"
          • destination — (String)

            The destination of the assessment report.

        • defaultProcessOwners — (Array<map>)

          The designated default audit owners.

          • roleType — (String)

            The type of customer persona.

            Note: In CreateAssessment, roleType can only be PROCESS_OWNER. In UpdateSettings, roleType can only be PROCESS_OWNER. In BatchCreateDelegationByAssessment, roleType can only be RESOURCE_OWNER.
            Possible values include:
            • "PROCESS_OWNER"
            • "RESOURCE_OWNER"
          • roleArn — (String)

            The Amazon Resource Name (ARN) of the IAM role.

        • kmsKey — (String)

          The KMS key details.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listAssessmentControlInsightsByControlDomain(params = {}, callback) ⇒ AWS.Request

Lists the latest analytics data for controls within a specific control domain and a specific active assessment.

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

Examples:

Calling the listAssessmentControlInsightsByControlDomain operation

var params = {
  assessmentId: 'STRING_VALUE', /* required */
  controlDomainId: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
auditmanager.listAssessmentControlInsightsByControlDomain(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • controlDomainId — (String)

      The unique identifier for the control domain.

    • assessmentId — (String)

      The unique identifier for the active assessment.

    • nextToken — (String)

      The pagination token that's used to fetch the next set of results.

    • maxResults — (Integer)

      Represents the maximum number of results on a page or for an API request call.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • controlInsightsByAssessment — (Array<map>)

        The assessment control analytics data that the ListAssessmentControlInsightsByControlDomain API returned.

        • name — (String)

          The name of the assessment control.

        • id — (String)

          The unique identifier for the assessment control.

        • evidenceInsights — (map)

          A breakdown of the compliance check status for the evidence that’s associated with the assessment control.

          • noncompliantEvidenceCount — (Integer)

            The number of compliance check evidence that Audit Manager classified as non-compliant. This includes evidence that was collected from Security Hub with a Fail ruling, or collected from Config with a Non-compliant ruling.

          • compliantEvidenceCount — (Integer)

            The number of compliance check evidence that Audit Manager classified as compliant. This includes evidence that was collected from Security Hub with a Pass ruling, or collected from Config with a Compliant ruling.

          • inconclusiveEvidenceCount — (Integer)

            The number of evidence that a compliance check ruling isn't available for. Evidence is inconclusive when the associated control uses Security Hub or Config as a data source but you didn't enable those services. This is also the case when a control uses a data source that doesn’t support compliance checks (for example, manual evidence, API calls, or CloudTrail).

            Note: If evidence has a compliance check status of not applicable in the console, it's classified as inconclusive in EvidenceInsights data.
        • controlSetName — (String)

          The name of the control set that the assessment control belongs to.

        • lastUpdated — (Date)

          The time when the assessment control insights were last updated.

      • nextToken — (String)

        The pagination token that's used to fetch the next set of results.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listAssessmentFrameworks(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listAssessmentFrameworks operation

var params = {
  frameworkType: Standard | Custom, /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
auditmanager.listAssessmentFrameworks(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • frameworkType — (String)

      The type of framework, such as a standard framework or a custom framework.

      Possible values include:
      • "Standard"
      • "Custom"
    • nextToken — (String)

      The pagination token that's used to fetch the next set of results.

    • maxResults — (Integer)

      Represents the maximum number of results on a page or for an API request call.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • frameworkMetadataList — (Array<map>)

        The list of metadata objects for the framework.

        • arn — (String)

          The Amazon Resource Name (ARN) of the framework.

        • id — (String)

          The unique identifier for the framework.

        • type — (String)

          The framework type, such as a standard framework or a custom framework.

          Possible values include:
          • "Standard"
          • "Custom"
        • name — (String)

          The name of the framework.

        • description — (String)

          The description of the framework.

        • logo — (String)

          The logo that's associated with the framework.

        • complianceType — (String)

          The compliance type that the new custom framework supports, such as CIS or HIPAA.

        • controlsCount — (Integer)

          The number of controls that are associated with the framework.

        • controlSetsCount — (Integer)

          The number of control sets that are associated with the framework.

        • createdAt — (Date)

          Specifies when the framework was created.

        • lastUpdatedAt — (Date)

          Specifies when the framework was most recently updated.

      • nextToken — (String)

        The pagination token that's used to fetch the next set of results.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listAssessmentFrameworkShareRequests(params = {}, callback) ⇒ AWS.Request

Returns a list of sent or received share requests for custom frameworks in Audit Manager.

Examples:

Calling the listAssessmentFrameworkShareRequests operation

var params = {
  requestType: SENT | RECEIVED, /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
auditmanager.listAssessmentFrameworkShareRequests(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • requestType — (String)

      Specifies whether the share request is a sent request or a received request.

      Possible values include:
      • "SENT"
      • "RECEIVED"
    • nextToken — (String)

      The pagination token that's used to fetch the next set of results.

    • maxResults — (Integer)

      Represents the maximum number of results on a page or for an API request call.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • assessmentFrameworkShareRequests — (Array<map>)

        The list of share requests that the ListAssessmentFrameworkShareRequests API returned.

        • id — (String)

          The unique identifier for the share request.

        • frameworkId — (String)

          The unique identifier for the shared custom framework.

        • frameworkName — (String)

          The name of the custom framework that the share request is for.

        • frameworkDescription — (String)

          The description of the shared custom framework.

        • status — (String)

          The status of the share request.

          Possible values include:
          • "ACTIVE"
          • "REPLICATING"
          • "SHARED"
          • "EXPIRING"
          • "FAILED"
          • "EXPIRED"
          • "DECLINED"
          • "REVOKED"
        • sourceAccount — (String)

          The Amazon Web Services account of the sender.

        • destinationAccount — (String)

          The Amazon Web Services account of the recipient.

        • destinationRegion — (String)

          The Amazon Web Services Region of the recipient.

        • expirationTime — (Date)

          The time when the share request expires.

        • creationTime — (Date)

          The time when the share request was created.

        • lastUpdated — (Date)

          Specifies when the share request was last updated.

        • comment — (String)

          An optional comment from the sender about the share request.

        • standardControlsCount — (Integer)

          The number of standard controls that are part of the shared custom framework.

        • customControlsCount — (Integer)

          The number of custom controls that are part of the shared custom framework.

        • complianceType — (String)

          The compliance type that the shared custom framework supports, such as CIS or HIPAA.

      • nextToken — (String)

        The pagination token that's used to fetch the next set of results.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listAssessmentReports(params = {}, callback) ⇒ AWS.Request

Returns a list of assessment reports created in Audit Manager.

Service Reference:

Examples:

Calling the listAssessmentReports operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
auditmanager.listAssessmentReports(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • nextToken — (String)

      The pagination token that's used to fetch the next set of results.

    • maxResults — (Integer)

      Represents the maximum number of results on a page or for an API request call.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • assessmentReports — (Array<map>)

        The list of assessment reports that the ListAssessmentReports API returned.

        • id — (String)

          The unique identifier for the assessment report.

        • name — (String)

          The name of the assessment report.

        • description — (String)

          The description of the assessment report.

        • assessmentId — (String)

          The unique identifier for the associated assessment.

        • assessmentName — (String)

          The name of the associated assessment.

        • author — (String)

          The name of the user who created the assessment report.

        • status — (String)

          The current status of the assessment report.

          Possible values include:
          • "COMPLETE"
          • "IN_PROGRESS"
          • "FAILED"
        • creationTime — (Date)

          Specifies when the assessment report was created.

      • nextToken — (String)

        The pagination token that's used to fetch the next set of results.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listAssessments(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listAssessments operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  status: ACTIVE | INACTIVE
};
auditmanager.listAssessments(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • status — (String)

      The current status of the assessment.

      Possible values include:
      • "ACTIVE"
      • "INACTIVE"
    • nextToken — (String)

      The pagination token that's used to fetch the next set of results.

    • maxResults — (Integer)

      Represents the maximum number of results on a page or for an API request call.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • assessmentMetadata — (Array<map>)

        The metadata that's associated with the assessment.

        • name — (String)

          The name of the assessment.

        • id — (String)

          The unique identifier for the assessment.

        • complianceType — (String)

          The name of the compliance standard that's related to the assessment, such as PCI-DSS.

        • status — (String)

          The current status of the assessment.

          Possible values include:
          • "ACTIVE"
          • "INACTIVE"
        • roles — (Array<map>)

          The roles that are associated with the assessment.

          • roleType — (String)

            The type of customer persona.

            Note: In CreateAssessment, roleType can only be PROCESS_OWNER. In UpdateSettings, roleType can only be PROCESS_OWNER. In BatchCreateDelegationByAssessment, roleType can only be RESOURCE_OWNER.
            Possible values include:
            • "PROCESS_OWNER"
            • "RESOURCE_OWNER"
          • roleArn — (String)

            The Amazon Resource Name (ARN) of the IAM role.

        • delegations — (Array<map>)

          The delegations that are associated with the assessment.

          • id — (String)

            The unique identifier for the delegation.

          • assessmentName — (String)

            The name of the assessment that's associated with the delegation.

          • assessmentId — (String)

            The identifier for the assessment that's associated with the delegation.

          • status — (String)

            The status of the delegation.

            Possible values include:
            • "IN_PROGRESS"
            • "UNDER_REVIEW"
            • "COMPLETE"
          • roleArn — (String)

            The Amazon Resource Name (ARN) of the IAM role.

          • roleType — (String)

            The type of customer persona.

            Note: In CreateAssessment, roleType can only be PROCESS_OWNER. In UpdateSettings, roleType can only be PROCESS_OWNER. In BatchCreateDelegationByAssessment, roleType can only be RESOURCE_OWNER.
            Possible values include:
            • "PROCESS_OWNER"
            • "RESOURCE_OWNER"
          • creationTime — (Date)

            Specifies when the delegation was created.

          • lastUpdated — (Date)

            Specifies when the delegation was last updated.

          • controlSetId — (String)

            The identifier for the control set that's associated with the delegation.

          • comment — (String)

            The comment that's related to the delegation.

          • createdBy — (String)

            The IAM user or role that created the delegation.

        • creationTime — (Date)

          Specifies when the assessment was created.

        • lastUpdated — (Date)

          The time of the most recent update.

      • nextToken — (String)

        The pagination token that's used to fetch the next set of results.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listControlDomainInsights(params = {}, callback) ⇒ AWS.Request

Lists the latest analytics data for control domains across all of your active assessments.

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

Service Reference:

Examples:

Calling the listControlDomainInsights operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
auditmanager.listControlDomainInsights(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • nextToken — (String)

      The pagination token that's used to fetch the next set of results.

    • maxResults — (Integer)

      Represents the maximum number of results on a page or for an API request call.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • controlDomainInsights — (Array<map>)

        The control domain analytics data that the ListControlDomainInsights API returned.

        • name — (String)

          The name of the control domain.

        • id — (String)

          The unique identifier for the control domain.

        • controlsCountByNoncompliantEvidence — (Integer)

          The number of controls in the control domain that collected non-compliant evidence on the lastUpdated date.

        • totalControlsCount — (Integer)

          The total number of controls in the control domain.

        • evidenceInsights — (map)

          A breakdown of the compliance check status for the evidence that’s associated with the control domain.

          • noncompliantEvidenceCount — (Integer)

            The number of compliance check evidence that Audit Manager classified as non-compliant. This includes evidence that was collected from Security Hub with a Fail ruling, or collected from Config with a Non-compliant ruling.

          • compliantEvidenceCount — (Integer)

            The number of compliance check evidence that Audit Manager classified as compliant. This includes evidence that was collected from Security Hub with a Pass ruling, or collected from Config with a Compliant ruling.

          • inconclusiveEvidenceCount — (Integer)

            The number of evidence that a compliance check ruling isn't available for. Evidence is inconclusive when the associated control uses Security Hub or Config as a data source but you didn't enable those services. This is also the case when a control uses a data source that doesn’t support compliance checks (for example, manual evidence, API calls, or CloudTrail).

            Note: If evidence has a compliance check status of not applicable in the console, it's classified as inconclusive in EvidenceInsights data.
        • lastUpdated — (Date)

          The time when the control domain insights were last updated.

      • nextToken — (String)

        The pagination token that's used to fetch the next set of results.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listControlDomainInsightsByAssessment(params = {}, callback) ⇒ AWS.Request

Lists analytics data for control domains within a specified active assessment.

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

Examples:

Calling the listControlDomainInsightsByAssessment operation

var params = {
  assessmentId: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
auditmanager.listControlDomainInsightsByAssessment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • assessmentId — (String)

      The unique identifier for the active assessment.

    • nextToken — (String)

      The pagination token that's used to fetch the next set of results.

    • maxResults — (Integer)

      Represents the maximum number of results on a page or for an API request call.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • controlDomainInsights — (Array<map>)

        The control domain analytics data that the ListControlDomainInsightsByAssessment API returned.

        • name — (String)

          The name of the control domain.

        • id — (String)

          The unique identifier for the control domain.

        • controlsCountByNoncompliantEvidence — (Integer)

          The number of controls in the control domain that collected non-compliant evidence on the lastUpdated date.

        • totalControlsCount — (Integer)

          The total number of controls in the control domain.

        • evidenceInsights — (map)

          A breakdown of the compliance check status for the evidence that’s associated with the control domain.

          • noncompliantEvidenceCount — (Integer)

            The number of compliance check evidence that Audit Manager classified as non-compliant. This includes evidence that was collected from Security Hub with a Fail ruling, or collected from Config with a Non-compliant ruling.

          • compliantEvidenceCount — (Integer)

            The number of compliance check evidence that Audit Manager classified as compliant. This includes evidence that was collected from Security Hub with a Pass ruling, or collected from Config with a Compliant ruling.

          • inconclusiveEvidenceCount — (Integer)

            The number of evidence that a compliance check ruling isn't available for. Evidence is inconclusive when the associated control uses Security Hub or Config as a data source but you didn't enable those services. This is also the case when a control uses a data source that doesn’t support compliance checks (for example, manual evidence, API calls, or CloudTrail).

            Note: If evidence has a compliance check status of not applicable in the console, it's classified as inconclusive in EvidenceInsights data.
        • lastUpdated — (Date)

          The time when the control domain insights were last updated.

      • nextToken — (String)

        The pagination token that's used to fetch the next set of results.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listControlInsightsByControlDomain(params = {}, callback) ⇒ AWS.Request

Lists the latest analytics data for controls within a specific control domain across all active assessments.

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

Examples:

Calling the listControlInsightsByControlDomain operation

var params = {
  controlDomainId: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
auditmanager.listControlInsightsByControlDomain(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • controlDomainId — (String)

      The unique identifier for the control domain.

    • nextToken — (String)

      The pagination token that's used to fetch the next set of results.

    • maxResults — (Integer)

      Represents the maximum number of results on a page or for an API request call.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • controlInsightsMetadata — (Array<map>)

        The control analytics data that the ListControlInsightsByControlDomain API returned.

        • name — (String)

          The name of the control.

        • id — (String)

          The unique identifier for the control.

        • evidenceInsights — (map)

          A breakdown of the compliance check status for the evidence that’s associated with the control.

          • noncompliantEvidenceCount — (Integer)

            The number of compliance check evidence that Audit Manager classified as non-compliant. This includes evidence that was collected from Security Hub with a Fail ruling, or collected from Config with a Non-compliant ruling.

          • compliantEvidenceCount — (Integer)

            The number of compliance check evidence that Audit Manager classified as compliant. This includes evidence that was collected from Security Hub with a Pass ruling, or collected from Config with a Compliant ruling.

          • inconclusiveEvidenceCount — (Integer)

            The number of evidence that a compliance check ruling isn't available for. Evidence is inconclusive when the associated control uses Security Hub or Config as a data source but you didn't enable those services. This is also the case when a control uses a data source that doesn’t support compliance checks (for example, manual evidence, API calls, or CloudTrail).

            Note: If evidence has a compliance check status of not applicable in the console, it's classified as inconclusive in EvidenceInsights data.
        • lastUpdated — (Date)

          The time when the control insights were last updated.

      • nextToken — (String)

        The pagination token that's used to fetch the next set of results.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listControls(params = {}, callback) ⇒ AWS.Request

Returns a list of controls from Audit Manager.

Service Reference:

Examples:

Calling the listControls operation

var params = {
  controlType: Standard | Custom, /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
auditmanager.listControls(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • controlType — (String)

      The type of control, such as a standard control or a custom control.

      Possible values include:
      • "Standard"
      • "Custom"
    • nextToken — (String)

      The pagination token that's used to fetch the next set of results.

    • maxResults — (Integer)

      Represents the maximum number of results on a page or for an API request call.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • controlMetadataList — (Array<map>)

        The list of control metadata objects that the ListControls API returned.

        • arn — (String)

          The Amazon Resource Name (ARN) of the control.

        • id — (String)

          The unique identifier for the control.

        • name — (String)

          The name of the control.

        • controlSources — (String)

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

        • createdAt — (Date)

          Specifies when the control was created.

        • lastUpdatedAt — (Date)

          Specifies when the control was most recently updated.

      • nextToken — (String)

        The pagination token that's used to fetch the next set of results.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listKeywordsForDataSource(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listKeywordsForDataSource operation

var params = {
  source: AWS_Cloudtrail | AWS_Config | AWS_Security_Hub | AWS_API_Call | MANUAL, /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
auditmanager.listKeywordsForDataSource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • source — (String)

      The control mapping data source that the keywords apply to.

      Possible values include:
      • "AWS_Cloudtrail"
      • "AWS_Config"
      • "AWS_Security_Hub"
      • "AWS_API_Call"
      • "MANUAL"
    • nextToken — (String)

      The pagination token that's used to fetch the next set of results.

    • maxResults — (Integer)

      Represents the maximum number of results on a page or for an API request call.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • keywords — (Array<String>)

        The list of keywords for the event mapping source.

      • nextToken — (String)

        The pagination token that's used to fetch the next set of results.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listNotifications(params = {}, callback) ⇒ AWS.Request

Returns a list of all Audit Manager notifications.

Service Reference:

Examples:

Calling the listNotifications operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
auditmanager.listNotifications(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • nextToken — (String)

      The pagination token that's used to fetch the next set of results.

    • maxResults — (Integer)

      Represents the maximum number of results on a page or for an API request call.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • notifications — (Array<map>)

        The returned list of notifications.

        • id — (String)

          The unique identifier for the notification.

        • assessmentId — (String)

          The identifier for the assessment.

        • assessmentName — (String)

          The name of the related assessment.

        • controlSetId — (String)

          The identifier for the control set.

        • controlSetName — (String)

          Specifies the name of the control set that the notification is about.

        • description — (String)

          The description of the notification.

        • eventTime — (Date)

          The time when the notification was sent.

        • source — (String)

          The sender of the notification.

      • nextToken — (String)

        The pagination token that's used to fetch the next set of results.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
auditmanager.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • resourceArn — (String)

      The Amazon Resource Name (ARN) of the resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • tags — (map<String>)

        The list of tags that the ListTagsForResource API returned.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

registerAccount(params = {}, callback) ⇒ AWS.Request

Enables Audit Manager for the specified Amazon Web Services account.

Service Reference:

Examples:

Calling the registerAccount operation

var params = {
  delegatedAdminAccount: 'STRING_VALUE',
  kmsKey: 'STRING_VALUE'
};
auditmanager.registerAccount(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • kmsKey — (String)

      The KMS key details.

    • delegatedAdminAccount — (String)

      The delegated administrator account for Audit Manager.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • status — (String)

        The status of the account registration request.

        Possible values include:
        • "ACTIVE"
        • "INACTIVE"
        • "PENDING_ACTIVATION"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

registerOrganizationAdminAccount(params = {}, callback) ⇒ AWS.Request

Enables an Amazon Web Services account within the organization as the delegated administrator for Audit Manager.

Examples:

Calling the registerOrganizationAdminAccount operation

var params = {
  adminAccountId: 'STRING_VALUE' /* required */
};
auditmanager.registerOrganizationAdminAccount(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • adminAccountId — (String)

      The identifier for the delegated administrator account.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • adminAccountId — (String)

        The identifier for the delegated administrator account.

      • organizationId — (String)

        The identifier for the organization.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

startAssessmentFrameworkShare(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the startAssessmentFrameworkShare operation

var params = {
  destinationAccount: 'STRING_VALUE', /* required */
  destinationRegion: 'STRING_VALUE', /* required */
  frameworkId: 'STRING_VALUE', /* required */
  comment: 'STRING_VALUE'
};
auditmanager.startAssessmentFrameworkShare(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • frameworkId — (String)

      The unique identifier for the custom framework to be shared.

    • destinationAccount — (String)

      The Amazon Web Services account of the recipient.

    • destinationRegion — (String)

      The Amazon Web Services Region of the recipient.

    • comment — (String)

      An optional comment from the sender about the share request.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • assessmentFrameworkShareRequest — (map)

        The share request that's created by the StartAssessmentFrameworkShare API.

        • id — (String)

          The unique identifier for the share request.

        • frameworkId — (String)

          The unique identifier for the shared custom framework.

        • frameworkName — (String)

          The name of the custom framework that the share request is for.

        • frameworkDescription — (String)

          The description of the shared custom framework.

        • status — (String)

          The status of the share request.

          Possible values include:
          • "ACTIVE"
          • "REPLICATING"
          • "SHARED"
          • "EXPIRING"
          • "FAILED"
          • "EXPIRED"
          • "DECLINED"
          • "REVOKED"
        • sourceAccount — (String)

          The Amazon Web Services account of the sender.

        • destinationAccount — (String)

          The Amazon Web Services account of the recipient.

        • destinationRegion — (String)

          The Amazon Web Services Region of the recipient.

        • expirationTime — (Date)

          The time when the share request expires.

        • creationTime — (Date)

          The time when the share request was created.

        • lastUpdated — (Date)

          Specifies when the share request was last updated.

        • comment — (String)

          An optional comment from the sender about the share request.

        • standardControlsCount — (Integer)

          The number of standard controls that are part of the shared custom framework.

        • customControlsCount — (Integer)

          The number of custom controls that are part of the shared custom framework.

        • complianceType — (String)

          The compliance type that the shared custom framework supports, such as CIS or HIPAA.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

tagResource(params = {}, callback) ⇒ AWS.Request

Tags the specified resource in Audit Manager.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
auditmanager.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • resourceArn — (String)

      The Amazon Resource Name (ARN) of the resource.

    • tags — (map<String>)

      The tags that are associated with the resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

untagResource(params = {}, callback) ⇒ AWS.Request

Removes a tag from a resource in Audit Manager.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
auditmanager.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • resourceArn — (String)

      The Amazon Resource Name (ARN) of the specified resource.

    • tagKeys — (Array<String>)

      The name or key of the tag.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateAssessment(params = {}, callback) ⇒ AWS.Request

Edits an Audit Manager assessment.

Service Reference:

Examples:

Calling the updateAssessment operation

var params = {
  assessmentId: 'STRING_VALUE', /* required */
  scope: { /* required */
    awsAccounts: [
      {
        emailAddress: 'STRING_VALUE',
        id: 'STRING_VALUE',
        name: 'STRING_VALUE'
      },
      /* more items */
    ],
    awsServices: [
      {
        serviceName: 'STRING_VALUE'
      },
      /* more items */
    ]
  },
  assessmentDescription: 'STRING_VALUE',
  assessmentName: 'STRING_VALUE',
  assessmentReportsDestination: {
    destination: 'STRING_VALUE',
    destinationType: S3
  },
  roles: [
    {
      roleArn: 'STRING_VALUE',
      roleType: PROCESS_OWNER | RESOURCE_OWNER
    },
    /* more items */
  ]
};
auditmanager.updateAssessment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • assessmentId — (String)

      The unique identifier for the assessment.

    • assessmentName — (String)

      The name of the assessment to be updated.

    • assessmentDescription — (String)

      The description of the assessment.

    • scope — (map)

      The scope of the assessment.

      • awsAccounts — (Array<map>)

        The Amazon Web Services accounts that are included in the scope of the assessment.

        • id — (String)

          The identifier for the Amazon Web Services account.

        • emailAddress — (String)

          The email address that's associated with the Amazon Web Services account.

        • name — (String)

          The name of the Amazon Web Services account.

      • awsServices — (Array<map>)

        The Amazon Web Services services that are included in the scope of the assessment.

        • serviceName — (String)

          The name of the Amazon Web Service.

    • assessmentReportsDestination — (map)

      The assessment report storage destination for the assessment that's being updated.

      • destinationType — (String)

        The destination type, such as Amazon S3.

        Possible values include:
        • "S3"
      • destination — (String)

        The destination of the assessment report.

    • roles — (Array<map>)

      The list of roles for the assessment.

      • roleType — (String)

        The type of customer persona.

        Note: In CreateAssessment, roleType can only be PROCESS_OWNER. In UpdateSettings, roleType can only be PROCESS_OWNER. In BatchCreateDelegationByAssessment, roleType can only be RESOURCE_OWNER.
        Possible values include:
        • "PROCESS_OWNER"
        • "RESOURCE_OWNER"
      • roleArn — (String)

        The Amazon Resource Name (ARN) of the IAM role.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • assessment — (map)

        The response object for the UpdateAssessmentRequest API. This is the name of the updated assessment.

        • arn — (String)

          The Amazon Resource Name (ARN) of the assessment.

        • awsAccount — (map)

          The Amazon Web Services account that's associated with the assessment.

          • id — (String)

            The identifier for the Amazon Web Services account.

          • emailAddress — (String)

            The email address that's associated with the Amazon Web Services account.

          • name — (String)

            The name of the Amazon Web Services account.

        • metadata — (map)

          The metadata for the assessment.

          • name — (String)

            The name of the assessment.

          • id — (String)

            The unique identifier for the assessment.

          • description — (String)

            The description of the assessment.

          • complianceType — (String)

            The name of the compliance standard that's related to the assessment, such as PCI-DSS.

          • status — (String)

            The overall status of the assessment.

            Possible values include:
            • "ACTIVE"
            • "INACTIVE"
          • assessmentReportsDestination — (map)

            The destination that evidence reports are stored in for the assessment.

            • destinationType — (String)

              The destination type, such as Amazon S3.

              Possible values include:
              • "S3"
            • destination — (String)

              The destination of the assessment report.

          • scope — (map)

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

            • awsAccounts — (Array<map>)

              The Amazon Web Services accounts that are included in the scope of the assessment.

              • id — (String)

                The identifier for the Amazon Web Services account.

              • emailAddress — (String)

                The email address that's associated with the Amazon Web Services account.

              • name — (String)

                The name of the Amazon Web Services account.

            • awsServices — (Array<map>)

              The Amazon Web Services services that are included in the scope of the assessment.

              • serviceName — (String)

                The name of the Amazon Web Service.

          • roles — (Array<map>)

            The roles that are associated with the assessment.

            • roleType — (String)

              The type of customer persona.

              Note: In CreateAssessment, roleType can only be PROCESS_OWNER. In UpdateSettings, roleType can only be PROCESS_OWNER. In BatchCreateDelegationByAssessment, roleType can only be RESOURCE_OWNER.
              Possible values include:
              • "PROCESS_OWNER"
              • "RESOURCE_OWNER"
            • roleArn — (String)

              The Amazon Resource Name (ARN) of the IAM role.

          • delegations — (Array<map>)

            The delegations that are associated with the assessment.

            • id — (String)

              The unique identifier for the delegation.

            • assessmentName — (String)

              The name of the assessment that's associated with the delegation.

            • assessmentId — (String)

              The identifier for the assessment that's associated with the delegation.

            • status — (String)

              The status of the delegation.

              Possible values include:
              • "IN_PROGRESS"
              • "UNDER_REVIEW"
              • "COMPLETE"
            • roleArn — (String)

              The Amazon Resource Name (ARN) of the IAM role.

            • roleType — (String)

              The type of customer persona.

              Note: In CreateAssessment, roleType can only be PROCESS_OWNER. In UpdateSettings, roleType can only be PROCESS_OWNER. In BatchCreateDelegationByAssessment, roleType can only be RESOURCE_OWNER.
              Possible values include:
              • "PROCESS_OWNER"
              • "RESOURCE_OWNER"
            • creationTime — (Date)

              Specifies when the delegation was created.

            • lastUpdated — (Date)

              Specifies when the delegation was last updated.

            • controlSetId — (String)

              The identifier for the control set that's associated with the delegation.

            • comment — (String)

              The comment that's related to the delegation.

            • createdBy — (String)

              The IAM user or role that created the delegation.

          • creationTime — (Date)

            Specifies when the assessment was created.

          • lastUpdated — (Date)

            The time of the most recent update.

        • framework — (map)

          The framework that the assessment was created from.

          • id — (String)

            The unique identifier for the framework.

          • arn — (String)

            The Amazon Resource Name (ARN) of the framework.

          • metadata — (map)

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

            • name — (String)

              The name of the framework.

            • description — (String)

              The description of the framework.

            • logo — (String)

              The logo that's associated with the framework.

            • complianceType — (String)

              The compliance standard that's associated with the framework. For example, this could be PCI DSS or HIPAA.

          • controlSets — (Array<map>)

            The control sets that are associated with the framework.

            • id — (String)

              The identifier of the control set in the assessment. This is the control set name in a plain string format.

            • description — (String)

              The description for the control set.

            • status — (String)

              Specifies the current status of the control set.

              Possible values include:
              • "ACTIVE"
              • "UNDER_REVIEW"
              • "REVIEWED"
            • roles — (Array<map>)

              The roles that are associated with the control set.

              • roleType — (String)

                The type of customer persona.

                Note: In CreateAssessment, roleType can only be PROCESS_OWNER. In UpdateSettings, roleType can only be PROCESS_OWNER. In BatchCreateDelegationByAssessment, roleType can only be RESOURCE_OWNER.
                Possible values include:
                • "PROCESS_OWNER"
                • "RESOURCE_OWNER"
              • roleArn — (String)

                The Amazon Resource Name (ARN) of the IAM role.

            • controls — (Array<map>)

              The list of controls that's contained with the control set.

              • id — (String)

                The identifier for the control.

              • name — (String)

                The name of the control.

              • description — (String)

                The description of the control.

              • status — (String)

                The status of the control.

                Possible values include:
                • "UNDER_REVIEW"
                • "REVIEWED"
                • "INACTIVE"
              • response — (String)

                The response of the control.

                Possible values include:
                • "MANUAL"
                • "AUTOMATE"
                • "DEFER"
                • "IGNORE"
              • comments — (Array<map>)

                The list of comments that's attached to the control.

                • authorName — (String)

                  The name of the user who authored the comment.

                • commentBody — (String)

                  The body text of a control comment.

                • postedDate — (Date)

                  The time when the comment was posted.

              • evidenceSources — (Array<String>)

                The list of data sources for the evidence.

              • evidenceCount — (Integer)

                The amount of evidence that's generated for the control.

              • assessmentReportEvidenceCount — (Integer)

                The amount of evidence in the assessment report.

            • delegations — (Array<map>)

              The delegations that are associated with the control set.

              • id — (String)

                The unique identifier for the delegation.

              • assessmentName — (String)

                The name of the assessment that's associated with the delegation.

              • assessmentId — (String)

                The identifier for the assessment that's associated with the delegation.

              • status — (String)

                The status of the delegation.

                Possible values include:
                • "IN_PROGRESS"
                • "UNDER_REVIEW"
                • "COMPLETE"
              • roleArn — (String)

                The Amazon Resource Name (ARN) of the IAM role.

              • roleType — (String)

                The type of customer persona.

                Note: In CreateAssessment, roleType can only be PROCESS_OWNER. In UpdateSettings, roleType can only be PROCESS_OWNER. In BatchCreateDelegationByAssessment, roleType can only be RESOURCE_OWNER.
                Possible values include:
                • "PROCESS_OWNER"
                • "RESOURCE_OWNER"
              • creationTime — (Date)

                Specifies when the delegation was created.

              • lastUpdated — (Date)

                Specifies when the delegation was last updated.

              • controlSetId — (String)

                The identifier for the control set that's associated with the delegation.

              • comment — (String)

                The comment that's related to the delegation.

              • createdBy — (String)

                The IAM user or role that created the delegation.

            • systemEvidenceCount — (Integer)

              The total number of evidence objects that are retrieved automatically for the control set.

            • manualEvidenceCount — (Integer)

              The total number of evidence objects that are uploaded manually to the control set.

        • tags — (map<String>)

          The tags that are associated with the assessment.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateAssessmentControl(params = {}, callback) ⇒ AWS.Request

Updates a control within an assessment in Audit Manager.

Service Reference:

Examples:

Calling the updateAssessmentControl operation

var params = {
  assessmentId: 'STRING_VALUE', /* required */
  controlId: 'STRING_VALUE', /* required */
  controlSetId: 'STRING_VALUE', /* required */
  commentBody: 'STRING_VALUE',
  controlStatus: UNDER_REVIEW | REVIEWED | INACTIVE
};
auditmanager.updateAssessmentControl(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • assessmentId — (String)

      The unique identifier for the assessment.

    • controlSetId — (String)

      The unique identifier for the control set.

    • controlId — (String)

      The unique identifier for the control.

    • controlStatus — (String)

      The status of the control.

      Possible values include:
      • "UNDER_REVIEW"
      • "REVIEWED"
      • "INACTIVE"
    • commentBody — (String)

      The comment body text for the control.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • control — (map)

        The name of the updated control set that the UpdateAssessmentControl API returned.

        • id — (String)

          The identifier for the control.

        • name — (String)

          The name of the control.

        • description — (String)

          The description of the control.

        • status — (String)

          The status of the control.

          Possible values include:
          • "UNDER_REVIEW"
          • "REVIEWED"
          • "INACTIVE"
        • response — (String)

          The response of the control.

          Possible values include:
          • "MANUAL"
          • "AUTOMATE"
          • "DEFER"
          • "IGNORE"
        • comments — (Array<map>)

          The list of comments that's attached to the control.

          • authorName — (String)

            The name of the user who authored the comment.

          • commentBody — (String)

            The body text of a control comment.

          • postedDate — (Date)

            The time when the comment was posted.

        • evidenceSources — (Array<String>)

          The list of data sources for the evidence.

        • evidenceCount — (Integer)

          The amount of evidence that's generated for the control.

        • assessmentReportEvidenceCount — (Integer)

          The amount of evidence in the assessment report.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateAssessmentControlSetStatus(params = {}, callback) ⇒ AWS.Request

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

Examples:

Calling the updateAssessmentControlSetStatus operation

var params = {
  assessmentId: 'STRING_VALUE', /* required */
  comment: 'STRING_VALUE', /* required */
  controlSetId: 'STRING_VALUE', /* required */
  status: ACTIVE | UNDER_REVIEW | REVIEWED /* required */
};
auditmanager.updateAssessmentControlSetStatus(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • assessmentId — (String)

      The unique identifier for the assessment.

    • controlSetId — (String)

      The unique identifier for the control set.

    • status — (String)

      The status of the control set that's being updated.

      Possible values include:
      • "ACTIVE"
      • "UNDER_REVIEW"
      • "REVIEWED"
    • comment — (String)

      The comment that's related to the status update.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • controlSet — (map)

        The name of the updated control set that the UpdateAssessmentControlSetStatus API returned.

        • id — (String)

          The identifier of the control set in the assessment. This is the control set name in a plain string format.

        • description — (String)

          The description for the control set.

        • status — (String)

          Specifies the current status of the control set.

          Possible values include:
          • "ACTIVE"
          • "UNDER_REVIEW"
          • "REVIEWED"
        • roles — (Array<map>)

          The roles that are associated with the control set.

          • roleType — (String)

            The type of customer persona.

            Note: In CreateAssessment, roleType can only be PROCESS_OWNER. In UpdateSettings, roleType can only be PROCESS_OWNER. In BatchCreateDelegationByAssessment, roleType can only be RESOURCE_OWNER.
            Possible values include:
            • "PROCESS_OWNER"
            • "RESOURCE_OWNER"
          • roleArn — (String)

            The Amazon Resource Name (ARN) of the IAM role.

        • controls — (Array<map>)

          The list of controls that's contained with the control set.

          • id — (String)

            The identifier for the control.

          • name — (String)

            The name of the control.

          • description — (String)

            The description of the control.

          • status — (String)

            The status of the control.

            Possible values include:
            • "UNDER_REVIEW"
            • "REVIEWED"
            • "INACTIVE"
          • response — (String)

            The response of the control.

            Possible values include:
            • "MANUAL"
            • "AUTOMATE"
            • "DEFER"
            • "IGNORE"
          • comments — (Array<map>)

            The list of comments that's attached to the control.

            • authorName — (String)

              The name of the user who authored the comment.

            • commentBody — (String)

              The body text of a control comment.

            • postedDate — (Date)

              The time when the comment was posted.

          • evidenceSources — (Array<String>)

            The list of data sources for the evidence.

          • evidenceCount — (Integer)

            The amount of evidence that's generated for the control.

          • assessmentReportEvidenceCount — (Integer)

            The amount of evidence in the assessment report.

        • delegations — (Array<map>)

          The delegations that are associated with the control set.

          • id — (String)

            The unique identifier for the delegation.

          • assessmentName — (String)

            The name of the assessment that's associated with the delegation.

          • assessmentId — (String)

            The identifier for the assessment that's associated with the delegation.

          • status — (String)

            The status of the delegation.

            Possible values include:
            • "IN_PROGRESS"
            • "UNDER_REVIEW"
            • "COMPLETE"
          • roleArn — (String)

            The Amazon Resource Name (ARN) of the IAM role.

          • roleType — (String)

            The type of customer persona.

            Note: In CreateAssessment, roleType can only be PROCESS_OWNER. In UpdateSettings, roleType can only be PROCESS_OWNER. In BatchCreateDelegationByAssessment, roleType can only be RESOURCE_OWNER.
            Possible values include:
            • "PROCESS_OWNER"
            • "RESOURCE_OWNER"
          • creationTime — (Date)

            Specifies when the delegation was created.

          • lastUpdated — (Date)

            Specifies when the delegation was last updated.

          • controlSetId — (String)

            The identifier for the control set that's associated with the delegation.

          • comment — (String)

            The comment that's related to the delegation.

          • createdBy — (String)

            The IAM user or role that created the delegation.

        • systemEvidenceCount — (Integer)

          The total number of evidence objects that are retrieved automatically for the control set.

        • manualEvidenceCount — (Integer)

          The total number of evidence objects that are uploaded manually to the control set.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateAssessmentFramework(params = {}, callback) ⇒ AWS.Request

Updates a custom framework in Audit Manager.

Service Reference:

Examples:

Calling the updateAssessmentFramework operation

var params = {
  controlSets: [ /* required */
    {
      name: 'STRING_VALUE', /* required */
      controls: [
        {
          id: 'STRING_VALUE'
        },
        /* more items */
      ],
      id: 'STRING_VALUE'
    },
    /* more items */
  ],
  frameworkId: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  complianceType: 'STRING_VALUE',
  description: 'STRING_VALUE'
};
auditmanager.updateAssessmentFramework(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • frameworkId — (String)

      The unique identifier for the framework.

    • name — (String)

      The name of the framework to be updated.

    • description — (String)

      The description of the updated framework.

    • complianceType — (String)

      The compliance type that the new custom framework supports, such as CIS or HIPAA.

    • controlSets — (Array<map>)

      The control sets that are associated with the framework.

      • id — (String)

        The unique identifier for the control set.

      • namerequired — (String)

        The name of the control set.

      • controls — (Array<map>)

        The list of controls that are contained within the control set.

        • id — (String)

          The unique identifier of the control.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • framework — (map)

        The name of the framework.

        • arn — (String)

          The Amazon Resource Name (ARN) of the framework.

        • id — (String)

          The unique identifier for the framework.

        • name — (String)

          The name of the framework.

        • type — (String)

          The framework type, such as a custom framework or a standard framework.

          Possible values include:
          • "Standard"
          • "Custom"
        • complianceType — (String)

          The compliance type that the new custom framework supports, such as CIS or HIPAA.

        • description — (String)

          The description of the framework.

        • logo — (String)

          The logo that's associated with the framework.

        • controlSources — (String)

          The sources that Audit Manager collects evidence from for the control.

        • controlSets — (Array<map>)

          The control sets that are associated with the framework.

          • id — (String)

            The identifier of the control set in the assessment. This is the control set name in a plain string format.

          • name — (String)

            The name of the control set.

          • controls — (Array<map>)

            The list of controls within the control set.

            • arn — (String)

              The Amazon Resource Name (ARN) of the control.

            • id — (String)

              The unique identifier for the control.

            • type — (String)

              The type of control, such as a custom control or a standard control.

              Possible values include:
              • "Standard"
              • "Custom"
            • name — (String)

              The name of the control.

            • description — (String)

              The description of the control.

            • testingInformation — (String)

              The steps that you should follow to determine if the control has been satisfied.

            • actionPlanTitle — (String)

              The title of the action plan for remediating the control.

            • actionPlanInstructions — (String)

              The recommended actions to carry out if the control isn't fulfilled.

            • controlSources — (String)

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

            • controlMappingSources — (Array<map>)

              The data mapping sources for the control.

              • sourceId — (String)

                The unique identifier for the source.

              • sourceName — (String)

                The name of the source.

              • sourceDescription — (String)

                The description of the source.

              • sourceSetUpOption — (String)

                The setup option for the data source. This option reflects if the evidence collection is automated or manual.

                Possible values include:
                • "System_Controls_Mapping"
                • "Procedural_Controls_Mapping"
              • sourceType — (String)

                Specifies one of the five types of data sources for evidence collection.

                Possible values include:
                • "AWS_Cloudtrail"
                • "AWS_Config"
                • "AWS_Security_Hub"
                • "AWS_API_Call"
                • "MANUAL"
              • sourceKeyword — (map)

                The keyword to search for in CloudTrail logs, Config rules, Security Hub checks, and Amazon Web Services API names.

                • keywordInputType — (String)

                  The method of input for the keyword.

                  Possible values include:
                  • "SELECT_FROM_LIST"
                • keywordValue — (String)

                  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.

              • sourceFrequency — (String)

                The frequency of evidence collection for the control mapping source.

                Possible values include:
                • "DAILY"
                • "WEEKLY"
                • "MONTHLY"
              • troubleshootingText — (String)

                The instructions for troubleshooting the control.

            • createdAt — (Date)

              Specifies when the control was created.

            • lastUpdatedAt — (Date)

              Specifies when the control was most recently updated.

            • createdBy — (String)

              The IAM user or role that created the control.

            • lastUpdatedBy — (String)

              The IAM user or role that most recently updated the control.

            • tags — (map<String>)

              The tags associated with the control.

        • createdAt — (Date)

          Specifies when the framework was created.

        • lastUpdatedAt — (Date)

          Specifies when the framework was most recently updated.

        • createdBy — (String)

          The IAM user or role that created the framework.

        • lastUpdatedBy — (String)

          The IAM user or role that most recently updated the framework.

        • tags — (map<String>)

          The tags that are associated with the framework.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateAssessmentFrameworkShare(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the updateAssessmentFrameworkShare operation

var params = {
  action: ACCEPT | DECLINE | REVOKE, /* required */
  requestId: 'STRING_VALUE', /* required */
  requestType: SENT | RECEIVED /* required */
};
auditmanager.updateAssessmentFrameworkShare(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • requestId — (String)

      The unique identifier for the share request.

    • requestType — (String)

      Specifies whether the share request is a sent request or a received request.

      Possible values include:
      • "SENT"
      • "RECEIVED"
    • action — (String)

      Specifies the update action for the share request.

      Possible values include:
      • "ACCEPT"
      • "DECLINE"
      • "REVOKE"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • assessmentFrameworkShareRequest — (map)

        The updated share request that's returned by the UpdateAssessmentFrameworkShare operation.

        • id — (String)

          The unique identifier for the share request.

        • frameworkId — (String)

          The unique identifier for the shared custom framework.

        • frameworkName — (String)

          The name of the custom framework that the share request is for.

        • frameworkDescription — (String)

          The description of the shared custom framework.

        • status — (String)

          The status of the share request.

          Possible values include:
          • "ACTIVE"
          • "REPLICATING"
          • "SHARED"
          • "EXPIRING"
          • "FAILED"
          • "EXPIRED"
          • "DECLINED"
          • "REVOKED"
        • sourceAccount — (String)

          The Amazon Web Services account of the sender.

        • destinationAccount — (String)

          The Amazon Web Services account of the recipient.

        • destinationRegion — (String)

          The Amazon Web Services Region of the recipient.

        • expirationTime — (Date)

          The time when the share request expires.

        • creationTime — (Date)

          The time when the share request was created.

        • lastUpdated — (Date)

          Specifies when the share request was last updated.

        • comment — (String)

          An optional comment from the sender about the share request.

        • standardControlsCount — (Integer)

          The number of standard controls that are part of the shared custom framework.

        • customControlsCount — (Integer)

          The number of custom controls that are part of the shared custom framework.

        • complianceType — (String)

          The compliance type that the shared custom framework supports, such as CIS or HIPAA.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateAssessmentStatus(params = {}, callback) ⇒ AWS.Request

Updates the status of an assessment in Audit Manager.

Service Reference:

Examples:

Calling the updateAssessmentStatus operation

var params = {
  assessmentId: 'STRING_VALUE', /* required */
  status: ACTIVE | INACTIVE /* required */
};
auditmanager.updateAssessmentStatus(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • assessmentId — (String)

      The unique identifier for the assessment.

    • status — (String)

      The current status of the assessment.

      Possible values include:
      • "ACTIVE"
      • "INACTIVE"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • assessment — (map)

        The name of the updated assessment that the UpdateAssessmentStatus API returned.

        • arn — (String)

          The Amazon Resource Name (ARN) of the assessment.

        • awsAccount — (map)

          The Amazon Web Services account that's associated with the assessment.

          • id — (String)

            The identifier for the Amazon Web Services account.

          • emailAddress — (String)

            The email address that's associated with the Amazon Web Services account.

          • name — (String)

            The name of the Amazon Web Services account.

        • metadata — (map)

          The metadata for the assessment.

          • name — (String)

            The name of the assessment.

          • id — (String)

            The unique identifier for the assessment.

          • description — (String)

            The description of the assessment.

          • complianceType — (String)

            The name of the compliance standard that's related to the assessment, such as PCI-DSS.

          • status — (String)

            The overall status of the assessment.

            Possible values include:
            • "ACTIVE"
            • "INACTIVE"
          • assessmentReportsDestination — (map)

            The destination that evidence reports are stored in for the assessment.

            • destinationType — (String)

              The destination type, such as Amazon S3.

              Possible values include:
              • "S3"
            • destination — (String)

              The destination of the assessment report.

          • scope — (map)

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

            • awsAccounts — (Array<map>)

              The Amazon Web Services accounts that are included in the scope of the assessment.

              • id — (String)

                The identifier for the Amazon Web Services account.

              • emailAddress — (String)

                The email address that's associated with the Amazon Web Services account.

              • name — (String)

                The name of the Amazon Web Services account.

            • awsServices — (Array<map>)

              The Amazon Web Services services that are included in the scope of the assessment.

              • serviceName — (String)

                The name of the Amazon Web Service.

          • roles — (Array<map>)

            The roles that are associated with the assessment.

            • roleType — (String)

              The type of customer persona.

              Note: In CreateAssessment, roleType can only be PROCESS_OWNER. In UpdateSettings, roleType can only be PROCESS_OWNER. In BatchCreateDelegationByAssessment, roleType can only be RESOURCE_OWNER.
              Possible values include:
              • "PROCESS_OWNER"
              • "RESOURCE_OWNER"
            • roleArn — (String)

              The Amazon Resource Name (ARN) of the IAM role.

          • delegations — (Array<map>)

            The delegations that are associated with the assessment.

            • id — (String)

              The unique identifier for the delegation.

            • assessmentName — (String)

              The name of the assessment that's associated with the delegation.

            • assessmentId — (String)

              The identifier for the assessment that's associated with the delegation.

            • status — (String)

              The status of the delegation.

              Possible values include:
              • "IN_PROGRESS"
              • "UNDER_REVIEW"
              • "COMPLETE"
            • roleArn — (String)

              The Amazon Resource Name (ARN) of the IAM role.

            • roleType — (String)

              The type of customer persona.

              Note: In CreateAssessment, roleType can only be PROCESS_OWNER. In UpdateSettings, roleType can only be PROCESS_OWNER. In BatchCreateDelegationByAssessment, roleType can only be RESOURCE_OWNER.
              Possible values include:
              • "PROCESS_OWNER"
              • "RESOURCE_OWNER"
            • creationTime — (Date)

              Specifies when the delegation was created.

            • lastUpdated — (Date)

              Specifies when the delegation was last updated.

            • controlSetId — (String)

              The identifier for the control set that's associated with the delegation.

            • comment — (String)

              The comment that's related to the delegation.

            • createdBy — (String)

              The IAM user or role that created the delegation.

          • creationTime — (Date)

            Specifies when the assessment was created.

          • lastUpdated — (Date)

            The time of the most recent update.

        • framework — (map)

          The framework that the assessment was created from.

          • id — (String)

            The unique identifier for the framework.

          • arn — (String)

            The Amazon Resource Name (ARN) of the framework.

          • metadata — (map)

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

            • name — (String)

              The name of the framework.

            • description — (String)

              The description of the framework.

            • logo — (String)

              The logo that's associated with the framework.

            • complianceType — (String)

              The compliance standard that's associated with the framework. For example, this could be PCI DSS or HIPAA.

          • controlSets — (Array<map>)

            The control sets that are associated with the framework.

            • id — (String)

              The identifier of the control set in the assessment. This is the control set name in a plain string format.

            • description — (String)

              The description for the control set.

            • status — (String)

              Specifies the current status of the control set.

              Possible values include:
              • "ACTIVE"
              • "UNDER_REVIEW"
              • "REVIEWED"
            • roles — (Array<map>)

              The roles that are associated with the control set.

              • roleType — (String)

                The type of customer persona.

                Note: In CreateAssessment, roleType can only be PROCESS_OWNER. In UpdateSettings, roleType can only be PROCESS_OWNER. In BatchCreateDelegationByAssessment, roleType can only be RESOURCE_OWNER.
                Possible values include:
                • "PROCESS_OWNER"
                • "RESOURCE_OWNER"
              • roleArn — (String)

                The Amazon Resource Name (ARN) of the IAM role.

            • controls — (Array<map>)

              The list of controls that's contained with the control set.

              • id — (String)

                The identifier for the control.

              • name — (String)

                The name of the control.

              • description — (String)

                The description of the control.

              • status — (String)

                The status of the control.

                Possible values include:
                • "UNDER_REVIEW"
                • "REVIEWED"
                • "INACTIVE"
              • response — (String)

                The response of the control.

                Possible values include:
                • "MANUAL"
                • "AUTOMATE"
                • "DEFER"
                • "IGNORE"
              • comments — (Array<map>)

                The list of comments that's attached to the control.

                • authorName — (String)

                  The name of the user who authored the comment.

                • commentBody — (String)

                  The body text of a control comment.

                • postedDate — (Date)

                  The time when the comment was posted.

              • evidenceSources — (Array<String>)

                The list of data sources for the evidence.

              • evidenceCount — (Integer)

                The amount of evidence that's generated for the control.

              • assessmentReportEvidenceCount — (Integer)

                The amount of evidence in the assessment report.

            • delegations — (Array<map>)

              The delegations that are associated with the control set.

              • id — (String)

                The unique identifier for the delegation.

              • assessmentName — (String)

                The name of the assessment that's associated with the delegation.

              • assessmentId — (String)

                The identifier for the assessment that's associated with the delegation.

              • status — (String)

                The status of the delegation.

                Possible values include:
                • "IN_PROGRESS"
                • "UNDER_REVIEW"
                • "COMPLETE"
              • roleArn — (String)

                The Amazon Resource Name (ARN) of the IAM role.

              • roleType — (String)

                The type of customer persona.

                Note: In CreateAssessment, roleType can only be PROCESS_OWNER. In UpdateSettings, roleType can only be PROCESS_OWNER. In BatchCreateDelegationByAssessment, roleType can only be RESOURCE_OWNER.
                Possible values include:
                • "PROCESS_OWNER"
                • "RESOURCE_OWNER"
              • creationTime — (Date)

                Specifies when the delegation was created.

              • lastUpdated — (Date)

                Specifies when the delegation was last updated.

              • controlSetId — (String)

                The identifier for the control set that's associated with the delegation.

              • comment — (String)

                The comment that's related to the delegation.

              • createdBy — (String)

                The IAM user or role that created the delegation.

            • systemEvidenceCount — (Integer)

              The total number of evidence objects that are retrieved automatically for the control set.

            • manualEvidenceCount — (Integer)

              The total number of evidence objects that are uploaded manually to the control set.

        • tags — (map<String>)

          The tags that are associated with the assessment.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateControl(params = {}, callback) ⇒ AWS.Request

Updates a custom control in Audit Manager.

Service Reference:

Examples:

Calling the updateControl operation

var params = {
  controlId: 'STRING_VALUE', /* required */
  controlMappingSources: [ /* required */
    {
      sourceDescription: 'STRING_VALUE',
      sourceFrequency: DAILY | WEEKLY | MONTHLY,
      sourceId: 'STRING_VALUE',
      sourceKeyword: {
        keywordInputType: SELECT_FROM_LIST,
        keywordValue: 'STRING_VALUE'
      },
      sourceName: 'STRING_VALUE',
      sourceSetUpOption: System_Controls_Mapping | Procedural_Controls_Mapping,
      sourceType: AWS_Cloudtrail | AWS_Config | AWS_Security_Hub | AWS_API_Call | MANUAL,
      troubleshootingText: 'STRING_VALUE'
    },
    /* more items */
  ],
  name: 'STRING_VALUE', /* required */
  actionPlanInstructions: 'STRING_VALUE',
  actionPlanTitle: 'STRING_VALUE',
  description: 'STRING_VALUE',
  testingInformation: 'STRING_VALUE'
};
auditmanager.updateControl(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • controlId — (String)

      The identifier for the control.

    • name — (String)

      The name of the updated control.

    • description — (String)

      The optional description of the control.

    • testingInformation — (String)

      The steps that you should follow to determine if the control is met.

    • actionPlanTitle — (String)

      The title of the action plan for remediating the control.

    • actionPlanInstructions — (String)

      The recommended actions to carry out if the control isn't fulfilled.

    • controlMappingSources — (Array<map>)

      The data mapping sources for the control.

      • sourceId — (String)

        The unique identifier for the source.

      • sourceName — (String)

        The name of the source.

      • sourceDescription — (String)

        The description of the source.

      • sourceSetUpOption — (String)

        The setup option for the data source. This option reflects if the evidence collection is automated or manual.

        Possible values include:
        • "System_Controls_Mapping"
        • "Procedural_Controls_Mapping"
      • sourceType — (String)

        Specifies one of the five types of data sources for evidence collection.

        Possible values include:
        • "AWS_Cloudtrail"
        • "AWS_Config"
        • "AWS_Security_Hub"
        • "AWS_API_Call"
        • "MANUAL"
      • sourceKeyword — (map)

        The keyword to search for in CloudTrail logs, Config rules, Security Hub checks, and Amazon Web Services API names.

        • keywordInputType — (String)

          The method of input for the keyword.

          Possible values include:
          • "SELECT_FROM_LIST"
        • keywordValue — (String)

          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.

      • sourceFrequency — (String)

        The frequency of evidence collection for the control mapping source.

        Possible values include:
        • "DAILY"
        • "WEEKLY"
        • "MONTHLY"
      • troubleshootingText — (String)

        The instructions for troubleshooting the control.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • control — (map)

        The name of the updated control set that the UpdateControl API returned.

        • arn — (String)

          The Amazon Resource Name (ARN) of the control.

        • id — (String)

          The unique identifier for the control.

        • type — (String)

          The type of control, such as a custom control or a standard control.

          Possible values include:
          • "Standard"
          • "Custom"
        • name — (String)

          The name of the control.

        • description — (String)

          The description of the control.

        • testingInformation — (String)

          The steps that you should follow to determine if the control has been satisfied.

        • actionPlanTitle — (String)

          The title of the action plan for remediating the control.

        • actionPlanInstructions — (String)

          The recommended actions to carry out if the control isn't fulfilled.

        • controlSources — (String)

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

        • controlMappingSources — (Array<map>)

          The data mapping sources for the control.

          • sourceId — (String)

            The unique identifier for the source.

          • sourceName — (String)

            The name of the source.

          • sourceDescription — (String)

            The description of the source.

          • sourceSetUpOption — (String)

            The setup option for the data source. This option reflects if the evidence collection is automated or manual.

            Possible values include:
            • "System_Controls_Mapping"
            • "Procedural_Controls_Mapping"
          • sourceType — (String)

            Specifies one of the five types of data sources for evidence collection.

            Possible values include:
            • "AWS_Cloudtrail"
            • "AWS_Config"
            • "AWS_Security_Hub"
            • "AWS_API_Call"
            • "MANUAL"
          • sourceKeyword — (map)

            The keyword to search for in CloudTrail logs, Config rules, Security Hub checks, and Amazon Web Services API names.

            • keywordInputType — (String)

              The method of input for the keyword.

              Possible values include:
              • "SELECT_FROM_LIST"
            • keywordValue — (String)

              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.

          • sourceFrequency — (String)

            The frequency of evidence collection for the control mapping source.

            Possible values include:
            • "DAILY"
            • "WEEKLY"
            • "MONTHLY"
          • troubleshootingText — (String)

            The instructions for troubleshooting the control.

        • createdAt — (Date)

          Specifies when the control was created.

        • lastUpdatedAt — (Date)

          Specifies when the control was most recently updated.

        • createdBy — (String)

          The IAM user or role that created the control.

        • lastUpdatedBy — (String)

          The IAM user or role that most recently updated the control.

        • tags — (map<String>)

          The tags associated with the control.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateSettings(params = {}, callback) ⇒ AWS.Request

Updates Audit Manager settings for the current user account.

Service Reference:

Examples:

Calling the updateSettings operation

var params = {
  defaultAssessmentReportsDestination: {
    destination: 'STRING_VALUE',
    destinationType: S3
  },
  defaultProcessOwners: [
    {
      roleArn: 'STRING_VALUE',
      roleType: PROCESS_OWNER | RESOURCE_OWNER
    },
    /* more items */
  ],
  kmsKey: 'STRING_VALUE',
  snsTopic: 'STRING_VALUE'
};
auditmanager.updateSettings(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • snsTopic — (String)

      The Amazon Simple Notification Service (Amazon SNS) topic that Audit Manager sends notifications to.

    • defaultAssessmentReportsDestination — (map)

      The default storage destination for assessment reports.

      • destinationType — (String)

        The destination type, such as Amazon S3.

        Possible values include:
        • "S3"
      • destination — (String)

        The destination of the assessment report.

    • defaultProcessOwners — (Array<map>)

      A list of the default audit owners.

      • roleType — (String)

        The type of customer persona.

        Note: In CreateAssessment, roleType can only be PROCESS_OWNER. In UpdateSettings, roleType can only be PROCESS_OWNER. In BatchCreateDelegationByAssessment, roleType can only be RESOURCE_OWNER.
        Possible values include:
        • "PROCESS_OWNER"
        • "RESOURCE_OWNER"
      • roleArn — (String)

        The Amazon Resource Name (ARN) of the IAM role.

    • kmsKey — (String)

      The KMS key details.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • settings — (map)

        The current list of settings.

        • isAwsOrgEnabled — (Boolean)

          Specifies whether Organizations is enabled.

        • snsTopic — (String)

          The designated Amazon Simple Notification Service (Amazon SNS) topic.

        • defaultAssessmentReportsDestination — (map)

          The default storage destination for assessment reports.

          • destinationType — (String)

            The destination type, such as Amazon S3.

            Possible values include:
            • "S3"
          • destination — (String)

            The destination of the assessment report.

        • defaultProcessOwners — (Array<map>)

          The designated default audit owners.

          • roleType — (String)

            The type of customer persona.

            Note: In CreateAssessment, roleType can only be PROCESS_OWNER. In UpdateSettings, roleType can only be PROCESS_OWNER. In BatchCreateDelegationByAssessment, roleType can only be RESOURCE_OWNER.
            Possible values include:
            • "PROCESS_OWNER"
            • "RESOURCE_OWNER"
          • roleArn — (String)

            The Amazon Resource Name (ARN) of the IAM role.

        • kmsKey — (String)

          The KMS key details.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

validateAssessmentReportIntegrity(params = {}, callback) ⇒ AWS.Request

Validates the integrity of an assessment report in Audit Manager.

Examples:

Calling the validateAssessmentReportIntegrity operation

var params = {
  s3RelativePath: 'STRING_VALUE' /* required */
};
auditmanager.validateAssessmentReportIntegrity(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • s3RelativePath — (String)

      The relative path of the Amazon S3 bucket that the assessment report is stored in.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • signatureValid — (Boolean)

        Specifies whether the signature key is valid.

      • signatureAlgorithm — (String)

        The signature algorithm that's used to code sign the assessment report file.

      • signatureDateTime — (String)

        The date and time signature that specifies when the assessment report was created.

      • signatureKeyId — (String)

        The unique identifier for the validation signature key.

      • validationErrors — (Array<String>)

        Represents any errors that occurred when validating the assessment report.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.