« blib/lib/Paws/Comprehend/CreateDocumentClassifierResponse.pm
↑ Summary
blib/lib/Paws/Comprehend/CreateEndpointResponse.pm »
| 1 | |||
| 2 | package Paws::Comprehend::CreateEndpoint; | ||
| 3 | use Moose; | ||
| 4 | has ClientRequestToken => (is => 'ro', isa => 'Str'); | ||
| 5 | has DataAccessRoleArn => (is => 'ro', isa => 'Str'); | ||
| 6 | has DesiredInferenceUnits => (is => 'ro', isa => 'Int', required => 1); | ||
| 7 | has EndpointName => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has ModelArn => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::Comprehend::Tag]'); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateEndpoint'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Comprehend::CreateEndpointResponse'); | ||
| 15 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::Comprehend::CreateEndpoint - Arguments for method CreateEndpoint on L<Paws::Comprehend> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method CreateEndpoint on the | ||
| 27 | L<Amazon Comprehend|Paws::Comprehend> service. Use the attributes of this class | ||
| 28 | as arguments to method CreateEndpoint. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateEndpoint. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $comprehend = Paws->service('Comprehend'); | ||
| 35 | my $CreateEndpointResponse = $comprehend->CreateEndpoint( | ||
| 36 | DesiredInferenceUnits => 1, | ||
| 37 | EndpointName => 'MyComprehendEndpointName', | ||
| 38 | ModelArn => 'MyComprehendModelArn', | ||
| 39 | ClientRequestToken => 'MyClientRequestTokenString', # OPTIONAL | ||
| 40 | DataAccessRoleArn => 'MyIamRoleArn', # OPTIONAL | ||
| 41 | Tags => [ | ||
| 42 | { | ||
| 43 | Key => 'MyTagKey', # min: 1, max: 128 | ||
| 44 | Value => 'MyTagValue', # max: 256; OPTIONAL | ||
| 45 | }, | ||
| 46 | ... | ||
| 47 | ], # OPTIONAL | ||
| 48 | ); | ||
| 49 | |||
| 50 | # Results: | ||
| 51 | my $EndpointArn = $CreateEndpointResponse->EndpointArn; | ||
| 52 | |||
| 53 | # Returns a L<Paws::Comprehend::CreateEndpointResponse> object. | ||
| 54 | |||
| 55 | 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. | ||
| 56 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/comprehend/CreateEndpoint> | ||
| 57 | |||
| 58 | =head1 ATTRIBUTES | ||
| 59 | |||
| 60 | |||
| 61 | =head2 ClientRequestToken => Str | ||
| 62 | |||
| 63 | An idempotency token provided by the customer. If this token matches a | ||
| 64 | previous endpoint creation request, Amazon Comprehend will not return a | ||
| 65 | C<ResourceInUseException>. | ||
| 66 | |||
| 67 | |||
| 68 | |||
| 69 | =head2 DataAccessRoleArn => Str | ||
| 70 | |||
| 71 | The Amazon Resource Name (ARN) of the AWS identity and Access | ||
| 72 | Management (IAM) role that grants Amazon Comprehend read access to | ||
| 73 | trained custom models encrypted with a customer managed key | ||
| 74 | (ModelKmsKeyId). | ||
| 75 | |||
| 76 | |||
| 77 | |||
| 78 | =head2 B<REQUIRED> DesiredInferenceUnits => Int | ||
| 79 | |||
| 80 | The desired number of inference units to be used by the model using | ||
| 81 | this endpoint. Each inference unit represents of a throughput of 100 | ||
| 82 | characters per second. | ||
| 83 | |||
| 84 | |||
| 85 | |||
| 86 | =head2 B<REQUIRED> EndpointName => Str | ||
| 87 | |||
| 88 | This is the descriptive suffix that becomes part of the C<EndpointArn> | ||
| 89 | used for all subsequent requests to this resource. | ||
| 90 | |||
| 91 | |||
| 92 | |||
| 93 | =head2 B<REQUIRED> ModelArn => Str | ||
| 94 | |||
| 95 | The Amazon Resource Number (ARN) of the model to which the endpoint | ||
| 96 | will be attached. | ||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | =head2 Tags => ArrayRef[L<Paws::Comprehend::Tag>] | ||
| 101 | |||
| 102 | Tags associated with the endpoint being created. A tag is a key-value | ||
| 103 | pair that adds metadata to the endpoint. For example, a tag with | ||
| 104 | "Sales" as the key might be added to an endpoint to indicate its use by | ||
| 105 | the sales department. | ||
| 106 | |||
| 107 | |||
| 108 | |||
| 109 | |||
| 110 | =head1 SEE ALSO | ||
| 111 | |||
| 112 | This class forms part of L<Paws>, documenting arguments for method CreateEndpoint in L<Paws::Comprehend> | ||
| 113 | |||
| 114 | =head1 BUGS and CONTRIBUTIONS | ||
| 115 | |||
| 116 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 117 | |||
| 118 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 119 | |||
| 120 | =cut | ||
| 121 |