Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . macie2 ]

get-custom-data-identifier

Description

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

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  get-custom-data-identifier
--id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--id (string)

The unique identifier for the Amazon Macie resource or account that the request applies to.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

arn -> (string)

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

createdAt -> (timestamp)

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 -> (list)

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.

(string)

keywords -> (list)

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

(string)

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)

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

key -> (string)

value -> (string)