« blib/lib/Paws/WorkDocs/DeactivateUser.pm
↑ Summary
blib/lib/Paws/WorkDocs/DeleteCustomMetadata.pm »
| 1 | |||
| 2 | package Paws::WorkDocs::DeleteComment; | ||
| 3 | use Moose; | ||
| 4 | has AuthenticationToken => (is => 'ro', isa => 'Str', traits => ['ParamInHeader'], header_name => 'Authentication'); | ||
| 5 | has CommentId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'CommentId', required => 1); | ||
| 6 | has DocumentId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'DocumentId', required => 1); | ||
| 7 | has VersionId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'VersionId', required => 1); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DeleteComment'); | ||
| 12 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/api/v1/documents/{DocumentId}/versions/{VersionId}/comment/{CommentId}'); | ||
| 13 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'DELETE'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::API::Response'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::WorkDocs::DeleteComment - Arguments for method DeleteComment on L<Paws::WorkDocs> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method DeleteComment on the | ||
| 26 | L<Amazon WorkDocs|Paws::WorkDocs> service. Use the attributes of this class | ||
| 27 | as arguments to method DeleteComment. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DeleteComment. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $workdocs = Paws->service('WorkDocs'); | ||
| 34 | $workdocs->DeleteComment( | ||
| 35 | CommentId => 'MyCommentIdType', | ||
| 36 | DocumentId => 'MyResourceIdType', | ||
| 37 | VersionId => 'MyDocumentVersionIdType', | ||
| 38 | AuthenticationToken => 'MyAuthenticationHeaderType', # OPTIONAL | ||
| 39 | ); | ||
| 40 | |||
| 41 | 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. | ||
| 42 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/workdocs/DeleteComment> | ||
| 43 | |||
| 44 | =head1 ATTRIBUTES | ||
| 45 | |||
| 46 | |||
| 47 | =head2 AuthenticationToken => Str | ||
| 48 | |||
| 49 | Amazon WorkDocs authentication token. Not required when using AWS | ||
| 50 | administrator credentials to access the API. | ||
| 51 | |||
| 52 | |||
| 53 | |||
| 54 | =head2 B<REQUIRED> CommentId => Str | ||
| 55 | |||
| 56 | The ID of the comment. | ||
| 57 | |||
| 58 | |||
| 59 | |||
| 60 | =head2 B<REQUIRED> DocumentId => Str | ||
| 61 | |||
| 62 | The ID of the document. | ||
| 63 | |||
| 64 | |||
| 65 | |||
| 66 | =head2 B<REQUIRED> VersionId => Str | ||
| 67 | |||
| 68 | The ID of the document version. | ||
| 69 | |||
| 70 | |||
| 71 | |||
| 72 | |||
| 73 | =head1 SEE ALSO | ||
| 74 | |||
| 75 | This class forms part of L<Paws>, documenting arguments for method DeleteComment in L<Paws::WorkDocs> | ||
| 76 | |||
| 77 | =head1 BUGS and CONTRIBUTIONS | ||
| 78 | |||
| 79 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 80 | |||
| 81 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 82 | |||
| 83 | =cut | ||
| 84 |