Class: Aws::CloudDirectory::Types::BatchReadSuccessfulResponse

Inherits:

Struct

• Object
• Struct
• Aws::CloudDirectory::Types::BatchReadSuccessfulResponse

Includes:

Structure

Defined in:

lib/aws-sdk-clouddirectory/types.rb

Overview

Represents the output of a ‘BatchRead` success response operation.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #get_link_attributes ⇒ Types::BatchGetLinkAttributesResponse

  The list of attributes to retrieve from the typed link.

• #get_object_attributes ⇒ Types::BatchGetObjectAttributesResponse

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

• #get_object_information ⇒ Types::BatchGetObjectInformationResponse

  Retrieves metadata about an object.

• #list_attached_indices ⇒ Types::BatchListAttachedIndicesResponse

  Lists indices attached to an object.

• #list_incoming_typed_links ⇒ Types::BatchListIncomingTypedLinksResponse

  Returns a paginated list of all the incoming TypedLinkSpecifier information for an object.

• #list_index ⇒ Types::BatchListIndexResponse

  Lists objects attached to the specified index.

• #list_object_attributes ⇒ Types::BatchListObjectAttributesResponse

  Lists all attributes that are associated with an object.

• #list_object_children ⇒ Types::BatchListObjectChildrenResponse

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

• #list_object_parent_paths ⇒ Types::BatchListObjectParentPathsResponse

  Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects.

• #list_object_parents ⇒ Types::BatchListObjectParentsResponse

  The list of parent objects to retrieve.

• #list_object_policies ⇒ Types::BatchListObjectPoliciesResponse

  Returns policies attached to an object in pagination fashion.

• #list_outgoing_typed_links ⇒ Types::BatchListOutgoingTypedLinksResponse

  Returns a paginated list of all the outgoing TypedLinkSpecifier information for an object.

• #list_policy_attachments ⇒ Types::BatchListPolicyAttachmentsResponse

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

• #lookup_policy ⇒ Types::BatchLookupPolicyResponse

  Lists all policies from the root of the Directory to the object specified.

Instance Attribute Details

#get_link_attributes ⇒ Types::BatchGetLinkAttributesResponse

The list of attributes to retrieve from the typed link.

Returns:

• (Types::BatchGetLinkAttributesResponse)

# File 'lib/aws-sdk-clouddirectory/types.rb', line 1701

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

#get_object_attributes ⇒ Types::BatchGetObjectAttributesResponse

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

Returns:

• (Types::BatchGetObjectAttributesResponse)

# File 'lib/aws-sdk-clouddirectory/types.rb', line 1701

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

#get_object_information ⇒ Types::BatchGetObjectInformationResponse

Retrieves metadata about an object.

Returns:

• (Types::BatchGetObjectInformationResponse)

# File 'lib/aws-sdk-clouddirectory/types.rb', line 1701

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

#list_attached_indices ⇒ Types::BatchListAttachedIndicesResponse

Lists indices attached to an object.

Returns:

• (Types::BatchListAttachedIndicesResponse)

# File 'lib/aws-sdk-clouddirectory/types.rb', line 1701

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

#list_incoming_typed_links ⇒ Types::BatchListIncomingTypedLinksResponse

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:

• (Types::BatchListIncomingTypedLinksResponse)

# File 'lib/aws-sdk-clouddirectory/types.rb', line 1701

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

#list_index ⇒ Types::BatchListIndexResponse

Lists objects attached to the specified index.

Returns:

• (Types::BatchListIndexResponse)

# File 'lib/aws-sdk-clouddirectory/types.rb', line 1701

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

#list_object_attributes ⇒ Types::BatchListObjectAttributesResponse

Lists all attributes that are associated with an object.

Returns:

• (Types::BatchListObjectAttributesResponse)

# File 'lib/aws-sdk-clouddirectory/types.rb', line 1701

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

#list_object_children ⇒ Types::BatchListObjectChildrenResponse

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

Returns:

• (Types::BatchListObjectChildrenResponse)

# File 'lib/aws-sdk-clouddirectory/types.rb', line 1701

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

#list_object_parent_paths ⇒ Types::BatchListObjectParentPathsResponse

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:

• (Types::BatchListObjectParentPathsResponse)

# File 'lib/aws-sdk-clouddirectory/types.rb', line 1701

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

#list_object_parents ⇒ Types::BatchListObjectParentsResponse

The list of parent objects to retrieve.

Returns:

• (Types::BatchListObjectParentsResponse)

# File 'lib/aws-sdk-clouddirectory/types.rb', line 1701

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

#list_object_policies ⇒ Types::BatchListObjectPoliciesResponse

Returns policies attached to an object in pagination fashion.

Returns:

• (Types::BatchListObjectPoliciesResponse)

# File 'lib/aws-sdk-clouddirectory/types.rb', line 1701

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

#list_outgoing_typed_links ⇒ Types::BatchListOutgoingTypedLinksResponse

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:

• (Types::BatchListOutgoingTypedLinksResponse)

# File 'lib/aws-sdk-clouddirectory/types.rb', line 1701

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

#list_policy_attachments ⇒ Types::BatchListPolicyAttachmentsResponse

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

Returns:

• (Types::BatchListPolicyAttachmentsResponse)

# File 'lib/aws-sdk-clouddirectory/types.rb', line 1701

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

#lookup_policy ⇒ Types::BatchLookupPolicyResponse

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:

• (Types::BatchLookupPolicyResponse)

# File 'lib/aws-sdk-clouddirectory/types.rb', line 1701

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