NAME
Paws::CloudDirectory::ListIndex - Arguments for method ListIndex on Paws::CloudDirectory
DESCRIPTION
This class represents the parameters used for calling the method ListIndex on the Amazon CloudDirectory service. Use the attributes of this class as arguments to method ListIndex.
You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListIndex.
SYNOPSIS
my $clouddirectory = Paws->service('CloudDirectory');
my $ListIndexResponse = $clouddirectory->ListIndex(
DirectoryArn => 'MyArn',
IndexReference => {
Selector => 'MySelectorObjectReference', # OPTIONAL
},
ConsistencyLevel => 'SERIALIZABLE', # OPTIONAL
MaxResults => 1, # OPTIONAL
NextToken => 'MyNextToken', # OPTIONAL
RangesOnIndexedValues => [
{
AttributeKey => {
FacetName => 'MyFacetName', # min: 1, max: 64
Name => 'MyAttributeName', # min: 1, max: 230
SchemaArn => 'MyArn',
}, # OPTIONAL
Range => {
EndMode => 'FIRST'
, # values: FIRST, LAST, LAST_BEFORE_MISSING_VALUES, INCLUSIVE, EXCLUSIVE
StartMode => 'FIRST'
, # values: FIRST, LAST, LAST_BEFORE_MISSING_VALUES, INCLUSIVE, EXCLUSIVE
EndValue => {
BinaryValue => 'BlobBinaryAttributeValue', # OPTIONAL
BooleanValue => 1, # OPTIONAL
DatetimeValue => '1970-01-01T01:00:00', # OPTIONAL
NumberValue => 'MyNumberAttributeValue', # OPTIONAL
StringValue => 'MyStringAttributeValue', # OPTIONAL
}, # OPTIONAL
StartValue => {
BinaryValue => 'BlobBinaryAttributeValue', # OPTIONAL
BooleanValue => 1, # OPTIONAL
DatetimeValue => '1970-01-01T01:00:00', # OPTIONAL
NumberValue => 'MyNumberAttributeValue', # OPTIONAL
StringValue => 'MyStringAttributeValue', # OPTIONAL
}, # OPTIONAL
}, # OPTIONAL
},
...
], # OPTIONAL
);
# Results:
my $IndexAttachments = $ListIndexResponse->IndexAttachments;
my $NextToken = $ListIndexResponse->NextToken;
# Returns a L<Paws::CloudDirectory::ListIndexResponse> 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/clouddirectory/ListIndex
ATTRIBUTES
ConsistencyLevel => Str
The consistency level to execute the request at.
Valid values are: "SERIALIZABLE"
, "EVENTUAL"
REQUIRED DirectoryArn => Str
The ARN of the directory that the index exists in.
REQUIRED IndexReference => Paws::CloudDirectory::ObjectReference
The reference to the index to list.
MaxResults => Int
The maximum number of objects in a single page to retrieve from the index during a request. For more information, see Amazon Cloud Directory Limits (http://docs.aws.amazon.com/clouddirectory/latest/developerguide/limits.html).
NextToken => Str
The pagination token.
RangesOnIndexedValues => ArrayRef[Paws::CloudDirectory::ObjectAttributeRange]
Specifies the ranges of indexed values that you want to query.
SEE ALSO
This class forms part of Paws, documenting arguments for method ListIndex in Paws::CloudDirectory
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