« blib/lib/Paws/Macie2/TagValuePair.pm
↑ Summary
blib/lib/Paws/Macie2/TestCustomDataIdentifierResponse.pm »
| 1 | |||
| 2 | package Paws::Macie2::TestCustomDataIdentifier; | ||
| 3 | use Moose; | ||
| 4 | has IgnoreWords => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'ignoreWords'); | ||
| 5 | has Keywords => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'keywords'); | ||
| 6 | has MaximumMatchDistance => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'maximumMatchDistance'); | ||
| 7 | has Regex => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'regex', required => 1); | ||
| 8 | has SampleText => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'sampleText', required => 1); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'TestCustomDataIdentifier'); | ||
| 13 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/custom-data-identifiers/test'); | ||
| 14 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Macie2::TestCustomDataIdentifierResponse'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::Macie2::TestCustomDataIdentifier - Arguments for method TestCustomDataIdentifier on L<Paws::Macie2> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method TestCustomDataIdentifier on the | ||
| 27 | L<Amazon Macie 2|Paws::Macie2> service. Use the attributes of this class | ||
| 28 | as arguments to method TestCustomDataIdentifier. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to TestCustomDataIdentifier. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $macie2 = Paws->service('Macie2'); | ||
| 35 | my $TestCustomDataIdentifierResponse = $macie2->TestCustomDataIdentifier( | ||
| 36 | Regex => 'My__string', | ||
| 37 | SampleText => 'My__string', | ||
| 38 | IgnoreWords => [ 'My__string', ... ], # OPTIONAL | ||
| 39 | Keywords => [ 'My__string', ... ], # OPTIONAL | ||
| 40 | MaximumMatchDistance => 1, # OPTIONAL | ||
| 41 | ); | ||
| 42 | |||
| 43 | # Results: | ||
| 44 | my $MatchCount = $TestCustomDataIdentifierResponse->MatchCount; | ||
| 45 | |||
| 46 | # Returns a L<Paws::Macie2::TestCustomDataIdentifierResponse> object. | ||
| 47 | |||
| 48 | 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. | ||
| 49 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/macie2/TestCustomDataIdentifier> | ||
| 50 | |||
| 51 | =head1 ATTRIBUTES | ||
| 52 | |||
| 53 | |||
| 54 | =head2 IgnoreWords => ArrayRef[Str|Undef] | ||
| 55 | |||
| 56 | An array that lists specific character sequences (ignore words) to | ||
| 57 | exclude from the results. If the text matched by the regular expression | ||
| 58 | is the same as any string in this array, Amazon Macie ignores it. The | ||
| 59 | array can contain as many as 10 ignore words. Each ignore word can | ||
| 60 | contain 4-90 characters. Ignore words are case sensitive. | ||
| 61 | |||
| 62 | |||
| 63 | |||
| 64 | =head2 Keywords => ArrayRef[Str|Undef] | ||
| 65 | |||
| 66 | An array that lists specific character sequences (keywords), one of | ||
| 67 | which must be within proximity (maximumMatchDistance) of the regular | ||
| 68 | expression to match. The array can contain as many as 50 keywords. Each | ||
| 69 | keyword can contain 3-90 characters. Keywords aren't case sensitive. | ||
| 70 | |||
| 71 | |||
| 72 | |||
| 73 | =head2 MaximumMatchDistance => Int | ||
| 74 | |||
| 75 | The maximum number of characters that can exist between text that | ||
| 76 | matches the regex pattern and the character sequences specified by the | ||
| 77 | keywords array. Macie includes or excludes a result based on the | ||
| 78 | proximity of a keyword to text that matches the regex pattern. The | ||
| 79 | distance can be 1-300 characters. The default value is 50. | ||
| 80 | |||
| 81 | |||
| 82 | |||
| 83 | =head2 B<REQUIRED> Regex => Str | ||
| 84 | |||
| 85 | The regular expression (I<regex>) that defines the pattern to match. | ||
| 86 | The expression can contain as many as 512 characters. | ||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | =head2 B<REQUIRED> SampleText => Str | ||
| 91 | |||
| 92 | The sample text to inspect by using the custom data identifier. The | ||
| 93 | text can contain as many as 1,000 characters. | ||
| 94 | |||
| 95 | |||
| 96 | |||
| 97 | |||
| 98 | =head1 SEE ALSO | ||
| 99 | |||
| 100 | This class forms part of L<Paws>, documenting arguments for method TestCustomDataIdentifier in L<Paws::Macie2> | ||
| 101 | |||
| 102 | =head1 BUGS and CONTRIBUTIONS | ||
| 103 | |||
| 104 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 105 | |||
| 106 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 107 | |||
| 108 | =cut | ||
| 109 |