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

Inherits:
AWS.Service show all
Identifier:
macie2
API Version:
2020-01-01
Defined in:
(unknown)

Overview

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

Service Description

Amazon Macie is a fully managed data security and data privacy service that uses machine learning and pattern matching to discover and protect your sensitive data in AWS. Macie automates the discovery of sensitive data, such as PII and intellectual property, to provide you with insight into the data that your organization stores in AWS. Macie also provides an inventory of your Amazon S3 buckets, which it continually monitors for you. If Macie detects sensitive data or potential data access issues, it generates detailed findings for you to review and act upon as necessary.

Sending a Request Using Macie2

var macie2 = new AWS.Macie2();
macie2.acceptInvitation(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 Macie2 object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var macie2 = new AWS.Macie2({apiVersion: '2020-01-01'});

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

AWS.config.apiVersions = {
  macie2: '2020-01-01',
  // other service API versions
};

var macie2 = new AWS.Macie2();

Version:

  • 2020-01-01

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.Macie2(options = {}) ⇒ Object

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

Examples:

Constructing a Macie2 object

var macie2 = new AWS.Macie2({apiVersion: '2020-01-01'});

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.Macie2.region for more information.

  • maxRetries (Integer)

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

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.Macie2.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'.

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

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

Accepts an Amazon Macie membership invitation that was received from a specific account.

Service Reference:

Examples:

Calling the acceptInvitation operation

var params = {
  invitationId: 'STRING_VALUE', /* required */
  administratorAccountId: 'STRING_VALUE',
  masterAccount: 'STRING_VALUE'
};
macie2.acceptInvitation(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: {})
    • administratorAccountId — (String)

      The Amazon Web Services account ID for the account that sent the invitation.

    • invitationId — (String)

      The unique identifier for the invitation to accept.

    • masterAccount — (String)

      (Deprecated) The Amazon Web Services account ID for the account that sent the invitation. This property has been replaced by the administratorAccountId property and is retained only for backward compatibility.

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.

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

Retrieves information about one or more custom data identifiers.

Service Reference:

Examples:

Calling the batchGetCustomDataIdentifiers operation

var params = {
  ids: [
    'STRING_VALUE',
    /* more items */
  ]
};
macie2.batchGetCustomDataIdentifiers(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: {})
    • ids — (Array<String>)

      An array of custom data identifier IDs, one for each custom data identifier to retrieve information about.

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:

      • customDataIdentifiers — (Array<map>)

        An array of objects, one for each custom data identifier that meets the criteria specified in the request.

        • arn — (String)

          The Amazon Resource Name (ARN) of the custom data identifier.

        • createdAt — (Date)

          The date and time, in UTC and extended ISO 8601 format, when the custom data identifier was created.

        • deleted — (Boolean)

          Specifies whether the custom data identifier was deleted. If you delete a custom data identifier, Amazon Macie doesn't delete it permanently. Instead, it soft deletes the identifier.

        • description — (String)

          The custom description of the custom data identifier.

        • id — (String)

          The unique identifier for the custom data identifier.

        • name — (String)

          The custom name of the custom data identifier.

      • notFoundIdentifierIds — (Array<String>)

        An array of custom data identifier IDs, one for each custom data identifier that was specified in the request but doesn't correlate to an existing custom data identifier.

Returns:

  • (AWS.Request)

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

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

Creates and defines the settings for a classification job.

Service Reference:

Examples:

Calling the createClassificationJob operation

var params = {
  clientToken: 'STRING_VALUE', /* required */
  jobType: ONE_TIME | SCHEDULED, /* required */
  name: 'STRING_VALUE', /* required */
  s3JobDefinition: { /* required */
    bucketCriteria: {
      excludes: {
        and: [
          {
            simpleCriterion: {
              comparator: EQ | GT | GTE | LT | LTE | NE | CONTAINS | STARTS_WITH,
              key: ACCOUNT_ID | S3_BUCKET_NAME | S3_BUCKET_EFFECTIVE_PERMISSION | S3_BUCKET_SHARED_ACCESS,
              values: [
                'STRING_VALUE',
                /* more items */
              ]
            },
            tagCriterion: {
              comparator: EQ | GT | GTE | LT | LTE | NE | CONTAINS | STARTS_WITH,
              tagValues: [
                {
                  key: 'STRING_VALUE',
                  value: 'STRING_VALUE'
                },
                /* more items */
              ]
            }
          },
          /* more items */
        ]
      },
      includes: {
        and: [
          {
            simpleCriterion: {
              comparator: EQ | GT | GTE | LT | LTE | NE | CONTAINS | STARTS_WITH,
              key: ACCOUNT_ID | S3_BUCKET_NAME | S3_BUCKET_EFFECTIVE_PERMISSION | S3_BUCKET_SHARED_ACCESS,
              values: [
                'STRING_VALUE',
                /* more items */
              ]
            },
            tagCriterion: {
              comparator: EQ | GT | GTE | LT | LTE | NE | CONTAINS | STARTS_WITH,
              tagValues: [
                {
                  key: 'STRING_VALUE',
                  value: 'STRING_VALUE'
                },
                /* more items */
              ]
            }
          },
          /* more items */
        ]
      }
    },
    bucketDefinitions: [
      {
        accountId: 'STRING_VALUE', /* required */
        buckets: [ /* required */
          'STRING_VALUE',
          /* more items */
        ]
      },
      /* more items */
    ],
    scoping: {
      excludes: {
        and: [
          {
            simpleScopeTerm: {
              comparator: EQ | GT | GTE | LT | LTE | NE | CONTAINS | STARTS_WITH,
              key: OBJECT_EXTENSION | OBJECT_LAST_MODIFIED_DATE | OBJECT_SIZE | OBJECT_KEY,
              values: [
                'STRING_VALUE',
                /* more items */
              ]
            },
            tagScopeTerm: {
              comparator: EQ | GT | GTE | LT | LTE | NE | CONTAINS | STARTS_WITH,
              key: 'STRING_VALUE',
              tagValues: [
                {
                  key: 'STRING_VALUE',
                  value: 'STRING_VALUE'
                },
                /* more items */
              ],
              target: S3_OBJECT
            }
          },
          /* more items */
        ]
      },
      includes: {
        and: [
          {
            simpleScopeTerm: {
              comparator: EQ | GT | GTE | LT | LTE | NE | CONTAINS | STARTS_WITH,
              key: OBJECT_EXTENSION | OBJECT_LAST_MODIFIED_DATE | OBJECT_SIZE | OBJECT_KEY,
              values: [
                'STRING_VALUE',
                /* more items */
              ]
            },
            tagScopeTerm: {
              comparator: EQ | GT | GTE | LT | LTE | NE | CONTAINS | STARTS_WITH,
              key: 'STRING_VALUE',
              tagValues: [
                {
                  key: 'STRING_VALUE',
                  value: 'STRING_VALUE'
                },
                /* more items */
              ],
              target: S3_OBJECT
            }
          },
          /* more items */
        ]
      }
    }
  },
  customDataIdentifierIds: [
    'STRING_VALUE',
    /* more items */
  ],
  description: 'STRING_VALUE',
  initialRun: true || false,
  managedDataIdentifierIds: [
    'STRING_VALUE',
    /* more items */
  ],
  managedDataIdentifierSelector: ALL | EXCLUDE | INCLUDE | NONE,
  samplingPercentage: 'NUMBER_VALUE',
  scheduleFrequency: {
    dailySchedule: {
    },
    monthlySchedule: {
      dayOfMonth: 'NUMBER_VALUE'
    },
    weeklySchedule: {
      dayOfWeek: SUNDAY | MONDAY | TUESDAY | WEDNESDAY | THURSDAY | FRIDAY | SATURDAY
    }
  },
  tags: {
    '<__string>': 'STRING_VALUE',
    /* '<__string>': ... */
  }
};
macie2.createClassificationJob(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: {})
    • clientToken — (String)

      A unique, case-sensitive token that you provide to ensure the idempotency of the request.

      If a token is not provided, the SDK will use a version 4 UUID.
    • customDataIdentifierIds — (Array<String>)

      An array of unique identifiers, one for each custom data identifier for the job to use when it analyzes data. To use only managed data identifiers, don't specify a value for this property and specify a value other than NONE for the managedDataIdentifierSelector property.

    • description — (String)

      A custom description of the job. The description can contain as many as 200 characters.

    • initialRun — (Boolean)

      For a recurring job, specifies whether to analyze all existing, eligible objects immediately after the job is created (true). To analyze only those objects that are created or changed after you create the job and before the job's first scheduled run, set this value to false.

      If you configure the job to run only once, don't specify a value for this property.

    • jobType — (String)

      The schedule for running the job. Valid values are:

      • ONE_TIME - Run the job only once. If you specify this value, don't specify a value for the scheduleFrequency property.

      • SCHEDULED - Run the job on a daily, weekly, or monthly basis. If you specify this value, use the scheduleFrequency property to define the recurrence pattern for the job.

      Possible values include:
      • "ONE_TIME"
      • "SCHEDULED"
    • managedDataIdentifierIds — (Array<String>)

      An array of unique identifiers, one for each managed data identifier for the job to include (use) or exclude (not use) when it analyzes data. Inclusion or exclusion depends on the managed data identifier selection type that you specify for the job (managedDataIdentifierSelector).

      To retrieve a list of valid values for this property, use the ListManagedDataIdentifiers operation.

    • managedDataIdentifierSelector — (String)

      The selection type to apply when determining which managed data identifiers the job uses to analyze data. Valid values are:

      • ALL - Use all the managed data identifiers that Amazon Macie provides. If you specify this value, don't specify any values for the managedDataIdentifierIds property.

      • EXCLUDE - Use all the managed data identifiers that Macie provides except the managed data identifiers specified by the managedDataIdentifierIds property.

      • INCLUDE - Use only the managed data identifiers specified by the managedDataIdentifierIds property.

      • NONE - Don't use any managed data identifiers. If you specify this value, specify at least one custom data identifier for the job (customDataIdentifierIds) and don't specify any values for the managedDataIdentifierIds property.

      If you don't specify a value for this property, the job uses all managed data identifiers. If you don't specify a value for this property or you specify ALL or EXCLUDE for a recurring job, the job also uses new managed data identifiers as they are released.

      Possible values include:
      • "ALL"
      • "EXCLUDE"
      • "INCLUDE"
      • "NONE"
    • name — (String)

      A custom name for the job. The name can contain as many as 500 characters.

    • s3JobDefinition — (map)

      The S3 buckets that contain the objects to analyze, and the scope of that analysis.

      • bucketDefinitions — (Array<map>)

        An array of objects, one for each Amazon Web Services account that owns specific S3 buckets to analyze. Each object specifies the account ID for an account and one or more buckets to analyze for that account. A job's definition can contain a bucketDefinitions array or a bucketCriteria object, not both.

        • accountIdrequired — (String)

          The unique identifier for the Amazon Web Services account that owns the buckets.

        • bucketsrequired — (Array<String>)

          An array that lists the names of the buckets.

      • scoping — (map)

        The property- and tag-based conditions that determine which S3 objects to include or exclude from the analysis. Each time the job runs, the job uses these criteria to determine which objects to analyze.

        • excludes — (map)

          The property- and tag-based conditions that determine which objects to exclude from the analysis.

          • and — (Array<map>)

            An array of conditions, one for each property- or tag-based condition that determines which objects to include or exclude from the job. If you specify more than one condition, Amazon Macie uses AND logic to join the conditions.

            • simpleScopeTerm — (map)

              A property-based condition that defines a property, operator, and one or more values for including or excluding objects from the job.

              • comparator — (String)

                The operator to use in the condition. Valid values for each supported property (key) are:

                • OBJECT_EXTENSION - EQ (equals) or NE (not equals)

                • OBJECT_KEY - STARTS_WITH

                • OBJECT_LAST_MODIFIED_DATE - Any operator except CONTAINS

                • OBJECT_SIZE - Any operator except CONTAINS

                Possible values include:
                • "EQ"
                • "GT"
                • "GTE"
                • "LT"
                • "LTE"
                • "NE"
                • "CONTAINS"
                • "STARTS_WITH"
              • key — (String)

                The object property to use in the condition.

                Possible values include:
                • "OBJECT_EXTENSION"
                • "OBJECT_LAST_MODIFIED_DATE"
                • "OBJECT_SIZE"
                • "OBJECT_KEY"
              • values — (Array<String>)

                An array that lists the values to use in the condition. If the value for the key property is OBJECT_EXTENSION or OBJECT_KEY, this array can specify multiple values and Amazon Macie uses OR logic to join the values. Otherwise, this array can specify only one value.

                Valid values for each supported property (key) are:

                • OBJECT_EXTENSION - A string that represents the file name extension of an object. For example: docx or pdf

                • OBJECT_KEY - A string that represents the key prefix (folder name or path) of an object. For example: logs or awslogs/eventlogs. This value applies a condition to objects whose keys (names) begin with the specified value.

                • OBJECT_LAST_MODIFIED_DATE - The date and time (in UTC and extended ISO 8601 format) when an object was created or last changed, whichever is latest. For example: 2020-09-28T14:31:13Z

                • OBJECT_SIZE - An integer that represents the storage size (in bytes) of an object.

                Macie doesn't support use of wildcard characters in these values. Also, string values are case sensitive.

            • tagScopeTerm — (map)

              A tag-based condition that defines the operator and tag keys or tag key and value pairs for including or excluding objects from the job.

              • comparator — (String)

                The operator to use in the condition. Valid values are EQ (equals) or NE (not equals).

                Possible values include:
                • "EQ"
                • "GT"
                • "GTE"
                • "LT"
                • "LTE"
                • "NE"
                • "CONTAINS"
                • "STARTS_WITH"
              • key — (String)

                The object property to use in the condition. The only valid value is TAG.

              • tagValues — (Array<map>)

                The tag keys or tag key and value pairs to use in the condition. To specify only tag keys in a condition, specify the keys in this array and set the value for each associated tag value to an empty string.

                • key — (String)

                  The value for the tag key to use in the condition.

                • value — (String)

                  The tag value, associated with the specified tag key (key), to use in the condition. To specify only a tag key for a condition, specify the tag key for the key property and set this value to an empty string.

              • target — (String)

                The type of object to apply the condition to.

                Possible values include:
                • "S3_OBJECT"
        • includes — (map)

          The property- and tag-based conditions that determine which objects to include in the analysis.

          • and — (Array<map>)

            An array of conditions, one for each property- or tag-based condition that determines which objects to include or exclude from the job. If you specify more than one condition, Amazon Macie uses AND logic to join the conditions.

            • simpleScopeTerm — (map)

              A property-based condition that defines a property, operator, and one or more values for including or excluding objects from the job.

              • comparator — (String)

                The operator to use in the condition. Valid values for each supported property (key) are:

                • OBJECT_EXTENSION - EQ (equals) or NE (not equals)

                • OBJECT_KEY - STARTS_WITH

                • OBJECT_LAST_MODIFIED_DATE - Any operator except CONTAINS

                • OBJECT_SIZE - Any operator except CONTAINS

                Possible values include:
                • "EQ"
                • "GT"
                • "GTE"
                • "LT"
                • "LTE"
                • "NE"
                • "CONTAINS"
                • "STARTS_WITH"
              • key — (String)

                The object property to use in the condition.

                Possible values include:
                • "OBJECT_EXTENSION"
                • "OBJECT_LAST_MODIFIED_DATE"
                • "OBJECT_SIZE"
                • "OBJECT_KEY"
              • values — (Array<String>)

                An array that lists the values to use in the condition. If the value for the key property is OBJECT_EXTENSION or OBJECT_KEY, this array can specify multiple values and Amazon Macie uses OR logic to join the values. Otherwise, this array can specify only one value.

                Valid values for each supported property (key) are:

                • OBJECT_EXTENSION - A string that represents the file name extension of an object. For example: docx or pdf

                • OBJECT_KEY - A string that represents the key prefix (folder name or path) of an object. For example: logs or awslogs/eventlogs. This value applies a condition to objects whose keys (names) begin with the specified value.

                • OBJECT_LAST_MODIFIED_DATE - The date and time (in UTC and extended ISO 8601 format) when an object was created or last changed, whichever is latest. For example: 2020-09-28T14:31:13Z

                • OBJECT_SIZE - An integer that represents the storage size (in bytes) of an object.

                Macie doesn't support use of wildcard characters in these values. Also, string values are case sensitive.

            • tagScopeTerm — (map)

              A tag-based condition that defines the operator and tag keys or tag key and value pairs for including or excluding objects from the job.

              • comparator — (String)

                The operator to use in the condition. Valid values are EQ (equals) or NE (not equals).

                Possible values include:
                • "EQ"
                • "GT"
                • "GTE"
                • "LT"
                • "LTE"
                • "NE"
                • "CONTAINS"
                • "STARTS_WITH"
              • key — (String)

                The object property to use in the condition. The only valid value is TAG.

              • tagValues — (Array<map>)

                The tag keys or tag key and value pairs to use in the condition. To specify only tag keys in a condition, specify the keys in this array and set the value for each associated tag value to an empty string.

                • key — (String)

                  The value for the tag key to use in the condition.

                • value — (String)

                  The tag value, associated with the specified tag key (key), to use in the condition. To specify only a tag key for a condition, specify the tag key for the key property and set this value to an empty string.

              • target — (String)

                The type of object to apply the condition to.

                Possible values include:
                • "S3_OBJECT"
      • bucketCriteria — (map)

        The property- and tag-based conditions that determine which S3 buckets to include or exclude from the analysis. Each time the job runs, the job uses these criteria to determine which buckets contain objects to analyze. A job's definition can contain a bucketCriteria object or a bucketDefinitions array, not both.

        • excludes — (map)

          The property- and tag-based conditions that determine which buckets to exclude from the job.

          • and — (Array<map>)

            An array of conditions, one for each condition that determines which buckets to include or exclude from the job. If you specify more than one condition, Amazon Macie uses AND logic to join the conditions.

            • simpleCriterion — (map)

              A property-based condition that defines a property, operator, and one or more values for including or excluding buckets from the job.

              • comparator — (String)

                The operator to use in the condition. Valid values are EQ (equals) and NE (not equals).

                Possible values include:
                • "EQ"
                • "GT"
                • "GTE"
                • "LT"
                • "LTE"
                • "NE"
                • "CONTAINS"
                • "STARTS_WITH"
              • key — (String)

                The property to use in the condition.

                Possible values include:
                • "ACCOUNT_ID"
                • "S3_BUCKET_NAME"
                • "S3_BUCKET_EFFECTIVE_PERMISSION"
                • "S3_BUCKET_SHARED_ACCESS"
              • values — (Array<String>)

                An array that lists one or more values to use in the condition. If you specify multiple values, Amazon Macie uses OR logic to join the values. Valid values for each supported property (key) are:

                • ACCOUNT_ID - A string that represents the unique identifier for the Amazon Web Services account that owns the bucket.

                • S3_BUCKET_EFFECTIVE_PERMISSION - A string that represents an enumerated value that Macie defines for the BucketPublicAccess.effectivePermission property of a bucket.

                • S3_BUCKET_NAME - A string that represents the name of a bucket.

                • S3_BUCKET_SHARED_ACCESS - A string that represents an enumerated value that Macie defines for the BucketMetadata.sharedAccess property of a bucket.

                Values are case sensitive. Also, Macie doesn't support use of partial values or wildcard characters in these values.

            • tagCriterion — (map)

              A tag-based condition that defines an operator and tag keys, tag values, or tag key and value pairs for including or excluding buckets from the job.

              • comparator — (String)

                The operator to use in the condition. Valid values are EQ (equals) and NE (not equals).

                Possible values include:
                • "EQ"
                • "GT"
                • "GTE"
                • "LT"
                • "LTE"
                • "NE"
                • "CONTAINS"
                • "STARTS_WITH"
              • tagValues — (Array<map>)

                The tag keys, tag values, or tag key and value pairs to use in the condition.

                • key — (String)

                  The value for the tag key to use in the condition.

                • value — (String)

                  The tag value to use in the condition.

        • includes — (map)

          The property- and tag-based conditions that determine which buckets to include in the job.

          • and — (Array<map>)

            An array of conditions, one for each condition that determines which buckets to include or exclude from the job. If you specify more than one condition, Amazon Macie uses AND logic to join the conditions.

            • simpleCriterion — (map)

              A property-based condition that defines a property, operator, and one or more values for including or excluding buckets from the job.

              • comparator — (String)

                The operator to use in the condition. Valid values are EQ (equals) and NE (not equals).

                Possible values include:
                • "EQ"
                • "GT"
                • "GTE"
                • "LT"
                • "LTE"
                • "NE"
                • "CONTAINS"
                • "STARTS_WITH"
              • key — (String)

                The property to use in the condition.

                Possible values include:
                • "ACCOUNT_ID"
                • "S3_BUCKET_NAME"
                • "S3_BUCKET_EFFECTIVE_PERMISSION"
                • "S3_BUCKET_SHARED_ACCESS"
              • values — (Array<String>)

                An array that lists one or more values to use in the condition. If you specify multiple values, Amazon Macie uses OR logic to join the values. Valid values for each supported property (key) are:

                • ACCOUNT_ID - A string that represents the unique identifier for the Amazon Web Services account that owns the bucket.

                • S3_BUCKET_EFFECTIVE_PERMISSION - A string that represents an enumerated value that Macie defines for the BucketPublicAccess.effectivePermission property of a bucket.

                • S3_BUCKET_NAME - A string that represents the name of a bucket.

                • S3_BUCKET_SHARED_ACCESS - A string that represents an enumerated value that Macie defines for the BucketMetadata.sharedAccess property of a bucket.

                Values are case sensitive. Also, Macie doesn't support use of partial values or wildcard characters in these values.

            • tagCriterion — (map)

              A tag-based condition that defines an operator and tag keys, tag values, or tag key and value pairs for including or excluding buckets from the job.

              • comparator — (String)

                The operator to use in the condition. Valid values are EQ (equals) and NE (not equals).

                Possible values include:
                • "EQ"
                • "GT"
                • "GTE"
                • "LT"
                • "LTE"
                • "NE"
                • "CONTAINS"
                • "STARTS_WITH"
              • tagValues — (Array<map>)

                The tag keys, tag values, or tag key and value pairs to use in the condition.

                • key — (String)

                  The value for the tag key to use in the condition.

                • value — (String)

                  The tag value to use in the condition.

    • samplingPercentage — (Integer)

      The sampling depth, as a percentage, for the job to apply when processing objects. This value determines the percentage of eligible objects that the job analyzes. If this value is less than 100, Amazon Macie selects the objects to analyze at random, up to the specified percentage, and analyzes all the data in those objects.

    • scheduleFrequency — (map)

      The recurrence pattern for running the job. To run the job only once, don't specify a value for this property and set the value for the jobType property to ONE_TIME.

      • dailySchedule — (map)

        Specifies a daily recurrence pattern for running the job.

      • monthlySchedule — (map)

        Specifies a monthly recurrence pattern for running the job.

        • dayOfMonth — (Integer)

          The numeric day of the month when Amazon Macie runs the job. This value can be an integer from 1 through 31.

          If this value exceeds the number of days in a certain month, Macie doesn't run the job that month. Macie runs the job only during months that have the specified day. For example, if this value is 31 and a month has only 30 days, Macie doesn't run the job that month. To run the job every month, specify a value that's less than 29.

      • weeklySchedule — (map)

        Specifies a weekly recurrence pattern for running the job.

        • dayOfWeek — (String)

          The day of the week when Amazon Macie runs the job.

          Possible values include:
          • "SUNDAY"
          • "MONDAY"
          • "TUESDAY"
          • "WEDNESDAY"
          • "THURSDAY"
          • "FRIDAY"
          • "SATURDAY"
    • tags — (map<String>)

      A map of key-value pairs that specifies the tags to associate with the job.

      A job can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

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:

      • jobArn — (String)

        The Amazon Resource Name (ARN) of the job.

      • jobId — (String)

        The unique identifier for the job.

Returns:

  • (AWS.Request)

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

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

Creates and defines the criteria and other settings for a custom data identifier.

Service Reference:

Examples:

Calling the createCustomDataIdentifier operation

var params = {
  clientToken: 'STRING_VALUE',
  description: 'STRING_VALUE',
  ignoreWords: [
    'STRING_VALUE',
    /* more items */
  ],
  keywords: [
    'STRING_VALUE',
    /* more items */
  ],
  maximumMatchDistance: 'NUMBER_VALUE',
  name: 'STRING_VALUE',
  regex: 'STRING_VALUE',
  tags: {
    '<__string>': 'STRING_VALUE',
    /* '<__string>': ... */
  }
};
macie2.createCustomDataIdentifier(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: {})
    • clientToken — (String)

      A unique, case-sensitive token that you provide to ensure the idempotency of the request.

      If a token is not provided, the SDK will use a version 4 UUID.
    • description — (String)

      A custom description of the custom data identifier. The description can contain as many as 512 characters.

      We strongly recommend that you avoid including any sensitive data in the description of a custom data identifier. Other users of your account might be able to see the identifier's description, depending on the actions that they're allowed to perform in Amazon Macie.

    • ignoreWords — (Array<String>)

      An array that lists specific character sequences (ignore words) to exclude from the results. If the text matched by the regular expression is the same as any string in this array, Amazon Macie ignores it. The array can contain as many as 10 ignore words. Each ignore word can contain 4-90 UTF-8 characters. Ignore words are case sensitive.

    • keywords — (Array<String>)

      An array that lists specific character sequences (keywords), one of which must be within proximity (maximumMatchDistance) of the regular expression to match. The array can contain as many as 50 keywords. Each keyword can contain 3-90 UTF-8 characters. Keywords aren't case sensitive.

    • maximumMatchDistance — (Integer)

      The maximum number of characters that can exist between text that matches the regex pattern and the character sequences specified by the keywords array. Amazon Macie includes or excludes a result based on the proximity of a keyword to text that matches the regex pattern. The distance can be 1-300 characters. The default value is 50.

    • name — (String)

      A custom name for the custom data identifier. The name can contain as many as 128 characters.

      We strongly recommend that you avoid including any sensitive data in the name of a custom data identifier. Other users of your account might be able to see the identifier's name, depending on the actions that they're allowed to perform in Amazon Macie.

    • regex — (String)

      The regular expression (regex) that defines the pattern to match. The expression can contain as many as 512 characters.

    • tags — (map<String>)

      A map of key-value pairs that specifies the tags to associate with the custom data identifier.

      A custom data identifier can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

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:

      • customDataIdentifierId — (String)

        The unique identifier for the custom data identifier that was created.

Returns:

  • (AWS.Request)

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

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

Creates and defines the criteria and other settings for a findings filter.

Service Reference:

Examples:

Calling the createFindingsFilter operation

var params = {
  action: ARCHIVE | NOOP, /* required */
  findingCriteria: { /* required */
    criterion: {
      '<__string>': {
        eq: [
          'STRING_VALUE',
          /* more items */
        ],
        eqExactMatch: [
          'STRING_VALUE',
          /* more items */
        ],
        gt: 'NUMBER_VALUE',
        gte: 'NUMBER_VALUE',
        lt: 'NUMBER_VALUE',
        lte: 'NUMBER_VALUE',
        neq: [
          'STRING_VALUE',
          /* more items */
        ]
      },
      /* '<__string>': ... */
    }
  },
  name: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  description: 'STRING_VALUE',
  position: 'NUMBER_VALUE',
  tags: {
    '<__string>': 'STRING_VALUE',
    /* '<__string>': ... */
  }
};
macie2.createFindingsFilter(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: {})
    • action — (String)

      The action to perform on findings that meet the filter criteria (findingCriteria). Valid values are: ARCHIVE, suppress (automatically archive) the findings; and, NOOP, don't perform any action on the findings.

      Possible values include:
      • "ARCHIVE"
      • "NOOP"
    • clientToken — (String)

      A unique, case-sensitive token that you provide to ensure the idempotency of the request.

      If a token is not provided, the SDK will use a version 4 UUID.
    • description — (String)

      A custom description of the filter. The description can contain as many as 512 characters.

      We strongly recommend that you avoid including any sensitive data in the description of a filter. Other users of your account might be able to see the filter's description, depending on the actions that they're allowed to perform in Amazon Macie.

    • findingCriteria — (map)

      The criteria to use to filter findings.

      • criterion — (map<map>)

        A condition that specifies the property, operator, and one or more values to use to filter the results.

        • eq — (Array<String>)

          The value for the property matches (equals) the specified value. If you specify multiple values, Macie uses OR logic to join the values.

        • eqExactMatch — (Array<String>)

          The value for the property exclusively matches (equals an exact match for) all the specified values. If you specify multiple values, Amazon Macie uses AND logic to join the values.

          You can use this operator with the following properties: customDataIdentifiers.detections.arn, customDataIdentifiers.detections.name, resourcesAffected.s3Bucket.tags.key, resourcesAffected.s3Bucket.tags.value, resourcesAffected.s3Object.tags.key, resourcesAffected.s3Object.tags.value, sensitiveData.category, and sensitiveData.detections.type.

        • gt — (Integer)

          The value for the property is greater than the specified value.

        • gte — (Integer)

          The value for the property is greater than or equal to the specified value.

        • lt — (Integer)

          The value for the property is less than the specified value.

        • lte — (Integer)

          The value for the property is less than or equal to the specified value.

        • neq — (Array<String>)

          The value for the property doesn't match (doesn't equal) the specified value. If you specify multiple values, Macie uses OR logic to join the values.

    • name — (String)

      A custom name for the filter. The name must contain at least 3 characters and can contain as many as 64 characters.

      We strongly recommend that you avoid including any sensitive data in the name of a filter. Other users of your account might be able to see the filter's name, depending on the actions that they're allowed to perform in Amazon Macie.

    • position — (Integer)

      The position of the filter in the list of saved filters on the Amazon Macie console. This value also determines the order in which the filter is applied to findings, relative to other filters that are also applied to the findings.

    • tags — (map<String>)

      A map of key-value pairs that specifies the tags to associate with the filter.

      A findings filter can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

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:

      • arn — (String)

        The Amazon Resource Name (ARN) of the filter that was created.

      • id — (String)

        The unique identifier for the filter that was created.

Returns:

  • (AWS.Request)

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

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

Sends an Amazon Macie membership invitation to one or more accounts.

Service Reference:

Examples:

Calling the createInvitations operation

var params = {
  accountIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  disableEmailNotification: true || false,
  message: 'STRING_VALUE'
};
macie2.createInvitations(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: {})
    • accountIds — (Array<String>)

      An array that lists Amazon Web Services account IDs, one for each account to send the invitation to.

    • disableEmailNotification — (Boolean)

      Specifies whether to send an email notification to the root user of each account that the invitation will be sent to. This notification is in addition to an alert that the root user receives in Personal Health Dashboard. To send an email notification to the root user of each account, set this value to true.

    • message — (String)

      A custom message to include in the invitation. Amazon Macie adds this message to the standard content that it sends for an invitation.

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:

      • unprocessedAccounts — (Array<map>)

        An array of objects, one for each account whose invitation hasn't been processed. Each object identifies the account and explains why the invitation hasn't been processed for the account.

        • accountId — (String)

          The Amazon Web Services account ID for the account that the request applies to.

        • errorCode — (String)

          The source of the issue or delay in processing the request.

          Possible values include:
          • "ClientError"
          • "InternalError"
        • errorMessage — (String)

          The reason why the request hasn't been processed.

Returns:

  • (AWS.Request)

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

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

Associates an account with an Amazon Macie administrator account.

Service Reference:

Examples:

Calling the createMember operation

var params = {
  account: { /* required */
    accountId: 'STRING_VALUE', /* required */
    email: 'STRING_VALUE' /* required */
  },
  tags: {
    '<__string>': 'STRING_VALUE',
    /* '<__string>': ... */
  }
};
macie2.createMember(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: {})
    • account — (map)

      The details of the account to associate with the administrator account.

      • accountIdrequired — (String)

        The Amazon Web Services account ID for the account.

      • emailrequired — (String)

        The email address for the account.

    • tags — (map<String>)

      A map of key-value pairs that specifies the tags to associate with the account in Amazon Macie.

      An account can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

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:

      • arn — (String)

        The Amazon Resource Name (ARN) of the account that was associated with the administrator account.

Returns:

  • (AWS.Request)

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

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

Creates sample findings.

Service Reference:

Examples:

Calling the createSampleFindings operation

var params = {
  findingTypes: [
    SensitiveData:S3Object/Multiple | SensitiveData:S3Object/Financial | SensitiveData:S3Object/Personal | SensitiveData:S3Object/Credentials | SensitiveData:S3Object/CustomIdentifier | Policy:IAMUser/S3BucketPublic | Policy:IAMUser/S3BucketSharedExternally | Policy:IAMUser/S3BucketReplicatedExternally | Policy:IAMUser/S3BucketEncryptionDisabled | Policy:IAMUser/S3BlockPublicAccessDisabled,
    /* more items */
  ]
};
macie2.createSampleFindings(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: {})
    • findingTypes — (Array<String>)

      An array that lists one or more types of findings to include in the set of sample findings. Currently, the only supported value is Policy:IAMUser/S3BucketEncryptionDisabled.

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.

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

Declines Amazon Macie membership invitations that were received from specific accounts.

Service Reference:

Examples:

Calling the declineInvitations operation

var params = {
  accountIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
macie2.declineInvitations(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: {})
    • accountIds — (Array<String>)

      An array that lists Amazon Web Services account IDs, one for each account that sent an invitation to decline.

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:

      • unprocessedAccounts — (Array<map>)

        An array of objects, one for each account whose invitation hasn't been declined. Each object identifies the account and explains why the request hasn't been processed for that account.

        • accountId — (String)

          The Amazon Web Services account ID for the account that the request applies to.

        • errorCode — (String)

          The source of the issue or delay in processing the request.

          Possible values include:
          • "ClientError"
          • "InternalError"
        • errorMessage — (String)

          The reason why the request hasn't been processed.

Returns:

  • (AWS.Request)

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

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

Soft deletes a custom data identifier.

Service Reference:

Examples:

Calling the deleteCustomDataIdentifier operation

var params = {
  id: 'STRING_VALUE' /* required */
};
macie2.deleteCustomDataIdentifier(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: {})
    • id — (String)

      The unique identifier for the Amazon Macie resource or account that the request applies 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.

Returns:

  • (AWS.Request)

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

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

Deletes a findings filter.

Service Reference:

Examples:

Calling the deleteFindingsFilter operation

var params = {
  id: 'STRING_VALUE' /* required */
};
macie2.deleteFindingsFilter(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: {})
    • id — (String)

      The unique identifier for the Amazon Macie resource or account that the request applies 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.

Returns:

  • (AWS.Request)

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

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

Deletes Amazon Macie membership invitations that were received from specific accounts.

Service Reference:

Examples:

Calling the deleteInvitations operation

var params = {
  accountIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
macie2.deleteInvitations(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: {})
    • accountIds — (Array<String>)

      An array that lists Amazon Web Services account IDs, one for each account that sent an invitation to delete.

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:

      • unprocessedAccounts — (Array<map>)

        An array of objects, one for each account whose invitation hasn't been deleted. Each object identifies the account and explains why the request hasn't been processed for that account.

        • accountId — (String)

          The Amazon Web Services account ID for the account that the request applies to.

        • errorCode — (String)

          The source of the issue or delay in processing the request.

          Possible values include:
          • "ClientError"
          • "InternalError"
        • errorMessage — (String)

          The reason why the request hasn't been processed.

Returns:

  • (AWS.Request)

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

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

Deletes the association between an Amazon Macie administrator account and an account.

Service Reference:

Examples:

Calling the deleteMember operation

var params = {
  id: 'STRING_VALUE' /* required */
};
macie2.deleteMember(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: {})
    • id — (String)

      The unique identifier for the Amazon Macie resource or account that the request applies 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.

Returns:

  • (AWS.Request)

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

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

Retrieves (queries) statistical data and other information about one or more S3 buckets that Amazon Macie monitors and analyzes.

Service Reference:

Examples:

Calling the describeBuckets operation

var params = {
  criteria: {
    '<__string>': {
      eq: [
        'STRING_VALUE',
        /* more items */
      ],
      gt: 'NUMBER_VALUE',
      gte: 'NUMBER_VALUE',
      lt: 'NUMBER_VALUE',
      lte: 'NUMBER_VALUE',
      neq: [
        'STRING_VALUE',
        /* more items */
      ],
      prefix: 'STRING_VALUE'
    },
    /* '<__string>': ... */
  },
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  sortCriteria: {
    attributeName: 'STRING_VALUE',
    orderBy: ASC | DESC
  }
};
macie2.describeBuckets(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: {})
    • criteria — (map<map>)

      The criteria to use to filter the query results.

      • eq — (Array<String>)

        The value for the property matches (equals) the specified value. If you specify multiple values, Macie uses OR logic to join the values.

      • gt — (Integer)

        The value for the property is greater than the specified value.

      • gte — (Integer)

        The value for the property is greater than or equal to the specified value.

      • lt — (Integer)

        The value for the property is less than the specified value.

      • lte — (Integer)

        The value for the property is less than or equal to the specified value.

      • neq — (Array<String>)

        The value for the property doesn't match (doesn't equal) the specified value. If you specify multiple values, Amazon Macie uses OR logic to join the values.

      • prefix — (String)

        The name of the bucket begins with the specified value.

    • maxResults — (Integer)

      The maximum number of items to include in each page of the response. The default value is 50.

    • nextToken — (String)

      The nextToken string that specifies which page of results to return in a paginated response.

    • sortCriteria — (map)

      The criteria to use to sort the query results.

      • attributeName — (String)

        The name of the bucket property to sort the results by. This value can be one of the following properties that Amazon Macie defines as bucket metadata: accountId, bucketName, classifiableObjectCount, classifiableSizeInBytes, objectCount, or sizeInBytes.

      • orderBy — (String)

        The sort order to apply to the results, based on the value specified by the attributeName property. Valid values are: ASC, sort the results in ascending order; and, DESC, sort the results in descending order.

        Possible values include:
        • "ASC"
        • "DESC"

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:

      • buckets — (Array<map>)

        An array of objects, one for each bucket that meets the filter criteria specified in the request.

        • accountId — (String)

          The unique identifier for the Amazon Web Services account that owns the bucket.

        • allowsUnencryptedObjectUploads — (String)

          Specifies whether the bucket policy for the bucket requires server-side encryption of objects when objects are uploaded to the bucket. Possible values are:

          • FALSE - The bucket policy requires server-side encryption of new objects. PutObject requests must include the x-amz-server-side-encryption header and the value for that header must be AES256 or aws:kms.

          • TRUE - The bucket doesn't have a bucket policy or it has a bucket policy that doesn't require server-side encryption of new objects. If a bucket policy exists, it doesn't require PutObject requests to include the x-amz-server-side-encryption header and it doesn't require the value for that header to be AES256 or aws:kms.

          • UNKNOWN - Amazon Macie can't determine whether the bucket policy requires server-side encryption of new objects.

          Possible values include:
          • "TRUE"
          • "FALSE"
          • "UNKNOWN"
        • bucketArn — (String)

          The Amazon Resource Name (ARN) of the bucket.

        • bucketCreatedAt — (Date)

          The date and time, in UTC and extended ISO 8601 format, when the bucket was created.

        • bucketName — (String)

          The name of the bucket.

        • classifiableObjectCount — (Integer)

          The total number of objects that Amazon Macie can analyze in the bucket. These objects use a supported storage class and have a file name extension for a supported file or storage format.

        • classifiableSizeInBytes — (Integer)

          The total storage size, in bytes, of the objects that Amazon Macie can analyze in the bucket. These objects use a supported storage class and have a file name extension for a supported file or storage format.

          If versioning is enabled for the bucket, Macie calculates this value based on the size of the latest version of each applicable object in the bucket. This value doesn't reflect the storage size of all versions of each applicable object in the bucket.

        • jobDetails — (map)

          Specifies whether any one-time or recurring classification jobs are configured to analyze data in the bucket, and, if so, the details of the job that ran most recently.

          • isDefinedInJob — (String)

            Specifies whether any one-time or recurring jobs are configured to analyze data in the bucket. Possible values are:

            • TRUE - The bucket is explicitly included in the bucket definition (S3BucketDefinitionForJob) for one or more jobs and at least one of those jobs has a status other than CANCELLED. Or the bucket matched the bucket criteria (S3BucketCriteriaForJob) for at least one job that previously ran.

            • FALSE - The bucket isn't explicitly included in the bucket definition (S3BucketDefinitionForJob) for any jobs, all the jobs that explicitly include the bucket in their bucket definitions have a status of CANCELLED, or the bucket didn't match the bucket criteria (S3BucketCriteriaForJob) for any jobs that previously ran.

            • UNKNOWN - An exception occurred when Amazon Macie attempted to retrieve job data for the bucket.

            Possible values include:
            • "TRUE"
            • "FALSE"
            • "UNKNOWN"
          • isMonitoredByJob — (String)

            Specifies whether any recurring jobs are configured to analyze data in the bucket. Possible values are:

            • TRUE - The bucket is explicitly included in the bucket definition (S3BucketDefinitionForJob) for one or more recurring jobs or the bucket matches the bucket criteria (S3BucketCriteriaForJob) for one or more recurring jobs. At least one of those jobs has a status other than CANCELLED.

            • FALSE - The bucket isn't explicitly included in the bucket definition (S3BucketDefinitionForJob) for any recurring jobs, the bucket doesn't match the bucket criteria (S3BucketCriteriaForJob) for any recurring jobs, or all the recurring jobs that are configured to analyze data in the bucket have a status of CANCELLED.

            • UNKNOWN - An exception occurred when Amazon Macie attempted to retrieve job data for the bucket.

            Possible values include:
            • "TRUE"
            • "FALSE"
            • "UNKNOWN"
          • lastJobId — (String)

            The unique identifier for the job that ran most recently and is configured to analyze data in the bucket, either the latest run of a recurring job or the only run of a one-time job.

            This value is typically null if the value for the isDefinedInJob property is FALSE or UNKNOWN.

          • lastJobRunTime — (Date)

            The date and time, in UTC and extended ISO 8601 format, when the job (lastJobId) started. If the job is a recurring job, this value indicates when the most recent run started.

            This value is typically null if the value for the isDefinedInJob property is FALSE or UNKNOWN.

        • lastUpdated — (Date)

          The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most recently retrieved both bucket and object metadata from Amazon S3 for the bucket.

        • objectCount — (Integer)

          The total number of objects in the bucket.

        • objectCountByEncryptionType — (map)

          The total number of objects that are in the bucket, grouped by server-side encryption type. This includes a grouping that reports the total number of objects that aren't encrypted or use client-side encryption.

          • customerManaged — (Integer)

            The total number of objects that are encrypted with a customer-managed key. The objects use customer-provided server-side encryption (SSE-C).

          • kmsManaged — (Integer)

            The total number of objects that are encrypted with an Key Management Service (KMS) customer master key (CMK). The objects use Amazon Web Services managed KMS encryption (AWS-KMS) or customer managed KMS encryption (SSE-KMS).

          • s3Managed — (Integer)

            The total number of objects that are encrypted with an Amazon S3 managed key. The objects use Amazon S3 managed encryption (SSE-S3).

          • unencrypted — (Integer)

            The total number of objects that aren't encrypted or use client-side encryption.

          • unknown — (Integer)

            The total number of objects that Amazon Macie doesn't have current encryption metadata for. Macie can't provide current data about the encryption settings for these objects.

        • publicAccess — (map)

          Specifies whether the bucket is publicly accessible due to the combination of permissions settings that apply to the bucket, and provides information about those settings.

          • effectivePermission — (String)

            Specifies whether the bucket is publicly accessible due to the combination of permissions settings that apply to the bucket. Possible values are:

            • NOT_PUBLIC - The bucket isn't publicly accessible.

            • PUBLIC - The bucket is publicly accessible.

            • UNKNOWN - Amazon Macie can't determine whether the bucket is publicly accessible.

            Possible values include:
            • "PUBLIC"
            • "NOT_PUBLIC"
            • "UNKNOWN"
          • permissionConfiguration — (map)

            The account-level and bucket-level permissions settings for the bucket.

            • accountLevelPermissions — (map)

              The account-level permissions settings that apply to the bucket.

              • blockPublicAccess — (map)

                The block public access settings for the Amazon Web Services account that owns the bucket.

                • blockPublicAcls — (Boolean)

                  Specifies whether Amazon S3 blocks public access control lists (ACLs) for the bucket and objects in the bucket.

                • blockPublicPolicy — (Boolean)

                  Specifies whether Amazon S3 blocks public bucket policies for the bucket.

                • ignorePublicAcls — (Boolean)

                  Specifies whether Amazon S3 ignores public ACLs for the bucket and objects in the bucket.

                • restrictPublicBuckets — (Boolean)

                  Specifies whether Amazon S3 restricts public bucket policies for the bucket.

            • bucketLevelPermissions — (map)

              The bucket-level permissions settings for the bucket.

              • accessControlList — (map)

                The permissions settings of the access control list (ACL) for the bucket. This value is null if an ACL hasn't been defined for the bucket.

                • allowsPublicReadAccess — (Boolean)

                  Specifies whether the ACL grants the general public with read access permissions for the bucket.

                • allowsPublicWriteAccess — (Boolean)

                  Specifies whether the ACL grants the general public with write access permissions for the bucket.

              • blockPublicAccess — (map)

                The block public access settings for the bucket.

                • blockPublicAcls — (Boolean)

                  Specifies whether Amazon S3 blocks public access control lists (ACLs) for the bucket and objects in the bucket.

                • blockPublicPolicy — (Boolean)

                  Specifies whether Amazon S3 blocks public bucket policies for the bucket.

                • ignorePublicAcls — (Boolean)

                  Specifies whether Amazon S3 ignores public ACLs for the bucket and objects in the bucket.

                • restrictPublicBuckets — (Boolean)

                  Specifies whether Amazon S3 restricts public bucket policies for the bucket.

              • bucketPolicy — (map)

                The permissions settings of the bucket policy for the bucket. This value is null if a bucket policy hasn't been defined for the bucket.

                • allowsPublicReadAccess — (Boolean)

                  Specifies whether the bucket policy allows the general public to have read access to the bucket.

                • allowsPublicWriteAccess — (Boolean)

                  Specifies whether the bucket policy allows the general public to have write access to the bucket.

        • region — (String)

          The Amazon Web Services Region that hosts the bucket.

        • replicationDetails — (map)

          Specifies whether the bucket is configured to replicate one or more objects to buckets for other Amazon Web Services accounts and, if so, which accounts.

          • replicated — (Boolean)

            Specifies whether the bucket is configured to replicate one or more objects to any destination.

          • replicatedExternally — (Boolean)

            Specifies whether the bucket is configured to replicate one or more objects to an Amazon Web Services account that isn't part of the same Amazon Macie organization.

          • replicationAccounts — (Array<String>)

            An array of Amazon Web Services account IDs, one for each Amazon Web Services account that the bucket is configured to replicate one or more objects to.

        • serverSideEncryption — (map)

          Specifies whether the bucket encrypts new objects by default and, if so, the type of server-side encryption that's used.

          • kmsMasterKeyId — (String)

            The Amazon Resource Name (ARN) or unique identifier (key ID) for the Key Management Service (KMS) customer master key (CMK) that's used by default to encrypt objects that are added to the bucket. This value is null if the bucket uses an Amazon S3 managed key to encrypt new objects or the bucket doesn't encrypt new objects by default.

          • type — (String)

            The type of server-side encryption that's used by default when storing new objects in the bucket. Possible values are:

            • AES256 - New objects are encrypted with an Amazon S3 managed key and use Amazon S3 managed encryption (SSE-S3).

            • aws:kms - New objects are encrypted with an KMS CMK, specified by the kmsMasterKeyId property, and use Amazon Web Services managed KMS encryption (AWS-KMS) or customer managed KMS encryption (SSE-KMS).

            • NONE - New objects aren't encrypted by default. Default encryption is disabled for the bucket.

            Possible values include:
            • "NONE"
            • "AES256"
            • "aws:kms"
        • sharedAccess — (String)

          Specifies whether the bucket is shared with another Amazon Web Services account. Possible values are:

          • EXTERNAL - The bucket is shared with an Amazon Web Services account that isn't part of the same Amazon Macie organization.

          • INTERNAL - The bucket is shared with an Amazon Web Services account that's part of the same Amazon Macie organization.

          • NOT_SHARED - The bucket isn't shared with other Amazon Web Services accounts.

          • UNKNOWN - Amazon Macie wasn't able to evaluate the shared access settings for the bucket.

          Possible values include:
          • "EXTERNAL"
          • "INTERNAL"
          • "NOT_SHARED"
          • "UNKNOWN"
        • sizeInBytes — (Integer)

          The total storage size, in bytes, of the bucket.

          If versioning is enabled for the bucket, Amazon Macie calculates this value based on the size of the latest version of each object in the bucket. This value doesn't reflect the storage size of all versions of each object in the bucket.

        • sizeInBytesCompressed — (Integer)

          The total storage size, in bytes, of the objects that are compressed (.gz, .gzip, .zip) files in the bucket.

          If versioning is enabled for the bucket, Macie calculates this value based on the size of the latest version of each applicable object in the bucket. This value doesn't reflect the storage size of all versions of each applicable object in the bucket.

        • tags — (Array<map>)

          An array that specifies the tags (keys and values) that are associated with the bucket.

          • key — (String)

            One part of a key-value pair that comprises a tag. A tag key is a general label that acts as a category for more specific tag values.

          • value — (String)

            One part of a key-value pair that comprises a tag. A tag value acts as a descriptor for a tag key. A tag value can be an empty string.

        • unclassifiableObjectCount — (map)

          The total number of objects that Amazon Macie can't analyze in the bucket. These objects don't use a supported storage class or don't have a file name extension for a supported file or storage format.

          • fileType — (Integer)

            The total storage size (in bytes) or number of objects that Amazon Macie can't analyze because the objects don't have a file name extension for a supported file or storage format.

          • storageClass — (Integer)

            The total storage size (in bytes) or number of objects that Amazon Macie can't analyze because the objects use an unsupported storage class.

          • total — (Integer)

            The total storage size (in bytes) or number of objects that Amazon Macie can't analyze because the objects use an unsupported storage class or don't have a file name extension for a supported file or storage format.

        • unclassifiableObjectSizeInBytes — (map)

          The total storage size, in bytes, of the objects that Amazon Macie can't analyze in the bucket. These objects don't use a supported storage class or don't have a file name extension for a supported file or storage format.

          • fileType — (Integer)

            The total storage size (in bytes) or number of objects that Amazon Macie can't analyze because the objects don't have a file name extension for a supported file or storage format.

          • storageClass — (Integer)

            The total storage size (in bytes) or number of objects that Amazon Macie can't analyze because the objects use an unsupported storage class.

          • total — (Integer)

            The total storage size (in bytes) or number of objects that Amazon Macie can't analyze because the objects use an unsupported storage class or don't have a file name extension for a supported file or storage format.

        • versioning — (Boolean)

          Specifies whether versioning is enabled for the bucket.

      • nextToken — (String)

        The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

Returns:

  • (AWS.Request)

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

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

Retrieves the status and settings for a classification job.

Service Reference:

Examples:

Calling the describeClassificationJob operation

var params = {
  jobId: 'STRING_VALUE' /* required */
};
macie2.describeClassificationJob(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: {})
    • jobId — (String)

      The unique identifier for the classification job.

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:

      • clientToken — (String)

        The token that was provided to ensure the idempotency of the request to create the job.

        If a token is not provided, the SDK will use a version 4 UUID.
      • createdAt — (Date)

        The date and time, in UTC and extended ISO 8601 format, when the job was created.

      • customDataIdentifierIds — (Array<String>)

        An array of unique identifiers, one for each custom data identifier that the job uses to analyze data. This value is null if the job uses only managed data identifiers to analyze data.

      • description — (String)

        The custom description of the job.

      • initialRun — (Boolean)

        For a recurring job, specifies whether you configured the job to analyze all existing, eligible objects immediately after the job was created (true). If you configured the job to analyze only those objects that were created or changed after the job was created and before the job's first scheduled run, this value is false. This value is also false for a one-time job.

      • jobArn — (String)

        The Amazon Resource Name (ARN) of the job.

      • jobId — (String)

        The unique identifier for the job.

      • jobStatus — (String)

        The current status of the job. Possible values are:

        • CANCELLED - You cancelled the job or, if it's a one-time job, you paused the job and didn't resume it within 30 days.

        • COMPLETE - For a one-time job, Amazon Macie finished processing the data specified for the job. This value doesn't apply to recurring jobs.

        • IDLE - For a recurring job, the previous scheduled run is complete and the next scheduled run is pending. This value doesn't apply to one-time jobs.

        • PAUSED - Macie started running the job but additional processing would exceed the monthly sensitive data discovery quota for your account or one or more member accounts that the job analyzes data for.

        • RUNNING - For a one-time job, the job is in progress. For a recurring job, a scheduled run is in progress.

        • USER_PAUSED - You paused the job. If you paused the job while it had a status of RUNNING and you don't resume it within 30 days of pausing it, the job or job run will expire and be cancelled, depending on the job's type. To check the expiration date, refer to the UserPausedDetails.jobExpiresAt property.

        Possible values include:
        • "RUNNING"
        • "PAUSED"
        • "CANCELLED"
        • "COMPLETE"
        • "IDLE"
        • "USER_PAUSED"
      • jobType — (String)

        The schedule for running the job. Possible values are:

        • ONE_TIME - The job runs only once.

        • SCHEDULED - The job runs on a daily, weekly, or monthly basis. The scheduleFrequency property indicates the recurrence pattern for the job.

        Possible values include:
        • "ONE_TIME"
        • "SCHEDULED"
      • lastRunErrorStatus — (map)

        Specifies whether any account- or bucket-level access errors occurred when the job ran. For a recurring job, this value indicates the error status of the job's most recent run.

        • code — (String)

          Specifies whether any account- or bucket-level access errors occurred when the job ran. For a recurring job, this value indicates the error status of the job's most recent run. Possible values are:

          • ERROR - One or more errors occurred. Amazon Macie didn't process all the data specified for the job.

          • NONE - No errors occurred. Macie processed all the data specified for the job.

          Possible values include:
          • "NONE"
          • "ERROR"
      • lastRunTime — (Date)

        The date and time, in UTC and extended ISO 8601 format, when the job started. If the job is a recurring job, this value indicates when the most recent run started.

      • managedDataIdentifierIds — (Array<String>)

        An array of unique identifiers, one for each managed data identifier that the job is explicitly configured to include (use) or exclude (not use) when it analyzes data. Inclusion or exclusion depends on the managed data identifier selection type specified for the job (managedDataIdentifierSelector). This value is null if the job's managed data identifier selection type is ALL or the job uses only custom data identifiers (customDataIdentifierIds) to analyze data.

      • managedDataIdentifierSelector — (String)

        The selection type that determines which managed data identifiers the job uses to analyze data. Possible values are:

        • ALL - Use all the managed data identifiers that Amazon Macie provides.

        • EXCLUDE - Use all the managed data identifiers that Macie provides except the managed data identifiers specified by the managedDataIdentifierIds property.

        • INCLUDE - Use only the managed data identifiers specified by the managedDataIdentifierIds property.

        • NONE - Don't use any managed data identifiers.

        If this value is null, the job uses all managed data identifiers. If this value is null, ALL, or EXCLUDE for a recurring job, the job also uses new managed data identifiers as they are released.

        Possible values include:
        • "ALL"
        • "EXCLUDE"
        • "INCLUDE"
        • "NONE"
      • name — (String)

        The custom name of the job.

      • s3JobDefinition — (map)

        The S3 buckets that contain the objects to analyze, and the scope of that analysis.

        • bucketDefinitions — (Array<map>)

          An array of objects, one for each Amazon Web Services account that owns specific S3 buckets to analyze. Each object specifies the account ID for an account and one or more buckets to analyze for that account. A job's definition can contain a bucketDefinitions array or a bucketCriteria object, not both.

          • accountIdrequired — (String)

            The unique identifier for the Amazon Web Services account that owns the buckets.

          • bucketsrequired — (Array<String>)

            An array that lists the names of the buckets.

        • scoping — (map)

          The property- and tag-based conditions that determine which S3 objects to include or exclude from the analysis. Each time the job runs, the job uses these criteria to determine which objects to analyze.

          • excludes — (map)

            The property- and tag-based conditions that determine which objects to exclude from the analysis.

            • and — (Array<map>)

              An array of conditions, one for each property- or tag-based condition that determines which objects to include or exclude from the job. If you specify more than one condition, Amazon Macie uses AND logic to join the conditions.

              • simpleScopeTerm — (map)

                A property-based condition that defines a property, operator, and one or more values for including or excluding objects from the job.

                • comparator — (String)

                  The operator to use in the condition. Valid values for each supported property (key) are:

                  • OBJECT_EXTENSION - EQ (equals) or NE (not equals)

                  • OBJECT_KEY - STARTS_WITH

                  • OBJECT_LAST_MODIFIED_DATE - Any operator except CONTAINS

                  • OBJECT_SIZE - Any operator except CONTAINS

                  Possible values include:
                  • "EQ"
                  • "GT"
                  • "GTE"
                  • "LT"
                  • "LTE"
                  • "NE"
                  • "CONTAINS"
                  • "STARTS_WITH"
                • key — (String)

                  The object property to use in the condition.

                  Possible values include:
                  • "OBJECT_EXTENSION"
                  • "OBJECT_LAST_MODIFIED_DATE"
                  • "OBJECT_SIZE"
                  • "OBJECT_KEY"
                • values — (Array<String>)

                  An array that lists the values to use in the condition. If the value for the key property is OBJECT_EXTENSION or OBJECT_KEY, this array can specify multiple values and Amazon Macie uses OR logic to join the values. Otherwise, this array can specify only one value.

                  Valid values for each supported property (key) are:

                  • OBJECT_EXTENSION - A string that represents the file name extension of an object. For example: docx or pdf

                  • OBJECT_KEY - A string that represents the key prefix (folder name or path) of an object. For example: logs or awslogs/eventlogs. This value applies a condition to objects whose keys (names) begin with the specified value.

                  • OBJECT_LAST_MODIFIED_DATE - The date and time (in UTC and extended ISO 8601 format) when an object was created or last changed, whichever is latest. For example: 2020-09-28T14:31:13Z

                  • OBJECT_SIZE - An integer that represents the storage size (in bytes) of an object.

                  Macie doesn't support use of wildcard characters in these values. Also, string values are case sensitive.

              • tagScopeTerm — (map)

                A tag-based condition that defines the operator and tag keys or tag key and value pairs for including or excluding objects from the job.

                • comparator — (String)

                  The operator to use in the condition. Valid values are EQ (equals) or NE (not equals).

                  Possible values include:
                  • "EQ"
                  • "GT"
                  • "GTE"
                  • "LT"
                  • "LTE"
                  • "NE"
                  • "CONTAINS"
                  • "STARTS_WITH"
                • key — (String)

                  The object property to use in the condition. The only valid value is TAG.

                • tagValues — (Array<map>)

                  The tag keys or tag key and value pairs to use in the condition. To specify only tag keys in a condition, specify the keys in this array and set the value for each associated tag value to an empty string.

                  • key — (String)

                    The value for the tag key to use in the condition.

                  • value — (String)

                    The tag value, associated with the specified tag key (key), to use in the condition. To specify only a tag key for a condition, specify the tag key for the key property and set this value to an empty string.

                • target — (String)

                  The type of object to apply the condition to.

                  Possible values include:
                  • "S3_OBJECT"
          • includes — (map)

            The property- and tag-based conditions that determine which objects to include in the analysis.

            • and — (Array<map>)

              An array of conditions, one for each property- or tag-based condition that determines which objects to include or exclude from the job. If you specify more than one condition, Amazon Macie uses AND logic to join the conditions.

              • simpleScopeTerm — (map)

                A property-based condition that defines a property, operator, and one or more values for including or excluding objects from the job.

                • comparator — (String)

                  The operator to use in the condition. Valid values for each supported property (key) are:

                  • OBJECT_EXTENSION - EQ (equals) or NE (not equals)

                  • OBJECT_KEY - STARTS_WITH

                  • OBJECT_LAST_MODIFIED_DATE - Any operator except CONTAINS

                  • OBJECT_SIZE - Any operator except CONTAINS

                  Possible values include:
                  • "EQ"
                  • "GT"
                  • "GTE"
                  • "LT"
                  • "LTE"
                  • "NE"
                  • "CONTAINS"
                  • "STARTS_WITH"
                • key — (String)

                  The object property to use in the condition.

                  Possible values include:
                  • "OBJECT_EXTENSION"
                  • "OBJECT_LAST_MODIFIED_DATE"
                  • "OBJECT_SIZE"
                  • "OBJECT_KEY"
                • values — (Array<String>)

                  An array that lists the values to use in the condition. If the value for the key property is OBJECT_EXTENSION or OBJECT_KEY, this array can specify multiple values and Amazon Macie uses OR logic to join the values. Otherwise, this array can specify only one value.

                  Valid values for each supported property (key) are:

                  • OBJECT_EXTENSION - A string that represents the file name extension of an object. For example: docx or pdf

                  • OBJECT_KEY - A string that represents the key prefix (folder name or path) of an object. For example: logs or awslogs/eventlogs. This value applies a condition to objects whose keys (names) begin with the specified value.

                  • OBJECT_LAST_MODIFIED_DATE - The date and time (in UTC and extended ISO 8601 format) when an object was created or last changed, whichever is latest. For example: 2020-09-28T14:31:13Z

                  • OBJECT_SIZE - An integer that represents the storage size (in bytes) of an object.

                  Macie doesn't support use of wildcard characters in these values. Also, string values are case sensitive.

              • tagScopeTerm — (map)

                A tag-based condition that defines the operator and tag keys or tag key and value pairs for including or excluding objects from the job.

                • comparator — (String)

                  The operator to use in the condition. Valid values are EQ (equals) or NE (not equals).

                  Possible values include:
                  • "EQ"
                  • "GT"
                  • "GTE"
                  • "LT"
                  • "LTE"
                  • "NE"
                  • "CONTAINS"
                  • "STARTS_WITH"
                • key — (String)

                  The object property to use in the condition. The only valid value is TAG.

                • tagValues — (Array<map>)

                  The tag keys or tag key and value pairs to use in the condition. To specify only tag keys in a condition, specify the keys in this array and set the value for each associated tag value to an empty string.

                  • key — (String)

                    The value for the tag key to use in the condition.

                  • value — (String)

                    The tag value, associated with the specified tag key (key), to use in the condition. To specify only a tag key for a condition, specify the tag key for the key property and set this value to an empty string.

                • target — (String)

                  The type of object to apply the condition to.

                  Possible values include:
                  • "S3_OBJECT"
        • bucketCriteria — (map)

          The property- and tag-based conditions that determine which S3 buckets to include or exclude from the analysis. Each time the job runs, the job uses these criteria to determine which buckets contain objects to analyze. A job's definition can contain a bucketCriteria object or a bucketDefinitions array, not both.

          • excludes — (map)

            The property- and tag-based conditions that determine which buckets to exclude from the job.

            • and — (Array<map>)

              An array of conditions, one for each condition that determines which buckets to include or exclude from the job. If you specify more than one condition, Amazon Macie uses AND logic to join the conditions.

              • simpleCriterion — (map)

                A property-based condition that defines a property, operator, and one or more values for including or excluding buckets from the job.

                • comparator — (String)

                  The operator to use in the condition. Valid values are EQ (equals) and NE (not equals).

                  Possible values include:
                  • "EQ"
                  • "GT"
                  • "GTE"
                  • "LT"
                  • "LTE"
                  • "NE"
                  • "CONTAINS"
                  • "STARTS_WITH"
                • key — (String)

                  The property to use in the condition.

                  Possible values include:
                  • "ACCOUNT_ID"
                  • "S3_BUCKET_NAME"
                  • "S3_BUCKET_EFFECTIVE_PERMISSION"
                  • "S3_BUCKET_SHARED_ACCESS"
                • values — (Array<String>)

                  An array that lists one or more values to use in the condition. If you specify multiple values, Amazon Macie uses OR logic to join the values. Valid values for each supported property (key) are:

                  • ACCOUNT_ID - A string that represents the unique identifier for the Amazon Web Services account that owns the bucket.

                  • S3_BUCKET_EFFECTIVE_PERMISSION - A string that represents an enumerated value that Macie defines for the BucketPublicAccess.effectivePermission property of a bucket.

                  • S3_BUCKET_NAME - A string that represents the name of a bucket.

                  • S3_BUCKET_SHARED_ACCESS - A string that represents an enumerated value that Macie defines for the BucketMetadata.sharedAccess property of a bucket.

                  Values are case sensitive. Also, Macie doesn't support use of partial values or wildcard characters in these values.

              • tagCriterion — (map)

                A tag-based condition that defines an operator and tag keys, tag values, or tag key and value pairs for including or excluding buckets from the job.

                • comparator — (String)

                  The operator to use in the condition. Valid values are EQ (equals) and NE (not equals).

                  Possible values include:
                  • "EQ"
                  • "GT"
                  • "GTE"
                  • "LT"
                  • "LTE"
                  • "NE"
                  • "CONTAINS"
                  • "STARTS_WITH"
                • tagValues — (Array<map>)

                  The tag keys, tag values, or tag key and value pairs to use in the condition.

                  • key — (String)

                    The value for the tag key to use in the condition.

                  • value — (String)

                    The tag value to use in the condition.

          • includes — (map)

            The property- and tag-based conditions that determine which buckets to include in the job.

            • and — (Array<map>)

              An array of conditions, one for each condition that determines which buckets to include or exclude from the job. If you specify more than one condition, Amazon Macie uses AND logic to join the conditions.

              • simpleCriterion — (map)

                A property-based condition that defines a property, operator, and one or more values for including or excluding buckets from the job.

                • comparator — (String)

                  The operator to use in the condition. Valid values are EQ (equals) and NE (not equals).

                  Possible values include:
                  • "EQ"
                  • "GT"
                  • "GTE"
                  • "LT"
                  • "LTE"
                  • "NE"
                  • "CONTAINS"
                  • "STARTS_WITH"
                • key — (String)

                  The property to use in the condition.

                  Possible values include:
                  • "ACCOUNT_ID"
                  • "S3_BUCKET_NAME"
                  • "S3_BUCKET_EFFECTIVE_PERMISSION"
                  • "S3_BUCKET_SHARED_ACCESS"
                • values — (Array<String>)

                  An array that lists one or more values to use in the condition. If you specify multiple values, Amazon Macie uses OR logic to join the values. Valid values for each supported property (key) are:

                  • ACCOUNT_ID - A string that represents the unique identifier for the Amazon Web Services account that owns the bucket.

                  • S3_BUCKET_EFFECTIVE_PERMISSION - A string that represents an enumerated value that Macie defines for the BucketPublicAccess.effectivePermission property of a bucket.

                  • S3_BUCKET_NAME - A string that represents the name of a bucket.

                  • S3_BUCKET_SHARED_ACCESS - A string that represents an enumerated value that Macie defines for the BucketMetadata.sharedAccess property of a bucket.

                  Values are case sensitive. Also, Macie doesn't support use of partial values or wildcard characters in these values.

              • tagCriterion — (map)

                A tag-based condition that defines an operator and tag keys, tag values, or tag key and value pairs for including or excluding buckets from the job.

                • comparator — (String)

                  The operator to use in the condition. Valid values are EQ (equals) and NE (not equals).

                  Possible values include:
                  • "EQ"
                  • "GT"
                  • "GTE"
                  • "LT"
                  • "LTE"
                  • "NE"
                  • "CONTAINS"
                  • "STARTS_WITH"
                • tagValues — (Array<map>)

                  The tag keys, tag values, or tag key and value pairs to use in the condition.

                  • key — (String)

                    The value for the tag key to use in the condition.

                  • value — (String)

                    The tag value to use in the condition.

      • samplingPercentage — (Integer)

        The sampling depth, as a percentage, that determines the percentage of eligible objects that the job analyzes.

      • scheduleFrequency — (map)

        The recurrence pattern for running the job. This value is null if the job is configured to run only once.

        • dailySchedule — (map)

          Specifies a daily recurrence pattern for running the job.

        • monthlySchedule — (map)

          Specifies a monthly recurrence pattern for running the job.

          • dayOfMonth — (Integer)

            The numeric day of the month when Amazon Macie runs the job. This value can be an integer from 1 through 31.

            If this value exceeds the number of days in a certain month, Macie doesn't run the job that month. Macie runs the job only during months that have the specified day. For example, if this value is 31 and a month has only 30 days, Macie doesn't run the job that month. To run the job every month, specify a value that's less than 29.

        • weeklySchedule — (map)

          Specifies a weekly recurrence pattern for running the job.

          • dayOfWeek — (String)

            The day of the week when Amazon Macie runs the job.

            Possible values include:
            • "SUNDAY"
            • "MONDAY"
            • "TUESDAY"
            • "WEDNESDAY"
            • "THURSDAY"
            • "FRIDAY"
            • "SATURDAY"
      • statistics — (map)

        The number of times that the job has run and processing statistics for the job's current run.

        • approximateNumberOfObjectsToProcess — (Float)

          The approximate number of objects that the job has yet to process during its current run.

        • numberOfRuns — (Float)

          The number of times that the job has run.

      • tags — (map<String>)

        A map of key-value pairs that specifies which tags (keys and values) are associated with the classification job.

      • userPausedDetails — (map)

        If the current status of the job is USER_PAUSED, specifies when the job was paused and when the job or job run will expire and be cancelled if it isn't resumed. This value is present only if the value for jobStatus is USER_PAUSED.

        • jobExpiresAt — (Date)

          The date and time, in UTC and extended ISO 8601 format, when the job or job run will expire and be cancelled if you don't resume it first.

        • jobImminentExpirationHealthEventArn — (String)

          The Amazon Resource Name (ARN) of the Health event that Amazon Macie sent to notify you of the job or job run's pending expiration and cancellation. This value is null if a job has been paused for less than 23 days.

        • jobPausedAt — (Date)

          The date and time, in UTC and extended ISO 8601 format, when you paused the job.

Returns:

  • (AWS.Request)

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

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

Retrieves the Amazon Macie configuration settings for an Amazon Web Services organization.

Examples:

Calling the describeOrganizationConfiguration operation

var params = {
};
macie2.describeOrganizationConfiguration(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:

      • autoEnable — (Boolean)

        Specifies whether Amazon Macie is enabled automatically for accounts that are added to the Amazon Web Services organization.

      • maxAccountLimitReached — (Boolean)

        Specifies whether the maximum number of Amazon Macie member accounts are part of the Amazon Web Services organization.

Returns:

  • (AWS.Request)

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

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

Disables an Amazon Macie account and deletes Macie resources for the account.

Service Reference:

Examples:

Calling the disableMacie operation

var params = {
};
macie2.disableMacie(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.

Returns:

  • (AWS.Request)

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

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

Disables an account as the delegated Amazon Macie administrator account for an Amazon Web Services organization.

Service Reference:

Examples:

Calling the disableOrganizationAdminAccount operation

var params = {
  adminAccountId: 'STRING_VALUE' /* required */
};
macie2.disableOrganizationAdminAccount(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 Amazon Web Services account ID of the delegated Amazon Macie 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.

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

Disassociates a member account from its Amazon Macie administrator account.

Examples:

Calling the disassociateFromAdministratorAccount operation

var params = {
};
macie2.disassociateFromAdministratorAccount(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.

Returns:

  • (AWS.Request)

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

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

(Deprecated) Disassociates a member account from its Amazon Macie administrator account. This operation has been replaced by the DisassociateFromAdministratorAccount operation.

Service Reference:

Examples:

Calling the disassociateFromMasterAccount operation

var params = {
};
macie2.disassociateFromMasterAccount(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.

Returns:

  • (AWS.Request)

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

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

Disassociates an Amazon Macie administrator account from a member account.

Service Reference:

Examples:

Calling the disassociateMember operation

var params = {
  id: 'STRING_VALUE' /* required */
};
macie2.disassociateMember(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: {})
    • id — (String)

      The unique identifier for the Amazon Macie resource or account that the request applies 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.

Returns:

  • (AWS.Request)

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

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

Enables Amazon Macie and specifies the configuration settings for a Macie account.

Service Reference:

Examples:

Calling the enableMacie operation

var params = {
  clientToken: 'STRING_VALUE',
  findingPublishingFrequency: FIFTEEN_MINUTES | ONE_HOUR | SIX_HOURS,
  status: PAUSED | ENABLED
};
macie2.enableMacie(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: {})
    • clientToken — (String)

      A unique, case-sensitive token that you provide to ensure the idempotency of the request.

      If a token is not provided, the SDK will use a version 4 UUID.
    • findingPublishingFrequency — (String)

      Specifies how often to publish updates to policy findings for the account. This includes publishing updates to Security Hub and Amazon EventBridge (formerly called Amazon CloudWatch Events).

      Possible values include:
      • "FIFTEEN_MINUTES"
      • "ONE_HOUR"
      • "SIX_HOURS"
    • status — (String)

      Specifies the new status for the account. To enable Amazon Macie and start all Macie activities for the account, set this value to ENABLED.

      Possible values include:
      • "PAUSED"
      • "ENABLED"

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.

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

Designates an account as the delegated Amazon Macie administrator account for an Amazon Web Services organization.

Service Reference:

Examples:

Calling the enableOrganizationAdminAccount operation

var params = {
  adminAccountId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
macie2.enableOrganizationAdminAccount(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 Amazon Web Services account ID for the account to designate as the delegated Amazon Macie administrator account for the organization.

    • clientToken — (String)

      A unique, case-sensitive token that you provide to ensure the idempotency of the request.

      If a token is not provided, the SDK will use a version 4 UUID.

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.

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

Retrieves information about the Amazon Macie administrator account for an account.

Service Reference:

Examples:

Calling the getAdministratorAccount operation

var params = {
};
macie2.getAdministratorAccount(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:

      • administrator — (map)

        The Amazon Web Services account ID for the administrator account. If the accounts are associated by a Macie membership invitation, this object also provides details about the invitation that was sent to establish the relationship between the accounts.

        • accountId — (String)

          The Amazon Web Services account ID for the account that sent the invitation.

        • invitationId — (String)

          The unique identifier for the invitation. Amazon Macie uses this identifier to validate the inviter account with the invitee account.

        • invitedAt — (Date)

          The date and time, in UTC and extended ISO 8601 format, when the invitation was sent.

        • relationshipStatus — (String)

          The status of the relationship between the account that sent the invitation (inviter account) and the account that received the invitation (invitee account).

          Possible values include:
          • "Enabled"
          • "Paused"
          • "Invited"
          • "Created"
          • "Removed"
          • "Resigned"
          • "EmailVerificationInProgress"
          • "EmailVerificationFailed"
          • "RegionDisabled"
          • "AccountSuspended"

Returns:

  • (AWS.Request)

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

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

Retrieves (queries) aggregated statistical data for all the S3 buckets that Amazon Macie monitors and analyzes.

Service Reference:

Examples:

Calling the getBucketStatistics operation

var params = {
  accountId: 'STRING_VALUE'
};
macie2.getBucketStatistics(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: {})
    • accountId — (String)

      The unique identifier for the Amazon Web Services 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:

      • bucketCount — (Integer)

        The total number of buckets.

      • bucketCountByEffectivePermission — (map)

        The total number of buckets that are publicly accessible based on a combination of permissions settings for each bucket.

        • publiclyAccessible — (Integer)

          The total number of buckets that allow the general public to have read or write access to the bucket.

        • publiclyReadable — (Integer)

          The total number of buckets that allow the general public to have read access to the bucket.

        • publiclyWritable — (Integer)

          The total number of buckets that allow the general public to have write access to the bucket.

        • unknown — (Integer)

          The total number of buckets that Amazon Macie wasn't able to evaluate permissions settings for. Macie can't determine whether these buckets are publicly accessible.

      • bucketCountByEncryptionType — (map)

        The total number of buckets that use certain types of server-side encryption to encrypt new objects by default. This object also reports the total number of buckets that don't encrypt new objects by default.

        • kmsManaged — (Integer)

          The total number of buckets that use an Key Management Service (KMS) customer master key (CMK) to encrypt new objects by default. These buckets use Amazon Web Services managed KMS encryption (AWS-KMS) or customer managed KMS encryption (SSE-KMS) by default.

        • s3Managed — (Integer)

          The total number of buckets that use an Amazon S3 managed key to encrypt new objects by default. These buckets use Amazon S3 managed encryption (SSE-S3) by default.

        • unencrypted — (Integer)

          The total number of buckets that don't encrypt new objects by default. Default encryption is disabled for these buckets.

        • unknown — (Integer)

          The total number of buckets that Amazon Macie doesn't have current encryption metadata for. Macie can't provide current data about the default encryption settings for these buckets.

      • bucketCountByObjectEncryptionRequirement — (map)

        The total number of buckets whose bucket policies do or don't require server-side encryption of objects when objects are uploaded to the buckets.

        • allowsUnencryptedObjectUploads — (Integer)

          The total number of buckets that don't have a bucket policy or have a bucket policy that doesn't require server-side encryption of new objects. If a bucket policy exists, the policy doesn't require PutObject requests to include the x-amz-server-side-encryption header and it doesn't require the value for that header to be AES256 or aws:kms.

        • deniesUnencryptedObjectUploads — (Integer)

          The total number of buckets whose bucket policies require server-side encryption of new objects. PutObject requests for these buckets must include the x-amz-server-side-encryption header and the value for that header must be AES256 or aws:kms.

        • unknown — (Integer)

          The total number of buckets that Amazon Macie wasn't able to evaluate server-side encryption requirements for. Macie can't determine whether the bucket policies for these buckets require server-side encryption of new objects.

      • bucketCountBySharedAccessType — (map)

        The total number of buckets that are or aren't shared with another Amazon Web Services account.

        • external — (Integer)

          The total number of buckets that are shared with an Amazon Web Services account that isn't part of the same Amazon Macie organization.

        • internal — (Integer)

          The total number of buckets that are shared with an Amazon Web Services account that's part of the same Amazon Macie organization.

        • notShared — (Integer)

          The total number of buckets that aren't shared with other Amazon Web Services accounts.

        • unknown — (Integer)

          The total number of buckets that Amazon Macie wasn't able to evaluate shared access settings for. Macie can't determine whether these buckets are shared with other Amazon Web Services accounts.

      • classifiableObjectCount — (Integer)

        The total number of objects that Amazon Macie can analyze in the buckets. These objects use a supported storage class and have a file name extension for a supported file or storage format.

      • classifiableSizeInBytes — (Integer)

        The total storage size, in bytes, of all the objects that Amazon Macie can analyze in the buckets. These objects use a supported storage class and have a file name extension for a supported file or storage format.

        If versioning is enabled for any of the buckets, Macie calculates this value based on the size of the latest version of each applicable object in those buckets. This value doesn't reflect the storage size of all versions of all applicable objects in the buckets.

      • lastUpdated — (Date)

        The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most recently retrieved both bucket and object metadata from Amazon S3 for the buckets.

      • objectCount — (Integer)

        The total number of objects in the buckets.

      • sizeInBytes — (Integer)

        The total storage size, in bytes, of the buckets.

        If versioning is enabled for any of the buckets, Macie calculates this value based on the size of the latest version of each object in those buckets. This value doesn't reflect the storage size of all versions of the objects in the buckets.

      • sizeInBytesCompressed — (Integer)

        The total storage size, in bytes, of the objects that are compressed (.gz, .gzip, .zip) files in the buckets.

        If versioning is enabled for any of the buckets, Macie calculates this value based on the size of the latest version of each applicable object in those buckets. This value doesn't reflect the storage size of all versions of the applicable objects in the buckets.

      • unclassifiableObjectCount — (map)

        The total number of objects that Amazon Macie can't analyze in the buckets. These objects don't use a supported storage class or don't have a file name extension for a supported file or storage format.

        • fileType — (Integer)

          The total storage size (in bytes) or number of objects that Amazon Macie can't analyze because the objects don't have a file name extension for a supported file or storage format.

        • storageClass — (Integer)

          The total storage size (in bytes) or number of objects that Amazon Macie can't analyze because the objects use an unsupported storage class.

        • total — (Integer)

          The total storage size (in bytes) or number of objects that Amazon Macie can't analyze because the objects use an unsupported storage class or don't have a file name extension for a supported file or storage format.

      • unclassifiableObjectSizeInBytes — (map)

        The total storage size, in bytes, of the objects that Amazon Macie can't analyze in the buckets. These objects don't use a supported storage class or don't have a file name extension for a supported file or storage format.

        • fileType — (Integer)

          The total storage size (in bytes) or number of objects that Amazon Macie can't analyze because the objects don't have a file name extension for a supported file or storage format.

        • storageClass — (Integer)

          The total storage size (in bytes) or number of objects that Amazon Macie can't analyze because the objects use an unsupported storage class.

        • total — (Integer)

          The total storage size (in bytes) or number of objects that Amazon Macie can't analyze because the objects use an unsupported storage class or don't have a file name extension for a supported file or storage format.

Returns:

  • (AWS.Request)

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

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

Retrieves the configuration settings for storing data classification results.

Examples:

Calling the getClassificationExportConfiguration operation

var params = {
};
macie2.getClassificationExportConfiguration(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:

      • configuration — (map)

        The location where data classification results are stored, and the encryption settings that are used when storing results in that location.

        • s3Destination — (map)

          The S3 bucket to store data classification results in, and the encryption settings to use when storing results in that bucket.

          • bucketNamerequired — (String)

            The name of the bucket.

          • keyPrefix — (String)

            The path prefix to use in the path to the location in the bucket. This prefix specifies where to store classification results in the bucket.

          • kmsKeyArnrequired — (String)

            The Amazon Resource Name (ARN) of the Key Management Service (KMS) customer master key (CMK) to use for encryption of the results. This must be the ARN of an existing CMK that's in the same Amazon Web Services Region as the bucket.

Returns:

  • (AWS.Request)

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

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

Retrieves the criteria and other settings for a custom data identifier.

Service Reference:

Examples:

Calling the getCustomDataIdentifier operation

var params = {
  id: 'STRING_VALUE' /* required */
};
macie2.getCustomDataIdentifier(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: {})
    • id — (String)

      The unique identifier for the Amazon Macie resource or account that the request applies 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:

      • arn — (String)

        The Amazon Resource Name (ARN) of the custom data identifier.

      • createdAt — (Date)

        The date and time, in UTC and extended ISO 8601 format, when the custom data identifier was created.

      • deleted — (Boolean)

        Specifies whether the custom data identifier was deleted. If you delete a custom data identifier, Amazon Macie doesn't delete it permanently. Instead, it soft deletes the identifier.

      • description — (String)

        The custom description of the custom data identifier.

      • id — (String)

        The unique identifier for the custom data identifier.

      • ignoreWords — (Array<String>)

        An array that lists specific character sequences (ignore words) to exclude from the results. If the text matched by the regular expression is the same as any string in this array, Amazon Macie ignores it. Ignore words are case sensitive.

      • keywords — (Array<String>)

        An array that lists specific character sequences (keywords), one of which must be within proximity (maximumMatchDistance) of the regular expression to match. Keywords aren't case sensitive.

      • maximumMatchDistance — (Integer)

        The maximum number of characters that can exist between text that matches the regex pattern and the character sequences specified by the keywords array. Amazon Macie includes or excludes a result based on the proximity of a keyword to text that matches the regex pattern.

      • name — (String)

        The custom name of the custom data identifier.

      • regex — (String)

        The regular expression (regex) that defines the pattern to match.

      • tags — (map<String>)

        A map of key-value pairs that identifies the tags (keys and values) that are associated with the custom data identifier.

Returns:

  • (AWS.Request)

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

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

Retrieves the details of one or more findings.

Service Reference:

Examples:

Calling the getFindings operation

var params = {
  findingIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  sortCriteria: {
    attributeName: 'STRING_VALUE',
    orderBy: ASC | DESC
  }
};
macie2.getFindings(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: {})
    • findingIds — (Array<String>)

      An array of strings that lists the unique identifiers for the findings to retrieve.

    • sortCriteria — (map)

      The criteria for sorting the results of the request.

      • attributeName — (String)

        The name of the property to sort the results by. This value can be the name of any property that Amazon Macie defines for a finding.

      • orderBy — (String)

        The sort order to apply to the results, based on the value for the property specified by the attributeName property. Valid values are: ASC, sort the results in ascending order; and, DESC, sort the results in descending order.

        Possible values include:
        • "ASC"
        • "DESC"

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:

      • findings — (Array<map>)

        An array of objects, one for each finding that meets the criteria specified in the request.

        • accountId — (String)

          The unique identifier for the Amazon Web Services account that the finding applies to. This is typically the account that owns the affected resource.

        • archived — (Boolean)

          Specifies whether the finding is archived (suppressed).

        • category — (String)

          The category of the finding. Possible values are: CLASSIFICATION, for a sensitive data finding; and, POLICY, for a policy finding.

          Possible values include:
          • "CLASSIFICATION"
          • "POLICY"
        • classificationDetails — (map)

          The details of a sensitive data finding. This value is null for a policy finding.

          • detailedResultsLocation — (String)

            The path to the folder or file (in Amazon S3) that contains the corresponding sensitive data discovery result for the finding. If a finding applies to a large archive or compressed file, this value is the path to a folder. Otherwise, this value is the path to a file.

          • jobArn — (String)

            The Amazon Resource Name (ARN) of the classification job that produced the finding.

          • jobId — (String)

            The unique identifier for the classification job that produced the finding.

          • result — (map)

            The status and other details of the finding.

            • additionalOccurrences — (Boolean)

              Specifies whether Amazon Macie detected additional occurrences of sensitive data in the S3 object. A finding includes location data for a maximum of 15 occurrences of sensitive data.

              This value can help you determine whether to investigate additional occurrences of sensitive data in an object. You can do this by referring to the corresponding sensitive data discovery result for the finding (ClassificationDetails.detailedResultsLocation).

            • customDataIdentifiers — (map)

              The custom data identifiers that detected the sensitive data and the number of occurrences of the data that they detected.

              • detections — (Array<map>)

                The custom data identifiers that detected the data, and the number of occurrences of the data that each identifier detected.

                • arn — (String)

                  The Amazon Resource Name (ARN) of the custom data identifier.

                • count — (Integer)

                  The total number of occurrences of the sensitive data that the custom data identifier detected.

                • name — (String)

                  The name of the custom data identifier.

                • occurrences — (map)

                  The location of 1-15 occurrences of the sensitive data that the custom data identifier detected. A finding includes location data for a maximum of 15 occurrences of sensitive data.

                  • cells — (Array<map>)

                    An array of objects, one for each occurrence of sensitive data in a Microsoft Excel workbook, CSV file, or TSV file. This value is null for all other types of files.

                    Each Cell object specifies a cell or field that contains the sensitive data.

                    • cellReference — (String)

                      The location of the cell, as an absolute cell reference, that contains the sensitive data, for example Sheet2!C5 for cell C5 on Sheet2 in a Microsoft Excel workbook. This value is null for CSV and TSV files.

                    • column — (Integer)

                      The column number of the column that contains the sensitive data. For a Microsoft Excel workbook, this value correlates to the alphabetical character(s) for a column identifier, for example: 1 for column A, 2 for column B, and so on.

                    • columnName — (String)

                      The name of the column that contains the sensitive data, if available.

                    • row — (Integer)

                      The row number of the row that contains the sensitive data.

                  • lineRanges — (Array<map>)

                    An array of objects, one for each occurrence of sensitive data in a non-binary text file, such as an HTML, TXT, or XML file. Each Range object specifies a line or inclusive range of lines that contains the sensitive data, and the position of the data on the specified line or lines.

                    This value is often null for file types that are supported by Cell, Page, or Record objects. Exceptions are the location of sensitive data in: unstructured sections of an otherwise structured file, such as a comment in a file; a malformed file that Amazon Macie analyzes as plain text; and, a CSV or TSV file that has any column names that contain sensitive data.

                    • end — (Integer)

                      The number of lines from the beginning of the file to the end of the sensitive data.

                    • start — (Integer)

                      The number of lines from the beginning of the file to the beginning of the sensitive data.

                    • startColumn — (Integer)

                      The number of characters, with spaces and starting from 1, from the beginning of the first line that contains the sensitive data (start) to the beginning of the sensitive data.

                  • offsetRanges — (Array<map>)

                    Reserved for future use.

                    • end — (Integer)

                      The number of lines from the beginning of the file to the end of the sensitive data.

                    • start — (Integer)

                      The number of lines from the beginning of the file to the beginning of the sensitive data.

                    • startColumn — (Integer)

                      The number of characters, with spaces and starting from 1, from the beginning of the first line that contains the sensitive data (start) to the beginning of the sensitive data.

                  • pages — (Array<map>)

                    An array of objects, one for each occurrence of sensitive data in an Adobe Portable Document Format file. This value is null for all other types of files.

                    Each Page object specifies a page that contains the sensitive data.

                    • lineRange — (map)

                      Reserved for future use.

                      • end — (Integer)

                        The number of lines from the beginning of the file to the end of the sensitive data.

                      • start — (Integer)

                        The number of lines from the beginning of the file to the beginning of the sensitive data.

                      • startColumn — (Integer)

                        The number of characters, with spaces and starting from 1, from the beginning of the first line that contains the sensitive data (start) to the beginning of the sensitive data.

                    • offsetRange — (map)

                      Reserved for future use.

                      • end — (Integer)

                        The number of lines from the beginning of the file to the end of the sensitive data.

                      • start — (Integer)

                        The number of lines from the beginning of the file to the beginning of the sensitive data.

                      • startColumn — (Integer)

                        The number of characters, with spaces and starting from 1, from the beginning of the first line that contains the sensitive data (start) to the beginning of the sensitive data.

                    • pageNumber — (Integer)

                      The page number of the page that contains the sensitive data.

                  • records — (Array<map>)

                    An array of objects, one for each occurrence of sensitive data in an Apache Avro object container, Apache Parquet file, JSON file, or JSON Lines file. This value is null for all other types of files.

                    For an Avro object container or Parquet file, each Record object specifies a record index and the path to a field in a record that contains the sensitive data. For a JSON or JSON Lines file, each Record object specifies the path to a field or array that contains the sensitive data. For a JSON Lines file, it also specifies the index of the line that contains the data.

                    • jsonPath — (String)

                      The path, as a JSONPath expression, to the sensitive data. For an Avro object container or Parquet file, this is the path to the field in the record (recordIndex) that contains the data. For a JSON or JSON Lines file, this is the path to the field or array that contains the data. If the data is a value in an array, the path also indicates which value contains the data.

                      If Amazon Macie detects sensitive data in the name of any element in the path, Macie omits this field. If the name of an element exceeds 20 characters, Macie truncates the name by removing characters from the beginning of the name. If the resulting full path exceeds 250 characters, Macie also truncates the path, starting with the first element in the path, until the path contains 250 or fewer characters.

                    • recordIndex — (Integer)

                      For an Avro object container or Parquet file, the record index, starting from 0, for the record that contains the sensitive data. For a JSON Lines file, the line index, starting from 0, for the line that contains the sensitive data. This value is always 0 for JSON files.

              • totalCount — (Integer)

                The total number of occurrences of the data that was detected by the custom data identifiers and produced the finding.

            • mimeType — (String)

              The type of content, as a MIME type, that the finding applies to. For example, application/gzip, for a GNU Gzip compressed archive file, or application/pdf, for an Adobe Portable Document Format file.

            • sensitiveData — (Array<map>)

              The category, types, and number of occurrences of the sensitive data that produced the finding.

              • category — (String)

                The category of sensitive data that was detected. For example: CREDENTIALS, for credentials data such as private keys or Amazon Web Services secret keys; FINANCIAL_INFORMATION, for financial data such as credit card numbers; or, PERSONAL_INFORMATION, for personal health information, such as health insurance identification numbers, or personally identifiable information, such as passport numbers.

                Possible values include:
                • "FINANCIAL_INFORMATION"
                • "PERSONAL_INFORMATION"
                • "CREDENTIALS"
                • "CUSTOM_IDENTIFIER"
              • detections — (Array<map>)

                An array of objects, one for each type of sensitive data that was detected. Each object reports the number of occurrences of a specific type of sensitive data that was detected, and the location of up to 15 of those occurrences.

                • count — (Integer)

                  The total number of occurrences of the type of sensitive data that was detected.

                • occurrences — (map)

                  The location of 1-15 occurrences of the sensitive data that was detected. A finding includes location data for a maximum of 15 occurrences of sensitive data.

                  • cells — (Array<map>)

                    An array of objects, one for each occurrence of sensitive data in a Microsoft Excel workbook, CSV file, or TSV file. This value is null for all other types of files.

                    Each Cell object specifies a cell or field that contains the sensitive data.

                    • cellReference — (String)

                      The location of the cell, as an absolute cell reference, that contains the sensitive data, for example Sheet2!C5 for cell C5 on Sheet2 in a Microsoft Excel workbook. This value is null for CSV and TSV files.

                    • column — (Integer)

                      The column number of the column that contains the sensitive data. For a Microsoft Excel workbook, this value correlates to the alphabetical character(s) for a column identifier, for example: 1 for column A, 2 for column B, and so on.

                    • columnName — (String)

                      The name of the column that contains the sensitive data, if available.

                    • row — (Integer)

                      The row number of the row that contains the sensitive data.

                  • lineRanges — (Array<map>)

                    An array of objects, one for each occurrence of sensitive data in a non-binary text file, such as an HTML, TXT, or XML file. Each Range object specifies a line or inclusive range of lines that contains the sensitive data, and the position of the data on the specified line or lines.

                    This value is often null for file types that are supported by Cell, Page, or Record objects. Exceptions are the location of sensitive data in: unstructured sections of an otherwise structured file, such as a comment in a file; a malformed file that Amazon Macie analyzes as plain text; and, a CSV or TSV file that has any column names that contain sensitive data.

                    • end — (Integer)

                      The number of lines from the beginning of the file to the end of the sensitive data.

                    • start — (Integer)

                      The number of lines from the beginning of the file to the beginning of the sensitive data.

                    • startColumn — (Integer)

                      The number of characters, with spaces and starting from 1, from the beginning of the first line that contains the sensitive data (start) to the beginning of the sensitive data.

                  • offsetRanges — (Array<map>)

                    Reserved for future use.

                    • end — (Integer)

                      The number of lines from the beginning of the file to the end of the sensitive data.

                    • start — (Integer)

                      The number of lines from the beginning of the file to the beginning of the sensitive data.

                    • startColumn — (Integer)

                      The number of characters, with spaces and starting from 1, from the beginning of the first line that contains the sensitive data (start) to the beginning of the sensitive data.

                  • pages — (Array<map>)

                    An array of objects, one for each occurrence of sensitive data in an Adobe Portable Document Format file. This value is null for all other types of files.

                    Each Page object specifies a page that contains the sensitive data.

                    • lineRange — (map)

                      Reserved for future use.

                      • end — (Integer)

                        The number of lines from the beginning of the file to the end of the sensitive data.

                      • start — (Integer)

                        The number of lines from the beginning of the file to the beginning of the sensitive data.

                      • startColumn — (Integer)

                        The number of characters, with spaces and starting from 1, from the beginning of the first line that contains the sensitive data (start) to the beginning of the sensitive data.

                    • offsetRange — (map)

                      Reserved for future use.

                      • end — (Integer)

                        The number of lines from the beginning of the file to the end of the sensitive data.

                      • start — (Integer)

                        The number of lines from the beginning of the file to the beginning of the sensitive data.

                      • startColumn — (Integer)

                        The number of characters, with spaces and starting from 1, from the beginning of the first line that contains the sensitive data (start) to the beginning of the sensitive data.

                    • pageNumber — (Integer)

                      The page number of the page that contains the sensitive data.

                  • records — (Array<map>)

                    An array of objects, one for each occurrence of sensitive data in an Apache Avro object container, Apache Parquet file, JSON file, or JSON Lines file. This value is null for all other types of files.

                    For an Avro object container or Parquet file, each Record object specifies a record index and the path to a field in a record that contains the sensitive data. For a JSON or JSON Lines file, each Record object specifies the path to a field or array that contains the sensitive data. For a JSON Lines file, it also specifies the index of the line that contains the data.

                    • jsonPath — (String)

                      The path, as a JSONPath expression, to the sensitive data. For an Avro object container or Parquet file, this is the path to the field in the record (recordIndex) that contains the data. For a JSON or JSON Lines file, this is the path to the field or array that contains the data. If the data is a value in an array, the path also indicates which value contains the data.

                      If Amazon Macie detects sensitive data in the name of any element in the path, Macie omits this field. If the name of an element exceeds 20 characters, Macie truncates the name by removing characters from the beginning of the name. If the resulting full path exceeds 250 characters, Macie also truncates the path, starting with the first element in the path, until the path contains 250 or fewer characters.

                    • recordIndex — (Integer)

                      For an Avro object container or Parquet file, the record index, starting from 0, for the record that contains the sensitive data. For a JSON Lines file, the line index, starting from 0, for the line that contains the sensitive data. This value is always 0 for JSON files.

                • type — (String)

                  The type of sensitive data that was detected. For example, AWS_CREDENTIALS, PHONE_NUMBER, or ADDRESS.

              • totalCount — (Integer)

                The total number of occurrences of the sensitive data that was detected.

            • sizeClassified — (Integer)

              The total size, in bytes, of the data that the finding applies to.

            • status — (map)

              The status of the finding.

              • code — (String)

                The status of the finding. Possible values are:

                • COMPLETE - Amazon Macie successfully completed its analysis of the S3 object that the finding applies to.

                • PARTIAL - Macie analyzed only a subset of the data in the S3 object that the finding applies to. For example, the object is an archive file that contains files in an unsupported format.

                • SKIPPED - Macie wasn't able to analyze the S3 object that the finding applies to. For example, the object is a file in an unsupported format.

              • reason — (String)

                A brief description of the status of the finding. Amazon Macie uses this value to notify you of any errors, warnings, or considerations that might impact your analysis of the finding.

        • count — (Integer)

          The total number of occurrences of the finding. For sensitive data findings, this value is always 1. All sensitive data findings are considered new (unique) because they derive from individual classification jobs.

        • createdAt — (Date)

          The date and time, in UTC and extended ISO 8601 format, when the finding was created.

        • description — (String)

          The description of the finding.

        • id — (String)

          The unique identifier for the finding. This is a random string that Amazon Macie generates and assigns to a finding when it creates the finding.

        • partition — (String)

          The Amazon Web Services partition that Amazon Macie created the finding in.

        • policyDetails — (map)

          The details of a policy finding. This value is null for a sensitive data finding.

          • action — (map)

            The action that produced the finding.

            • actionType — (String)

              The type of action that occurred for the affected resource. This value is typically AWS_API_CALL, which indicates that an entity invoked an API operation for the resource.

              Possible values include:
              • "AWS_API_CALL"
            • apiCallDetails — (map)

              The invocation details of the API operation that an entity invoked for the affected resource, if the value for the actionType property is AWS_API_CALL.

              • api — (String)

                The name of the operation that was invoked most recently and produced the finding.

              • apiServiceName — (String)

                The URL of the Amazon Web Service that provides the operation, for example: s3.amazonaws.com.

              • firstSeen — (Date)

                The first date and time, in UTC and extended ISO 8601 format, when any operation was invoked and produced the finding.

              • lastSeen — (Date)

                The most recent date and time, in UTC and extended ISO 8601 format, when the specified operation (api) was invoked and produced the finding.

          • actor — (map)

            The entity that performed the action that produced the finding.

            • domainDetails — (map)

              The domain name of the device that the entity used to perform the action on the affected resource.

              • domainName — (String)

                The name of the domain.

            • ipAddressDetails — (map)

              The IP address of the device that the entity used to perform the action on the affected resource. This object also provides information such as the owner and geographic location for the IP address.

              • ipAddressV4 — (String)

                The Internet Protocol version 4 (IPv4) address of the device.

              • ipCity — (map)

                The city that the IP address originated from.

                • name — (String)

                  The name of the city.

              • ipCountry — (map)

                The country that the IP address originated from.

                • code — (String)

                  The two-character code, in ISO 3166-1 alpha-2 format, for the country that the IP address originated from. For example, US for the United States.

                • name — (String)

                  The name of the country that the IP address originated from.

              • ipGeoLocation — (map)

                The geographic coordinates of the location that the IP address originated from.

                • lat — (Float)

                  The latitude coordinate of the location, rounded to four decimal places.

                • lon — (Float)

                  The longitude coordinate of the location, rounded to four decimal places.

              • ipOwner — (map)

                The registered owner of the IP address.

                • asn — (String)

                  The autonomous system number (ASN) for the autonomous system that included the IP address.

                • asnOrg — (String)

                  The organization identifier that's associated with the autonomous system number (ASN) for the autonomous system that included the IP address.

                • isp — (String)

                  The name of the internet service provider (ISP) that owned the IP address.

                • org — (String)

                  The name of the organization that owned the IP address.

            • userIdentity — (map)

              The type and other characteristics of the entity that performed the action on the affected resource.

              • assumedRole — (map)

                If the action was performed with temporary security credentials that were obtained using the AssumeRole operation of the Security Token Service (STS) API, the identifiers, session context, and other details about the identity.

                • accessKeyId — (String)

                  The Amazon Web Services access key ID that identifies the credentials.

                • accountId — (String)

                  The unique identifier for the Amazon Web Services account that owns the entity that was used to get the credentials.

                • arn — (String)

                  The Amazon Resource Name (ARN) of the entity that was used to get the credentials.

                • principalId — (String)

                  The unique identifier for the entity that was used to get the credentials.

                • sessionContext — (map)

                  The details of the session that was created for the credentials, including the entity that issued the session.

                  • attributes — (map)

                    The date and time when the credentials were issued, and whether the credentials were authenticated with a multi-factor authentication (MFA) device.

                    • creationDate — (Date)

                      The date and time, in UTC and ISO 8601 format, when the credentials were issued.

                    • mfaAuthenticated — (Boolean)

                      Specifies whether the credentials were authenticated with a multi-factor authentication (MFA) device.

                  • sessionIssuer — (map)

                    The source and type of credentials that were issued to the entity.

                    • accountId — (String)

                      The unique identifier for the Amazon Web Services account that owns the entity that was used to get the credentials.

                    • arn — (String)

                      The Amazon Resource Name (ARN) of the source account, IAM user, or role that was used to get the credentials.

                    • principalId — (String)

                      The unique identifier for the entity that was used to get the credentials.

                    • type — (String)

                      The source of the temporary security credentials, such as Root, IAMUser, or Role.

                    • userName — (String)

                      The name or alias of the user or role that issued the session. This value is null if the credentials were obtained from a root account that doesn't have an alias.

              • awsAccount — (map)

                If the action was performed using the credentials for another Amazon Web Services account, the details of that account.

                • accountId — (String)

                  The unique identifier for the Amazon Web Services account.

                • principalId — (String)

                  The unique identifier for the entity that performed the action.

              • awsService — (map)

                If the action was performed by an Amazon Web Services account that belongs to an Amazon Web Service, the name of the service.

                • invokedBy — (String)

                  The name of the Amazon Web Service that performed the action.

              • federatedUser — (map)

                If the action was performed with temporary security credentials that were obtained using the GetFederationToken operation of the Security Token Service (STS) API, the identifiers, session context, and other details about the identity.

                • accessKeyId — (String)

                  The Amazon Web Services access key ID that identifies the credentials.

                • accountId — (String)

                  The unique identifier for the Amazon Web Services account that owns the entity that was used to get the credentials.

                • arn — (String)

                  The Amazon Resource Name (ARN) of the entity that was used to get the credentials.

                • principalId — (String)

                  The unique identifier for the entity that was used to get the credentials.

                • sessionContext — (map)

                  The details of the session that was created for the credentials, including the entity that issued the session.

                  • attributes — (map)

                    The date and time when the credentials were issued, and whether the credentials were authenticated with a multi-factor authentication (MFA) device.

                    • creationDate — (Date)

                      The date and time, in UTC and ISO 8601 format, when the credentials were issued.

                    • mfaAuthenticated — (Boolean)

                      Specifies whether the credentials were authenticated with a multi-factor authentication (MFA) device.

                  • sessionIssuer — (map)

                    The source and type of credentials that were issued to the entity.

                    • accountId — (String)

                      The unique identifier for the Amazon Web Services account that owns the entity that was used to get the credentials.

                    • arn — (String)

                      The Amazon Resource Name (ARN) of the source account, IAM user, or role that was used to get the credentials.

                    • principalId — (String)

                      The unique identifier for the entity that was used to get the credentials.

                    • type — (String)

                      The source of the temporary security credentials, such as Root, IAMUser, or Role.

                    • userName — (String)

                      The name or alias of the user or role that issued the session. This value is null if the credentials were obtained from a root account that doesn't have an alias.

              • iamUser — (map)

                If the action was performed using the credentials for an Identity and Access Management (IAM) user, the name and other details about the user.

                • accountId — (String)

                  The unique identifier for the Amazon Web Services account that's associated with the IAM user who performed the action.

                • arn — (String)

                  The Amazon Resource Name (ARN) of the principal that performed the action. The last section of the ARN contains the name of the user who performed the action.

                • principalId — (String)

                  The unique identifier for the IAM user who performed the action.

                • userName — (String)

                  The user name of the IAM user who performed the action.

              • root — (map)

                If the action was performed using the credentials for your Amazon Web Services account, the details of your account.

                • accountId — (String)

                  The unique identifier for the Amazon Web Services account.

                • arn — (String)

                  The Amazon Resource Name (ARN) of the principal that performed the action. The last section of the ARN contains the name of the user or role that performed the action.

                • principalId — (String)

                  The unique identifier for the entity that performed the action.

              • type — (String)

                The type of entity that performed the action.

                Possible values include:
                • "AssumedRole"
                • "IAMUser"
                • "FederatedUser"
                • "Root"
                • "AWSAccount"
                • "AWSService"
        • region — (String)

          The Amazon Web Services Region that Amazon Macie created the finding in.

        • resourcesAffected — (map)

          The resources that the finding applies to.

          • s3Bucket — (map)

            The details of the S3 bucket that the finding applies to.

            • allowsUnencryptedObjectUploads — (String)

              Specifies whether the bucket policy for the bucket requires server-side encryption of objects when objects are uploaded to the bucket. Possible values are:

              • FALSE - The bucket policy requires server-side encryption of new objects. PutObject requests must include the x-amz-server-side-encryption header and the value for that header must be AES256 or aws:kms.

              • TRUE - The bucket doesn't have a bucket policy or it has a bucket policy that doesn't require server-side encryption of new objects. If a bucket policy exists, it doesn't require PutObject requests to include the x-amz-server-side-encryption header and it doesn't require the value for that header to be AES256 or aws:kms.

              • UNKNOWN - Amazon Macie can't determine whether the bucket policy requires server-side encryption of objects.

              Possible values include:
              • "TRUE"
              • "FALSE"
              • "UNKNOWN"
            • arn — (String)

              The Amazon Resource Name (ARN) of the bucket.

            • createdAt — (Date)

              The date and time, in UTC and extended ISO 8601 format, when the bucket was created.

            • defaultServerSideEncryption — (map)

              The type of server-side encryption that's used by default to encrypt objects in the bucket.

              • encryptionType — (String)

                The server-side encryption algorithm that's used when storing data in the bucket or object. If default encryption is disabled for the bucket or the object isn't encrypted using server-side encryption, this value is NONE.

                Possible values include:
                • "NONE"
                • "AES256"
                • "aws:kms"
                • "UNKNOWN"
              • kmsMasterKeyId — (String)

                The Amazon Resource Name (ARN) or unique identifier (key ID) for the Key Management Service (KMS) customer master key (CMK) that's used to encrypt data in the bucket or the object. If an KMS CMK isn't used, this value is null.

            • name — (String)

              The name of the bucket.

            • owner — (map)

              The display name and canonical user ID for the Amazon Web Services account that owns the bucket.

              • displayName — (String)

                The display name of the account that owns the bucket.

              • id — (String)

                The canonical user ID for the account that owns the bucket.

            • publicAccess — (map)

              The permissions settings that determine whether the bucket is publicly accessible.

              • effectivePermission — (String)

                Specifies whether the bucket is publicly accessible due to the combination of permissions settings that apply to the bucket. Possible values are:

                • NOT_PUBLIC - The bucket isn't publicly accessible.

                • PUBLIC - The bucket is publicly accessible.

                • UNKNOWN - Amazon Macie can't determine whether the bucket is publicly accessible.

                Possible values include:
                • "PUBLIC"
                • "NOT_PUBLIC"
                • "UNKNOWN"
              • permissionConfiguration — (map)

                The account-level and bucket-level permissions settings for the bucket.

                • accountLevelPermissions — (map)

                  The account-level permissions settings that apply to the bucket.

                  • blockPublicAccess — (map)

                    The block public access settings for the Amazon Web Services account that owns the bucket.

                    • blockPublicAcls — (Boolean)

                      Specifies whether Amazon S3 blocks public access control lists (ACLs) for the bucket and objects in the bucket.

                    • blockPublicPolicy — (Boolean)

                      Specifies whether Amazon S3 blocks public bucket policies for the bucket.

                    • ignorePublicAcls — (Boolean)

                      Specifies whether Amazon S3 ignores public ACLs for the bucket and objects in the bucket.

                    • restrictPublicBuckets — (Boolean)

                      Specifies whether Amazon S3 restricts public bucket policies for the bucket.

                • bucketLevelPermissions — (map)

                  The bucket-level permissions settings for the bucket.

                  • accessControlList — (map)

                    The permissions settings of the access control list (ACL) for the bucket. This value is null if an ACL hasn't been defined for the bucket.

                    • allowsPublicReadAccess — (Boolean)

                      Specifies whether the ACL grants the general public with read access permissions for the bucket.

                    • allowsPublicWriteAccess — (Boolean)

                      Specifies whether the ACL grants the general public with write access permissions for the bucket.

                  • blockPublicAccess — (map)

                    The block public access settings for the bucket.

                    • blockPublicAcls — (Boolean)

                      Specifies whether Amazon S3 blocks public access control lists (ACLs) for the bucket and objects in the bucket.

                    • blockPublicPolicy — (Boolean)

                      Specifies whether Amazon S3 blocks public bucket policies for the bucket.

                    • ignorePublicAcls — (Boolean)

                      Specifies whether Amazon S3 ignores public ACLs for the bucket and objects in the bucket.

                    • restrictPublicBuckets — (Boolean)

                      Specifies whether Amazon S3 restricts public bucket policies for the bucket.

                  • bucketPolicy — (map)

                    The permissions settings of the bucket policy for the bucket. This value is null if a bucket policy hasn't been defined for the bucket.

                    • allowsPublicReadAccess — (Boolean)

                      Specifies whether the bucket policy allows the general public to have read access to the bucket.

                    • allowsPublicWriteAccess — (Boolean)

                      Specifies whether the bucket policy allows the general public to have write access to the bucket.

            • tags — (Array<map>)

              The tags that are associated with the bucket.

              • key — (String)

                One part of a key-value pair that comprises a tag. A tag key is a general label that acts as a category for more specific tag values.

              • value — (String)

                One part of a key-value pair that comprises a tag. A tag value acts as a descriptor for a tag key. A tag value can be an empty string.

          • s3Object — (map)

            The details of the S3 object that the finding applies to.

            • bucketArn — (String)

              The Amazon Resource Name (ARN) of the bucket that contains the object.

            • eTag — (String)

              The entity tag (ETag) that identifies the affected version of the object. If the object was overwritten or changed after Amazon Macie produced the finding, this value might be different from the current ETag for the object.

            • extension — (String)

              The file name extension of the object. If the object doesn't have a file name extension, this value is "".

            • key — (String)

              The full key (name) that's assigned to the object.

            • lastModified — (Date)

              The date and time, in UTC and extended ISO 8601 format, when the object was last modified.

            • path — (String)

              The path to the object, including the full key (name).

            • publicAccess — (Boolean)

              Specifies whether the object is publicly accessible due to the combination of permissions settings that apply to the object.

            • serverSideEncryption — (map)

              The type of server-side encryption that's used to encrypt the object.

              • encryptionType — (String)

                The server-side encryption algorithm that's used when storing data in the bucket or object. If default encryption is disabled for the bucket or the object isn't encrypted using server-side encryption, this value is NONE.

                Possible values include:
                • "NONE"
                • "AES256"
                • "aws:kms"
                • "UNKNOWN"
              • kmsMasterKeyId — (String)

                The Amazon Resource Name (ARN) or unique identifier (key ID) for the Key Management Service (KMS) customer master key (CMK) that's used to encrypt data in the bucket or the object. If an KMS CMK isn't used, this value is null.

            • size — (Integer)

              The total storage size, in bytes, of the object.

            • storageClass — (String)

              The storage class of the object.

              Possible values include:
              • "STANDARD"
              • "REDUCED_REDUNDANCY"
              • "STANDARD_IA"
              • "INTELLIGENT_TIERING"
              • "DEEP_ARCHIVE"
              • "ONEZONE_IA"
              • "GLACIER"
            • tags — (Array<map>)

              The tags that are associated with the object.

              • key — (String)

                One part of a key-value pair that comprises a tag. A tag key is a general label that acts as a category for more specific tag values.

              • value — (String)

                One part of a key-value pair that comprises a tag. A tag value acts as a descriptor for a tag key. A tag value can be an empty string.

            • versionId — (String)

              The identifier for the affected version of the object.

        • sample — (Boolean)

          Specifies whether the finding is a sample finding. A sample finding is a finding that uses example data to demonstrate what a finding might contain.

        • schemaVersion — (String)

          The version of the schema that was used to define the data structures in the finding.

        • severity — (map)

          The severity level and score for the finding.

          • description — (String)

            The qualitative representation of the finding's severity, ranging from Low (least severe) to High (most severe).

            Possible values include:
            • "Low"
            • "Medium"
            • "High"
          • score — (Integer)

            The numerical representation of the finding's severity, ranging from 1 (least severe) to 3 (most severe).

        • title — (String)

          The brief description of the finding.

        • type — (String)

          The type of the finding.

          Possible values include:
          • "SensitiveData:S3Object/Multiple"
          • "SensitiveData:S3Object/Financial"
          • "SensitiveData:S3Object/Personal"
          • "SensitiveData:S3Object/Credentials"
          • "SensitiveData:S3Object/CustomIdentifier"
          • "Policy:IAMUser/S3BucketPublic"
          • "Policy:IAMUser/S3BucketSharedExternally"
          • "Policy:IAMUser/S3BucketReplicatedExternally"
          • "Policy:IAMUser/S3BucketEncryptionDisabled"
          • "Policy:IAMUser/S3BlockPublicAccessDisabled"
        • updatedAt — (Date)

          The date and time, in UTC and extended ISO 8601 format, when the finding was last updated. For sensitive data findings, this value is the same as the value for the createdAt property. All sensitive data findings are considered new (unique) because they derive from individual classification jobs.

Returns:

  • (AWS.Request)

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

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

Retrieves the criteria and other settings for a findings filter.

Service Reference:

Examples:

Calling the getFindingsFilter operation

var params = {
  id: 'STRING_VALUE' /* required */
};
macie2.getFindingsFilter(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: {})
    • id — (String)

      The unique identifier for the Amazon Macie resource or account that the request applies 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:

      • action — (String)

        The action that's performed on findings that meet the filter criteria (findingCriteria). Possible values are: ARCHIVE, suppress (automatically archive) the findings; and, NOOP, don't perform any action on the findings.

        Possible values include:
        • "ARCHIVE"
        • "NOOP"
      • arn — (String)

        The Amazon Resource Name (ARN) of the filter.

      • description — (String)

        The custom description of the filter.

      • findingCriteria — (map)

        The criteria that's used to filter findings.

        • criterion — (map<map>)

          A condition that specifies the property, operator, and one or more values to use to filter the results.

          • eq — (Array<String>)

            The value for the property matches (equals) the specified value. If you specify multiple values, Macie uses OR logic to join the values.

          • eqExactMatch — (Array<String>)

            The value for the property exclusively matches (equals an exact match for) all the specified values. If you specify multiple values, Amazon Macie uses AND logic to join the values.

            You can use this operator with the following properties: customDataIdentifiers.detections.arn, customDataIdentifiers.detections.name, resourcesAffected.s3Bucket.tags.key, resourcesAffected.s3Bucket.tags.value, resourcesAffected.s3Object.tags.key, resourcesAffected.s3Object.tags.value, sensitiveData.category, and sensitiveData.detections.type.

          • gt — (Integer)

            The value for the property is greater than the specified value.

          • gte — (Integer)

            The value for the property is greater than or equal to the specified value.

          • lt — (Integer)

            The value for the property is less than the specified value.

          • lte — (Integer)

            The value for the property is less than or equal to the specified value.

          • neq — (Array<String>)

            The value for the property doesn't match (doesn't equal) the specified value. If you specify multiple values, Macie uses OR logic to join the values.

      • id — (String)

        The unique identifier for the filter.

      • name — (String)

        The custom name of the filter.

      • position — (Integer)

        The position of the filter in the list of saved filters on the Amazon Macie console. This value also determines the order in which the filter is applied to findings, relative to other filters that are also applied to the findings.

      • tags — (map<String>)

        A map of key-value pairs that identifies the tags (keys and values) that are associated with the filter.

Returns:

  • (AWS.Request)

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

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

Retrieves the configuration settings for publishing findings to Security Hub.

Examples:

Calling the getFindingsPublicationConfiguration operation

var params = {
};
macie2.getFindingsPublicationConfiguration(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:

      • securityHubConfiguration — (map)

        The configuration settings that determine which findings are published to Security Hub.

        • publishClassificationFindingsrequired — (Boolean)

          Specifies whether to publish sensitive data findings to Security Hub. If you set this value to true, Amazon Macie automatically publishes all sensitive data findings that weren't suppressed by a findings filter. The default value is false.

        • publishPolicyFindingsrequired — (Boolean)

          Specifies whether to publish policy findings to Security Hub. If you set this value to true, Amazon Macie automatically publishes all new and updated policy findings that weren't suppressed by a findings filter. The default value is true.

Returns:

  • (AWS.Request)

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

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

Retrieves (queries) aggregated statistical data about findings.

Service Reference:

Examples:

Calling the getFindingStatistics operation

var params = {
  groupBy: resourcesAffected.s3Bucket.name | type | classificationDetails.jobId | severity.description, /* required */
  findingCriteria: {
    criterion: {
      '<__string>': {
        eq: [
          'STRING_VALUE',
          /* more items */
        ],
        eqExactMatch: [
          'STRING_VALUE',
          /* more items */
        ],
        gt: 'NUMBER_VALUE',
        gte: 'NUMBER_VALUE',
        lt: 'NUMBER_VALUE',
        lte: 'NUMBER_VALUE',
        neq: [
          'STRING_VALUE',
          /* more items */
        ]
      },
      /* '<__string>': ... */
    }
  },
  size: 'NUMBER_VALUE',
  sortCriteria: {
    attributeName: groupKey | count,
    orderBy: ASC | DESC
  }
};
macie2.getFindingStatistics(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: {})
    • findingCriteria — (map)

      The criteria to use to filter the query results.

      • criterion — (map<map>)

        A condition that specifies the property, operator, and one or more values to use to filter the results.

        • eq — (Array<String>)

          The value for the property matches (equals) the specified value. If you specify multiple values, Macie uses OR logic to join the values.

        • eqExactMatch — (Array<String>)

          The value for the property exclusively matches (equals an exact match for) all the specified values. If you specify multiple values, Amazon Macie uses AND logic to join the values.

          You can use this operator with the following properties: customDataIdentifiers.detections.arn, customDataIdentifiers.detections.name, resourcesAffected.s3Bucket.tags.key, resourcesAffected.s3Bucket.tags.value, resourcesAffected.s3Object.tags.key, resourcesAffected.s3Object.tags.value, sensitiveData.category, and sensitiveData.detections.type.

        • gt — (Integer)

          The value for the property is greater than the specified value.

        • gte — (Integer)

          The value for the property is greater than or equal to the specified value.

        • lt — (Integer)

          The value for the property is less than the specified value.

        • lte — (Integer)

          The value for the property is less than or equal to the specified value.

        • neq — (Array<String>)

          The value for the property doesn't match (doesn't equal) the specified value. If you specify multiple values, Macie uses OR logic to join the values.

    • groupBy — (String)

      The finding property to use to group the query results. Valid values are:

      • classificationDetails.jobId - The unique identifier for the classification job that produced the finding.

      • resourcesAffected.s3Bucket.name - The name of the S3 bucket that the finding applies to.

      • severity.description - The severity level of the finding, such as High or Medium.

      • type - The type of finding, such as Policy:IAMUser/S3BucketPublic and SensitiveData:S3Object/Personal.

      Possible values include:
      • "resourcesAffected.s3Bucket.name"
      • "type"
      • "classificationDetails.jobId"
      • "severity.description"
    • size — (Integer)

      The maximum number of items to include in each page of the response.

    • sortCriteria — (map)

      The criteria to use to sort the query results.

      • attributeName — (String)

        The grouping to sort the results by. Valid values are: count, sort the results by the number of findings in each group of results; and, groupKey, sort the results by the name of each group of results.

        Possible values include:
        • "groupKey"
        • "count"
      • orderBy — (String)

        The sort order to apply to the results, based on the value for the property specified by the attributeName property. Valid values are: ASC, sort the results in ascending order; and, DESC, sort the results in descending order.

        Possible values include:
        • "ASC"
        • "DESC"

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:

      • countsByGroup — (Array<map>)

        An array of objects, one for each group of findings that meet the filter criteria specified in the request.

        • count — (Integer)

          The total number of findings in the group of query results.

        • groupKey — (String)

          The name of the property that defines the group in the query results, as specified by the groupBy property in the query request.

Returns:

  • (AWS.Request)

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

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

Retrieves the count of Amazon Macie membership invitations that were received by an account.

Service Reference:

Examples:

Calling the getInvitationsCount operation

var params = {
};
macie2.getInvitationsCount(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:

      • invitationsCount — (Integer)

        The total number of invitations that were received by the account, not including the currently accepted invitation.

Returns:

  • (AWS.Request)

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

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

Retrieves the current status and configuration settings for an Amazon Macie account.

Service Reference:

Examples:

Calling the getMacieSession operation

var params = {
};
macie2.getMacieSession(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:

      • createdAt — (Date)

        The date and time, in UTC and extended ISO 8601 format, when the Amazon Macie account was created.

      • findingPublishingFrequency — (String)

        The frequency with which Macie publishes updates to policy findings for the account. This includes publishing updates to Security Hub and Amazon EventBridge (formerly called Amazon CloudWatch Events).

        Possible values include:
        • "FIFTEEN_MINUTES"
        • "ONE_HOUR"
        • "SIX_HOURS"
      • serviceRole — (String)

        The Amazon Resource Name (ARN) of the service-linked role that allows Macie to monitor and analyze data in Amazon Web Services resources for the account.

      • status — (String)

        The current status of the Macie account. Possible values are: PAUSED, the account is enabled but all Macie activities are suspended (paused) for the account; and, ENABLED, the account is enabled and all Macie activities are enabled for the account.

        Possible values include:
        • "PAUSED"
        • "ENABLED"
      • updatedAt — (Date)

        The date and time, in UTC and extended ISO 8601 format, of the most recent change to the status of the Macie account.

Returns:

  • (AWS.Request)

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

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

(Deprecated) Retrieves information about the Amazon Macie administrator account for an account. This operation has been replaced by the GetAdministratorAccount operation.

Service Reference:

Examples:

Calling the getMasterAccount operation

var params = {
};
macie2.getMasterAccount(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:

      • master — (map)

        (Deprecated) The Amazon Web Services account ID for the administrator account. If the accounts are associated by a Macie membership invitation, this object also provides details about the invitation that was sent to establish the relationship between the accounts.

        • accountId — (String)

          The Amazon Web Services account ID for the account that sent the invitation.

        • invitationId — (String)

          The unique identifier for the invitation. Amazon Macie uses this identifier to validate the inviter account with the invitee account.

        • invitedAt — (Date)

          The date and time, in UTC and extended ISO 8601 format, when the invitation was sent.

        • relationshipStatus — (String)

          The status of the relationship between the account that sent the invitation (inviter account) and the account that received the invitation (invitee account).

          Possible values include:
          • "Enabled"
          • "Paused"
          • "Invited"
          • "Created"
          • "Removed"
          • "Resigned"
          • "EmailVerificationInProgress"
          • "EmailVerificationFailed"
          • "RegionDisabled"
          • "AccountSuspended"

Returns:

  • (AWS.Request)

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

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

Retrieves information about an account that's associated with an Amazon Macie administrator account.

Service Reference:

Examples:

Calling the getMember operation

var params = {
  id: 'STRING_VALUE' /* required */
};
macie2.getMember(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: {})
    • id — (String)

      The unique identifier for the Amazon Macie resource or account that the request applies 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:

      • accountId — (String)

        The Amazon Web Services account ID for the account.

      • administratorAccountId — (String)

        The Amazon Web Services account ID for the administrator account.

      • arn — (String)

        The Amazon Resource Name (ARN) of the account.

      • email — (String)

        The email address for the account.

      • invitedAt — (Date)

        The date and time, in UTC and extended ISO 8601 format, when an Amazon Macie membership invitation was last sent to the account. This value is null if a Macie invitation hasn't been sent to the account.

      • masterAccountId — (String)

        (Deprecated) The Amazon Web Services account ID for the administrator account. This property has been replaced by the administratorAccountId property and is retained only for backward compatibility.

      • relationshipStatus — (String)

        The current status of the relationship between the account and the administrator account.

        Possible values include:
        • "Enabled"
        • "Paused"
        • "Invited"
        • "Created"
        • "Removed"
        • "Resigned"
        • "EmailVerificationInProgress"
        • "EmailVerificationFailed"
        • "RegionDisabled"
        • "AccountSuspended"
      • tags — (map<String>)

        A map of key-value pairs that identifies the tags (keys and values) that are associated with the member account in Amazon Macie.

      • updatedAt — (Date)

        The date and time, in UTC and extended ISO 8601 format, of the most recent change to the status of the relationship between the account and the administrator account.

Returns:

  • (AWS.Request)

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

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

Retrieves (queries) quotas and aggregated usage data for one or more accounts.

Service Reference:

Examples:

Calling the getUsageStatistics operation

var params = {
  filterBy: [
    {
      comparator: GT | GTE | LT | LTE | EQ | NE | CONTAINS,
      key: accountId | serviceLimit | freeTrialStartDate | total,
      values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  sortBy: {
    key: accountId | total | serviceLimitValue | freeTrialStartDate,
    orderBy: ASC | DESC
  },
  timeRange: MONTH_TO_DATE | PAST_30_DAYS
};
macie2.getUsageStatistics(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: {})
    • filterBy — (Array<map>)

      An array of objects, one for each condition to use to filter the query results. If you specify more than one condition, Amazon Macie uses an AND operator to join the conditions.

      • comparator — (String)

        The operator to use in the condition. If the value for the key property is accountId, this value must be CONTAINS. If the value for the key property is any other supported field, this value can be EQ, GT, GTE, LT, LTE, or NE.

        Possible values include:
        • "GT"
        • "GTE"
        • "LT"
        • "LTE"
        • "EQ"
        • "NE"
        • "CONTAINS"
      • key — (String)

        The field to use in the condition.

        Possible values include:
        • "accountId"
        • "serviceLimit"
        • "freeTrialStartDate"
        • "total"
      • values — (Array<String>)

        An array that lists values to use in the condition, based on the value for the field specified by the key property. If the value for the key property is accountId, this array can specify multiple values. Otherwise, this array can specify only one value.

        Valid values for each supported field are:

        • accountId - The unique identifier for an Amazon Web Services account.

        • freeTrialStartDate - The date and time, in UTC and extended ISO 8601 format, when the free trial started for an account.

        • serviceLimit - A Boolean (true or false) value that indicates whether an account has reached its monthly quota.

        • total - A string that represents the current estimated cost for an account.

    • maxResults — (Integer)

      The maximum number of items to include in each page of the response.

    • nextToken — (String)

      The nextToken string that specifies which page of results to return in a paginated response.

    • sortBy — (map)

      The criteria to use to sort the query results.

      • key — (String)

        The field to sort the results by.

        Possible values include:
        • "accountId"
        • "total"
        • "serviceLimitValue"
        • "freeTrialStartDate"
      • orderBy — (String)

        The sort order to apply to the results, based on the value for the field specified by the key property. Valid values are: ASC, sort the results in ascending order; and, DESC, sort the results in descending order.

        Possible values include:
        • "ASC"
        • "DESC"
    • timeRange — (String)

      The inclusive time period to query usage data for. Valid values are: MONTH_TO_DATE, for the current calendar month to date; and, PAST_30_DAYS, for the preceding 30 days. If you don't specify a value, Amazon Macie provides usage data for the preceding 30 days.

      Possible values include:
      • "MONTH_TO_DATE"
      • "PAST_30_DAYS"

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:

      • nextToken — (String)

        The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

      • records — (Array<map>)

        An array of objects that contains the results of the query. Each object contains the data for an account that meets the filter criteria specified in the request.

        • accountId — (String)

          The unique identifier for the Amazon Web Services account that the data applies to.

        • freeTrialStartDate — (Date)

          The date and time, in UTC and extended ISO 8601 format, when the free trial started for the account.

        • usage — (Array<map>)

          An array of objects that contains usage data and quotas for the account. Each object contains the data for a specific usage metric and the corresponding quota.

          • currency — (String)

            The type of currency that the value for the metric (estimatedCost) is reported in.

            Possible values include:
            • "USD"
          • estimatedCost — (String)

            The estimated value for the metric.

          • serviceLimit — (map)

            The current value for the quota that corresponds to the metric specified by the type field.

            • isServiceLimited — (Boolean)

              Specifies whether the account has met the quota that corresponds to the metric specified by the UsageByAccount.type field in the response.

            • unit — (String)

              The unit of measurement for the value specified by the value field.

              Possible values include:
              • "TERABYTES"
            • value — (Integer)

              The value for the metric specified by the UsageByAccount.type field in the response.

          • type — (String)

            The name of the metric. Possible values are: DATA_INVENTORY_EVALUATION, for monitoring S3 buckets; and, SENSITIVE_DATA_DISCOVERY, for analyzing S3 objects to detect sensitive data.

            Possible values include:
            • "DATA_INVENTORY_EVALUATION"
            • "SENSITIVE_DATA_DISCOVERY"
      • timeRange — (String)

        The inclusive time period that the usage data applies to. Possible values are: MONTH_TO_DATE, for the current calendar month to date; and, PAST_30_DAYS, for the preceding 30 days.

        Possible values include:
        • "MONTH_TO_DATE"
        • "PAST_30_DAYS"

Returns:

  • (AWS.Request)

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

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

Retrieves (queries) aggregated usage data for an account.

Service Reference:

Examples:

Calling the getUsageTotals operation

var params = {
  timeRange: 'STRING_VALUE'
};
macie2.getUsageTotals(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: {})
    • timeRange — (String)

      The inclusive time period to retrieve the data for. Valid values are: MONTH_TO_DATE, for the current calendar month to date; and, PAST_30_DAYS, for the preceding 30 days. If you don't specify a value for this parameter, Amazon Macie provides aggregated usage data for the preceding 30 days.

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:

      • timeRange — (String)

        The inclusive time period that the usage data applies to. Possible values are: MONTH_TO_DATE, for the current calendar month to date; and, PAST_30_DAYS, for the preceding 30 days.

        Possible values include:
        • "MONTH_TO_DATE"
        • "PAST_30_DAYS"
      • usageTotals — (Array<map>)

        An array of objects that contains the results of the query. Each object contains the data for a specific usage metric.

        • currency — (String)

          The type of currency that the value for the metric (estimatedCost) is reported in.

          Possible values include:
          • "USD"
        • estimatedCost — (String)

          The estimated value for the metric.

        • type — (String)

          The name of the metric. Possible values are: DATA_INVENTORY_EVALUATION, for monitoring S3 buckets; and, SENSITIVE_DATA_DISCOVERY, for analyzing S3 objects to detect sensitive data.

          Possible values include:
          • "DATA_INVENTORY_EVALUATION"
          • "SENSITIVE_DATA_DISCOVERY"

Returns:

  • (AWS.Request)

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

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

Retrieves a subset of information about one or more classification jobs.

Service Reference:

Examples:

Calling the listClassificationJobs operation

var params = {
  filterCriteria: {
    excludes: [
      {
        comparator: EQ | GT | GTE | LT | LTE | NE | CONTAINS | STARTS_WITH,
        key: jobType | jobStatus | createdAt | name,
        values: [
          'STRING_VALUE',
          /* more items */
        ]
      },
      /* more items */
    ],
    includes: [
      {
        comparator: EQ | GT | GTE | LT | LTE | NE | CONTAINS | STARTS_WITH,
        key: jobType | jobStatus | createdAt | name,
        values: [
          'STRING_VALUE',
          /* more items */
        ]
      },
      /* more items */
    ]
  },
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  sortCriteria: {
    attributeName: createdAt | jobStatus | name | jobType,
    orderBy: ASC | DESC
  }
};
macie2.listClassificationJobs(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: {})
    • filterCriteria — (map)

      The criteria to use to filter the results.

      • excludes — (Array<map>)

        An array of objects, one for each condition that determines which jobs to exclude from the results.

        • comparator — (String)

          The operator to use to filter the results.

          Possible values include:
          • "EQ"
          • "GT"
          • "GTE"
          • "LT"
          • "LTE"
          • "NE"
          • "CONTAINS"
          • "STARTS_WITH"
        • key — (String)

          The property to use to filter the results.

          Possible values include:
          • "jobType"
          • "jobStatus"
          • "createdAt"
          • "name"
        • values — (Array<String>)

          An array that lists one or more values to use to filter the results.

      • includes — (Array<map>)

        An array of objects, one for each condition that determines which jobs to include in the results.

        • comparator — (String)

          The operator to use to filter the results.

          Possible values include:
          • "EQ"
          • "GT"
          • "GTE"
          • "LT"
          • "LTE"
          • "NE"
          • "CONTAINS"
          • "STARTS_WITH"
        • key — (String)

          The property to use to filter the results.

          Possible values include:
          • "jobType"
          • "jobStatus"
          • "createdAt"
          • "name"
        • values — (Array<String>)

          An array that lists one or more values to use to filter the results.

    • maxResults — (Integer)

      The maximum number of items to include in each page of the response.

    • nextToken — (String)

      The nextToken string that specifies which page of results to return in a paginated response.

    • sortCriteria — (map)

      The criteria to use to sort the results.

      • attributeName — (String)

        The property to sort the results by.

        Possible values include:
        • "createdAt"
        • "jobStatus"
        • "name"
        • "jobType"
      • orderBy — (String)

        The sort order to apply to the results, based on the value for the property specified by the attributeName property. Valid values are: ASC, sort the results in ascending order; and, DESC, sort the results in descending order.

        Possible values include:
        • "ASC"
        • "DESC"

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:

      • items — (Array<map>)

        An array of objects, one for each job that meets the filter criteria specified in the request.

        • bucketDefinitions — (Array<map>)

          An array of objects, one for each Amazon Web Services account that owns specific S3 buckets for the job to analyze. Each object specifies the account ID for an account and one or more buckets to analyze for that account. A job's definition can contain a bucketDefinitions array or a bucketCriteria object, not both.

          • accountIdrequired — (String)

            The unique identifier for the Amazon Web Services account that owns the buckets.

          • bucketsrequired — (Array<String>)

            An array that lists the names of the buckets.

        • createdAt — (Date)

          The date and time, in UTC and extended ISO 8601 format, when the job was created.

        • jobId — (String)

          The unique identifier for the job.

        • jobStatus — (String)

          The current status of the job. Possible values are:

          • CANCELLED - You cancelled the job or, if it's a one-time job, you paused the job and didn't resume it within 30 days.

          • COMPLETE - For a one-time job, Amazon Macie finished processing the data specified for the job. This value doesn't apply to recurring jobs.

          • IDLE - For a recurring job, the previous scheduled run is complete and the next scheduled run is pending. This value doesn't apply to one-time jobs.

          • PAUSED - Macie started running the job but additional processing would exceed the monthly sensitive data discovery quota for your account or one or more member accounts that the job analyzes data for.

          • RUNNING - For a one-time job, the job is in progress. For a recurring job, a scheduled run is in progress.

          • USER_PAUSED - You paused the job. If you paused the job while it had a status of RUNNING and you don't resume it within 30 days of pausing it, the job or job run will expire and be cancelled, depending on the job's type. To check the expiration date, refer to the UserPausedDetails.jobExpiresAt property.

          Possible values include:
          • "RUNNING"
          • "PAUSED"
          • "CANCELLED"
          • "COMPLETE"
          • "IDLE"
          • "USER_PAUSED"
        • jobType — (String)

          The schedule for running the job. Possible values are:

          • ONE_TIME - The job runs only once.

          • SCHEDULED - The job runs on a daily, weekly, or monthly basis.

          Possible values include:
          • "ONE_TIME"
          • "SCHEDULED"
        • lastRunErrorStatus — (map)

          Specifies whether any account- or bucket-level access errors occurred when the job ran. For a recurring job, this value indicates the error status of the job's most recent run.

          • code — (String)

            Specifies whether any account- or bucket-level access errors occurred when the job ran. For a recurring job, this value indicates the error status of the job's most recent run. Possible values are:

            • ERROR - One or more errors occurred. Amazon Macie didn't process all the data specified for the job.

            • NONE - No errors occurred. Macie processed all the data specified for the job.

            Possible values include:
            • "NONE"
            • "ERROR"
        • name — (String)

          The custom name of the job.

        • userPausedDetails — (map)

          If the current status of the job is USER_PAUSED, specifies when the job was paused and when the job or job run will expire and be cancelled if it isn't resumed. This value is present only if the value for jobStatus is USER_PAUSED.

          • jobExpiresAt — (Date)

            The date and time, in UTC and extended ISO 8601 format, when the job or job run will expire and be cancelled if you don't resume it first.

          • jobImminentExpirationHealthEventArn — (String)

            The Amazon Resource Name (ARN) of the Health event that Amazon Macie sent to notify you of the job or job run's pending expiration and cancellation. This value is null if a job has been paused for less than 23 days.

          • jobPausedAt — (Date)

            The date and time, in UTC and extended ISO 8601 format, when you paused the job.

        • bucketCriteria — (map)

          The property- and tag-based conditions that determine which S3 buckets are included or excluded from the job's analysis. Each time the job runs, the job uses these criteria to determine which buckets to analyze. A job's definition can contain a bucketCriteria object or a bucketDefinitions array, not both.

          • excludes — (map)

            The property- and tag-based conditions that determine which buckets to exclude from the job.

            • and — (Array<map>)

              An array of conditions, one for each condition that determines which buckets to include or exclude from the job. If you specify more than one condition, Amazon Macie uses AND logic to join the conditions.

              • simpleCriterion — (map)

                A property-based condition that defines a property, operator, and one or more values for including or excluding buckets from the job.

                • comparator — (String)

                  The operator to use in the condition. Valid values are EQ (equals) and NE (not equals).

                  Possible values include:
                  • "EQ"
                  • "GT"
                  • "GTE"
                  • "LT"
                  • "LTE"
                  • "NE"
                  • "CONTAINS"
                  • "STARTS_WITH"
                • key — (String)

                  The property to use in the condition.

                  Possible values include:
                  • "ACCOUNT_ID"
                  • "S3_BUCKET_NAME"
                  • "S3_BUCKET_EFFECTIVE_PERMISSION"
                  • "S3_BUCKET_SHARED_ACCESS"
                • values — (Array<String>)

                  An array that lists one or more values to use in the condition. If you specify multiple values, Amazon Macie uses OR logic to join the values. Valid values for each supported property (key) are:

                  • ACCOUNT_ID - A string that represents the unique identifier for the Amazon Web Services account that owns the bucket.

                  • S3_BUCKET_EFFECTIVE_PERMISSION - A string that represents an enumerated value that Macie defines for the BucketPublicAccess.effectivePermission property of a bucket.

                  • S3_BUCKET_NAME - A string that represents the name of a bucket.

                  • S3_BUCKET_SHARED_ACCESS - A string that represents an enumerated value that Macie defines for the BucketMetadata.sharedAccess property of a bucket.

                  Values are case sensitive. Also, Macie doesn't support use of partial values or wildcard characters in these values.

              • tagCriterion — (map)

                A tag-based condition that defines an operator and tag keys, tag values, or tag key and value pairs for including or excluding buckets from the job.

                • comparator — (String)

                  The operator to use in the condition. Valid values are EQ (equals) and NE (not equals).

                  Possible values include:
                  • "EQ"
                  • "GT"
                  • "GTE"
                  • "LT"
                  • "LTE"
                  • "NE"
                  • "CONTAINS"
                  • "STARTS_WITH"
                • tagValues — (Array<map>)

                  The tag keys, tag values, or tag key and value pairs to use in the condition.

                  • key — (String)

                    The value for the tag key to use in the condition.

                  • value — (String)

                    The tag value to use in the condition.

          • includes — (map)

            The property- and tag-based conditions that determine which buckets to include in the job.

            • and — (Array<map>)

              An array of conditions, one for each condition that determines which buckets to include or exclude from the job. If you specify more than one condition, Amazon Macie uses AND logic to join the conditions.

              • simpleCriterion — (map)

                A property-based condition that defines a property, operator, and one or more values for including or excluding buckets from the job.

                • comparator — (String)

                  The operator to use in the condition. Valid values are EQ (equals) and NE (not equals).

                  Possible values include:
                  • "EQ"
                  • "GT"
                  • "GTE"
                  • "LT"
                  • "LTE"
                  • "NE"
                  • "CONTAINS"
                  • "STARTS_WITH"
                • key — (String)

                  The property to use in the condition.

                  Possible values include:
                  • "ACCOUNT_ID"
                  • "S3_BUCKET_NAME"
                  • "S3_BUCKET_EFFECTIVE_PERMISSION"
                  • "S3_BUCKET_SHARED_ACCESS"
                • values — (Array<String>)

                  An array that lists one or more values to use in the condition. If you specify multiple values, Amazon Macie uses OR logic to join the values. Valid values for each supported property (key) are:

                  • ACCOUNT_ID - A string that represents the unique identifier for the Amazon Web Services account that owns the bucket.

                  • S3_BUCKET_EFFECTIVE_PERMISSION - A string that represents an enumerated value that Macie defines for the BucketPublicAccess.effectivePermission property of a bucket.

                  • S3_BUCKET_NAME - A string that represents the name of a bucket.

                  • S3_BUCKET_SHARED_ACCESS - A string that represents an enumerated value that Macie defines for the BucketMetadata.sharedAccess property of a bucket.

                  Values are case sensitive. Also, Macie doesn't support use of partial values or wildcard characters in these values.

              • tagCriterion — (map)

                A tag-based condition that defines an operator and tag keys, tag values, or tag key and value pairs for including or excluding buckets from the job.

                • comparator — (String)

                  The operator to use in the condition. Valid values are EQ (equals) and NE (not equals).

                  Possible values include:
                  • "EQ"
                  • "GT"
                  • "GTE"
                  • "LT"
                  • "LTE"
                  • "NE"
                  • "CONTAINS"
                  • "STARTS_WITH"
                • tagValues — (Array<map>)

                  The tag keys, tag values, or tag key and value pairs to use in the condition.

                  • key — (String)

                    The value for the tag key to use in the condition.

                  • value — (String)

                    The tag value to use in the condition.

      • nextToken — (String)

        The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

Returns:

  • (AWS.Request)

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

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

Retrieves a subset of information about all the custom data identifiers for an account.

Service Reference:

Examples:

Calling the listCustomDataIdentifiers operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
macie2.listCustomDataIdentifiers(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: {})
    • maxResults — (Integer)

      The maximum number of items to include in each page of the response.

    • nextToken — (String)

      The nextToken string that specifies which page of results to return in a paginated response.

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:

      • items — (Array<map>)

        An array of objects, one for each custom data identifier.

        • arn — (String)

          The Amazon Resource Name (ARN) of the custom data identifier.

        • createdAt — (Date)

          The date and time, in UTC and extended ISO 8601 format, when the custom data identifier was created.

        • description — (String)

          The custom description of the custom data identifier.

        • id — (String)

          The unique identifier for the custom data identifier.

        • name — (String)

          The custom name of the custom data identifier.

      • nextToken — (String)

        The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

Returns:

  • (AWS.Request)

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

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

Retrieves a subset of information about one or more findings.

Service Reference:

Examples:

Calling the listFindings operation

var params = {
  findingCriteria: {
    criterion: {
      '<__string>': {
        eq: [
          'STRING_VALUE',
          /* more items */
        ],
        eqExactMatch: [
          'STRING_VALUE',
          /* more items */
        ],
        gt: 'NUMBER_VALUE',
        gte: 'NUMBER_VALUE',
        lt: 'NUMBER_VALUE',
        lte: 'NUMBER_VALUE',
        neq: [
          'STRING_VALUE',
          /* more items */
        ]
      },
      /* '<__string>': ... */
    }
  },
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  sortCriteria: {
    attributeName: 'STRING_VALUE',
    orderBy: ASC | DESC
  }
};
macie2.listFindings(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: {})
    • findingCriteria — (map)

      The criteria to use to filter the results.

      • criterion — (map<map>)

        A condition that specifies the property, operator, and one or more values to use to filter the results.

        • eq — (Array<String>)

          The value for the property matches (equals) the specified value. If you specify multiple values, Macie uses OR logic to join the values.

        • eqExactMatch — (Array<String>)

          The value for the property exclusively matches (equals an exact match for) all the specified values. If you specify multiple values, Amazon Macie uses AND logic to join the values.

          You can use this operator with the following properties: customDataIdentifiers.detections.arn, customDataIdentifiers.detections.name, resourcesAffected.s3Bucket.tags.key, resourcesAffected.s3Bucket.tags.value, resourcesAffected.s3Object.tags.key, resourcesAffected.s3Object.tags.value, sensitiveData.category, and sensitiveData.detections.type.

        • gt — (Integer)

          The value for the property is greater than the specified value.

        • gte — (Integer)

          The value for the property is greater than or equal to the specified value.

        • lt — (Integer)

          The value for the property is less than the specified value.

        • lte — (Integer)

          The value for the property is less than or equal to the specified value.

        • neq — (Array<String>)

          The value for the property doesn't match (doesn't equal) the specified value. If you specify multiple values, Macie uses OR logic to join the values.

    • maxResults — (Integer)

      The maximum number of items to include in each page of the response.

    • nextToken — (String)

      The nextToken string that specifies which page of results to return in a paginated response.

    • sortCriteria — (map)

      The criteria to use to sort the results.

      • attributeName — (String)

        The name of the property to sort the results by. This value can be the name of any property that Amazon Macie defines for a finding.

      • orderBy — (String)

        The sort order to apply to the results, based on the value for the property specified by the attributeName property. Valid values are: ASC, sort the results in ascending order; and, DESC, sort the results in descending order.

        Possible values include:
        • "ASC"
        • "DESC"

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:

      • findingIds — (Array<String>)

        An array of strings, where each string is the unique identifier for a finding that meets the filter criteria specified in the request.

      • nextToken — (String)

        The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

Returns:

  • (AWS.Request)

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

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

Retrieves a subset of information about all the findings filters for an account.

Service Reference:

Examples:

Calling the listFindingsFilters operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
macie2.listFindingsFilters(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: {})
    • maxResults — (Integer)

      The maximum number of items to include in each page of a paginated response.

    • nextToken — (String)

      The nextToken string that specifies which page of results to return in a paginated response.

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:

      • findingsFilterListItems — (Array<map>)

        An array of objects, one for each filter that's associated with the account.

        • action — (String)

          The action that's performed on findings that meet the filter criteria. Possible values are: ARCHIVE, suppress (automatically archive) the findings; and, NOOP, don't perform any action on the findings.

          Possible values include:
          • "ARCHIVE"
          • "NOOP"
        • arn — (String)

          The Amazon Resource Name (ARN) of the filter.

        • id — (String)

          The unique identifier for the filter.

        • name — (String)

          The custom name of the filter.

        • tags — (map<String>)

          A map of key-value pairs that identifies the tags (keys and values) that are associated with the filter.

      • nextToken — (String)

        The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

Returns:

  • (AWS.Request)

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

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

Retrieves information about the Amazon Macie membership invitations that were received by an account.

Service Reference:

Examples:

Calling the listInvitations operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
macie2.listInvitations(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: {})
    • maxResults — (Integer)

      The maximum number of items to include in each page of a paginated response.

    • nextToken — (String)

      The nextToken string that specifies which page of results to return in a paginated response.

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:

      • invitations — (Array<map>)

        An array of objects, one for each invitation that was received by the account.

        • accountId — (String)

          The Amazon Web Services account ID for the account that sent the invitation.

        • invitationId — (String)

          The unique identifier for the invitation. Amazon Macie uses this identifier to validate the inviter account with the invitee account.

        • invitedAt — (Date)

          The date and time, in UTC and extended ISO 8601 format, when the invitation was sent.

        • relationshipStatus — (String)

          The status of the relationship between the account that sent the invitation (inviter account) and the account that received the invitation (invitee account).

          Possible values include:
          • "Enabled"
          • "Paused"
          • "Invited"
          • "Created"
          • "Removed"
          • "Resigned"
          • "EmailVerificationInProgress"
          • "EmailVerificationFailed"
          • "RegionDisabled"
          • "AccountSuspended"
      • nextToken — (String)

        The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

Returns:

  • (AWS.Request)

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

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

Retrieves information about all the managed data identifiers that Amazon Macie currently provides.

Service Reference:

Examples:

Calling the listManagedDataIdentifiers operation

var params = {
  nextToken: 'STRING_VALUE'
};
macie2.listManagedDataIdentifiers(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 nextToken string that specifies which page of results to return in a paginated response.

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:

      • items — (Array<map>)

        An array of objects, one for each managed data identifier.

        • category — (String)

          The category of sensitive data that the managed data identifier detects: CREDENTIALS, for credentials data such as private keys or Amazon Web Services secret keys; FINANCIAL_INFORMATION, for financial data such as credit card numbers; or, PERSONAL_INFORMATION, for personal health information, such as health insurance identification numbers, or personally identifiable information, such as passport numbers.

          Possible values include:
          • "FINANCIAL_INFORMATION"
          • "PERSONAL_INFORMATION"
          • "CREDENTIALS"
          • "CUSTOM_IDENTIFIER"
        • id — (String)

          The unique identifier for the managed data identifier. This is a string that describes the type of sensitive data that the managed data identifier detects. For example: OPENSSH_PRIVATE_KEY for OpenSSH private keys, CREDIT_CARD_NUMBER for credit card numbers, or USA_PASSPORT_NUMBER for US passport numbers.

      • nextToken — (String)

        The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

Returns:

  • (AWS.Request)

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

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

Retrieves information about the accounts that are associated with an Amazon Macie administrator account.

Service Reference:

Examples:

Calling the listMembers operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  onlyAssociated: 'STRING_VALUE'
};
macie2.listMembers(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: {})
    • maxResults — (Integer)

      The maximum number of items to include in each page of a paginated response.

    • nextToken — (String)

      The nextToken string that specifies which page of results to return in a paginated response.

    • onlyAssociated — (String)

      Specifies which accounts to include in the response, based on the status of an account's relationship with the administrator account. By default, the response includes only current member accounts. To include all accounts, set this value to false.

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:

      • members — (Array<map>)

        An array of objects, one for each account that's associated with the administrator account and meets the criteria specified by the onlyAssociated request parameter.

        • accountId — (String)

          The Amazon Web Services account ID for the account.

        • administratorAccountId — (String)

          The Amazon Web Services account ID for the administrator account.

        • arn — (String)

          The Amazon Resource Name (ARN) of the account.

        • email — (String)

          The email address for the account.

        • invitedAt — (Date)

          The date and time, in UTC and extended ISO 8601 format, when an Amazon Macie membership invitation was last sent to the account. This value is null if a Macie invitation hasn't been sent to the account.

        • masterAccountId — (String)

          (Deprecated) The Amazon Web Services account ID for the administrator account. This property has been replaced by the administratorAccountId property and is retained only for backward compatibility.

        • relationshipStatus — (String)

          The current status of the relationship between the account and the administrator account.

          Possible values include:
          • "Enabled"
          • "Paused"
          • "Invited"
          • "Created"
          • "Removed"
          • "Resigned"
          • "EmailVerificationInProgress"
          • "EmailVerificationFailed"
          • "RegionDisabled"
          • "AccountSuspended"
        • tags — (map<String>)

          A map of key-value pairs that identifies the tags (keys and values) that are associated with the account in Amazon Macie.

        • updatedAt — (Date)

          The date and time, in UTC and extended ISO 8601 format, of the most recent change to the status of the relationship between the account and the administrator account.

      • nextToken — (String)

        The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

Returns:

  • (AWS.Request)

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

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

Retrieves information about the delegated Amazon Macie administrator account for an Amazon Web Services organization.

Service Reference:

Examples:

Calling the listOrganizationAdminAccounts operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
macie2.listOrganizationAdminAccounts(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: {})
    • maxResults — (Integer)

      The maximum number of items to include in each page of a paginated response.

    • nextToken — (String)

      The nextToken string that specifies which page of results to return in a paginated response.

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:

      • adminAccounts — (Array<map>)

        An array of objects, one for each delegated Amazon Macie administrator account for the organization. Only one of these accounts can have a status of ENABLED.

        • accountId — (String)

          The Amazon Web Services account ID for the account.

        • status — (String)

          The current status of the account as the delegated administrator of Amazon Macie for the organization.

          Possible values include:
          • "ENABLED"
          • "DISABLING_IN_PROGRESS"
      • nextToken — (String)

        The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

Returns:

  • (AWS.Request)

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

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

Retrieves the tags (keys and values) that are associated with a classification job, custom data identifier, findings filter, or member account.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
macie2.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 classification job, custom data identifier, findings filter, or member 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:

      • tags — (map<String>)

        A map of key-value pairs that identifies the tags (keys and values) that are associated with the resource.

Returns:

  • (AWS.Request)

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

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

Creates or updates the configuration settings for storing data classification results.

Examples:

Calling the putClassificationExportConfiguration operation

var params = {
  configuration: { /* required */
    s3Destination: {
      bucketName: 'STRING_VALUE', /* required */
      kmsKeyArn: 'STRING_VALUE', /* required */
      keyPrefix: 'STRING_VALUE'
    }
  }
};
macie2.putClassificationExportConfiguration(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: {})
    • configuration — (map)

      The location to store data classification results in, and the encryption settings to use when storing results in that location.

      • s3Destination — (map)

        The S3 bucket to store data classification results in, and the encryption settings to use when storing results in that bucket.

        • bucketNamerequired — (String)

          The name of the bucket.

        • keyPrefix — (String)

          The path prefix to use in the path to the location in the bucket. This prefix specifies where to store classification results in the bucket.

        • kmsKeyArnrequired — (String)

          The Amazon Resource Name (ARN) of the Key Management Service (KMS) customer master key (CMK) to use for encryption of the results. This must be the ARN of an existing CMK that's in the same Amazon Web Services Region as the bucket.

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:

      • configuration — (map)

        The location where the data classification results are stored, and the encryption settings that are used when storing results in that location.

        • s3Destination — (map)

          The S3 bucket to store data classification results in, and the encryption settings to use when storing results in that bucket.

          • bucketNamerequired — (String)

            The name of the bucket.

          • keyPrefix — (String)

            The path prefix to use in the path to the location in the bucket. This prefix specifies where to store classification results in the bucket.

          • kmsKeyArnrequired — (String)

            The Amazon Resource Name (ARN) of the Key Management Service (KMS) customer master key (CMK) to use for encryption of the results. This must be the ARN of an existing CMK that's in the same Amazon Web Services Region as the bucket.

Returns:

  • (AWS.Request)

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

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

Updates the configuration settings for publishing findings to Security Hub.

Examples:

Calling the putFindingsPublicationConfiguration operation

var params = {
  clientToken: 'STRING_VALUE',
  securityHubConfiguration: {
    publishClassificationFindings: true || false, /* required */
    publishPolicyFindings: true || false /* required */
  }
};
macie2.putFindingsPublicationConfiguration(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: {})
    • clientToken — (String)

      A unique, case-sensitive token that you provide to ensure the idempotency of the request.

      If a token is not provided, the SDK will use a version 4 UUID.
    • securityHubConfiguration — (map)

      The configuration settings that determine which findings to publish to Security Hub.

      • publishClassificationFindingsrequired — (Boolean)

        Specifies whether to publish sensitive data findings to Security Hub. If you set this value to true, Amazon Macie automatically publishes all sensitive data findings that weren't suppressed by a findings filter. The default value is false.

      • publishPolicyFindingsrequired — (Boolean)

        Specifies whether to publish policy findings to Security Hub. If you set this value to true, Amazon Macie automatically publishes all new and updated policy findings that weren't suppressed by a findings filter. The default value is true.

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.

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

Retrieves (queries) statistical data and other information about Amazon Web Services resources that Amazon Macie monitors and analyzes.

Service Reference:

Examples:

Calling the searchResources operation

var params = {
  bucketCriteria: {
    excludes: {
      and: [
        {
          simpleCriterion: {
            comparator: EQ | NE,
            key: ACCOUNT_ID | S3_BUCKET_NAME | S3_BUCKET_EFFECTIVE_PERMISSION | S3_BUCKET_SHARED_ACCESS,
            values: [
              'STRING_VALUE',
              /* more items */
            ]
          },
          tagCriterion: {
            comparator: EQ | NE,
            tagValues: [
              {
                key: 'STRING_VALUE',
                value: 'STRING_VALUE'
              },
              /* more items */
            ]
          }
        },
        /* more items */
      ]
    },
    includes: {
      and: [
        {
          simpleCriterion: {
            comparator: EQ | NE,
            key: ACCOUNT_ID | S3_BUCKET_NAME | S3_BUCKET_EFFECTIVE_PERMISSION | S3_BUCKET_SHARED_ACCESS,
            values: [
              'STRING_VALUE',
              /* more items */
            ]
          },
          tagCriterion: {
            comparator: EQ | NE,
            tagValues: [
              {
                key: 'STRING_VALUE',
                value: 'STRING_VALUE'
              },
              /* more items */
            ]
          }
        },
        /* more items */
      ]
    }
  },
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  sortCriteria: {
    attributeName: ACCOUNT_ID | RESOURCE_NAME | S3_CLASSIFIABLE_OBJECT_COUNT | S3_CLASSIFIABLE_SIZE_IN_BYTES,
    orderBy: ASC | DESC
  }
};
macie2.searchResources(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: {})
    • bucketCriteria — (map)

      The filter conditions that determine which S3 buckets to include or exclude from the query results.

      • excludes — (map)

        The property- and tag-based conditions that determine which buckets to exclude from the results.

        • and — (Array<map>)

          An array of objects, one for each property- or tag-based condition that includes or excludes resources from the query results. If you specify more than one condition, Amazon Macie uses AND logic to join the conditions.

          • simpleCriterion — (map)

            A property-based condition that defines a property, operator, and one or more values for including or excluding resources from the results.

            • comparator — (String)

              The operator to use in the condition. Valid values are EQ (equals) and NE (not equals).

              Possible values include:
              • "EQ"
              • "NE"
            • key — (String)

              The property to use in the condition.

              Possible values include:
              • "ACCOUNT_ID"
              • "S3_BUCKET_NAME"
              • "S3_BUCKET_EFFECTIVE_PERMISSION"
              • "S3_BUCKET_SHARED_ACCESS"
            • values — (Array<String>)

              An array that lists one or more values to use in the condition. If you specify multiple values, Amazon Macie uses OR logic to join the values. Valid values for each supported property (key) are:

              • ACCOUNT_ID - A string that represents the unique identifier for the Amazon Web Services account that owns the resource.

              • S3_BUCKET_EFFECTIVE_PERMISSION - A string that represents an enumerated value that Macie defines for the BucketPublicAccess.effectivePermission property of an S3 bucket.

              • S3_BUCKET_NAME - A string that represents the name of an S3 bucket.

              • S3_BUCKET_SHARED_ACCESS - A string that represents an enumerated value that Macie defines for the BucketMetadata.sharedAccess property of an S3 bucket.

              Values are case sensitive. Also, Macie doesn't support use of partial values or wildcard characters in values.

          • tagCriterion — (map)

            A tag-based condition that defines an operator and tag keys, tag values, or tag key and value pairs for including or excluding resources from the results.

            • comparator — (String)

              The operator to use in the condition. Valid values are EQ (equals) and NE (not equals).

              Possible values include:
              • "EQ"
              • "NE"
            • tagValues — (Array<map>)

              The tag keys, tag values, or tag key and value pairs to use in the condition.

              • key — (String)

                The value for the tag key to use in the condition.

              • value — (String)

                The tag value to use in the condition.

      • includes — (map)

        The property- and tag-based conditions that determine which buckets to include in the results.

        • and — (Array<map>)

          An array of objects, one for each property- or tag-based condition that includes or excludes resources from the query results. If you specify more than one condition, Amazon Macie uses AND logic to join the conditions.

          • simpleCriterion — (map)

            A property-based condition that defines a property, operator, and one or more values for including or excluding resources from the results.

            • comparator — (String)

              The operator to use in the condition. Valid values are EQ (equals) and NE (not equals).

              Possible values include:
              • "EQ"
              • "NE"
            • key — (String)

              The property to use in the condition.

              Possible values include:
              • "ACCOUNT_ID"
              • "S3_BUCKET_NAME"
              • "S3_BUCKET_EFFECTIVE_PERMISSION"
              • "S3_BUCKET_SHARED_ACCESS"
            • values — (Array<String>)

              An array that lists one or more values to use in the condition. If you specify multiple values, Amazon Macie uses OR logic to join the values. Valid values for each supported property (key) are:

              • ACCOUNT_ID - A string that represents the unique identifier for the Amazon Web Services account that owns the resource.

              • S3_BUCKET_EFFECTIVE_PERMISSION - A string that represents an enumerated value that Macie defines for the BucketPublicAccess.effectivePermission property of an S3 bucket.

              • S3_BUCKET_NAME - A string that represents the name of an S3 bucket.

              • S3_BUCKET_SHARED_ACCESS - A string that represents an enumerated value that Macie defines for the BucketMetadata.sharedAccess property of an S3 bucket.

              Values are case sensitive. Also, Macie doesn't support use of partial values or wildcard characters in values.

          • tagCriterion — (map)

            A tag-based condition that defines an operator and tag keys, tag values, or tag key and value pairs for including or excluding resources from the results.

            • comparator — (String)

              The operator to use in the condition. Valid values are EQ (equals) and NE (not equals).

              Possible values include:
              • "EQ"
              • "NE"
            • tagValues — (Array<map>)

              The tag keys, tag values, or tag key and value pairs to use in the condition.

              • key — (String)

                The value for the tag key to use in the condition.

              • value — (String)

                The tag value to use in the condition.

    • maxResults — (Integer)

      The maximum number of items to include in each page of the response. The default value is 50.

    • nextToken — (String)

      The nextToken string that specifies which page of results to return in a paginated response.

    • sortCriteria — (map)

      The criteria to use to sort the results.

      • attributeName — (String)

        The property to sort the results by.

        Possible values include:
        • "ACCOUNT_ID"
        • "RESOURCE_NAME"
        • "S3_CLASSIFIABLE_OBJECT_COUNT"
        • "S3_CLASSIFIABLE_SIZE_IN_BYTES"
      • orderBy — (String)

        The sort order to apply to the results, based on the value for the property specified by the attributeName property. Valid values are: ASC, sort the results in ascending order; and, DESC, sort the results in descending order.

        Possible values include:
        • "ASC"
        • "DESC"

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:

      • matchingResources — (Array<map>)

        An array of objects, one for each resource that meets the filter criteria specified in the request.

        • matchingBucket — (map)

          The details of an S3 bucket that Amazon Macie monitors and analyzes.

          • accountId — (String)

            The unique identifier for the Amazon Web Services account that owns the bucket.

          • bucketName — (String)

            The name of the bucket.

          • classifiableObjectCount — (Integer)

            The total number of objects that Amazon Macie can analyze in the bucket. These objects use a supported storage class and have a file name extension for a supported file or storage format.

          • classifiableSizeInBytes — (Integer)

            The total storage size, in bytes, of the objects that Amazon Macie can analyze in the bucket. These objects use a supported storage class and have a file name extension for a supported file or storage format.

            If versioning is enabled for the bucket, Macie calculates this value based on the size of the latest version of each applicable object in the bucket. This value doesn't reflect the storage size of all versions of each applicable object in the bucket.

          • jobDetails — (map)

            Specifies whether any one-time or recurring classification jobs are configured to analyze objects in the bucket, and, if so, the details of the job that ran most recently.

            • isDefinedInJob — (String)

              Specifies whether any one-time or recurring jobs are configured to analyze data in the bucket. Possible values are:

              • TRUE - The bucket is explicitly included in the bucket definition (S3BucketDefinitionForJob) for one or more jobs and at least one of those jobs has a status other than CANCELLED. Or the bucket matched the bucket criteria (S3BucketCriteriaForJob) for at least one job that previously ran.

              • FALSE - The bucket isn't explicitly included in the bucket definition (S3BucketDefinitionForJob) for any jobs, all the jobs that explicitly include the bucket in their bucket definitions have a status of CANCELLED, or the bucket didn't match the bucket criteria (S3BucketCriteriaForJob) for any jobs that previously ran.

              • UNKNOWN - An exception occurred when Amazon Macie attempted to retrieve job data for the bucket.

              Possible values include:
              • "TRUE"
              • "FALSE"
              • "UNKNOWN"
            • isMonitoredByJob — (String)

              Specifies whether any recurring jobs are configured to analyze data in the bucket. Possible values are:

              • TRUE - The bucket is explicitly included in the bucket definition (S3BucketDefinitionForJob) for one or more recurring jobs or the bucket matches the bucket criteria (S3BucketCriteriaForJob) for one or more recurring jobs. At least one of those jobs has a status other than CANCELLED.

              • FALSE - The bucket isn't explicitly included in the bucket definition (S3BucketDefinitionForJob) for any recurring jobs, the bucket doesn't match the bucket criteria (S3BucketCriteriaForJob) for any recurring jobs, or all the recurring jobs that are configured to analyze data in the bucket have a status of CANCELLED.

              • UNKNOWN - An exception occurred when Amazon Macie attempted to retrieve job data for the bucket.

              Possible values include:
              • "TRUE"
              • "FALSE"
              • "UNKNOWN"
            • lastJobId — (String)

              The unique identifier for the job that ran most recently and is configured to analyze data in the bucket, either the latest run of a recurring job or the only run of a one-time job.

              This value is typically null if the value for the isDefinedInJob property is FALSE or UNKNOWN.

            • lastJobRunTime — (Date)

              The date and time, in UTC and extended ISO 8601 format, when the job (lastJobId) started. If the job is a recurring job, this value indicates when the most recent run started.

              This value is typically null if the value for the isDefinedInJob property is FALSE or UNKNOWN.

          • objectCount — (Integer)

            The total number of objects in the bucket.

          • objectCountByEncryptionType — (map)

            The total number of objects that are in the bucket, grouped by server-side encryption type. This includes a grouping that reports the total number of objects that aren't encrypted or use client-side encryption.

            • customerManaged — (Integer)

              The total number of objects that are encrypted with a customer-managed key. The objects use customer-provided server-side encryption (SSE-C).

            • kmsManaged — (Integer)

              The total number of objects that are encrypted with an Key Management Service (KMS) customer master key (CMK). The objects use Amazon Web Services managed KMS encryption (AWS-KMS) or customer managed KMS encryption (SSE-KMS).

            • s3Managed — (Integer)

              The total number of objects that are encrypted with an Amazon S3 managed key. The objects use Amazon S3 managed encryption (SSE-S3).

            • unencrypted — (Integer)

              The total number of objects that aren't encrypted or use client-side encryption.

            • unknown — (Integer)

              The total number of objects that Amazon Macie doesn't have current encryption metadata for. Macie can't provide current data about the encryption settings for these objects.

          • sizeInBytes — (Integer)

            The total storage size, in bytes, of the bucket.

            If versioning is enabled for the bucket, Amazon Macie calculates this value based on the size of the latest version of each object in the bucket. This value doesn't reflect the storage size of all versions of each object in the bucket.

          • sizeInBytesCompressed — (Integer)

            The total storage size, in bytes, of the objects that are compressed (.gz, .gzip, .zip) files in the bucket.

            If versioning is enabled for the bucket, Macie calculates this value based on the size of the latest version of each applicable object in the bucket. This value doesn't reflect the storage size of all versions of each applicable object in the bucket.

          • unclassifiableObjectCount — (map)

            The total number of objects that Amazon Macie can't analyze in the bucket. These objects don't use a supported storage class or don't have a file name extension for a supported file or storage format.

            • fileType — (Integer)

              The total storage size (in bytes) or number of objects that Amazon Macie can't analyze because the objects don't have a file name extension for a supported file or storage format.

            • storageClass — (Integer)

              The total storage size (in bytes) or number of objects that Amazon Macie can't analyze because the objects use an unsupported storage class.

            • total — (Integer)

              The total storage size (in bytes) or number of objects that Amazon Macie can't analyze because the objects use an unsupported storage class or don't have a file name extension for a supported file or storage format.

          • unclassifiableObjectSizeInBytes — (map)

            The total storage size, in bytes, of the objects that Amazon Macie can't analyze in the bucket. These objects don't use a supported storage class or don't have a file name extension for a supported file or storage format.

            • fileType — (Integer)

              The total storage size (in bytes) or number of objects that Amazon Macie can't analyze because the objects don't have a file name extension for a supported file or storage format.

            • storageClass — (Integer)

              The total storage size (in bytes) or number of objects that Amazon Macie can't analyze because the objects use an unsupported storage class.

            • total — (Integer)

              The total storage size (in bytes) or number of objects that Amazon Macie can't analyze because the objects use an unsupported storage class or don't have a file name extension for a supported file or storage format.

      • nextToken — (String)

        The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

Returns:

  • (AWS.Request)

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

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

Adds or updates one or more tags (keys and values) that are associated with a classification job, custom data identifier, findings filter, or member account.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: { /* required */
    '<__string>': 'STRING_VALUE',
    /* '<__string>': ... */
  }
};
macie2.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 classification job, custom data identifier, findings filter, or member account.

    • tags — (map<String>)

      A map of key-value pairs that specifies the tags to associate with the resource.

      A resource can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

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.

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

Tests a custom data identifier.

Service Reference:

Examples:

Calling the testCustomDataIdentifier operation

var params = {
  regex: 'STRING_VALUE', /* required */
  sampleText: 'STRING_VALUE', /* required */
  ignoreWords: [
    'STRING_VALUE',
    /* more items */
  ],
  keywords: [
    'STRING_VALUE',
    /* more items */
  ],
  maximumMatchDistance: 'NUMBER_VALUE'
};
macie2.testCustomDataIdentifier(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: {})
    • ignoreWords — (Array<String>)

      An array that lists specific character sequences (ignore words) to exclude from the results. If the text matched by the regular expression is the same as any string in this array, Amazon Macie ignores it. The array can contain as many as 10 ignore words. Each ignore word can contain 4-90 UTF-8 characters. Ignore words are case sensitive.

    • keywords — (Array<String>)

      An array that lists specific character sequences (keywords), one of which must be within proximity (maximumMatchDistance) of the regular expression to match. The array can contain as many as 50 keywords. Each keyword can contain 3-90 UTF-8 characters. Keywords aren't case sensitive.

    • maximumMatchDistance — (Integer)

      The maximum number of characters that can exist between text that matches the regex pattern and the character sequences specified by the keywords array. Amazon Macie includes or excludes a result based on the proximity of a keyword to text that matches the regex pattern. The distance can be 1-300 characters. The default value is 50.

    • regex — (String)

      The regular expression (regex) that defines the pattern to match. The expression can contain as many as 512 characters.

    • sampleText — (String)

      The sample text to inspect by using the custom data identifier. The text can contain as many as 1,000 characters.

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:

      • matchCount — (Integer)

        The number of instances of sample text that matched the detection criteria specified in the custom data identifier.

Returns:

  • (AWS.Request)

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

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

Removes one or more tags (keys and values) from a classification job, custom data identifier, findings filter, or member account.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
macie2.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 classification job, custom data identifier, findings filter, or member account.

    • tagKeys — (Array<String>)

      The key of the tag to remove from the resource. To remove multiple tags, append the tagKeys parameter and argument for each additional tag to remove, separated by an ampersand (&).

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.

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

Changes the status of a classification job.

Service Reference:

Examples:

Calling the updateClassificationJob operation

var params = {
  jobId: 'STRING_VALUE', /* required */
  jobStatus: RUNNING | PAUSED | CANCELLED | COMPLETE | IDLE | USER_PAUSED /* required */
};
macie2.updateClassificationJob(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: {})
    • jobId — (String)

      The unique identifier for the classification job.

    • jobStatus — (String)

      The new status for the job. Valid values are:

      • CANCELLED - Stops the job permanently and cancels it. This value is valid only if the job's current status is IDLE, PAUSED, RUNNING, or USER_PAUSED.

        If you specify this value and the job's current status is RUNNING, Amazon Macie immediately begins to stop all processing tasks for the job. You can't resume or restart a job after you cancel it.

      • RUNNING - Resumes the job. This value is valid only if the job's current status is USER_PAUSED.

        If you paused the job while it was actively running and you specify this value less than 30 days after you paused the job, Macie immediately resumes processing from the point where you paused the job. Otherwise, Macie resumes the job according to the schedule and other settings for the job.

      • USER_PAUSED - Pauses the job temporarily. This value is valid only if the job's current status is IDLE, PAUSED, or RUNNING. If you specify this value and the job's current status is RUNNING, Macie immediately begins to pause all processing tasks for the job.

        If you pause a one-time job and you don't resume it within 30 days, the job expires and Macie cancels the job. If you pause a recurring job when its status is RUNNING and you don't resume it within 30 days, the job run expires and Macie cancels the run. To check the expiration date, refer to the UserPausedDetails.jobExpiresAt property.

      Possible values include:
      • "RUNNING"
      • "PAUSED"
      • "CANCELLED"
      • "COMPLETE"
      • "IDLE"
      • "USER_PAUSED"

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.

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

Updates the criteria and other settings for a findings filter.

Service Reference:

Examples:

Calling the updateFindingsFilter operation

var params = {
  id: 'STRING_VALUE', /* required */
  action: ARCHIVE | NOOP,
  clientToken: 'STRING_VALUE',
  description: 'STRING_VALUE',
  findingCriteria: {
    criterion: {
      '<__string>': {
        eq: [
          'STRING_VALUE',
          /* more items */
        ],
        eqExactMatch: [
          'STRING_VALUE',
          /* more items */
        ],
        gt: 'NUMBER_VALUE',
        gte: 'NUMBER_VALUE',
        lt: 'NUMBER_VALUE',
        lte: 'NUMBER_VALUE',
        neq: [
          'STRING_VALUE',
          /* more items */
        ]
      },
      /* '<__string>': ... */
    }
  },
  name: 'STRING_VALUE',
  position: 'NUMBER_VALUE'
};
macie2.updateFindingsFilter(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: {})
    • action — (String)

      The action to perform on findings that meet the filter criteria (findingCriteria). Valid values are: ARCHIVE, suppress (automatically archive) the findings; and, NOOP, don't perform any action on the findings.

      Possible values include:
      • "ARCHIVE"
      • "NOOP"
    • description — (String)

      A custom description of the filter. The description can contain as many as 512 characters.

      We strongly recommend that you avoid including any sensitive data in the description of a filter. Other users might be able to see the filter's description, depending on the actions that they're allowed to perform in Amazon Macie.

    • findingCriteria — (map)

      The criteria to use to filter findings.

      • criterion — (map<map>)

        A condition that specifies the property, operator, and one or more values to use to filter the results.

        • eq — (Array<String>)

          The value for the property matches (equals) the specified value. If you specify multiple values, Macie uses OR logic to join the values.

        • eqExactMatch — (Array<String>)

          The value for the property exclusively matches (equals an exact match for) all the specified values. If you specify multiple values, Amazon Macie uses AND logic to join the values.

          You can use this operator with the following properties: customDataIdentifiers.detections.arn, customDataIdentifiers.detections.name, resourcesAffected.s3Bucket.tags.key, resourcesAffected.s3Bucket.tags.value, resourcesAffected.s3Object.tags.key, resourcesAffected.s3Object.tags.value, sensitiveData.category, and sensitiveData.detections.type.

        • gt — (Integer)

          The value for the property is greater than the specified value.

        • gte — (Integer)

          The value for the property is greater than or equal to the specified value.

        • lt — (Integer)

          The value for the property is less than the specified value.

        • lte — (Integer)

          The value for the property is less than or equal to the specified value.

        • neq — (Array<String>)

          The value for the property doesn't match (doesn't equal) the specified value. If you specify multiple values, Macie uses OR logic to join the values.

    • id — (String)

      The unique identifier for the Amazon Macie resource or account that the request applies to.

    • name — (String)

      A custom name for the filter. The name must contain at least 3 characters and can contain as many as 64 characters.

      We strongly recommend that you avoid including any sensitive data in the name of a filter. Other users might be able to see the filter's name, depending on the actions that they're allowed to perform in Amazon Macie.

    • position — (Integer)

      The position of the filter in the list of saved filters on the Amazon Macie console. This value also determines the order in which the filter is applied to findings, relative to other filters that are also applied to the findings.

    • clientToken — (String)

      A unique, case-sensitive token that you provide to ensure the idempotency of the request.

      If a token is not provided, the SDK will use a version 4 UUID.

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:

      • arn — (String)

        The Amazon Resource Name (ARN) of the filter that was updated.

      • id — (String)

        The unique identifier for the filter that was updated.

Returns:

  • (AWS.Request)

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

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

Suspends or re-enables an Amazon Macie account, or updates the configuration settings for a Macie account.

Service Reference:

Examples:

Calling the updateMacieSession operation

var params = {
  findingPublishingFrequency: FIFTEEN_MINUTES | ONE_HOUR | SIX_HOURS,
  status: PAUSED | ENABLED
};
macie2.updateMacieSession(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: {})
    • findingPublishingFrequency — (String)

      Specifies how often to publish updates to policy findings for the account. This includes publishing updates to Security Hub and Amazon EventBridge (formerly called Amazon CloudWatch Events).

      Possible values include:
      • "FIFTEEN_MINUTES"
      • "ONE_HOUR"
      • "SIX_HOURS"
    • status — (String)

      Specifies a new status for the account. Valid values are: ENABLED, resume all Amazon Macie activities for the account; and, PAUSED, suspend all Macie activities for the account.

      Possible values include:
      • "PAUSED"
      • "ENABLED"

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.

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

Enables an Amazon Macie administrator to suspend or re-enable a member account.

Service Reference:

Examples:

Calling the updateMemberSession operation

var params = {
  id: 'STRING_VALUE', /* required */
  status: PAUSED | ENABLED /* required */
};
macie2.updateMemberSession(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: {})
    • id — (String)

      The unique identifier for the Amazon Macie resource or account that the request applies to.

    • status — (String)

      Specifies the new status for the account. Valid values are: ENABLED, resume all Amazon Macie activities for the account; and, PAUSED, suspend all Macie activities for the account.

      Possible values include:
      • "PAUSED"
      • "ENABLED"

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.

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

Updates the Amazon Macie configuration settings for an Amazon Web Services organization.

Service Reference:

Examples:

Calling the updateOrganizationConfiguration operation

var params = {
  autoEnable: true || false /* required */
};
macie2.updateOrganizationConfiguration(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: {})
    • autoEnable — (Boolean)

      Specifies whether to enable Amazon Macie automatically for each account, when the account is added to the Amazon Web Services organization.

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.