Class: AWS.Macie

Inherits:
AWS.Service show all
Identifier:
macie
API Version:
2017-12-19
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 security service that uses machine learning to automatically discover, classify, and protect sensitive data in AWS. Macie recognizes sensitive data such as personally identifiable information (PII) or intellectual property, and provides you with dashboards and alerts that give visibility into how this data is being accessed or moved. For more information, see the Macie User Guide.

Sending a Request Using Macie

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

var macie = new AWS.Macie({apiVersion: '2017-12-19'});

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

AWS.config.apiVersions = {
  macie: '2017-12-19',
  // other service API versions
};

var macie = new AWS.Macie();

Version:

  • 2017-12-19

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

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

Examples:

Constructing a Macie object

var macie = new AWS.Macie({apiVersion: '2017-12-19'});

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

  • maxRetries (Integer)

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

  • maxRedirects (Integer)

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

  • 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 returns the amount of time to delay in milliseconds. 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)

    whether to enable endpoint discovery for operations that allow optionally using an endpoint returned by the service. Defaults to 'false'

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

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

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

Associates a specified AWS account with Amazon Macie as a member account.

Service Reference:

Examples:

Calling the associateMemberAccount operation

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

      The ID of the AWS account that you want to associate with Amazon Macie as a 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.

Returns:

  • (AWS.Request)

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

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

Associates specified S3 resources with Amazon Macie for monitoring and data classification. If memberAccountId isn't specified, the action associates specified S3 resources with Macie for the current master account. If memberAccountId is specified, the action associates specified S3 resources with Macie for the specified member account.

Service Reference:

Examples:

Calling the associateS3Resources operation

var params = {
  s3Resources: [ /* required */
    {
      bucketName: 'STRING_VALUE', /* required */
      classificationType: { /* required */
        continuous: FULL, /* required */
        oneTime: FULL | NONE /* required */
      },
      prefix: 'STRING_VALUE'
    },
    /* more items */
  ],
  memberAccountId: 'STRING_VALUE'
};
macie.associateS3Resources(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: {})
    • memberAccountId — (String)

      The ID of the Amazon Macie member account whose resources you want to associate with Macie.

    • s3Resources — (Array<map>)

      The S3 resources that you want to associate with Amazon Macie for monitoring and data classification.

      • bucketNamerequired — (String)

        The name of the S3 bucket that you want to associate with Amazon Macie.

      • prefix — (String)

        The prefix of the S3 bucket that you want to associate with Amazon Macie.

      • classificationTyperequired — (map)

        The classification type that you want to specify for the resource associated with Amazon Macie.

        • oneTimerequired — (String)

          A one-time classification of all of the existing objects in a specified S3 bucket.

          Possible values include:
          • "FULL"
          • "NONE"
        • continuousrequired — (String)

          A continuous classification of the objects that are added to a specified S3 bucket. Amazon Macie begins performing continuous classification after a bucket is successfully associated with Amazon Macie.

          Possible values include:
          • "FULL"

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:

      • failedS3Resources — (Array<map>)

        S3 resources that couldn't be associated with Amazon Macie. An error code and an error message are provided for each failed item.

        • failedItem — (map)

          The failed S3 resources.

          • bucketNamerequired — (String)

            The name of the S3 bucket.

          • prefix — (String)

            The prefix of the S3 bucket.

        • errorCode — (String)

          The status code of a failed item.

        • errorMessage — (String)

          The error message of a failed item.

Returns:

  • (AWS.Request)

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

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

Removes the specified member account from Amazon Macie.

Service Reference:

Examples:

Calling the disassociateMemberAccount operation

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

      The ID of the member account that you want to remove from Amazon Macie.

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.

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

Removes specified S3 resources from being monitored by Amazon Macie. If memberAccountId isn't specified, the action removes specified S3 resources from Macie for the current master account. If memberAccountId is specified, the action removes specified S3 resources from Macie for the specified member account.

Service Reference:

Examples:

Calling the disassociateS3Resources operation

var params = {
  associatedS3Resources: [ /* required */
    {
      bucketName: 'STRING_VALUE', /* required */
      prefix: 'STRING_VALUE'
    },
    /* more items */
  ],
  memberAccountId: 'STRING_VALUE'
};
macie.disassociateS3Resources(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: {})
    • memberAccountId — (String)

      The ID of the Amazon Macie member account whose resources you want to remove from being monitored by Amazon Macie.

    • associatedS3Resources — (Array<map>)

      The S3 resources (buckets or prefixes) that you want to remove from being monitored and classified by Amazon Macie.

      • bucketNamerequired — (String)

        The name of the S3 bucket.

      • prefix — (String)

        The prefix of the S3 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:

      • failedS3Resources — (Array<map>)

        S3 resources that couldn't be removed from being monitored and classified by Amazon Macie. An error code and an error message are provided for each failed item.

        • failedItem — (map)

          The failed S3 resources.

          • bucketNamerequired — (String)

            The name of the S3 bucket.

          • prefix — (String)

            The prefix of the S3 bucket.

        • errorCode — (String)

          The status code of a failed item.

        • errorMessage — (String)

          The error message of a failed item.

Returns:

  • (AWS.Request)

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

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

Lists all Amazon Macie member accounts for the current Amazon Macie master account.

Service Reference:

Examples:

Calling the listMemberAccounts operation

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

Parameters:

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

      Use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListMemberAccounts action. Subsequent calls to the action fill nextToken in the request with the value of nextToken from the previous response to continue listing data.

    • maxResults — (Integer)

      Use this parameter to indicate the maximum number of items that you want in the response. The default value is 250.

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:

      • memberAccounts — (Array<map>)

        A list of the Amazon Macie member accounts returned by the action. The current master account is also included in this list.

        • accountId — (String)

          The AWS account ID of the Amazon Macie member account.

      • nextToken — (String)

        When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null.

Returns:

  • (AWS.Request)

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

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

Lists all the S3 resources associated with Amazon Macie. If memberAccountId isn't specified, the action lists the S3 resources associated with Amazon Macie for the current master account. If memberAccountId is specified, the action lists the S3 resources associated with Amazon Macie for the specified member account.

Service Reference:

Examples:

Calling the listS3Resources operation

var params = {
  maxResults: 'NUMBER_VALUE',
  memberAccountId: 'STRING_VALUE',
  nextToken: 'STRING_VALUE'
};
macie.listS3Resources(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: {})
    • memberAccountId — (String)

      The Amazon Macie member account ID whose associated S3 resources you want to list.

    • nextToken — (String)

      Use this parameter when paginating results. Set its value to null on your first call to the ListS3Resources action. Subsequent calls to the action fill nextToken in the request with the value of nextToken from the previous response to continue listing data.

    • maxResults — (Integer)

      Use this parameter to indicate the maximum number of items that you want in the response. The default value is 250.

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:

      • s3Resources — (Array<map>)

        A list of the associated S3 resources returned by the action.

        • bucketNamerequired — (String)

          The name of the S3 bucket that you want to associate with Amazon Macie.

        • prefix — (String)

          The prefix of the S3 bucket that you want to associate with Amazon Macie.

        • classificationTyperequired — (map)

          The classification type that you want to specify for the resource associated with Amazon Macie.

          • oneTimerequired — (String)

            A one-time classification of all of the existing objects in a specified S3 bucket.

            Possible values include:
            • "FULL"
            • "NONE"
          • continuousrequired — (String)

            A continuous classification of the objects that are added to a specified S3 bucket. Amazon Macie begins performing continuous classification after a bucket is successfully associated with Amazon Macie.

            Possible values include:
            • "FULL"
      • nextToken — (String)

        When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null.

Returns:

  • (AWS.Request)

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

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

Updates the classification types for the specified S3 resources. If memberAccountId isn't specified, the action updates the classification types of the S3 resources associated with Amazon Macie for the current master account. If memberAccountId is specified, the action updates the classification types of the S3 resources associated with Amazon Macie for the specified member account.

Service Reference:

Examples:

Calling the updateS3Resources operation

var params = {
  s3ResourcesUpdate: [ /* required */
    {
      bucketName: 'STRING_VALUE', /* required */
      classificationTypeUpdate: { /* required */
        continuous: FULL,
        oneTime: FULL | NONE
      },
      prefix: 'STRING_VALUE'
    },
    /* more items */
  ],
  memberAccountId: 'STRING_VALUE'
};
macie.updateS3Resources(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: {})
    • memberAccountId — (String)

      The AWS ID of the Amazon Macie member account whose S3 resources' classification types you want to update.

    • s3ResourcesUpdate — (Array<map>)

      The S3 resources whose classification types you want to update.

      • bucketNamerequired — (String)

        The name of the S3 bucket whose classification types you want to update.

      • prefix — (String)

        The prefix of the S3 bucket whose classification types you want to update.

      • classificationTypeUpdaterequired — (map)

        The classification type that you want to update for the resource associated with Amazon Macie.

        • oneTime — (String)

          A one-time classification of all of the existing objects in a specified S3 bucket.

          Possible values include:
          • "FULL"
          • "NONE"
        • continuous — (String)

          A continuous classification of the objects that are added to a specified S3 bucket. Amazon Macie begins performing continuous classification after a bucket is successfully associated with Amazon Macie.

          Possible values include:
          • "FULL"

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:

      • failedS3Resources — (Array<map>)

        The S3 resources whose classification types can't be updated. An error code and an error message are provided for each failed item.

        • failedItem — (map)

          The failed S3 resources.

          • bucketNamerequired — (String)

            The name of the S3 bucket.

          • prefix — (String)

            The prefix of the S3 bucket.

        • errorCode — (String)

          The status code of a failed item.

        • errorMessage — (String)

          The error message of a failed item.

Returns:

  • (AWS.Request)

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