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::GetDocumentPath - Arguments for method GetDocumentPath on Paws::WorkDocs

DESCRIPTION

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

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

SYNOPSIS

    my $workdocs = Paws->service('WorkDocs');
    my $GetDocumentPathResponse = $workdocs->GetDocumentPath(
      DocumentId          => 'MyIdType',
      AuthenticationToken => 'MyAuthenticationHeaderType',    # OPTIONAL
      Fields              => 'MyFieldNamesType',              # OPTIONAL
      Limit               => 1,                               # OPTIONAL
      Marker              => 'MyPageMarkerType',              # OPTIONAL
    );

    # Results:
    my $Path = $GetDocumentPathResponse->Path;

    # Returns a L<Paws::WorkDocs::GetDocumentPathResponse> 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/GetDocumentPath

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.

Fields => Str

A comma-separated list of values. Specify NAME to include the names of the parent folders.

Limit => Int

The maximum number of levels in the hierarchy to return.

Marker => Str

This value is not supported.

SEE ALSO

This class forms part of Paws, documenting arguments for method GetDocumentPath 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