AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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)

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

  • 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.
  • 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 */
  masterAccount: 'STRING_VALUE' /* required */
};
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: {})
    • invitationId — (String)

      The unique identifier for the invitation to accept.

    • masterAccount — (String)

      The AWS account ID for the account that sent the 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.

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 strings that lists the unique identifiers for the custom data identifiers 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 identifiers, one for each 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 */
    bucketDefinitions: [
      {
        accountId: 'STRING_VALUE',
        buckets: [
          'STRING_VALUE',
          /* more items */
        ]
      },
      /* more items */
    ],
    scoping: {
      excludes: {
        and: [
          {
            simpleScopeTerm: {
              comparator: EQ | GT | GTE | LT | LTE | NE | CONTAINS,
              key: BUCKET_CREATION_DATE | OBJECT_EXTENSION | OBJECT_LAST_MODIFIED_DATE | OBJECT_SIZE | TAG,
              values: [
                'STRING_VALUE',
                /* more items */
              ]
            },
            tagScopeTerm: {
              comparator: EQ | GT | GTE | LT | LTE | NE | CONTAINS,
              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,
              key: BUCKET_CREATION_DATE | OBJECT_EXTENSION | OBJECT_LAST_MODIFIED_DATE | OBJECT_SIZE | TAG,
              values: [
                'STRING_VALUE',
                /* more items */
              ]
            },
            tagScopeTerm: {
              comparator: EQ | GT | GTE | LT | LTE | NE | CONTAINS,
              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,
  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>)

      The custom data identifiers to use for data analysis and classification.

    • description — (String)

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

    • initialRun — (Boolean)

      Specifies whether to run the job immediately, after it's created.

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

      A custom name for the job. The name must contain at least 3 characters and can contain as many as 64 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 bucket that contains objects to analyze.

        • accountId — (String)

          The unique identifier for the AWS account that owns one or more of the buckets. If specified, the job analyzes objects in all the buckets that are owned by the account and meet other conditions specified for the job.

        • buckets — (Array<String>)

          An array that lists the names of the buckets.

      • scoping — (map)

        A JobScopeTerm object that specifies conditions for including or excluding objects from the job.

        • excludes — (map)

          Reserved for future use.

          • and — (Array<map>)

            Reserved for future use.

            • simpleScopeTerm — (map)

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

              • comparator — (String)

                The operator to use in the condition.

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

                The property to use in the condition.

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

                An array that lists one or more values to use in the condition.

            • tagScopeTerm — (map)

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

              • comparator — (String)

                The operator to use in the condition.

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

                The tag key to use in the condition.

              • tagValues — (Array<map>)

                The 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, associated with the specified tag key, to use in the condition.

              • target — (String)

                The type of object to apply the condition to.

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

          Reserved for future use.

          • and — (Array<map>)

            Reserved for future use.

            • simpleScopeTerm — (map)

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

              • comparator — (String)

                The operator to use in the condition.

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

                The property to use in the condition.

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

                An array that lists one or more values to use in the condition.

            • tagScopeTerm — (map)

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

              • comparator — (String)

                The operator to use in the condition.

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

                The tag key to use in the condition.

              • tagValues — (Array<map>)

                The 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, associated with the specified tag key, to use in the condition.

              • target — (String)

                The type of object to apply the condition to.

                Possible values include:
                • "S3_OBJECT"
    • samplingPercentage — (Integer)

      The sampling depth, as a percentage, to apply when processing objects. This value determines the percentage of eligible objects that the job analyzes. If the value is less than 100, Amazon Macie randomly selects the objects to analyze, up to the specified percentage.

    • 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 of the jobType property to ONE_TIME.

      • dailySchedule — (map)

        Run the job once a day, every day. If specified, this is an empty object.

      • monthlySchedule — (map)

        Run the job once a month, on a specific day of the month. This value can be an integer from 1 through 30.

        • dayOfMonth — (Integer)

          Run the job once a month, on a specific day of the month. This value can be an integer from 1 through 30.

      • weeklySchedule — (map)

        Run the job once a week, on a specific day of the week. Valid values are: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, and SUNDAY.

        • dayOfWeek — (String)

          Run the job once a week, on a specific day of the week. Valid values are: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, and SUNDAY.

          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 required 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 up to 120 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 characters.

    • 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 4 - 90 characters.

    • 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. 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 120 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 500 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 required 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 */
        ],
        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 value to use to filter the results.

        • eq — (Array<String>)

          An equal to condition to apply to a specified property value for findings.

        • gt — (Integer)

          A greater than condition to apply to a specified property value for findings.

        • gte — (Integer)

          A greater than or equal to condition to apply to a specified property value for findings.

        • lt — (Integer)

          A less than condition to apply to a specified property value for findings.

        • lte — (Integer)

          A less than or equal to condition to apply to a specified property value for findings.

        • neq — (Array<String>)

          A not equal to condition to apply to a specified property value for findings.

    • 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 required 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 AWS 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 AWS 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 AWS 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 master 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 for the account to associate with the master account.

      • accountIdrequired — (String)

        The AWS 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 required 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 master 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 AWS 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 AWS 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

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 AWS 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 AWS 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 master 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>)

        An equal to condition to apply to a specified attribute value for buckets.

      • gt — (Integer)

        A greater than condition to apply to a specified attribute value for buckets.

      • gte — (Integer)

        A greater than or equal to condition to apply to a specified attribute value for buckets.

      • lt — (Integer)

        A less than condition to apply to a specified attribute value for buckets.

      • lte — (Integer)

        A less than or equal to condition to apply to a specified attribute value for buckets.

      • neq — (Array<String>)

        A not equal to condition to apply to a specified attribute value for buckets.

      • prefix — (String)

        The prefix of the buckets to include in the results.

    • 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 attribute to sort the results by. This value can be the name of any property that Amazon Macie defines as bucket metadata, such as bucketName, accountId, or lastUpdated.

      • 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:

      • 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 AWS account that's associated with the bucket.

        • 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 monitor and analyze in the bucket. These objects use a file format, file extension, or content type that Amazon Macie supports.

        • lastUpdated — (Date)

          The date and time, in UTC and extended ISO 8601 format, when Amazon Macie last analyzed 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.

          • customerManaged — (Integer)

            Reserved for future use.

          • kmsManaged — (Integer)

            Reserved for future use.

          • s3Managed — (Integer)

            Reserved for future use.

          • unencrypted — (Integer)

            Reserved for future use.

        • publicAccess — (map)

          Specifies whether the bucket is publicly accessible. If this value is true, an access control list (ACL), bucket policy, or block public access settings allow the bucket to be accessed by the general public.

          • effectivePermission — (String)

            Specifies whether the bucket is publicly accessible due to the combination of permissions settings that apply to the bucket. Possible values are: PUBLIC, the bucket is publicly accessible; and, NOT_PUBLIC, the bucket isn't publicly accessible.

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

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

            • accountLevelPermissions — (map)

              The account-level permissions settings that apply to 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.

            • 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 AWS Region that hosts the bucket.

        • replicationDetails — (map)

          Specifies whether the bucket is configured to replicate one or more objects to buckets for other AWS 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 AWS account that isn't part of the Amazon Macie organization.

          • replicationAccounts — (Array<String>)

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

        • sharedAccess — (String)

          Specifies whether the bucket is shared with another AWS account or configured to support cross-origin resource sharing (CORS). Valid values are:

          • EXTERNAL - The bucket is shared with an AWS account that isn’t part of the Amazon Macie organization.

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

          • NOT_SHARED - The bucket isn't shared with other AWS accounts.

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

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

        • sizeInBytesCompressed — (Integer)

          The total compressed storage size, in bytes, of 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 empty or null.

        • 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 information about 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>)

        The custom data identifiers that the job uses to analyze data.

      • description — (String)

        The custom description of the job.

      • initialRun — (Boolean)

        Specifies whether the job has run for the first time.

      • 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 value are:

        • CANCELLED - The job was cancelled by you or a user of the master account for your organization. A job might also be cancelled if ownership of an S3 bucket changed while the job was running, and that change affected the job's access to the bucket.

        • COMPLETE - Amazon Macie finished processing all the data specified for the job.

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

        • PAUSED - Amazon Macie started the job, but completion of the job would exceed one or more quotas for your account.

        • RUNNING - The job is in progress.

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

        The schedule for running the job. Possible value are:

        • ONE_TIME - The job ran or will run 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"
      • lastRunTime — (Date)

        The date and time, in UTC and extended ISO 8601 format, when the job last ran.

      • name — (String)

        The custom name of the job.

      • s3JobDefinition — (map)

        The S3 buckets that the job is configured to analyze, and the scope of that analysis.

        • bucketDefinitions — (Array<map>)

          An array of objects, one for each bucket that contains objects to analyze.

          • accountId — (String)

            The unique identifier for the AWS account that owns one or more of the buckets. If specified, the job analyzes objects in all the buckets that are owned by the account and meet other conditions specified for the job.

          • buckets — (Array<String>)

            An array that lists the names of the buckets.

        • scoping — (map)

          A JobScopeTerm object that specifies conditions for including or excluding objects from the job.

          • excludes — (map)

            Reserved for future use.

            • and — (Array<map>)

              Reserved for future use.

              • simpleScopeTerm — (map)

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

                • comparator — (String)

                  The operator to use in the condition.

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

                  The property to use in the condition.

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

                  An array that lists one or more values to use in the condition.

              • tagScopeTerm — (map)

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

                • comparator — (String)

                  The operator to use in the condition.

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

                  The tag key to use in the condition.

                • tagValues — (Array<map>)

                  The 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, associated with the specified tag key, to use in the condition.

                • target — (String)

                  The type of object to apply the condition to.

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

            Reserved for future use.

            • and — (Array<map>)

              Reserved for future use.

              • simpleScopeTerm — (map)

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

                • comparator — (String)

                  The operator to use in the condition.

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

                  The property to use in the condition.

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

                  An array that lists one or more values to use in the condition.

              • tagScopeTerm — (map)

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

                • comparator — (String)

                  The operator to use in the condition.

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

                  The tag key to use in the condition.

                • tagValues — (Array<map>)

                  The 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, associated with the specified tag key, to use in the condition.

                • target — (String)

                  The type of object to apply the condition to.

                  Possible values include:
                  • "S3_OBJECT"
      • samplingPercentage — (Integer)

        The sampling depth, as a percentage, that the job applies when it processes objects.

      • scheduleFrequency — (map)

        The recurrence pattern for running the job. If the job is configured to run every day, this value is an empty dailySchedule object. If the job is configured to run only once, this value is null.

        • dailySchedule — (map)

          Run the job once a day, every day. If specified, this is an empty object.

        • monthlySchedule — (map)

          Run the job once a month, on a specific day of the month. This value can be an integer from 1 through 30.

          • dayOfMonth — (Integer)

            Run the job once a month, on a specific day of the month. This value can be an integer from 1 through 30.

        • weeklySchedule — (map)

          Run the job once a week, on a specific day of the week. Valid values are: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, and SUNDAY.

          • dayOfWeek — (String)

            Run the job once a week, on a specific day of the week. Valid values are: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, and SUNDAY.

            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 most recent 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 identifies the tags (keys and values) that are associated with the classification job.

Returns:

  • (AWS.Request)

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

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

Retrieves information about the Amazon Macie configuration settings for an AWS 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 AWS organization.

      • maxAccountLimitReached — (Boolean)

        Specifies whether the maximum number of Amazon Macie member accounts are already associated with the AWS 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 a delegated administrator of Amazon Macie for an AWS 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 AWS account ID of the delegated administrator account.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

Returns:

  • (AWS.Request)

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

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

Disassociates a member account from its Amazon Macie master account.

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 master 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 AWS Security Hub and Amazon EventBridge (formerly called Amazon CloudWatch Events). Possible values include:
      • "FIFTEEN_MINUTES"
      • "ONE_HOUR"
      • "SIX_HOURS"
    • status — (String)

      Specifies the status for the account. To enable Amazon Macie and start all Amazon 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

Enables an account as a delegated administrator of Amazon Macie for an AWS 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 AWS account ID for the account.

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

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

          Reserved for future use.

        • publiclyReadable — (Integer)

          Reserved for future use.

        • publiclyWritable — (Integer)

          Reserved for future use.

      • bucketCountByEncryptionType — (map)

        The total number of buckets, grouped by server-side encryption type. This object also reports the total number of buckets that aren't encrypted.

        • kmsManaged — (Integer)

          Reserved for future use.

        • s3Managed — (Integer)

          Reserved for future use.

        • unencrypted — (Integer)

          Reserved for future use.

      • bucketCountBySharedAccessType — (map)

        The total number of buckets that are shared with another AWS account or configured to support cross-origin resource sharing (CORS).

        • external — (Integer)

          Reserved for future use.

        • internal — (Integer)

          Reserved for future use.

        • notShared — (Integer)

          Reserved for future use.

      • classifiableObjectCount — (Integer)

        The total number of objects that Amazon Macie can monitor and analyze in all the buckets. These objects use a file format, file extension, or content type that Amazon Macie supports.

      • lastUpdated — (Date)

        The date and time, in UTC and extended ISO 8601 format, when Amazon Macie last analyzed the buckets.

      • objectCount — (Integer)

        The total number of objects in all the buckets.

      • sizeInBytes — (Integer)

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

      • sizeInBytesCompressed — (Integer)

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

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 AWS Key Management Service 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 AWS Region as the bucket.

Returns:

  • (AWS.Request)

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

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

Retrieves information about 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.

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

      • 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. 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 information about 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 information about.

    • 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 identifier for the AWS account that the finding applies to. This is typically the account that owns the affected resource.

        • archived — (Boolean)

          Specifies whether the finding is archived.

        • 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 Amazon Resource Name (ARN) of the file that contains the detailed record, including offsets, for the finding.

          • 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 detailed results of the finding.

            • customDataIdentifiers — (map)

              The number of occurrences of the data that produced the finding, and the custom data identifiers that detected the data.

              • detections — (Array<map>)

                The names of 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 data that the custom data identifier detected for the finding.

                • name — (String)

                  The name of the custom data identifier.

              • 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, expressed 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 PDF file.

            • sensitiveData — (Array<map>)

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

              • category — (String)

                The category of sensitive data that was detected. For example: FINANCIAL_INFORMATION, for financial information such as credit card numbers; PERSONAL_INFORMATION, for personally identifiable information such as full names and mailing addresses; or, CUSTOM_IDENTIFIER, for data that was detected by a custom data identifier.

                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.

                • count — (Integer)

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

                • type — (String)

                  The type of 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, such as COMPLETE.

              • 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 this finding.

        • 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 AWS 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 occurred and 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)

              For the affected resource:

              • The name of the operation that was invoked most recently and produced the finding (api).

              • The first date and time when any operation was invoked and produced the finding (firstSeen).

              • The most recent date and time when the specified operation was invoked and produced the finding (lastSeen).

              All date and time values are in UTC and extended ISO 8601 format.

              • api — (String)

                Reserved for future use.

              • apiServiceName — (String)

                Reserved for future use.

              • firstSeen — (Date)

                Reserved for future use.

              • lastSeen — (Date)

                Reserved for future use.

          • actor — (map)

            The entity that performed the action that produced the finding.

            • domainDetails — (map)

              The DNS name of the entity that performed the action on the affected resource.

              • domainName — (String)

                Reserved for future use.

            • 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 geographical location for the IP address.

              • ipAddressV4 — (String)

                Reserved for future use.

              • ipCity — (map)

                Reserved for future use.

                • name — (String)

                  Reserved for future use.

              • ipCountry — (map)

                Reserved for future use.

                • code — (String)

                  Reserved for future use.

                • name — (String)

                  Reserved for future use.

              • ipGeoLocation — (map)

                Reserved for future use.

                • lat — (Float)

                  Reserved for future use.

                • lon — (Float)

                  Reserved for future use.

              • ipOwner — (map)

                Reserved for future use.

                • asn — (String)

                  Reserved for future use.

                • asnOrg — (String)

                  Reserved for future use.

                • isp — (String)

                  Reserved for future use.

                • org — (String)

                  Reserved for future use.

            • userIdentity — (map)

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

              • assumedRole — (map)

                Reserved for future use.

                • accessKeyId — (String)

                  Reserved for future use.

                • accountId — (String)

                  Reserved for future use.

                • arn — (String)

                  Reserved for future use.

                • principalId — (String)

                  Reserved for future use.

                • sessionContext — (map)

                  Reserved for future use.

                  • 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 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 the entity obtained.

                    • accountId — (String)

                      The 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 internal 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)

                Reserved for future use.

                • accountId — (String)

                  Reserved for future use.

                • principalId — (String)

                  Reserved for future use.

              • awsService — (map)

                Reserved for future use.

                • invokedBy — (String)

                  Reserved for future use.

              • federatedUser — (map)

                Reserved for future use.

                • accessKeyId — (String)

                  Reserved for future use.

                • accountId — (String)

                  Reserved for future use.

                • arn — (String)

                  Reserved for future use.

                • principalId — (String)

                  Reserved for future use.

                • sessionContext — (map)

                  Reserved for future use.

                  • 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 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 the entity obtained.

                    • accountId — (String)

                      The 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 internal 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)

                Reserved for future use.

                • accountId — (String)

                  Reserved for future use.

                • arn — (String)

                  Reserved for future use.

                • principalId — (String)

                  Reserved for future use.

                • userName — (String)

                  Reserved for future use.

              • root — (map)

                Reserved for future use.

                • accountId — (String)

                  Reserved for future use.

                • arn — (String)

                  Reserved for future use.

                • principalId — (String)

                  Reserved for future use.

              • type — (String)

                Reserved for future use.

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

          The AWS Region that Amazon Macie created the finding in.

        • resourcesAffected — (map)

          The resources that the finding applies to.

          • s3Bucket — (map)

            An array of objects, one for each S3 bucket that the finding applies to. Each object provides a set of metadata about an affected S3 bucket.

            • 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 server-side encryption settings for the bucket.

              • encryptionType — (String)

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

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

                The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) master key that's used to encrypt the bucket or object. This value is null if KMS isn't used to encrypt the bucket or object.

            • name — (String)

              The name of the bucket.

            • owner — (map)

              The display name and account identifier for the user who owns the bucket.

              • displayName — (String)

                The display name of the user who owns the bucket.

              • id — (String)

                The AWS account ID for the user who 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: PUBLIC, the bucket is publicly accessible; and, NOT_PUBLIC, the bucket isn't publicly accessible.

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

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

                • accountLevelPermissions — (map)

                  The account-level permissions settings that apply to 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.

                • 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 empty or null.

          • s3Object — (map)

            An array of objects, one for each S3 object that the finding applies to. Each object provides a set of metadata about an affected S3 object.

            • 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 extension of the object. If the object doesn't have a file 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 server-side encryption settings for the object.

              • encryptionType — (String)

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

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

                The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) master key that's used to encrypt the bucket or object. This value is null if KMS isn't used to encrypt the bucket or object.

            • 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 empty or null.

            • 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 of the finding.

          • description — (String)

            The textual representation of the severity value, such as Low or High.

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

            The numeric score for the severity value, ranging from 0 (least severe) to 4 (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. Sensitive data findings aren't updated.

Returns:

  • (AWS.Request)

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

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

Retrieves information about 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 value to use to filter the results.

          • eq — (Array<String>)

            An equal to condition to apply to a specified property value for findings.

          • gt — (Integer)

            A greater than condition to apply to a specified property value for findings.

          • gte — (Integer)

            A greater than or equal to condition to apply to a specified property value for findings.

          • lt — (Integer)

            A less than condition to apply to a specified property value for findings.

          • lte — (Integer)

            A less than or equal to condition to apply to a specified property value for findings.

          • neq — (Array<String>)

            A not equal to condition to apply to a specified property value for findings.

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

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 */
        ],
        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 value to use to filter the results.

        • eq — (Array<String>)

          An equal to condition to apply to a specified property value for findings.

        • gt — (Integer)

          A greater than condition to apply to a specified property value for findings.

        • gte — (Integer)

          A greater than or equal to condition to apply to a specified property value for findings.

        • lt — (Integer)

          A less than condition to apply to a specified property value for findings.

        • lte — (Integer)

          A less than or equal to condition to apply to a specified property value for findings.

        • neq — (Array<String>)

          A not equal to condition to apply to a specified property value for findings.

    • 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 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 information about 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 Amazon Macie publishes updates to policy findings for the account. This includes publishing updates to AWS 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-level role that allows Amazon Macie to monitor and analyze data in AWS resources for the account.

      • status — (String)

        The current status of the Amazon Macie account. Possible values are: PAUSED, the account is enabled but all Amazon Macie activities are suspended (paused) for the account; and, ENABLED, the account is enabled and all Amazon 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 Amazon Macie account.

Returns:

  • (AWS.Request)

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

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

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

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)

        The AWS account ID for the master account. If the accounts are associated by a Macie membership invitation, this object also provides details about the invitation that was sent and accepted to establish the relationship between the accounts.

        • accountId — (String)

          The AWS 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"

Returns:

  • (AWS.Request)

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

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

Retrieves information about a member account that's associated with an Amazon Macie master 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 AWS account ID for the 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)

        The AWS account ID for the master account.

      • relationshipStatus — (String)

        The current status of the relationship between the account and the master account.

        Possible values include:
        • "Enabled"
        • "Paused"
        • "Invited"
        • "Created"
        • "Removed"
        • "Resigned"
        • "EmailVerificationInProgress"
        • "EmailVerificationFailed"
      • 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 master 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: [
    {
      key: accountId,
      values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  sortBy: {
    key: accountId | total,
    orderBy: ASC | DESC
  }
};
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>)

      The criteria to use to filter the query results.

      • key — (String)

        The field to use to filter the results. The only supported value is accountId.

        Possible values include:
        • "accountId"
      • values — (Array<String>)

        An array that lists the AWS account ID for each account to include in 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.

    • 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"
      • 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"

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 AWS account ID for the account that the data applies to.

        • freeTrialStartDate — (Date)

          The date and time, in UTC and extended ISO 8601 format, when the free trial period started for the account. This value is null if the account didn't participate in the free trial.

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

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

Retrieves (queries) aggregated usage data for an account.

Service Reference:

Examples:

Calling the getUsageTotals operation

var params = {
};
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: {})

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:

      • 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 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 information about the status and settings for one or more classification jobs.

Service Reference:

Examples:

Calling the listClassificationJobs operation

var params = {
  filterCriteria: {
    excludes: [
      {
        comparator: EQ | GT | GTE | LT | LTE | NE | CONTAINS,
        key: jobType | jobStatus | createdAt | name,
        values: [
          'STRING_VALUE',
          /* more items */
        ]
      },
      /* more items */
    ],
    includes: [
      {
        comparator: EQ | GT | GTE | LT | LTE | NE | CONTAINS,
        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"
        • 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"
        • 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>)

          The S3 buckets that the job is configured to analyze.

          • accountId — (String)

            The unique identifier for the AWS account that owns one or more of the buckets. If specified, the job analyzes objects in all the buckets that are owned by the account and meet other conditions specified for the job.

          • buckets — (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 value are:

          • CANCELLED - The job was cancelled by you or a user of the master account for your organization. A job might also be cancelled if ownership of an S3 bucket changed while the job was running, and that change affected the job's access to the bucket.

          • COMPLETE - Amazon Macie finished processing all the data specified for the job.

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

          • PAUSED - Amazon Macie started the job, but completion of the job would exceed one or more quotas for your account.

          • RUNNING - The job is in progress.

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

          The schedule for running the job. Possible value are:

          • ONE_TIME - The job ran or will run only once.

          • SCHEDULED - The job runs on a daily, weekly, or monthly basis.

          Possible values include:
          • "ONE_TIME"
          • "SCHEDULED"
        • name — (String)

          The custom name of the job.

      • 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 */
        ],
        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 value to use to filter the results.

        • eq — (Array<String>)

          An equal to condition to apply to a specified property value for findings.

        • gt — (Integer)

          A greater than condition to apply to a specified property value for findings.

        • gte — (Integer)

          A greater than or equal to condition to apply to a specified property value for findings.

        • lt — (Integer)

          A less than condition to apply to a specified property value for findings.

        • lte — (Integer)

          A less than or equal to condition to apply to a specified property value for findings.

        • neq — (Array<String>)

          A not equal to condition to apply to a specified property value for findings.

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

        • 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 all 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 AWS 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"
      • 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 master 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 master account. By default, the response includes only current member accounts. To include all accounts, set the value for this parameter 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 master account and meets the criteria specified by the onlyAssociated request parameter.

        • accountId — (String)

          The AWS account ID for the 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)

          The AWS account ID for the master account.

        • relationshipStatus — (String)

          The current status of the relationship between the account and the master account.

          Possible values include:
          • "Enabled"
          • "Paused"
          • "Invited"
          • "Created"
          • "Removed"
          • "Resigned"
          • "EmailVerificationInProgress"
          • "EmailVerificationFailed"
        • 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 master 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 account that's designated as the delegated administrator of Amazon Macie for an AWS 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 account that's designated as a delegated administrator of Amazon Macie for the AWS organization. Of those accounts, only one can have a status of ENABLED.

        • accountId — (String)

          The AWS account ID for the account.

        • status — (String)

          The current status of the account as a 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 AWS Key Management Service 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 AWS 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 AWS Key Management Service 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 AWS Region as the bucket.

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 required 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 characters.

    • 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 4 - 90 characters.

    • 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. 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 500 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

Cancels a classification job.

Service Reference:

Examples:

Calling the updateClassificationJob operation

var params = {
  jobId: 'STRING_VALUE', /* required */
  jobStatus: RUNNING | PAUSED | CANCELLED | COMPLETE | IDLE /* 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 status to change the job's status to. The only supported value is CANCELLED, which cancels the job completely.

      Possible values include:
      • "RUNNING"
      • "PAUSED"
      • "CANCELLED"
      • "COMPLETE"
      • "IDLE"

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,
  description: 'STRING_VALUE',
  findingCriteria: {
    criterion: {
      '<__string>': {
        eq: [
          '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 value to use to filter the results.

        • eq — (Array<String>)

          An equal to condition to apply to a specified property value for findings.

        • gt — (Integer)

          A greater than condition to apply to a specified property value for findings.

        • gte — (Integer)

          A greater than or equal to condition to apply to a specified property value for findings.

        • lt — (Integer)

          A less than condition to apply to a specified property value for findings.

        • lte — (Integer)

          A less than or equal to condition to apply to a specified property value for findings.

        • neq — (Array<String>)

          A not equal to condition to apply to a specified property value for findings.

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

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 AWS Security Hub and Amazon EventBridge (formerly called Amazon CloudWatch Events). Possible values include:
      • "FIFTEEN_MINUTES"
      • "ONE_HOUR"
      • "SIX_HOURS"
    • status — (String)

      Specifies whether to change the status of 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 master account 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 Amazon Macie configuration settings for an AWS 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 Amazon Macie is enabled automatically for each account, when the account is added to the AWS 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.