« blib/lib/Paws/Comprehend/StartSentimentDetectionJobResponse.pm
↑ Summary
blib/lib/Paws/Comprehend/StartTopicsDetectionJobResponse.pm »
| 1 | |||
| 2 | package Paws::Comprehend::StartTopicsDetectionJob; | ||
| 3 | use Moose; | ||
| 4 | has ClientRequestToken => (is => 'ro', isa => 'Str'); | ||
| 5 | has DataAccessRoleArn => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has InputDataConfig => (is => 'ro', isa => 'Paws::Comprehend::InputDataConfig', required => 1); | ||
| 7 | has JobName => (is => 'ro', isa => 'Str'); | ||
| 8 | has NumberOfTopics => (is => 'ro', isa => 'Int'); | ||
| 9 | has OutputDataConfig => (is => 'ro', isa => 'Paws::Comprehend::OutputDataConfig', required => 1); | ||
| 10 | has VolumeKmsKeyId => (is => 'ro', isa => 'Str'); | ||
| 11 | has VpcConfig => (is => 'ro', isa => 'Paws::Comprehend::VpcConfig'); | ||
| 12 | |||
| 13 | use MooseX::ClassAttribute; | ||
| 14 | |||
| 15 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'StartTopicsDetectionJob'); | ||
| 16 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Comprehend::StartTopicsDetectionJobResponse'); | ||
| 17 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 18 | 1; | ||
| 19 | |||
| 20 | ### main pod documentation begin ### | ||
| 21 | |||
| 22 | =head1 NAME | ||
| 23 | |||
| 24 | Paws::Comprehend::StartTopicsDetectionJob - Arguments for method StartTopicsDetectionJob on L<Paws::Comprehend> | ||
| 25 | |||
| 26 | =head1 DESCRIPTION | ||
| 27 | |||
| 28 | This class represents the parameters used for calling the method StartTopicsDetectionJob on the | ||
| 29 | L<Amazon Comprehend|Paws::Comprehend> service. Use the attributes of this class | ||
| 30 | as arguments to method StartTopicsDetectionJob. | ||
| 31 | |||
| 32 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to StartTopicsDetectionJob. | ||
| 33 | |||
| 34 | =head1 SYNOPSIS | ||
| 35 | |||
| 36 | my $comprehend = Paws->service('Comprehend'); | ||
| 37 | my $StartTopicsDetectionJobResponse = $comprehend->StartTopicsDetectionJob( | ||
| 38 | DataAccessRoleArn => 'MyIamRoleArn', | ||
| 39 | InputDataConfig => { | ||
| 40 | S3Uri => 'MyS3Uri', # max: 1024 | ||
| 41 | InputFormat => 'ONE_DOC_PER_FILE' | ||
| 42 | , # values: ONE_DOC_PER_FILE, ONE_DOC_PER_LINE; OPTIONAL | ||
| 43 | }, | ||
| 44 | OutputDataConfig => { | ||
| 45 | S3Uri => 'MyS3Uri', # max: 1024 | ||
| 46 | KmsKeyId => 'MyKmsKeyId', # max: 2048; OPTIONAL | ||
| 47 | }, | ||
| 48 | ClientRequestToken => 'MyClientRequestTokenString', # OPTIONAL | ||
| 49 | JobName => 'MyJobName', # OPTIONAL | ||
| 50 | NumberOfTopics => 1, # OPTIONAL | ||
| 51 | VolumeKmsKeyId => 'MyKmsKeyId', # OPTIONAL | ||
| 52 | VpcConfig => { | ||
| 53 | SecurityGroupIds => [ | ||
| 54 | 'MySecurityGroupId', ... # min: 1, max: 32 | ||
| 55 | ], # min: 1, max: 5 | ||
| 56 | Subnets => [ | ||
| 57 | 'MySubnetId', ... # min: 1, max: 32 | ||
| 58 | ], # min: 1, max: 16 | ||
| 59 | |||
| 60 | }, # OPTIONAL | ||
| 61 | ); | ||
| 62 | |||
| 63 | # Results: | ||
| 64 | my $JobId = $StartTopicsDetectionJobResponse->JobId; | ||
| 65 | my $JobStatus = $StartTopicsDetectionJobResponse->JobStatus; | ||
| 66 | |||
| 67 | # Returns a L<Paws::Comprehend::StartTopicsDetectionJobResponse> 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/comprehend/StartTopicsDetectionJob> | ||
| 71 | |||
| 72 | =head1 ATTRIBUTES | ||
| 73 | |||
| 74 | |||
| 75 | =head2 ClientRequestToken => Str | ||
| 76 | |||
| 77 | A unique identifier for the request. If you do not set the client | ||
| 78 | request token, Amazon Comprehend generates one. | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | =head2 B<REQUIRED> DataAccessRoleArn => Str | ||
| 83 | |||
| 84 | The Amazon Resource Name (ARN) of the AWS Identity and Access | ||
| 85 | Management (IAM) role that grants Amazon Comprehend read access to your | ||
| 86 | input data. For more information, see | ||
| 87 | https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions | ||
| 88 | (https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions). | ||
| 89 | |||
| 90 | |||
| 91 | |||
| 92 | =head2 B<REQUIRED> InputDataConfig => L<Paws::Comprehend::InputDataConfig> | ||
| 93 | |||
| 94 | Specifies the format and location of the input data for the job. | ||
| 95 | |||
| 96 | |||
| 97 | |||
| 98 | =head2 JobName => Str | ||
| 99 | |||
| 100 | The identifier of the job. | ||
| 101 | |||
| 102 | |||
| 103 | |||
| 104 | =head2 NumberOfTopics => Int | ||
| 105 | |||
| 106 | The number of topics to detect. | ||
| 107 | |||
| 108 | |||
| 109 | |||
| 110 | =head2 B<REQUIRED> OutputDataConfig => L<Paws::Comprehend::OutputDataConfig> | ||
| 111 | |||
| 112 | Specifies where to send the output files. The output is a compressed | ||
| 113 | archive with two files, C<topic-terms.csv> that lists the terms | ||
| 114 | associated with each topic, and C<doc-topics.csv> that lists the | ||
| 115 | documents associated with each topic | ||
| 116 | |||
| 117 | |||
| 118 | |||
| 119 | =head2 VolumeKmsKeyId => Str | ||
| 120 | |||
| 121 | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend | ||
| 122 | uses to encrypt data on the storage volume attached to the ML compute | ||
| 123 | instance(s) that process the analysis job. The VolumeKmsKeyId can be | ||
| 124 | either of the following formats: | ||
| 125 | |||
| 126 | =over | ||
| 127 | |||
| 128 | =item * | ||
| 129 | |||
| 130 | KMS Key ID: C<"1234abcd-12ab-34cd-56ef-1234567890ab"> | ||
| 131 | |||
| 132 | =item * | ||
| 133 | |||
| 134 | Amazon Resource Name (ARN) of a KMS Key: | ||
| 135 | C<"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"> | ||
| 136 | |||
| 137 | =back | ||
| 138 | |||
| 139 | |||
| 140 | |||
| 141 | |||
| 142 | =head2 VpcConfig => L<Paws::Comprehend::VpcConfig> | ||
| 143 | |||
| 144 | Configuration parameters for an optional private Virtual Private Cloud | ||
| 145 | (VPC) containing the resources you are using for your topic detection | ||
| 146 | job. For more information, see Amazon VPC | ||
| 147 | (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html). | ||
| 148 | |||
| 149 | |||
| 150 | |||
| 151 | |||
| 152 | =head1 SEE ALSO | ||
| 153 | |||
| 154 | This class forms part of L<Paws>, documenting arguments for method StartTopicsDetectionJob in L<Paws::Comprehend> | ||
| 155 | |||
| 156 | =head1 BUGS and CONTRIBUTIONS | ||
| 157 | |||
| 158 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 159 | |||
| 160 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 161 | |||
| 162 | =cut | ||
| 163 |