« blib/lib/Paws/FraudDetector/CreateBatchPredictionJobResult.pm
↑ Summary
blib/lib/Paws/FraudDetector/CreateDetectorVersionResult.pm »
| 1 | |||
| 2 | package Paws::FraudDetector::CreateDetectorVersion; | ||
| 3 | use Moose; | ||
| 4 | has Description => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'description' ); | ||
| 5 | has DetectorId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'detectorId' , required => 1); | ||
| 6 | has ExternalModelEndpoints => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'externalModelEndpoints' ); | ||
| 7 | has ModelVersions => (is => 'ro', isa => 'ArrayRef[Paws::FraudDetector::ModelVersion]', traits => ['NameInRequest'], request_name => 'modelVersions' ); | ||
| 8 | has RuleExecutionMode => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'ruleExecutionMode' ); | ||
| 9 | has Rules => (is => 'ro', isa => 'ArrayRef[Paws::FraudDetector::Rule]', traits => ['NameInRequest'], request_name => 'rules' , required => 1); | ||
| 10 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::FraudDetector::Tag]', traits => ['NameInRequest'], request_name => 'tags' ); | ||
| 11 | |||
| 12 | use MooseX::ClassAttribute; | ||
| 13 | |||
| 14 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateDetectorVersion'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::FraudDetector::CreateDetectorVersionResult'); | ||
| 16 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::FraudDetector::CreateDetectorVersion - Arguments for method CreateDetectorVersion on L<Paws::FraudDetector> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method CreateDetectorVersion on the | ||
| 28 | L<Amazon Fraud Detector|Paws::FraudDetector> service. Use the attributes of this class | ||
| 29 | as arguments to method CreateDetectorVersion. | ||
| 30 | |||
| 31 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateDetectorVersion. | ||
| 32 | |||
| 33 | =head1 SYNOPSIS | ||
| 34 | |||
| 35 | my $frauddetector = Paws->service('FraudDetector'); | ||
| 36 | my $CreateDetectorVersionResult = $frauddetector->CreateDetectorVersion( | ||
| 37 | DetectorId => 'Myidentifier', | ||
| 38 | Rules => [ | ||
| 39 | { | ||
| 40 | DetectorId => 'Myidentifier', # min: 1, max: 64 | ||
| 41 | RuleId => 'Myidentifier', # min: 1, max: 64 | ||
| 42 | RuleVersion => 'MywholeNumberVersionString', # min: 1, max: 5 | ||
| 43 | |||
| 44 | }, | ||
| 45 | ... | ||
| 46 | ], | ||
| 47 | Description => 'Mydescription', # OPTIONAL | ||
| 48 | ExternalModelEndpoints => [ 'Mystring', ... ], # OPTIONAL | ||
| 49 | ModelVersions => [ | ||
| 50 | { | ||
| 51 | ModelId => 'MymodelIdentifier', # min: 1, max: 64 | ||
| 52 | ModelType => 'ONLINE_FRAUD_INSIGHTS', # values: ONLINE_FRAUD_INSIGHTS | ||
| 53 | ModelVersionNumber => 'MynonEmptyString', # min: 1 | ||
| 54 | Arn => 'MyfraudDetectorArn', # min: 1, max: 256; OPTIONAL | ||
| 55 | }, | ||
| 56 | ... | ||
| 57 | ], # OPTIONAL | ||
| 58 | RuleExecutionMode => 'ALL_MATCHED', # OPTIONAL | ||
| 59 | Tags => [ | ||
| 60 | { | ||
| 61 | Key => 'MytagKey', # min: 1, max: 128 | ||
| 62 | Value => 'MytagValue', # max: 256 | ||
| 63 | |||
| 64 | }, | ||
| 65 | ... | ||
| 66 | ], # OPTIONAL | ||
| 67 | ); | ||
| 68 | |||
| 69 | # Results: | ||
| 70 | my $DetectorId = $CreateDetectorVersionResult->DetectorId; | ||
| 71 | my $DetectorVersionId = $CreateDetectorVersionResult->DetectorVersionId; | ||
| 72 | my $Status = $CreateDetectorVersionResult->Status; | ||
| 73 | |||
| 74 | # Returns a L<Paws::FraudDetector::CreateDetectorVersionResult> object. | ||
| 75 | |||
| 76 | 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. | ||
| 77 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/frauddetector/CreateDetectorVersion> | ||
| 78 | |||
| 79 | =head1 ATTRIBUTES | ||
| 80 | |||
| 81 | |||
| 82 | =head2 Description => Str | ||
| 83 | |||
| 84 | The description of the detector version. | ||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | =head2 B<REQUIRED> DetectorId => Str | ||
| 89 | |||
| 90 | The ID of the detector under which you want to create a new version. | ||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | =head2 ExternalModelEndpoints => ArrayRef[Str|Undef] | ||
| 95 | |||
| 96 | The Amazon Sagemaker model endpoints to include in the detector | ||
| 97 | version. | ||
| 98 | |||
| 99 | |||
| 100 | |||
| 101 | =head2 ModelVersions => ArrayRef[L<Paws::FraudDetector::ModelVersion>] | ||
| 102 | |||
| 103 | The model versions to include in the detector version. | ||
| 104 | |||
| 105 | |||
| 106 | |||
| 107 | =head2 RuleExecutionMode => Str | ||
| 108 | |||
| 109 | The rule execution mode for the rules included in the detector version. | ||
| 110 | |||
| 111 | You can define and edit the rule mode at the detector version level, | ||
| 112 | when it is in draft status. | ||
| 113 | |||
| 114 | If you specify C<FIRST_MATCHED>, Amazon Fraud Detector evaluates rules | ||
| 115 | sequentially, first to last, stopping at the first matched rule. Amazon | ||
| 116 | Fraud dectector then provides the outcomes for that single rule. | ||
| 117 | |||
| 118 | If you specifiy C<ALL_MATCHED>, Amazon Fraud Detector evaluates all | ||
| 119 | rules and returns the outcomes for all matched rules. | ||
| 120 | |||
| 121 | The default behavior is C<FIRST_MATCHED>. | ||
| 122 | |||
| 123 | Valid values are: C<"ALL_MATCHED">, C<"FIRST_MATCHED"> | ||
| 124 | |||
| 125 | =head2 B<REQUIRED> Rules => ArrayRef[L<Paws::FraudDetector::Rule>] | ||
| 126 | |||
| 127 | The rules to include in the detector version. | ||
| 128 | |||
| 129 | |||
| 130 | |||
| 131 | =head2 Tags => ArrayRef[L<Paws::FraudDetector::Tag>] | ||
| 132 | |||
| 133 | A collection of key and value pairs. | ||
| 134 | |||
| 135 | |||
| 136 | |||
| 137 | |||
| 138 | =head1 SEE ALSO | ||
| 139 | |||
| 140 | This class forms part of L<Paws>, documenting arguments for method CreateDetectorVersion in L<Paws::FraudDetector> | ||
| 141 | |||
| 142 | =head1 BUGS and CONTRIBUTIONS | ||
| 143 | |||
| 144 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 145 | |||
| 146 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 147 | |||
| 148 | =cut | ||
| 149 |