NAME

Paws::SSM::ListDocuments - Arguments for method ListDocuments on Paws::SSM

DESCRIPTION

This class represents the parameters used for calling the method ListDocuments on the Amazon Simple Systems Manager (SSM) service. Use the attributes of this class as arguments to method ListDocuments.

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

SYNOPSIS

    my $ssm = Paws->service('SSM');
    my $ListDocumentsResult = $ssm->ListDocuments(
      DocumentFilterList => [
        {
          Key   => 'Name',    # values: Name, Owner, PlatformTypes, DocumentType
          Value => 'MyDocumentFilterValue',    # min: 1
        },
        ...
      ],    # OPTIONAL
      Filters => [
        {
          Key    => 'MyDocumentKeyValuesFilterKey', # min: 1, max: 128; OPTIONAL
          Values => [
            'MyDocumentKeyValuesFilterValue', ...    # min: 1, max: 256
          ],    # OPTIONAL
        },
        ...
      ],    # OPTIONAL
      MaxResults => 1,                # OPTIONAL
      NextToken  => 'MyNextToken',    # OPTIONAL
    );
    # Results:
    my $DocumentIdentifiers = $ListDocumentsResult->DocumentIdentifiers;
    my $NextToken           = $ListDocumentsResult->NextToken;
    # Returns a L<Paws::SSM::ListDocumentsResult> 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/ssm/ListDocuments>

ATTRIBUTES

DocumentFilterList => ArrayRef[Paws::SSM::DocumentFilter]

This data type is deprecated. Instead, use "Filters".

Filters => ArrayRef[Paws::SSM::DocumentKeyValuesFilter]

One or more "DocumentKeyValuesFilter" objects. Use a filter to return a more specific list of results. For keys, you can specify one or more key-value pair tags that have been applied to a document. Other valid keys include "Owner", "Name", "PlatformTypes", "DocumentType", and "TargetType". For example, to return documents you own use "Key=Owner,Values=Self". To specify a custom key-value pair, use the format "Key=tag:tagName,Values=valueName".

This API action only supports filtering documents by using a single tag key and one or more tag values. For example: "Key=tag:tagName,Values=valueName1,valueName2"

MaxResults => Int

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

NextToken => Str

The token for the next set of items to return. (You received this token from a previous call.)

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>