« blib/lib/Paws/FraudDetector/GetEntityTypesResult.pm
↑ Summary
blib/lib/Paws/FraudDetector/GetEventPredictionResult.pm »
| 1 | |||
| 2 | package Paws::FraudDetector::GetEventPrediction; | ||
| 3 | use Moose; | ||
| 4 | has DetectorId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'detectorId' , required => 1); | ||
| 5 | has DetectorVersionId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'detectorVersionId' ); | ||
| 6 | has Entities => (is => 'ro', isa => 'ArrayRef[Paws::FraudDetector::Entity]', traits => ['NameInRequest'], request_name => 'entities' , required => 1); | ||
| 7 | has EventId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'eventId' , required => 1); | ||
| 8 | has EventTimestamp => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'eventTimestamp' , required => 1); | ||
| 9 | has EventTypeName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'eventTypeName' , required => 1); | ||
| 10 | has EventVariables => (is => 'ro', isa => 'Paws::FraudDetector::EventVariableMap', traits => ['NameInRequest'], request_name => 'eventVariables' , required => 1); | ||
| 11 | has ExternalModelEndpointDataBlobs => (is => 'ro', isa => 'Paws::FraudDetector::ExternalModelEndpointDataBlobMap', traits => ['NameInRequest'], request_name => 'externalModelEndpointDataBlobs' ); | ||
| 12 | |||
| 13 | use MooseX::ClassAttribute; | ||
| 14 | |||
| 15 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetEventPrediction'); | ||
| 16 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::FraudDetector::GetEventPredictionResult'); | ||
| 17 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 18 | 1; | ||
| 19 | |||
| 20 | ### main pod documentation begin ### | ||
| 21 | |||
| 22 | =head1 NAME | ||
| 23 | |||
| 24 | Paws::FraudDetector::GetEventPrediction - Arguments for method GetEventPrediction on L<Paws::FraudDetector> | ||
| 25 | |||
| 26 | =head1 DESCRIPTION | ||
| 27 | |||
| 28 | This class represents the parameters used for calling the method GetEventPrediction on the | ||
| 29 | L<Amazon Fraud Detector|Paws::FraudDetector> service. Use the attributes of this class | ||
| 30 | as arguments to method GetEventPrediction. | ||
| 31 | |||
| 32 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetEventPrediction. | ||
| 33 | |||
| 34 | =head1 SYNOPSIS | ||
| 35 | |||
| 36 | my $frauddetector = Paws->service('FraudDetector'); | ||
| 37 | my $GetEventPredictionResult = $frauddetector->GetEventPrediction( | ||
| 38 | DetectorId => 'Mystring', | ||
| 39 | Entities => [ | ||
| 40 | { | ||
| 41 | EntityId => 'Myidentifier', # min: 1, max: 64 | ||
| 42 | EntityType => 'Mystring', | ||
| 43 | |||
| 44 | }, | ||
| 45 | ... | ||
| 46 | ], | ||
| 47 | EventId => 'Mystring', | ||
| 48 | EventTimestamp => 'Mystring', | ||
| 49 | EventTypeName => 'Mystring', | ||
| 50 | EventVariables => { | ||
| 51 | 'MyvariableName' => | ||
| 52 | 'MyvariableValue', # key: min: 1, max: 64, value: min: 1, max: 1024 | ||
| 53 | }, | ||
| 54 | DetectorVersionId => 'MywholeNumberVersionString', # OPTIONAL | ||
| 55 | ExternalModelEndpointDataBlobs => { | ||
| 56 | 'Mystring' => { | ||
| 57 | ByteBuffer => 'Blobblob', # OPTIONAL | ||
| 58 | ContentType => 'MycontentType', # min: 1, max: 1024; OPTIONAL | ||
| 59 | }, | ||
| 60 | }, # OPTIONAL | ||
| 61 | ); | ||
| 62 | |||
| 63 | # Results: | ||
| 64 | my $ModelScores = $GetEventPredictionResult->ModelScores; | ||
| 65 | my $RuleResults = $GetEventPredictionResult->RuleResults; | ||
| 66 | |||
| 67 | # Returns a L<Paws::FraudDetector::GetEventPredictionResult> object. | ||
| 68 | |||
| 69 | 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. | ||
| 70 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/frauddetector/GetEventPrediction> | ||
| 71 | |||
| 72 | =head1 ATTRIBUTES | ||
| 73 | |||
| 74 | |||
| 75 | =head2 B<REQUIRED> DetectorId => Str | ||
| 76 | |||
| 77 | The detector ID. | ||
| 78 | |||
| 79 | |||
| 80 | |||
| 81 | =head2 DetectorVersionId => Str | ||
| 82 | |||
| 83 | The detector version ID. | ||
| 84 | |||
| 85 | |||
| 86 | |||
| 87 | =head2 B<REQUIRED> Entities => ArrayRef[L<Paws::FraudDetector::Entity>] | ||
| 88 | |||
| 89 | The entity type (associated with the detector's event type) and | ||
| 90 | specific entity ID representing who performed the event. If an entity | ||
| 91 | id is not available, use "UNKNOWN." | ||
| 92 | |||
| 93 | |||
| 94 | |||
| 95 | =head2 B<REQUIRED> EventId => Str | ||
| 96 | |||
| 97 | The unique ID used to identify the event. | ||
| 98 | |||
| 99 | |||
| 100 | |||
| 101 | =head2 B<REQUIRED> EventTimestamp => Str | ||
| 102 | |||
| 103 | Timestamp that defines when the event under evaluation occurred. | ||
| 104 | |||
| 105 | |||
| 106 | |||
| 107 | =head2 B<REQUIRED> EventTypeName => Str | ||
| 108 | |||
| 109 | The event type associated with the detector specified for the | ||
| 110 | prediction. | ||
| 111 | |||
| 112 | |||
| 113 | |||
| 114 | =head2 B<REQUIRED> EventVariables => L<Paws::FraudDetector::EventVariableMap> | ||
| 115 | |||
| 116 | Names of the event type's variables you defined in Amazon Fraud | ||
| 117 | Detector to represent data elements and their corresponding values for | ||
| 118 | the event you are sending for evaluation. | ||
| 119 | |||
| 120 | |||
| 121 | |||
| 122 | =head2 ExternalModelEndpointDataBlobs => L<Paws::FraudDetector::ExternalModelEndpointDataBlobMap> | ||
| 123 | |||
| 124 | The Amazon SageMaker model endpoint input data blobs. | ||
| 125 | |||
| 126 | |||
| 127 | |||
| 128 | |||
| 129 | =head1 SEE ALSO | ||
| 130 | |||
| 131 | This class forms part of L<Paws>, documenting arguments for method GetEventPrediction in L<Paws::FraudDetector> | ||
| 132 | |||
| 133 | =head1 BUGS and CONTRIBUTIONS | ||
| 134 | |||
| 135 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 136 | |||
| 137 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 138 | |||
| 139 | =cut | ||
| 140 |