Class: Aws::CloudDirectory::Types::BatchReadOperation

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-clouddirectory/types.rb

Overview

Represents the output of a ‘BatchRead` operation.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

Retrieves attributes that are associated with a typed link.

Returns:



1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
 
# File 'lib/aws-sdk-clouddirectory/types.rb', line 1532

class BatchReadOperation < Struct.new(
  :list_object_attributes,
  :list_object_children,
  :list_attached_indices,
  :list_object_parent_paths,
  :get_object_information,
  :get_object_attributes,
  :list_object_parents,
  :list_object_policies,
  :list_policy_attachments,
  :lookup_policy,
  :list_index,
  :list_outgoing_typed_links,
  :list_incoming_typed_links,
  :get_link_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#get_object_attributes ⇒ Types::BatchGetObjectAttributes

Retrieves attributes within a facet that are associated with an object.

Returns:



1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
 
# File 'lib/aws-sdk-clouddirectory/types.rb', line 1532

class BatchReadOperation < Struct.new(
  :list_object_attributes,
  :list_object_children,
  :list_attached_indices,
  :list_object_parent_paths,
  :get_object_information,
  :get_object_attributes,
  :list_object_parents,
  :list_object_policies,
  :list_policy_attachments,
  :lookup_policy,
  :list_index,
  :list_outgoing_typed_links,
  :list_incoming_typed_links,
  :get_link_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#get_object_information ⇒ Types::BatchGetObjectInformation

Retrieves metadata about an object.

Returns:



1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
 
# File 'lib/aws-sdk-clouddirectory/types.rb', line 1532

class BatchReadOperation < Struct.new(
  :list_object_attributes,
  :list_object_children,
  :list_attached_indices,
  :list_object_parent_paths,
  :get_object_information,
  :get_object_attributes,
  :list_object_parents,
  :list_object_policies,
  :list_policy_attachments,
  :lookup_policy,
  :list_index,
  :list_outgoing_typed_links,
  :list_incoming_typed_links,
  :get_link_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#list_attached_indices ⇒ Types::BatchListAttachedIndices

Lists indices attached to an object.

Returns:



1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
 
# File 'lib/aws-sdk-clouddirectory/types.rb', line 1532

class BatchReadOperation < Struct.new(
  :list_object_attributes,
  :list_object_children,
  :list_attached_indices,
  :list_object_parent_paths,
  :get_object_information,
  :get_object_attributes,
  :list_object_parents,
  :list_object_policies,
  :list_policy_attachments,
  :lookup_policy,
  :list_index,
  :list_outgoing_typed_links,
  :list_incoming_typed_links,
  :get_link_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#list_incoming_typed_links ⇒ Types::BatchListIncomingTypedLinks

Returns a paginated list of all the incoming TypedLinkSpecifier information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see [Typed Links].

[1]: docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink

Returns:



1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
 
# File 'lib/aws-sdk-clouddirectory/types.rb', line 1532

class BatchReadOperation < Struct.new(
  :list_object_attributes,
  :list_object_children,
  :list_attached_indices,
  :list_object_parent_paths,
  :get_object_information,
  :get_object_attributes,
  :list_object_parents,
  :list_object_policies,
  :list_policy_attachments,
  :lookup_policy,
  :list_index,
  :list_outgoing_typed_links,
  :list_incoming_typed_links,
  :get_link_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#list_index ⇒ Types::BatchListIndex

Lists objects attached to the specified index.

Returns:



1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
 
# File 'lib/aws-sdk-clouddirectory/types.rb', line 1532

class BatchReadOperation < Struct.new(
  :list_object_attributes,
  :list_object_children,
  :list_attached_indices,
  :list_object_parent_paths,
  :get_object_information,
  :get_object_attributes,
  :list_object_parents,
  :list_object_policies,
  :list_policy_attachments,
  :lookup_policy,
  :list_index,
  :list_outgoing_typed_links,
  :list_incoming_typed_links,
  :get_link_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#list_object_attributes ⇒ Types::BatchListObjectAttributes

Lists all attributes that are associated with an object.

Returns:



1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
 
# File 'lib/aws-sdk-clouddirectory/types.rb', line 1532

class BatchReadOperation < Struct.new(
  :list_object_attributes,
  :list_object_children,
  :list_attached_indices,
  :list_object_parent_paths,
  :get_object_information,
  :get_object_attributes,
  :list_object_parents,
  :list_object_policies,
  :list_policy_attachments,
  :lookup_policy,
  :list_index,
  :list_outgoing_typed_links,
  :list_incoming_typed_links,
  :get_link_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#list_object_children ⇒ Types::BatchListObjectChildren

Returns a paginated list of child objects that are associated with a given object.

Returns:



1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
 
# File 'lib/aws-sdk-clouddirectory/types.rb', line 1532

class BatchReadOperation < Struct.new(
  :list_object_attributes,
  :list_object_children,
  :list_attached_indices,
  :list_object_parent_paths,
  :get_object_information,
  :get_object_attributes,
  :list_object_parents,
  :list_object_policies,
  :list_policy_attachments,
  :lookup_policy,
  :list_index,
  :list_outgoing_typed_links,
  :list_incoming_typed_links,
  :get_link_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#list_object_parent_paths ⇒ Types::BatchListObjectParentPaths

Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects. For more information about objects, see [Directory Structure].

[1]: docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directorystructure.html

Returns:



1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
 
# File 'lib/aws-sdk-clouddirectory/types.rb', line 1532

class BatchReadOperation < Struct.new(
  :list_object_attributes,
  :list_object_children,
  :list_attached_indices,
  :list_object_parent_paths,
  :get_object_information,
  :get_object_attributes,
  :list_object_parents,
  :list_object_policies,
  :list_policy_attachments,
  :lookup_policy,
  :list_index,
  :list_outgoing_typed_links,
  :list_incoming_typed_links,
  :get_link_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#list_object_parents ⇒ Types::BatchListObjectParents

Lists parent objects that are associated with a given object in pagination fashion.

Returns:



1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
 
# File 'lib/aws-sdk-clouddirectory/types.rb', line 1532

class BatchReadOperation < Struct.new(
  :list_object_attributes,
  :list_object_children,
  :list_attached_indices,
  :list_object_parent_paths,
  :get_object_information,
  :get_object_attributes,
  :list_object_parents,
  :list_object_policies,
  :list_policy_attachments,
  :lookup_policy,
  :list_index,
  :list_outgoing_typed_links,
  :list_incoming_typed_links,
  :get_link_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#list_object_policies ⇒ Types::BatchListObjectPolicies

Returns policies attached to an object in pagination fashion.

Returns:



1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
 
# File 'lib/aws-sdk-clouddirectory/types.rb', line 1532

class BatchReadOperation < Struct.new(
  :list_object_attributes,
  :list_object_children,
  :list_attached_indices,
  :list_object_parent_paths,
  :get_object_information,
  :get_object_attributes,
  :list_object_parents,
  :list_object_policies,
  :list_policy_attachments,
  :lookup_policy,
  :list_index,
  :list_outgoing_typed_links,
  :list_incoming_typed_links,
  :get_link_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#list_outgoing_typed_links ⇒ Types::BatchListOutgoingTypedLinks

Returns a paginated list of all the outgoing TypedLinkSpecifier information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see [Typed Links].

[1]: docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink

Returns:



1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
 
# File 'lib/aws-sdk-clouddirectory/types.rb', line 1532

class BatchReadOperation < Struct.new(
  :list_object_attributes,
  :list_object_children,
  :list_attached_indices,
  :list_object_parent_paths,
  :get_object_information,
  :get_object_attributes,
  :list_object_parents,
  :list_object_policies,
  :list_policy_attachments,
  :lookup_policy,
  :list_index,
  :list_outgoing_typed_links,
  :list_incoming_typed_links,
  :get_link_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#list_policy_attachments ⇒ Types::BatchListPolicyAttachments

Returns all of the ‘ObjectIdentifiers` to which a given policy is attached.

Returns:



1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
 
# File 'lib/aws-sdk-clouddirectory/types.rb', line 1532

class BatchReadOperation < Struct.new(
  :list_object_attributes,
  :list_object_children,
  :list_attached_indices,
  :list_object_parent_paths,
  :get_object_information,
  :get_object_attributes,
  :list_object_parents,
  :list_object_policies,
  :list_policy_attachments,
  :lookup_policy,
  :list_index,
  :list_outgoing_typed_links,
  :list_incoming_typed_links,
  :get_link_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#lookup_policy ⇒ Types::BatchLookupPolicy

Lists all policies from the root of the Directory to the object specified. If there are no policies present, an empty list is returned. If policies are present, and if some objects don’t have the policies attached, it returns the ‘ObjectIdentifier` for such objects. If policies are present, it returns `ObjectIdentifier`, `policyId`, and `policyType`. Paths that don’t lead to the root from the target object are ignored. For more information, see [Policies].

[1]: docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directory.html#key_concepts_policies

Returns:



1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
 
# File 'lib/aws-sdk-clouddirectory/types.rb', line 1532

class BatchReadOperation < Struct.new(
  :list_object_attributes,
  :list_object_children,
  :list_attached_indices,
  :list_object_parent_paths,
  :get_object_information,
  :get_object_attributes,
  :list_object_parents,
  :list_object_policies,
  :list_policy_attachments,
  :lookup_policy,
  :list_index,
  :list_outgoing_typed_links,
  :list_incoming_typed_links,
  :get_link_attributes)
  SENSITIVE = []
  include Aws::Structure
end