« blib/lib/Paws/Macie2/CreateClassificationJobResponse.pm
↑ Summary
blib/lib/Paws/Macie2/CreateCustomDataIdentifierResponse.pm »
| 1 | |||
| 2 | package Paws::Macie2::CreateCustomDataIdentifier; | ||
| 3 | use Moose; | ||
| 4 | has ClientToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'clientToken'); | ||
| 5 | has Description => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'description'); | ||
| 6 | has IgnoreWords => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'ignoreWords'); | ||
| 7 | has Keywords => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'keywords'); | ||
| 8 | has MaximumMatchDistance => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'maximumMatchDistance'); | ||
| 9 | has Name => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'name'); | ||
| 10 | has Regex => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'regex'); | ||
| 11 | has Tags => (is => 'ro', isa => 'Paws::Macie2::TagMap', traits => ['NameInRequest'], request_name => 'tags'); | ||
| 12 | |||
| 13 | use MooseX::ClassAttribute; | ||
| 14 | |||
| 15 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateCustomDataIdentifier'); | ||
| 16 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/custom-data-identifiers'); | ||
| 17 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 18 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Macie2::CreateCustomDataIdentifierResponse'); | ||
| 19 | 1; | ||
| 20 | |||
| 21 | ### main pod documentation begin ### | ||
| 22 | |||
| 23 | =head1 NAME | ||
| 24 | |||
| 25 | Paws::Macie2::CreateCustomDataIdentifier - Arguments for method CreateCustomDataIdentifier on L<Paws::Macie2> | ||
| 26 | |||
| 27 | =head1 DESCRIPTION | ||
| 28 | |||
| 29 | This class represents the parameters used for calling the method CreateCustomDataIdentifier on the | ||
| 30 | L<Amazon Macie 2|Paws::Macie2> service. Use the attributes of this class | ||
| 31 | as arguments to method CreateCustomDataIdentifier. | ||
| 32 | |||
| 33 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateCustomDataIdentifier. | ||
| 34 | |||
| 35 | =head1 SYNOPSIS | ||
| 36 | |||
| 37 | my $macie2 = Paws->service('Macie2'); | ||
| 38 | my $CreateCustomDataIdentifierResponse = | ||
| 39 | $macie2->CreateCustomDataIdentifier( | ||
| 40 | ClientToken => 'My__string', # OPTIONAL | ||
| 41 | Description => 'My__string', # OPTIONAL | ||
| 42 | IgnoreWords => [ 'My__string', ... ], # OPTIONAL | ||
| 43 | Keywords => [ 'My__string', ... ], # OPTIONAL | ||
| 44 | MaximumMatchDistance => 1, # OPTIONAL | ||
| 45 | Name => 'My__string', # OPTIONAL | ||
| 46 | Regex => 'My__string', # OPTIONAL | ||
| 47 | Tags => { 'My__string' => 'My__string', }, # OPTIONAL | ||
| 48 | ); | ||
| 49 | |||
| 50 | # Results: | ||
| 51 | my $CustomDataIdentifierId = | ||
| 52 | $CreateCustomDataIdentifierResponse->CustomDataIdentifierId; | ||
| 53 | |||
| 54 | # Returns a L<Paws::Macie2::CreateCustomDataIdentifierResponse> object. | ||
| 55 | |||
| 56 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 57 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/macie2/CreateCustomDataIdentifier> | ||
| 58 | |||
| 59 | =head1 ATTRIBUTES | ||
| 60 | |||
| 61 | |||
| 62 | =head2 ClientToken => Str | ||
| 63 | |||
| 64 | A unique, case-sensitive token that you provide to ensure the | ||
| 65 | idempotency of the request. | ||
| 66 | |||
| 67 | |||
| 68 | |||
| 69 | =head2 Description => Str | ||
| 70 | |||
| 71 | A custom description of the custom data identifier. The description can | ||
| 72 | contain as many as 512 characters. | ||
| 73 | |||
| 74 | We strongly recommend that you avoid including any sensitive data in | ||
| 75 | the description of a custom data identifier. Other users of your | ||
| 76 | account might be able to see the identifier's description, depending on | ||
| 77 | the actions that they're allowed to perform in Amazon Macie. | ||
| 78 | |||
| 79 | |||
| 80 | |||
| 81 | =head2 IgnoreWords => ArrayRef[Str|Undef] | ||
| 82 | |||
| 83 | An array that lists specific character sequences (ignore words) to | ||
| 84 | exclude from the results. If the text matched by the regular expression | ||
| 85 | is the same as any string in this array, Amazon Macie ignores it. The | ||
| 86 | array can contain as many as 10 ignore words. Each ignore word can | ||
| 87 | contain 4-90 characters. Ignore words are case sensitive. | ||
| 88 | |||
| 89 | |||
| 90 | |||
| 91 | =head2 Keywords => ArrayRef[Str|Undef] | ||
| 92 | |||
| 93 | An array that lists specific character sequences (keywords), one of | ||
| 94 | which must be within proximity (maximumMatchDistance) of the regular | ||
| 95 | expression to match. The array can contain as many as 50 keywords. Each | ||
| 96 | keyword can contain 3-90 characters. Keywords aren't case sensitive. | ||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | =head2 MaximumMatchDistance => Int | ||
| 101 | |||
| 102 | The maximum number of characters that can exist between text that | ||
| 103 | matches the regex pattern and the character sequences specified by the | ||
| 104 | keywords array. Macie includes or excludes a result based on the | ||
| 105 | proximity of a keyword to text that matches the regex pattern. The | ||
| 106 | distance can be 1-300 characters. The default value is 50. | ||
| 107 | |||
| 108 | |||
| 109 | |||
| 110 | =head2 Name => Str | ||
| 111 | |||
| 112 | A custom name for the custom data identifier. The name can contain as | ||
| 113 | many as 128 characters. | ||
| 114 | |||
| 115 | We strongly recommend that you avoid including any sensitive data in | ||
| 116 | the name of a custom data identifier. Other users of your account might | ||
| 117 | be able to see the identifier's name, depending on the actions that | ||
| 118 | they're allowed to perform in Amazon Macie. | ||
| 119 | |||
| 120 | |||
| 121 | |||
| 122 | =head2 Regex => Str | ||
| 123 | |||
| 124 | The regular expression (I<regex>) that defines the pattern to match. | ||
| 125 | The expression can contain as many as 512 characters. | ||
| 126 | |||
| 127 | |||
| 128 | |||
| 129 | =head2 Tags => L<Paws::Macie2::TagMap> | ||
| 130 | |||
| 131 | A map of key-value pairs that specifies the tags to associate with the | ||
| 132 | custom data identifier. | ||
| 133 | |||
| 134 | A custom data identifier can have a maximum of 50 tags. Each tag | ||
| 135 | consists of a tag key and an associated tag value. The maximum length | ||
| 136 | of a tag key is 128 characters. The maximum length of a tag value is | ||
| 137 | 256 characters. | ||
| 138 | |||
| 139 | |||
| 140 | |||
| 141 | |||
| 142 | =head1 SEE ALSO | ||
| 143 | |||
| 144 | This class forms part of L<Paws>, documenting arguments for method CreateCustomDataIdentifier in L<Paws::Macie2> | ||
| 145 | |||
| 146 | =head1 BUGS and CONTRIBUTIONS | ||
| 147 | |||
| 148 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 149 | |||
| 150 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 151 | |||
| 152 | =cut | ||
| 153 |