« blib/lib/Paws/Comprehend/EndpointFilter.pm
↑ Summary
blib/lib/Paws/Comprehend/EntitiesDetectionJobFilter.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Comprehend::EndpointProperties; | ||
| 3 | use Moose; | ||
| 4 | has CreationTime => (is => 'ro', isa => 'Str'); | ||
| 5 | has CurrentInferenceUnits => (is => 'ro', isa => 'Int'); | ||
| 6 | has DataAccessRoleArn => (is => 'ro', isa => 'Str'); | ||
| 7 | has DesiredInferenceUnits => (is => 'ro', isa => 'Int'); | ||
| 8 | has EndpointArn => (is => 'ro', isa => 'Str'); | ||
| 9 | has LastModifiedTime => (is => 'ro', isa => 'Str'); | ||
| 10 | has Message => (is => 'ro', isa => 'Str'); | ||
| 11 | has ModelArn => (is => 'ro', isa => 'Str'); | ||
| 12 | has Status => (is => 'ro', isa => 'Str'); | ||
| 13 | |||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::Comprehend::EndpointProperties | ||
| 21 | |||
| 22 | =head1 USAGE | ||
| 23 | |||
| 24 | This class represents one of two things: | ||
| 25 | |||
| 26 | =head3 Arguments in a call to a service | ||
| 27 | |||
| 28 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 29 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 30 | |||
| 31 | As an example, if Att1 is expected to be a Paws::Comprehend::EndpointProperties object: | ||
| 32 | |||
| 33 | $service_obj->Method(Att1 => { CreationTime => $value, ..., Status => $value }); | ||
| 34 | |||
| 35 | =head3 Results returned from an API call | ||
| 36 | |||
| 37 | Use accessors for each attribute. If Att1 is expected to be an Paws::Comprehend::EndpointProperties object: | ||
| 38 | |||
| 39 | $result = $service_obj->Method(...); | ||
| 40 | $result->Att1->CreationTime | ||
| 41 | |||
| 42 | =head1 DESCRIPTION | ||
| 43 | |||
| 44 | Specifies information about the specified endpoint. | ||
| 45 | |||
| 46 | =head1 ATTRIBUTES | ||
| 47 | |||
| 48 | |||
| 49 | =head2 CreationTime => Str | ||
| 50 | |||
| 51 | The creation date and time of the endpoint. | ||
| 52 | |||
| 53 | |||
| 54 | =head2 CurrentInferenceUnits => Int | ||
| 55 | |||
| 56 | The number of inference units currently used by the model using this | ||
| 57 | endpoint. | ||
| 58 | |||
| 59 | |||
| 60 | =head2 DataAccessRoleArn => Str | ||
| 61 | |||
| 62 | The Amazon Resource Name (ARN) of the AWS identity and Access | ||
| 63 | Management (IAM) role that grants Amazon Comprehend read access to | ||
| 64 | trained custom models encrypted with a customer managed key | ||
| 65 | (ModelKmsKeyId). | ||
| 66 | |||
| 67 | |||
| 68 | =head2 DesiredInferenceUnits => Int | ||
| 69 | |||
| 70 | The desired number of inference units to be used by the model using | ||
| 71 | this endpoint. Each inference unit represents of a throughput of 100 | ||
| 72 | characters per second. | ||
| 73 | |||
| 74 | |||
| 75 | =head2 EndpointArn => Str | ||
| 76 | |||
| 77 | The Amazon Resource Number (ARN) of the endpoint. | ||
| 78 | |||
| 79 | |||
| 80 | =head2 LastModifiedTime => Str | ||
| 81 | |||
| 82 | The date and time that the endpoint was last modified. | ||
| 83 | |||
| 84 | |||
| 85 | =head2 Message => Str | ||
| 86 | |||
| 87 | Specifies a reason for failure in cases of C<Failed> status. | ||
| 88 | |||
| 89 | |||
| 90 | =head2 ModelArn => Str | ||
| 91 | |||
| 92 | The Amazon Resource Number (ARN) of the model to which the endpoint is | ||
| 93 | attached. | ||
| 94 | |||
| 95 | |||
| 96 | =head2 Status => Str | ||
| 97 | |||
| 98 | Specifies the status of the endpoint. Because the endpoint updates and | ||
| 99 | creation are asynchronous, so customers will need to wait for the | ||
| 100 | endpoint to be C<Ready> status before making inference requests. | ||
| 101 | |||
| 102 | |||
| 103 | |||
| 104 | =head1 SEE ALSO | ||
| 105 | |||
| 106 | This class forms part of L<Paws>, describing an object used in L<Paws::Comprehend> | ||
| 107 | |||
| 108 | =head1 BUGS and CONTRIBUTIONS | ||
| 109 | |||
| 110 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 111 | |||
| 112 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 113 | |||
| 114 | =cut | ||
| 115 |