« blib/lib/Paws/CloudDirectory/BatchLookupPolicyResponse.pm
↑ Summary
blib/lib/Paws/CloudDirectory/BatchReadException.pm »
| 1 | |||
| 2 | package Paws::CloudDirectory::BatchRead; | ||
| 3 | use Moose; | ||
| 4 | has ConsistencyLevel => (is => 'ro', isa => 'Str', traits => ['ParamInHeader'], header_name => 'x-amz-consistency-level'); | ||
| 5 | has DirectoryArn => (is => 'ro', isa => 'Str', traits => ['ParamInHeader'], header_name => 'x-amz-data-partition', required => 1); | ||
| 6 | has Operations => (is => 'ro', isa => 'ArrayRef[Paws::CloudDirectory::BatchReadOperation]', required => 1); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'BatchRead'); | ||
| 11 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/amazonclouddirectory/2017-01-11/batchread'); | ||
| 12 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CloudDirectory::BatchReadResponse'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::CloudDirectory::BatchRead - Arguments for method BatchRead on L<Paws::CloudDirectory> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method BatchRead on the | ||
| 25 | L<Amazon CloudDirectory|Paws::CloudDirectory> service. Use the attributes of this class | ||
| 26 | as arguments to method BatchRead. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to BatchRead. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $clouddirectory = Paws->service('CloudDirectory'); | ||
| 33 | my $BatchReadResponse = $clouddirectory->BatchRead( | ||
| 34 | DirectoryArn => 'MyArn', | ||
| 35 | Operations => [ | ||
| 36 | { | ||
| 37 | GetLinkAttributes => { | ||
| 38 | AttributeNames => [ | ||
| 39 | 'MyAttributeName', ... # min: 1, max: 230 | ||
| 40 | ], | ||
| 41 | TypedLinkSpecifier => { | ||
| 42 | IdentityAttributeValues => [ | ||
| 43 | { | ||
| 44 | AttributeName => 'MyAttributeName', # min: 1, max: 230 | ||
| 45 | Value => { | ||
| 46 | BinaryValue => 'BlobBinaryAttributeValue', # OPTIONAL | ||
| 47 | BooleanValue => 1, # OPTIONAL | ||
| 48 | DatetimeValue => '1970-01-01T01:00:00', # OPTIONAL | ||
| 49 | NumberValue => 'MyNumberAttributeValue', # OPTIONAL | ||
| 50 | StringValue => 'MyStringAttributeValue', # OPTIONAL | ||
| 51 | }, | ||
| 52 | |||
| 53 | }, | ||
| 54 | ... | ||
| 55 | ], | ||
| 56 | SourceObjectReference => { | ||
| 57 | Selector => 'MySelectorObjectReference', # OPTIONAL | ||
| 58 | }, | ||
| 59 | TargetObjectReference => { | ||
| 60 | Selector => 'MySelectorObjectReference', # OPTIONAL | ||
| 61 | }, | ||
| 62 | TypedLinkFacet => { | ||
| 63 | SchemaArn => 'MyArn', | ||
| 64 | TypedLinkName => 'MyTypedLinkName', | ||
| 65 | |||
| 66 | }, | ||
| 67 | |||
| 68 | }, | ||
| 69 | |||
| 70 | }, # OPTIONAL | ||
| 71 | GetObjectAttributes => { | ||
| 72 | AttributeNames => [ | ||
| 73 | 'MyAttributeName', ... # min: 1, max: 230 | ||
| 74 | ], | ||
| 75 | ObjectReference => { | ||
| 76 | Selector => 'MySelectorObjectReference', # OPTIONAL | ||
| 77 | }, | ||
| 78 | SchemaFacet => { | ||
| 79 | FacetName => 'MyFacetName', # min: 1, max: 64; OPTIONAL | ||
| 80 | SchemaArn => 'MyArn', | ||
| 81 | }, | ||
| 82 | |||
| 83 | }, # OPTIONAL | ||
| 84 | GetObjectInformation => { | ||
| 85 | ObjectReference => { | ||
| 86 | Selector => 'MySelectorObjectReference', # OPTIONAL | ||
| 87 | }, | ||
| 88 | |||
| 89 | }, # OPTIONAL | ||
| 90 | ListAttachedIndices => { | ||
| 91 | TargetReference => { | ||
| 92 | Selector => 'MySelectorObjectReference', # OPTIONAL | ||
| 93 | }, | ||
| 94 | MaxResults => 1, # min: 1; OPTIONAL | ||
| 95 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 96 | }, # OPTIONAL | ||
| 97 | ListIncomingTypedLinks => { | ||
| 98 | ObjectReference => { | ||
| 99 | Selector => 'MySelectorObjectReference', # OPTIONAL | ||
| 100 | }, | ||
| 101 | FilterAttributeRanges => [ | ||
| 102 | { | ||
| 103 | Range => { | ||
| 104 | EndMode => 'FIRST' | ||
| 105 | , # values: FIRST, LAST, LAST_BEFORE_MISSING_VALUES, INCLUSIVE, EXCLUSIVE | ||
| 106 | StartMode => 'FIRST' | ||
| 107 | , # values: FIRST, LAST, LAST_BEFORE_MISSING_VALUES, INCLUSIVE, EXCLUSIVE | ||
| 108 | EndValue => { | ||
| 109 | BinaryValue => 'BlobBinaryAttributeValue', # OPTIONAL | ||
| 110 | BooleanValue => 1, # OPTIONAL | ||
| 111 | DatetimeValue => '1970-01-01T01:00:00', # OPTIONAL | ||
| 112 | NumberValue => 'MyNumberAttributeValue', # OPTIONAL | ||
| 113 | StringValue => 'MyStringAttributeValue', # OPTIONAL | ||
| 114 | }, | ||
| 115 | StartValue => { | ||
| 116 | BinaryValue => 'BlobBinaryAttributeValue', # OPTIONAL | ||
| 117 | BooleanValue => 1, # OPTIONAL | ||
| 118 | DatetimeValue => '1970-01-01T01:00:00', # OPTIONAL | ||
| 119 | NumberValue => 'MyNumberAttributeValue', # OPTIONAL | ||
| 120 | StringValue => 'MyStringAttributeValue', # OPTIONAL | ||
| 121 | }, | ||
| 122 | }, | ||
| 123 | AttributeName => 'MyAttributeName', # min: 1, max: 230 | ||
| 124 | }, | ||
| 125 | ... | ||
| 126 | ], # OPTIONAL | ||
| 127 | FilterTypedLink => { | ||
| 128 | SchemaArn => 'MyArn', | ||
| 129 | TypedLinkName => 'MyTypedLinkName', | ||
| 130 | |||
| 131 | }, | ||
| 132 | MaxResults => 1, # min: 1; OPTIONAL | ||
| 133 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 134 | }, # OPTIONAL | ||
| 135 | ListIndex => { | ||
| 136 | IndexReference => { | ||
| 137 | Selector => 'MySelectorObjectReference', # OPTIONAL | ||
| 138 | }, | ||
| 139 | MaxResults => 1, # min: 1; OPTIONAL | ||
| 140 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 141 | RangesOnIndexedValues => [ | ||
| 142 | { | ||
| 143 | AttributeKey => { | ||
| 144 | FacetName => 'MyFacetName', # min: 1, max: 64; OPTIONAL | ||
| 145 | Name => 'MyAttributeName', # min: 1, max: 230 | ||
| 146 | SchemaArn => 'MyArn', | ||
| 147 | |||
| 148 | }, # OPTIONAL | ||
| 149 | Range => { | ||
| 150 | EndMode => 'FIRST' | ||
| 151 | , # values: FIRST, LAST, LAST_BEFORE_MISSING_VALUES, INCLUSIVE, EXCLUSIVE | ||
| 152 | StartMode => 'FIRST' | ||
| 153 | , # values: FIRST, LAST, LAST_BEFORE_MISSING_VALUES, INCLUSIVE, EXCLUSIVE | ||
| 154 | EndValue => { | ||
| 155 | BinaryValue => 'BlobBinaryAttributeValue', # OPTIONAL | ||
| 156 | BooleanValue => 1, # OPTIONAL | ||
| 157 | DatetimeValue => '1970-01-01T01:00:00', # OPTIONAL | ||
| 158 | NumberValue => 'MyNumberAttributeValue', # OPTIONAL | ||
| 159 | StringValue => 'MyStringAttributeValue', # OPTIONAL | ||
| 160 | }, | ||
| 161 | StartValue => { | ||
| 162 | BinaryValue => 'BlobBinaryAttributeValue', # OPTIONAL | ||
| 163 | BooleanValue => 1, # OPTIONAL | ||
| 164 | DatetimeValue => '1970-01-01T01:00:00', # OPTIONAL | ||
| 165 | NumberValue => 'MyNumberAttributeValue', # OPTIONAL | ||
| 166 | StringValue => 'MyStringAttributeValue', # OPTIONAL | ||
| 167 | }, | ||
| 168 | }, | ||
| 169 | }, | ||
| 170 | ... | ||
| 171 | ], # OPTIONAL | ||
| 172 | }, # OPTIONAL | ||
| 173 | ListObjectAttributes => { | ||
| 174 | ObjectReference => { | ||
| 175 | Selector => 'MySelectorObjectReference', # OPTIONAL | ||
| 176 | }, | ||
| 177 | FacetFilter => { | ||
| 178 | FacetName => 'MyFacetName', # min: 1, max: 64; OPTIONAL | ||
| 179 | SchemaArn => 'MyArn', | ||
| 180 | }, | ||
| 181 | MaxResults => 1, # min: 1; OPTIONAL | ||
| 182 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 183 | }, # OPTIONAL | ||
| 184 | ListObjectChildren => { | ||
| 185 | ObjectReference => { | ||
| 186 | Selector => 'MySelectorObjectReference', # OPTIONAL | ||
| 187 | }, | ||
| 188 | MaxResults => 1, # min: 1; OPTIONAL | ||
| 189 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 190 | }, # OPTIONAL | ||
| 191 | ListObjectParentPaths => { | ||
| 192 | ObjectReference => { | ||
| 193 | Selector => 'MySelectorObjectReference', # OPTIONAL | ||
| 194 | }, | ||
| 195 | MaxResults => 1, # min: 1; OPTIONAL | ||
| 196 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 197 | }, # OPTIONAL | ||
| 198 | ListObjectParents => { | ||
| 199 | ObjectReference => { | ||
| 200 | Selector => 'MySelectorObjectReference', # OPTIONAL | ||
| 201 | }, | ||
| 202 | MaxResults => 1, # min: 1; OPTIONAL | ||
| 203 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 204 | }, # OPTIONAL | ||
| 205 | ListObjectPolicies => { | ||
| 206 | ObjectReference => { | ||
| 207 | Selector => 'MySelectorObjectReference', # OPTIONAL | ||
| 208 | }, | ||
| 209 | MaxResults => 1, # min: 1; OPTIONAL | ||
| 210 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 211 | }, # OPTIONAL | ||
| 212 | ListOutgoingTypedLinks => { | ||
| 213 | ObjectReference => { | ||
| 214 | Selector => 'MySelectorObjectReference', # OPTIONAL | ||
| 215 | }, | ||
| 216 | FilterAttributeRanges => [ | ||
| 217 | { | ||
| 218 | Range => { | ||
| 219 | EndMode => 'FIRST' | ||
| 220 | , # values: FIRST, LAST, LAST_BEFORE_MISSING_VALUES, INCLUSIVE, EXCLUSIVE | ||
| 221 | StartMode => 'FIRST' | ||
| 222 | , # values: FIRST, LAST, LAST_BEFORE_MISSING_VALUES, INCLUSIVE, EXCLUSIVE | ||
| 223 | EndValue => { | ||
| 224 | BinaryValue => 'BlobBinaryAttributeValue', # OPTIONAL | ||
| 225 | BooleanValue => 1, # OPTIONAL | ||
| 226 | DatetimeValue => '1970-01-01T01:00:00', # OPTIONAL | ||
| 227 | NumberValue => 'MyNumberAttributeValue', # OPTIONAL | ||
| 228 | StringValue => 'MyStringAttributeValue', # OPTIONAL | ||
| 229 | }, | ||
| 230 | StartValue => { | ||
| 231 | BinaryValue => 'BlobBinaryAttributeValue', # OPTIONAL | ||
| 232 | BooleanValue => 1, # OPTIONAL | ||
| 233 | DatetimeValue => '1970-01-01T01:00:00', # OPTIONAL | ||
| 234 | NumberValue => 'MyNumberAttributeValue', # OPTIONAL | ||
| 235 | StringValue => 'MyStringAttributeValue', # OPTIONAL | ||
| 236 | }, | ||
| 237 | }, | ||
| 238 | AttributeName => 'MyAttributeName', # min: 1, max: 230 | ||
| 239 | }, | ||
| 240 | ... | ||
| 241 | ], # OPTIONAL | ||
| 242 | FilterTypedLink => { | ||
| 243 | SchemaArn => 'MyArn', | ||
| 244 | TypedLinkName => 'MyTypedLinkName', | ||
| 245 | |||
| 246 | }, | ||
| 247 | MaxResults => 1, # min: 1; OPTIONAL | ||
| 248 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 249 | }, # OPTIONAL | ||
| 250 | ListPolicyAttachments => { | ||
| 251 | PolicyReference => { | ||
| 252 | Selector => 'MySelectorObjectReference', # OPTIONAL | ||
| 253 | }, | ||
| 254 | MaxResults => 1, # min: 1; OPTIONAL | ||
| 255 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 256 | }, # OPTIONAL | ||
| 257 | LookupPolicy => { | ||
| 258 | ObjectReference => { | ||
| 259 | Selector => 'MySelectorObjectReference', # OPTIONAL | ||
| 260 | }, | ||
| 261 | MaxResults => 1, # min: 1; OPTIONAL | ||
| 262 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 263 | }, # OPTIONAL | ||
| 264 | }, | ||
| 265 | ... | ||
| 266 | ], | ||
| 267 | ConsistencyLevel => 'SERIALIZABLE', # OPTIONAL | ||
| 268 | ); | ||
| 269 | |||
| 270 | # Results: | ||
| 271 | my $Responses = $BatchReadResponse->Responses; | ||
| 272 | |||
| 273 | # Returns a L<Paws::CloudDirectory::BatchReadResponse> object. | ||
| 274 | |||
| 275 | 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. | ||
| 276 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/clouddirectory/BatchRead> | ||
| 277 | |||
| 278 | =head1 ATTRIBUTES | ||
| 279 | |||
| 280 | |||
| 281 | =head2 ConsistencyLevel => Str | ||
| 282 | |||
| 283 | Represents the manner and timing in which the successful write or | ||
| 284 | update of an object is reflected in a subsequent read operation of that | ||
| 285 | same object. | ||
| 286 | |||
| 287 | Valid values are: C<"SERIALIZABLE">, C<"EVENTUAL"> | ||
| 288 | |||
| 289 | =head2 B<REQUIRED> DirectoryArn => Str | ||
| 290 | |||
| 291 | The Amazon Resource Name (ARN) that is associated with the Directory. | ||
| 292 | For more information, see arns. | ||
| 293 | |||
| 294 | |||
| 295 | |||
| 296 | =head2 B<REQUIRED> Operations => ArrayRef[L<Paws::CloudDirectory::BatchReadOperation>] | ||
| 297 | |||
| 298 | A list of operations that are part of the batch. | ||
| 299 | |||
| 300 | |||
| 301 | |||
| 302 | |||
| 303 | =head1 SEE ALSO | ||
| 304 | |||
| 305 | This class forms part of L<Paws>, documenting arguments for method BatchRead in L<Paws::CloudDirectory> | ||
| 306 | |||
| 307 | =head1 BUGS and CONTRIBUTIONS | ||
| 308 | |||
| 309 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 310 | |||
| 311 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 312 | |||
| 313 | =cut | ||
| 314 |