« blib/lib/Paws/DataPipeline/SetStatus.pm
↑ Summary
blib/lib/Paws/DataPipeline/SetTaskStatusOutput.pm »
| 1 | |||
| 2 | package Paws::DataPipeline::SetTaskStatus; | ||
| 3 | use Moose; | ||
| 4 | has ErrorId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'errorId' ); | ||
| 5 | has ErrorMessage => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'errorMessage' ); | ||
| 6 | has ErrorStackTrace => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'errorStackTrace' ); | ||
| 7 | has TaskId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'taskId' , required => 1); | ||
| 8 | has TaskStatus => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'taskStatus' , required => 1); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'SetTaskStatus'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::DataPipeline::SetTaskStatusOutput'); | ||
| 14 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::DataPipeline::SetTaskStatus - Arguments for method SetTaskStatus on L<Paws::DataPipeline> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method SetTaskStatus on the | ||
| 26 | L<AWS Data Pipeline|Paws::DataPipeline> service. Use the attributes of this class | ||
| 27 | as arguments to method SetTaskStatus. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to SetTaskStatus. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $datapipeline = Paws->service('DataPipeline'); | ||
| 34 | my $SetTaskStatusOutput = $datapipeline->SetTaskStatus( | ||
| 35 | TaskId => 'MytaskId', | ||
| 36 | TaskStatus => 'FINISHED', | ||
| 37 | ErrorId => 'Mystring', # OPTIONAL | ||
| 38 | ErrorMessage => 'MyerrorMessage', # OPTIONAL | ||
| 39 | ErrorStackTrace => 'Mystring', # OPTIONAL | ||
| 40 | ); | ||
| 41 | |||
| 42 | 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. | ||
| 43 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/datapipeline/SetTaskStatus> | ||
| 44 | |||
| 45 | =head1 ATTRIBUTES | ||
| 46 | |||
| 47 | |||
| 48 | =head2 ErrorId => Str | ||
| 49 | |||
| 50 | If an error occurred during the task, this value specifies the error | ||
| 51 | code. This value is set on the physical attempt object. It is used to | ||
| 52 | display error information to the user. It should not start with string | ||
| 53 | "Service_" which is reserved by the system. | ||
| 54 | |||
| 55 | |||
| 56 | |||
| 57 | =head2 ErrorMessage => Str | ||
| 58 | |||
| 59 | If an error occurred during the task, this value specifies a text | ||
| 60 | description of the error. This value is set on the physical attempt | ||
| 61 | object. It is used to display error information to the user. The web | ||
| 62 | service does not parse this value. | ||
| 63 | |||
| 64 | |||
| 65 | |||
| 66 | =head2 ErrorStackTrace => Str | ||
| 67 | |||
| 68 | If an error occurred during the task, this value specifies the stack | ||
| 69 | trace associated with the error. This value is set on the physical | ||
| 70 | attempt object. It is used to display error information to the user. | ||
| 71 | The web service does not parse this value. | ||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head2 B<REQUIRED> TaskId => Str | ||
| 76 | |||
| 77 | The ID of the task assigned to the task runner. This value is provided | ||
| 78 | in the response for PollForTask. | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | =head2 B<REQUIRED> TaskStatus => Str | ||
| 83 | |||
| 84 | If C<FINISHED>, the task successfully completed. If C<FAILED>, the task | ||
| 85 | ended unsuccessfully. Preconditions use false. | ||
| 86 | |||
| 87 | Valid values are: C<"FINISHED">, C<"FAILED">, C<"FALSE"> | ||
| 88 | |||
| 89 | |||
| 90 | =head1 SEE ALSO | ||
| 91 | |||
| 92 | This class forms part of L<Paws>, documenting arguments for method SetTaskStatus in L<Paws::DataPipeline> | ||
| 93 | |||
| 94 | =head1 BUGS and CONTRIBUTIONS | ||
| 95 | |||
| 96 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 97 | |||
| 98 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 99 | |||
| 100 | =cut | ||
| 101 |