NAME

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

DESCRIPTION

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

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

SYNOPSIS

    my $workdocs = Paws->service('WorkDocs');
    my $DescribeFolderContentsResponse = $workdocs->DescribeFolderContents(
      FolderId            => 'MyResourceIdType',
      AuthenticationToken => 'MyAuthenticationHeaderType',    # OPTIONAL
      Include             => 'MyFieldNamesType',              # OPTIONAL
      Limit               => 1,                               # OPTIONAL
      Marker              => 'MyPageMarkerType',              # OPTIONAL
      Order               => 'ASCENDING',                     # OPTIONAL
      Sort                => 'DATE',                          # OPTIONAL
      Type                => 'ALL',                           # OPTIONAL
    );

    # Results:
    my $Documents = $DescribeFolderContentsResponse->Documents;
    my $Folders   = $DescribeFolderContentsResponse->Folders;
    my $Marker    = $DescribeFolderContentsResponse->Marker;

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

ATTRIBUTES

AuthenticationToken => Str

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

REQUIRED FolderId => Str

The ID of the folder.

Include => Str

The contents to include. Specify "INITIALIZED" to include initialized documents.

Limit => Int

The maximum number of items to return with this call.

Marker => Str

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

Order => Str

The order for the contents of the folder.

Valid values are: "ASCENDING", "DESCENDING"

Sort => Str

The sorting criteria.

Valid values are: "DATE", "NAME"

Type => Str

The type of items.

Valid values are: "ALL", "DOCUMENT", "FOLDER"

SEE ALSO

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

cpanm Paws

perl -MCPAN -e shell
install Paws