The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

NAME

Paws::WorkDocs::DescribeComments - Arguments for method DescribeComments on Paws::WorkDocs

DESCRIPTION

This class represents the parameters used for calling the method DescribeComments on the Amazon WorkDocs service. Use the attributes of this class as arguments to method DescribeComments.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeComments.

SYNOPSIS

    my $workdocs = Paws->service('WorkDocs');
    my $DescribeCommentsResponse = $workdocs->DescribeComments(
      DocumentId          => 'MyResourceIdType',
      VersionId           => 'MyDocumentVersionIdType',
      AuthenticationToken => 'MyAuthenticationHeaderType',    # OPTIONAL
      Limit               => 1,                               # OPTIONAL
      Marker              => 'MyMarkerType',                  # OPTIONAL
    );

    # Results:
    my $Comments = $DescribeCommentsResponse->Comments;
    my $Marker   = $DescribeCommentsResponse->Marker;

    # Returns a L<Paws::WorkDocs::DescribeCommentsResponse> object.

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. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/workdocs/DescribeComments

ATTRIBUTES

AuthenticationToken => Str

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

REQUIRED DocumentId => Str

The ID of the document.

Limit => Int

The maximum number of items to return.

Marker => Str

The marker for the next set of results. This marker was received from a previous call.

REQUIRED VersionId => Str

The ID of the document version.

SEE ALSO

This class forms part of Paws, documenting arguments for method DescribeComments in Paws::WorkDocs

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues