« blib/lib/Paws/CloudDirectory/BatchReadException.pm
↑ Summary
blib/lib/Paws/CloudDirectory/BatchReadOperationResponse.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::CloudDirectory::BatchReadOperation; | ||
| 3 | use Moose; | ||
| 4 | has GetLinkAttributes => (is => 'ro', isa => 'Paws::CloudDirectory::BatchGetLinkAttributes'); | ||
| 5 | has GetObjectAttributes => (is => 'ro', isa => 'Paws::CloudDirectory::BatchGetObjectAttributes'); | ||
| 6 | has GetObjectInformation => (is => 'ro', isa => 'Paws::CloudDirectory::BatchGetObjectInformation'); | ||
| 7 | has ListAttachedIndices => (is => 'ro', isa => 'Paws::CloudDirectory::BatchListAttachedIndices'); | ||
| 8 | has ListIncomingTypedLinks => (is => 'ro', isa => 'Paws::CloudDirectory::BatchListIncomingTypedLinks'); | ||
| 9 | has ListIndex => (is => 'ro', isa => 'Paws::CloudDirectory::BatchListIndex'); | ||
| 10 | has ListObjectAttributes => (is => 'ro', isa => 'Paws::CloudDirectory::BatchListObjectAttributes'); | ||
| 11 | has ListObjectChildren => (is => 'ro', isa => 'Paws::CloudDirectory::BatchListObjectChildren'); | ||
| 12 | has ListObjectParentPaths => (is => 'ro', isa => 'Paws::CloudDirectory::BatchListObjectParentPaths'); | ||
| 13 | has ListObjectParents => (is => 'ro', isa => 'Paws::CloudDirectory::BatchListObjectParents'); | ||
| 14 | has ListObjectPolicies => (is => 'ro', isa => 'Paws::CloudDirectory::BatchListObjectPolicies'); | ||
| 15 | has ListOutgoingTypedLinks => (is => 'ro', isa => 'Paws::CloudDirectory::BatchListOutgoingTypedLinks'); | ||
| 16 | has ListPolicyAttachments => (is => 'ro', isa => 'Paws::CloudDirectory::BatchListPolicyAttachments'); | ||
| 17 | has LookupPolicy => (is => 'ro', isa => 'Paws::CloudDirectory::BatchLookupPolicy'); | ||
| 18 | |||
| 19 | 1; | ||
| 20 | |||
| 21 | ### main pod documentation begin ### | ||
| 22 | |||
| 23 | =head1 NAME | ||
| 24 | |||
| 25 | Paws::CloudDirectory::BatchReadOperation | ||
| 26 | |||
| 27 | =head1 USAGE | ||
| 28 | |||
| 29 | This class represents one of two things: | ||
| 30 | |||
| 31 | =head3 Arguments in a call to a service | ||
| 32 | |||
| 33 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 34 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 35 | |||
| 36 | As an example, if Att1 is expected to be a Paws::CloudDirectory::BatchReadOperation object: | ||
| 37 | |||
| 38 | $service_obj->Method(Att1 => { GetLinkAttributes => $value, ..., LookupPolicy => $value }); | ||
| 39 | |||
| 40 | =head3 Results returned from an API call | ||
| 41 | |||
| 42 | Use accessors for each attribute. If Att1 is expected to be an Paws::CloudDirectory::BatchReadOperation object: | ||
| 43 | |||
| 44 | $result = $service_obj->Method(...); | ||
| 45 | $result->Att1->GetLinkAttributes | ||
| 46 | |||
| 47 | =head1 DESCRIPTION | ||
| 48 | |||
| 49 | Represents the output of a C<BatchRead> operation. | ||
| 50 | |||
| 51 | =head1 ATTRIBUTES | ||
| 52 | |||
| 53 | |||
| 54 | =head2 GetLinkAttributes => L<Paws::CloudDirectory::BatchGetLinkAttributes> | ||
| 55 | |||
| 56 | Retrieves attributes that are associated with a typed link. | ||
| 57 | |||
| 58 | |||
| 59 | =head2 GetObjectAttributes => L<Paws::CloudDirectory::BatchGetObjectAttributes> | ||
| 60 | |||
| 61 | Retrieves attributes within a facet that are associated with an object. | ||
| 62 | |||
| 63 | |||
| 64 | =head2 GetObjectInformation => L<Paws::CloudDirectory::BatchGetObjectInformation> | ||
| 65 | |||
| 66 | Retrieves metadata about an object. | ||
| 67 | |||
| 68 | |||
| 69 | =head2 ListAttachedIndices => L<Paws::CloudDirectory::BatchListAttachedIndices> | ||
| 70 | |||
| 71 | Lists indices attached to an object. | ||
| 72 | |||
| 73 | |||
| 74 | =head2 ListIncomingTypedLinks => L<Paws::CloudDirectory::BatchListIncomingTypedLinks> | ||
| 75 | |||
| 76 | Returns a paginated list of all the incoming TypedLinkSpecifier | ||
| 77 | information for an object. It also supports filtering by typed link | ||
| 78 | facet and identity attributes. For more information, see Typed Links | ||
| 79 | (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink). | ||
| 80 | |||
| 81 | |||
| 82 | =head2 ListIndex => L<Paws::CloudDirectory::BatchListIndex> | ||
| 83 | |||
| 84 | Lists objects attached to the specified index. | ||
| 85 | |||
| 86 | |||
| 87 | =head2 ListObjectAttributes => L<Paws::CloudDirectory::BatchListObjectAttributes> | ||
| 88 | |||
| 89 | Lists all attributes that are associated with an object. | ||
| 90 | |||
| 91 | |||
| 92 | =head2 ListObjectChildren => L<Paws::CloudDirectory::BatchListObjectChildren> | ||
| 93 | |||
| 94 | Returns a paginated list of child objects that are associated with a | ||
| 95 | given object. | ||
| 96 | |||
| 97 | |||
| 98 | =head2 ListObjectParentPaths => L<Paws::CloudDirectory::BatchListObjectParentPaths> | ||
| 99 | |||
| 100 | Retrieves all available parent paths for any object type such as node, | ||
| 101 | leaf node, policy node, and index node objects. For more information | ||
| 102 | about objects, see Directory Structure | ||
| 103 | (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directorystructure.html). | ||
| 104 | |||
| 105 | |||
| 106 | =head2 ListObjectParents => L<Paws::CloudDirectory::BatchListObjectParents> | ||
| 107 | |||
| 108 | |||
| 109 | |||
| 110 | |||
| 111 | =head2 ListObjectPolicies => L<Paws::CloudDirectory::BatchListObjectPolicies> | ||
| 112 | |||
| 113 | Returns policies attached to an object in pagination fashion. | ||
| 114 | |||
| 115 | |||
| 116 | =head2 ListOutgoingTypedLinks => L<Paws::CloudDirectory::BatchListOutgoingTypedLinks> | ||
| 117 | |||
| 118 | Returns a paginated list of all the outgoing TypedLinkSpecifier | ||
| 119 | information for an object. It also supports filtering by typed link | ||
| 120 | facet and identity attributes. For more information, see Typed Links | ||
| 121 | (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink). | ||
| 122 | |||
| 123 | |||
| 124 | =head2 ListPolicyAttachments => L<Paws::CloudDirectory::BatchListPolicyAttachments> | ||
| 125 | |||
| 126 | Returns all of the C<ObjectIdentifiers> to which a given policy is | ||
| 127 | attached. | ||
| 128 | |||
| 129 | |||
| 130 | =head2 LookupPolicy => L<Paws::CloudDirectory::BatchLookupPolicy> | ||
| 131 | |||
| 132 | Lists all policies from the root of the Directory to the object | ||
| 133 | specified. If there are no policies present, an empty list is returned. | ||
| 134 | If policies are present, and if some objects don't have the policies | ||
| 135 | attached, it returns the C<ObjectIdentifier> for such objects. If | ||
| 136 | policies are present, it returns C<ObjectIdentifier>, C<policyId>, and | ||
| 137 | C<policyType>. Paths that don't lead to the root from the target object | ||
| 138 | are ignored. For more information, see Policies | ||
| 139 | (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directory.html#key_concepts_policies). | ||
| 140 | |||
| 141 | |||
| 142 | |||
| 143 | =head1 SEE ALSO | ||
| 144 | |||
| 145 | This class forms part of L<Paws>, describing an object used in L<Paws::CloudDirectory> | ||
| 146 | |||
| 147 | =head1 BUGS and CONTRIBUTIONS | ||
| 148 | |||
| 149 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 150 | |||
| 151 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 152 | |||
| 153 | =cut | ||
| 154 |