|
Unix VPS
Support
FAQ
Network
Miscellaneous
|
| Paws::CloudDirectory::BatchRead(3) | User Contributed Perl Documentation | Paws::CloudDirectory::BatchRead(3) |
NAME
Paws::CloudDirectory::BatchRead - Arguments for method BatchRead on Paws::CloudDirectory
DESCRIPTION
This class represents the parameters used for calling the method BatchRead on the Amazon CloudDirectory service. Use the attributes of this class as arguments to method BatchRead.
You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to BatchRead.
SYNOPSIS
my $clouddirectory = Paws->service('CloudDirectory');
my $BatchReadResponse = $clouddirectory->BatchRead(
DirectoryArn => 'MyArn',
Operations => [
{
GetLinkAttributes => {
AttributeNames => [
'MyAttributeName', ... # min: 1, max: 230
],
TypedLinkSpecifier => {
IdentityAttributeValues => [
{
AttributeName => 'MyAttributeName', # min: 1, max: 230
Value => {
BinaryValue => 'BlobBinaryAttributeValue', # OPTIONAL
BooleanValue => 1, # OPTIONAL
DatetimeValue => '1970-01-01T01:00:00', # OPTIONAL
NumberValue => 'MyNumberAttributeValue', # OPTIONAL
StringValue => 'MyStringAttributeValue', # OPTIONAL
},
},
...
],
SourceObjectReference => {
Selector => 'MySelectorObjectReference', # OPTIONAL
},
TargetObjectReference => {
Selector => 'MySelectorObjectReference', # OPTIONAL
},
TypedLinkFacet => {
SchemaArn => 'MyArn',
TypedLinkName => 'MyTypedLinkName',
},
},
}, # OPTIONAL
GetObjectAttributes => {
AttributeNames => [
'MyAttributeName', ... # min: 1, max: 230
],
ObjectReference => {
Selector => 'MySelectorObjectReference', # OPTIONAL
},
SchemaFacet => {
FacetName => 'MyFacetName', # min: 1, max: 64; OPTIONAL
SchemaArn => 'MyArn',
},
}, # OPTIONAL
GetObjectInformation => {
ObjectReference => {
Selector => 'MySelectorObjectReference', # OPTIONAL
},
}, # OPTIONAL
ListAttachedIndices => {
TargetReference => {
Selector => 'MySelectorObjectReference', # OPTIONAL
},
MaxResults => 1, # min: 1; OPTIONAL
NextToken => 'MyNextToken', # OPTIONAL
}, # OPTIONAL
ListIncomingTypedLinks => {
ObjectReference => {
Selector => 'MySelectorObjectReference', # OPTIONAL
},
FilterAttributeRanges => [
{
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
},
StartValue => {
BinaryValue => 'BlobBinaryAttributeValue', # OPTIONAL
BooleanValue => 1, # OPTIONAL
DatetimeValue => '1970-01-01T01:00:00', # OPTIONAL
NumberValue => 'MyNumberAttributeValue', # OPTIONAL
StringValue => 'MyStringAttributeValue', # OPTIONAL
},
},
AttributeName => 'MyAttributeName', # min: 1, max: 230
},
...
], # OPTIONAL
FilterTypedLink => {
SchemaArn => 'MyArn',
TypedLinkName => 'MyTypedLinkName',
},
MaxResults => 1, # min: 1; OPTIONAL
NextToken => 'MyNextToken', # OPTIONAL
}, # OPTIONAL
ListIndex => {
IndexReference => {
Selector => 'MySelectorObjectReference', # OPTIONAL
},
MaxResults => 1, # min: 1; OPTIONAL
NextToken => 'MyNextToken', # OPTIONAL
RangesOnIndexedValues => [
{
AttributeKey => {
FacetName => 'MyFacetName', # min: 1, max: 64; OPTIONAL
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
},
StartValue => {
BinaryValue => 'BlobBinaryAttributeValue', # OPTIONAL
BooleanValue => 1, # OPTIONAL
DatetimeValue => '1970-01-01T01:00:00', # OPTIONAL
NumberValue => 'MyNumberAttributeValue', # OPTIONAL
StringValue => 'MyStringAttributeValue', # OPTIONAL
},
},
},
...
], # OPTIONAL
}, # OPTIONAL
ListObjectAttributes => {
ObjectReference => {
Selector => 'MySelectorObjectReference', # OPTIONAL
},
FacetFilter => {
FacetName => 'MyFacetName', # min: 1, max: 64; OPTIONAL
SchemaArn => 'MyArn',
},
MaxResults => 1, # min: 1; OPTIONAL
NextToken => 'MyNextToken', # OPTIONAL
}, # OPTIONAL
ListObjectChildren => {
ObjectReference => {
Selector => 'MySelectorObjectReference', # OPTIONAL
},
MaxResults => 1, # min: 1; OPTIONAL
NextToken => 'MyNextToken', # OPTIONAL
}, # OPTIONAL
ListObjectParentPaths => {
ObjectReference => {
Selector => 'MySelectorObjectReference', # OPTIONAL
},
MaxResults => 1, # min: 1; OPTIONAL
NextToken => 'MyNextToken', # OPTIONAL
}, # OPTIONAL
ListObjectParents => {
ObjectReference => {
Selector => 'MySelectorObjectReference', # OPTIONAL
},
MaxResults => 1, # min: 1; OPTIONAL
NextToken => 'MyNextToken', # OPTIONAL
}, # OPTIONAL
ListObjectPolicies => {
ObjectReference => {
Selector => 'MySelectorObjectReference', # OPTIONAL
},
MaxResults => 1, # min: 1; OPTIONAL
NextToken => 'MyNextToken', # OPTIONAL
}, # OPTIONAL
ListOutgoingTypedLinks => {
ObjectReference => {
Selector => 'MySelectorObjectReference', # OPTIONAL
},
FilterAttributeRanges => [
{
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
},
StartValue => {
BinaryValue => 'BlobBinaryAttributeValue', # OPTIONAL
BooleanValue => 1, # OPTIONAL
DatetimeValue => '1970-01-01T01:00:00', # OPTIONAL
NumberValue => 'MyNumberAttributeValue', # OPTIONAL
StringValue => 'MyStringAttributeValue', # OPTIONAL
},
},
AttributeName => 'MyAttributeName', # min: 1, max: 230
},
...
], # OPTIONAL
FilterTypedLink => {
SchemaArn => 'MyArn',
TypedLinkName => 'MyTypedLinkName',
},
MaxResults => 1, # min: 1; OPTIONAL
NextToken => 'MyNextToken', # OPTIONAL
}, # OPTIONAL
ListPolicyAttachments => {
PolicyReference => {
Selector => 'MySelectorObjectReference', # OPTIONAL
},
MaxResults => 1, # min: 1; OPTIONAL
NextToken => 'MyNextToken', # OPTIONAL
}, # OPTIONAL
LookupPolicy => {
ObjectReference => {
Selector => 'MySelectorObjectReference', # OPTIONAL
},
MaxResults => 1, # min: 1; OPTIONAL
NextToken => 'MyNextToken', # OPTIONAL
}, # OPTIONAL
},
...
],
ConsistencyLevel => 'SERIALIZABLE', # OPTIONAL
);
# Results:
my $Responses = $BatchReadResponse->Responses;
# Returns a L<Paws::CloudDirectory::BatchReadResponse> 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/BatchRead>
ATTRIBUTES
ConsistencyLevel => Str
Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.
Valid values are: "SERIALIZABLE", "EVENTUAL"
REQUIRED DirectoryArn => Str
The Amazon Resource Name (ARN) that is associated with the Directory. For more information, see arns.
REQUIRED Operations => ArrayRef[Paws::CloudDirectory::BatchReadOperation]
A list of operations that are part of the batch.
SEE ALSO
This class forms part of Paws, documenting arguments for method BatchRead 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>
| 2022-06-01 | perl v5.40.2 |
Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.