Class: Aws::CloudDirectory::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::CloudDirectory::Client
- Includes:
- Aws::ClientStubs
- Defined in:
- gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb
Overview
An API client for CloudDirectory. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::CloudDirectory::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#add_facet_to_object(params = {}) ⇒ Struct
Adds a new Facet to an object.
-
#apply_schema(params = {}) ⇒ Types::ApplySchemaResponse
Copies the input published schema, at the specified version, into the Directory with the same name and version as that of the published schema.
-
#attach_object(params = {}) ⇒ Types::AttachObjectResponse
Attaches an existing object to another object.
-
#attach_policy(params = {}) ⇒ Struct
Attaches a policy object to a regular object.
-
#attach_to_index(params = {}) ⇒ Types::AttachToIndexResponse
Attaches the specified object to the specified index.
-
#attach_typed_link(params = {}) ⇒ Types::AttachTypedLinkResponse
Attaches a typed link to a specified source and target object.
-
#batch_read(params = {}) ⇒ Types::BatchReadResponse
Performs all the read operations in a batch.
-
#batch_write(params = {}) ⇒ Types::BatchWriteResponse
Performs all the write operations in a batch.
-
#create_directory(params = {}) ⇒ Types::CreateDirectoryResponse
Creates a Directory by copying the published schema into the directory.
-
#create_facet(params = {}) ⇒ Struct
Creates a new Facet in a schema.
-
#create_index(params = {}) ⇒ Types::CreateIndexResponse
Creates an index object.
-
#create_object(params = {}) ⇒ Types::CreateObjectResponse
Creates an object in a Directory.
-
#create_schema(params = {}) ⇒ Types::CreateSchemaResponse
Creates a new schema in a development state.
-
#create_typed_link_facet(params = {}) ⇒ Struct
Creates a TypedLinkFacet.
-
#delete_directory(params = {}) ⇒ Types::DeleteDirectoryResponse
Deletes a directory.
-
#delete_facet(params = {}) ⇒ Struct
Deletes a given Facet.
-
#delete_object(params = {}) ⇒ Struct
Deletes an object and its associated attributes.
-
#delete_schema(params = {}) ⇒ Types::DeleteSchemaResponse
Deletes a given schema.
-
#delete_typed_link_facet(params = {}) ⇒ Struct
Deletes a TypedLinkFacet.
-
#detach_from_index(params = {}) ⇒ Types::DetachFromIndexResponse
Detaches the specified object from the specified index.
-
#detach_object(params = {}) ⇒ Types::DetachObjectResponse
Detaches a given object from the parent object.
-
#detach_policy(params = {}) ⇒ Struct
Detaches a policy from an object.
-
#detach_typed_link(params = {}) ⇒ Struct
Detaches a typed link from a specified source and target object.
-
#disable_directory(params = {}) ⇒ Types::DisableDirectoryResponse
Disables the specified directory.
-
#enable_directory(params = {}) ⇒ Types::EnableDirectoryResponse
Enables the specified directory.
-
#get_applied_schema_version(params = {}) ⇒ Types::GetAppliedSchemaVersionResponse
Returns current applied schema version ARN, including the minor version in use.
-
#get_directory(params = {}) ⇒ Types::GetDirectoryResponse
Retrieves metadata about a directory.
-
#get_facet(params = {}) ⇒ Types::GetFacetResponse
Gets details of the Facet, such as facet name, attributes, Rules, or
ObjectType
. -
#get_link_attributes(params = {}) ⇒ Types::GetLinkAttributesResponse
Retrieves attributes that are associated with a typed link.
-
#get_object_attributes(params = {}) ⇒ Types::GetObjectAttributesResponse
Retrieves attributes within a facet that are associated with an object.
-
#get_object_information(params = {}) ⇒ Types::GetObjectInformationResponse
Retrieves metadata about an object.
-
#get_schema_as_json(params = {}) ⇒ Types::GetSchemaAsJsonResponse
Retrieves a JSON representation of the schema.
-
#get_typed_link_facet_information(params = {}) ⇒ Types::GetTypedLinkFacetInformationResponse
Returns the identity attribute order for a specific TypedLinkFacet.
-
#list_applied_schema_arns(params = {}) ⇒ Types::ListAppliedSchemaArnsResponse
Lists schema major versions applied to a directory.
-
#list_attached_indices(params = {}) ⇒ Types::ListAttachedIndicesResponse
Lists indices attached to the specified object.
-
#list_development_schema_arns(params = {}) ⇒ Types::ListDevelopmentSchemaArnsResponse
Retrieves each Amazon Resource Name (ARN) of schemas in the development state.
-
#list_directories(params = {}) ⇒ Types::ListDirectoriesResponse
Lists directories created within an account.
-
#list_facet_attributes(params = {}) ⇒ Types::ListFacetAttributesResponse
Retrieves attributes attached to the facet.
-
#list_facet_names(params = {}) ⇒ Types::ListFacetNamesResponse
Retrieves the names of facets that exist in a schema.
-
#list_incoming_typed_links(params = {}) ⇒ Types::ListIncomingTypedLinksResponse
Returns a paginated list of all the incoming TypedLinkSpecifier information for an object.
-
#list_index(params = {}) ⇒ Types::ListIndexResponse
Lists objects attached to the specified index.
-
#list_managed_schema_arns(params = {}) ⇒ Types::ListManagedSchemaArnsResponse
Lists the major version families of each managed schema.
-
#list_object_attributes(params = {}) ⇒ Types::ListObjectAttributesResponse
Lists all attributes that are associated with an object.
-
#list_object_children(params = {}) ⇒ Types::ListObjectChildrenResponse
Returns a paginated list of child objects that are associated with a given object.
-
#list_object_parent_paths(params = {}) ⇒ Types::ListObjectParentPathsResponse
Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects.
-
#list_object_parents(params = {}) ⇒ Types::ListObjectParentsResponse
Lists parent objects that are associated with a given object in pagination fashion.
-
#list_object_policies(params = {}) ⇒ Types::ListObjectPoliciesResponse
Returns policies attached to an object in pagination fashion.
-
#list_outgoing_typed_links(params = {}) ⇒ Types::ListOutgoingTypedLinksResponse
Returns a paginated list of all the outgoing TypedLinkSpecifier information for an object.
-
#list_policy_attachments(params = {}) ⇒ Types::ListPolicyAttachmentsResponse
Returns all of the
ObjectIdentifiers
to which a given policy is attached. -
#list_published_schema_arns(params = {}) ⇒ Types::ListPublishedSchemaArnsResponse
Lists the major version families of each published schema.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Returns tags for a resource.
-
#list_typed_link_facet_attributes(params = {}) ⇒ Types::ListTypedLinkFacetAttributesResponse
Returns a paginated list of all attribute definitions for a particular TypedLinkFacet.
-
#list_typed_link_facet_names(params = {}) ⇒ Types::ListTypedLinkFacetNamesResponse
Returns a paginated list of
TypedLink
facet names for a particular schema. -
#lookup_policy(params = {}) ⇒ Types::LookupPolicyResponse
Lists all policies from the root of the Directory to the object specified.
-
#publish_schema(params = {}) ⇒ Types::PublishSchemaResponse
Publishes a development schema with a major version and a recommended minor version.
-
#put_schema_from_json(params = {}) ⇒ Types::PutSchemaFromJsonResponse
Allows a schema to be updated using JSON upload.
-
#remove_facet_from_object(params = {}) ⇒ Struct
Removes the specified facet from the specified object.
-
#tag_resource(params = {}) ⇒ Struct
An API operation for adding tags to a resource.
-
#untag_resource(params = {}) ⇒ Struct
An API operation for removing tags from a resource.
-
#update_facet(params = {}) ⇒ Struct
Does the following:.
-
#update_link_attributes(params = {}) ⇒ Struct
Updates a given typed link’s attributes.
-
#update_object_attributes(params = {}) ⇒ Types::UpdateObjectAttributesResponse
Updates a given object's attributes.
-
#update_schema(params = {}) ⇒ Types::UpdateSchemaResponse
Updates the schema name with a new name.
-
#update_typed_link_facet(params = {}) ⇒ Struct
Updates a TypedLinkFacet.
-
#upgrade_applied_schema(params = {}) ⇒ Types::UpgradeAppliedSchemaResponse
Upgrades a single directory in-place using the
PublishedSchemaArn
with schema updates found inMinorVersion
. -
#upgrade_published_schema(params = {}) ⇒ Types::UpgradePublishedSchemaResponse
Upgrades a published schema under a new minor version revision using the current contents of
DevelopmentSchemaArn
.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from Aws::ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
444 445 446 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 444 def initialize(*args) super end |
Instance Method Details
#add_facet_to_object(params = {}) ⇒ Struct
Adds a new Facet to an object. An object can have more than one facet applied on it.
522 523 524 525 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 522 def add_facet_to_object(params = {}, = {}) req = build_request(:add_facet_to_object, params) req.send_request() end |
#apply_schema(params = {}) ⇒ Types::ApplySchemaResponse
Copies the input published schema, at the specified version, into the Directory with the same name and version as that of the published schema.
574 575 576 577 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 574 def apply_schema(params = {}, = {}) req = build_request(:apply_schema, params) req.send_request() end |
#attach_object(params = {}) ⇒ Types::AttachObjectResponse
Attaches an existing object to another object. An object can be accessed in two ways:
Using the path
Using
ObjectIdentifier
643 644 645 646 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 643 def attach_object(params = {}, = {}) req = build_request(:attach_object, params) req.send_request() end |
#attach_policy(params = {}) ⇒ Struct
Attaches a policy object to a regular object. An object can have a limited number of attached policies.
697 698 699 700 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 697 def attach_policy(params = {}, = {}) req = build_request(:attach_policy, params) req.send_request() end |
#attach_to_index(params = {}) ⇒ Types::AttachToIndexResponse
Attaches the specified object to the specified index.
756 757 758 759 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 756 def attach_to_index(params = {}, = {}) req = build_request(:attach_to_index, params) req.send_request() end |
#attach_typed_link(params = {}) ⇒ Types::AttachTypedLinkResponse
Attaches a typed link to a specified source and target object. For more information, see Typed Links.
884 885 886 887 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 884 def attach_typed_link(params = {}, = {}) req = build_request(:attach_typed_link, params) req.send_request() end |
#batch_read(params = {}) ⇒ Types::BatchReadResponse
Performs all the read operations in a batch.
1255 1256 1257 1258 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 1255 def batch_read(params = {}, = {}) req = build_request(:batch_read, params) req.send_request() end |
#batch_write(params = {}) ⇒ Types::BatchWriteResponse
Performs all the write operations in a batch. Either all the operations succeed or none.
1575 1576 1577 1578 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 1575 def batch_write(params = {}, = {}) req = build_request(:batch_write, params) req.send_request() end |
#create_directory(params = {}) ⇒ Types::CreateDirectoryResponse
Creates a Directory by copying the published schema into the directory. A directory cannot be created without a schema.
You can also quickly create a directory using a managed schema, called
the QuickStartSchema
. For more information, see Managed Schema
in the Amazon Cloud Directory Developer Guide.
1639 1640 1641 1642 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 1639 def create_directory(params = {}, = {}) req = build_request(:create_directory, params) req.send_request() end |
#create_facet(params = {}) ⇒ Struct
Creates a new Facet in a schema. Facet creation is allowed only in development or applied schemas.
1748 1749 1750 1751 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 1748 def create_facet(params = {}, = {}) req = build_request(:create_facet, params) req.send_request() end |
#create_index(params = {}) ⇒ Types::CreateIndexResponse
Creates an index object. See Indexing and search for more information.
1825 1826 1827 1828 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 1825 def create_index(params = {}, = {}) req = build_request(:create_index, params) req.send_request() end |
#create_object(params = {}) ⇒ Types::CreateObjectResponse
Creates an object in a Directory. Additionally attaches the object to
a parent, if a parent reference and LinkName
is specified. An object
is simply a collection of Facet attributes. You can also use this API
call to create a policy object, if the facet from which you create the
object is a policy facet.
1917 1918 1919 1920 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 1917 def create_object(params = {}, = {}) req = build_request(:create_object, params) req.send_request() end |
#create_schema(params = {}) ⇒ Types::CreateSchemaResponse
Creates a new schema in a development state. A schema can exist in three phases:
Development: This is a mutable phase of the schema. All new schemas are in the development phase. Once the schema is finalized, it can be published.
Published: Published schemas are immutable and have a version associated with them.
Applied: Applied schemas are mutable in a way that allows you to add new schema facets. You can also add new, nonrequired attributes to existing schema facets. You can apply only published schemas to directories.
1971 1972 1973 1974 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 1971 def create_schema(params = {}, = {}) req = build_request(:create_schema, params) req.send_request() end |
#create_typed_link_facet(params = {}) ⇒ Struct
Creates a TypedLinkFacet. For more information, see Typed Links.
2052 2053 2054 2055 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 2052 def create_typed_link_facet(params = {}, = {}) req = build_request(:create_typed_link_facet, params) req.send_request() end |
#delete_directory(params = {}) ⇒ Types::DeleteDirectoryResponse
Deletes a directory. Only disabled directories can be deleted. A deleted directory cannot be undone. Exercise extreme caution when deleting directories.
2094 2095 2096 2097 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 2094 def delete_directory(params = {}, = {}) req = build_request(:delete_directory, params) req.send_request() end |
#delete_facet(params = {}) ⇒ Struct
Deletes a given Facet. All attributes and Rules that are associated with the facet will be deleted. Only development schema facets are allowed deletion.
2135 2136 2137 2138 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 2135 def delete_facet(params = {}, = {}) req = build_request(:delete_facet, params) req.send_request() end |
#delete_object(params = {}) ⇒ Struct
Deletes an object and its associated attributes. Only objects with no children and no parents can be deleted. The maximum number of attributes that can be deleted during an object deletion is 30. For more information, see Amazon Cloud Directory Limits.
2185 2186 2187 2188 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 2185 def delete_object(params = {}, = {}) req = build_request(:delete_object, params) req.send_request() end |
#delete_schema(params = {}) ⇒ Types::DeleteSchemaResponse
Deletes a given schema. Schemas in a development and published state can only be deleted.
2227 2228 2229 2230 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 2227 def delete_schema(params = {}, = {}) req = build_request(:delete_schema, params) req.send_request() end |
#delete_typed_link_facet(params = {}) ⇒ Struct
Deletes a TypedLinkFacet. For more information, see Typed Links.
2270 2271 2272 2273 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 2270 def delete_typed_link_facet(params = {}, = {}) req = build_request(:delete_typed_link_facet, params) req.send_request() end |
#detach_from_index(params = {}) ⇒ Types::DetachFromIndexResponse
Detaches the specified object from the specified index.
2329 2330 2331 2332 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 2329 def detach_from_index(params = {}, = {}) req = build_request(:detach_from_index, params) req.send_request() end |
#detach_object(params = {}) ⇒ Types::DetachObjectResponse
Detaches a given object from the parent object. The object that is to be detached from the parent is specified by the link name.
2386 2387 2388 2389 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 2386 def detach_object(params = {}, = {}) req = build_request(:detach_object, params) req.send_request() end |
#detach_policy(params = {}) ⇒ Struct
Detaches a policy from an object.
2439 2440 2441 2442 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 2439 def detach_policy(params = {}, = {}) req = build_request(:detach_policy, params) req.send_request() end |
#detach_typed_link(params = {}) ⇒ Struct
Detaches a typed link from a specified source and target object. For more information, see Typed Links.
2521 2522 2523 2524 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 2521 def detach_typed_link(params = {}, = {}) req = build_request(:detach_typed_link, params) req.send_request() end |
#disable_directory(params = {}) ⇒ Types::DisableDirectoryResponse
Disables the specified directory. Disabled directories cannot be read or written to. Only enabled directories can be disabled. Disabled directories may be reenabled.
2563 2564 2565 2566 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 2563 def disable_directory(params = {}, = {}) req = build_request(:disable_directory, params) req.send_request() end |
#enable_directory(params = {}) ⇒ Types::EnableDirectoryResponse
Enables the specified directory. Only disabled directories can be enabled. Once enabled, the directory can then be read and written to.
2604 2605 2606 2607 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 2604 def enable_directory(params = {}, = {}) req = build_request(:enable_directory, params) req.send_request() end |
#get_applied_schema_version(params = {}) ⇒ Types::GetAppliedSchemaVersionResponse
Returns current applied schema version ARN, including the minor version in use.
2633 2634 2635 2636 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 2633 def get_applied_schema_version(params = {}, = {}) req = build_request(:get_applied_schema_version, params) req.send_request() end |
#get_directory(params = {}) ⇒ Types::GetDirectoryResponse
Retrieves metadata about a directory.
2681 2682 2683 2684 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 2681 def get_directory(params = {}, = {}) req = build_request(:get_directory, params) req.send_request() end |
#get_facet(params = {}) ⇒ Types::GetFacetResponse
Gets details of the Facet, such as facet name, attributes, Rules, or
ObjectType
. You can call this on all kinds of schema facets --
published, development, or applied.
2734 2735 2736 2737 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 2734 def get_facet(params = {}, = {}) req = build_request(:get_facet, params) req.send_request() end |
#get_link_attributes(params = {}) ⇒ Types::GetLinkAttributesResponse
Retrieves attributes that are associated with a typed link.
2812 2813 2814 2815 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 2812 def get_link_attributes(params = {}, = {}) req = build_request(:get_link_attributes, params) req.send_request() end |
#get_object_attributes(params = {}) ⇒ Types::GetObjectAttributesResponse
Retrieves attributes within a facet that are associated with an object.
2874 2875 2876 2877 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 2874 def get_object_attributes(params = {}, = {}) req = build_request(:get_object_attributes, params) req.send_request() end |
#get_object_information(params = {}) ⇒ Types::GetObjectInformationResponse
Retrieves metadata about an object.
2938 2939 2940 2941 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 2938 def get_object_information(params = {}, = {}) req = build_request(:get_object_information, params) req.send_request() end |
#get_schema_as_json(params = {}) ⇒ Types::GetSchemaAsJsonResponse
Retrieves a JSON representation of the schema. See JSON Schema Format for more information.
2986 2987 2988 2989 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 2986 def get_schema_as_json(params = {}, = {}) req = build_request(:get_schema_as_json, params) req.send_request() end |
#get_typed_link_facet_information(params = {}) ⇒ Types::GetTypedLinkFacetInformationResponse
Returns the identity attribute order for a specific TypedLinkFacet. For more information, see Typed Links.
3040 3041 3042 3043 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 3040 def get_typed_link_facet_information(params = {}, = {}) req = build_request(:get_typed_link_facet_information, params) req.send_request() end |
#list_applied_schema_arns(params = {}) ⇒ Types::ListAppliedSchemaArnsResponse
Lists schema major versions applied to a directory. If SchemaArn
is
provided, lists the minor version.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3101 3102 3103 3104 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 3101 def list_applied_schema_arns(params = {}, = {}) req = build_request(:list_applied_schema_arns, params) req.send_request() end |
#list_attached_indices(params = {}) ⇒ Types::ListAttachedIndicesResponse
Lists indices attached to the specified object.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3182 3183 3184 3185 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 3182 def list_attached_indices(params = {}, = {}) req = build_request(:list_attached_indices, params) req.send_request() end |
#list_development_schema_arns(params = {}) ⇒ Types::ListDevelopmentSchemaArnsResponse
Retrieves each Amazon Resource Name (ARN) of schemas in the development state.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3238 3239 3240 3241 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 3238 def list_development_schema_arns(params = {}, = {}) req = build_request(:list_development_schema_arns, params) req.send_request() end |
#list_directories(params = {}) ⇒ Types::ListDirectoriesResponse
Lists directories created within an account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3325 3326 3327 3328 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 3325 def list_directories(params = {}, = {}) req = build_request(:list_directories, params) req.send_request() end |
#list_facet_attributes(params = {}) ⇒ Types::ListFacetAttributesResponse
Retrieves attributes attached to the facet.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3569 3570 3571 3572 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 3569 def list_facet_attributes(params = {}, = {}) req = build_request(:list_facet_attributes, params) req.send_request() end |
#list_facet_names(params = {}) ⇒ Types::ListFacetNamesResponse
Retrieves the names of facets that exist in a schema.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3629 3630 3631 3632 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 3629 def list_facet_names(params = {}, = {}) req = build_request(:list_facet_names, params) req.send_request() end |
#list_incoming_typed_links(params = {}) ⇒ Types::ListIncomingTypedLinksResponse
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.
3810 3811 3812 3813 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 3810 def list_incoming_typed_links(params = {}, = {}) req = build_request(:list_incoming_typed_links, params) req.send_request() end |
#list_index(params = {}) ⇒ Types::ListIndexResponse
Lists objects attached to the specified index.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3936 3937 3938 3939 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 3936 def list_index(params = {}, = {}) req = build_request(:list_index, params) req.send_request() end |
#list_managed_schema_arns(params = {}) ⇒ Types::ListManagedSchemaArnsResponse
Lists the major version families of each managed schema. If a major version ARN is provided as SchemaArn, the minor version revisions in that family are listed instead.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3980 3981 3982 3983 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 3980 def list_managed_schema_arns(params = {}, = {}) req = build_request(:list_managed_schema_arns, params) req.send_request() end |
#list_object_attributes(params = {}) ⇒ Types::ListObjectAttributesResponse
Lists all attributes that are associated with an object.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4087 4088 4089 4090 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 4087 def list_object_attributes(params = {}, = {}) req = build_request(:list_object_attributes, params) req.send_request() end |
#list_object_children(params = {}) ⇒ Types::ListObjectChildrenResponse
Returns a paginated list of child objects that are associated with a given object.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4161 4162 4163 4164 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 4161 def list_object_children(params = {}, = {}) req = build_request(:list_object_children, params) req.send_request() end |
#list_object_parent_paths(params = {}) ⇒ Types::ListObjectParentPathsResponse
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.
Use this API to evaluate all parents for an object. The call returns
all objects from the root of the directory up to the requested object.
The API returns the number of paths based on user-defined
MaxResults
, in case there are multiple paths to the parent. The
order of the paths and nodes returned is consistent among multiple API
calls unless the objects are deleted or moved. Paths not leading to
the directory root are ignored from the target object.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4226 4227 4228 4229 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 4226 def list_object_parent_paths(params = {}, = {}) req = build_request(:list_object_parent_paths, params) req.send_request() end |
#list_object_parents(params = {}) ⇒ Types::ListObjectParentsResponse
Lists parent objects that are associated with a given object in pagination fashion.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4292 4293 4294 4295 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 4292 def list_object_parents(params = {}, = {}) req = build_request(:list_object_parents, params) req.send_request() end |
#list_object_policies(params = {}) ⇒ Types::ListObjectPoliciesResponse
Returns policies attached to an object in pagination fashion.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4348 4349 4350 4351 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 4348 def list_object_policies(params = {}, = {}) req = build_request(:list_object_policies, params) req.send_request() end |
#list_outgoing_typed_links(params = {}) ⇒ Types::ListOutgoingTypedLinksResponse
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.
4453 4454 4455 4456 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 4453 def list_outgoing_typed_links(params = {}, = {}) req = build_request(:list_outgoing_typed_links, params) req.send_request() end |
#list_policy_attachments(params = {}) ⇒ Types::ListPolicyAttachmentsResponse
Returns all of the ObjectIdentifiers
to which a given policy is
attached.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4509 4510 4511 4512 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 4509 def (params = {}, = {}) req = build_request(:list_policy_attachments, params) req.send_request() end |
#list_published_schema_arns(params = {}) ⇒ Types::ListPublishedSchemaArnsResponse
Lists the major version families of each published schema. If a major
version ARN is provided as SchemaArn
, the minor version revisions in
that family are listed instead.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4553 4554 4555 4556 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 4553 def list_published_schema_arns(params = {}, = {}) req = build_request(:list_published_schema_arns, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Returns tags for a resource. Tagging is currently supported only for directories with a limit of 50 tags per directory. All 50 tags are returned for a given directory with this API call.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4601 4602 4603 4604 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 4601 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#list_typed_link_facet_attributes(params = {}) ⇒ Types::ListTypedLinkFacetAttributesResponse
Returns a paginated list of all attribute definitions for a particular TypedLinkFacet. For more information, see Typed Links.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4664 4665 4666 4667 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 4664 def list_typed_link_facet_attributes(params = {}, = {}) req = build_request(:list_typed_link_facet_attributes, params) req.send_request() end |
#list_typed_link_facet_names(params = {}) ⇒ Types::ListTypedLinkFacetNamesResponse
Returns a paginated list of TypedLink
facet names for a particular
schema. For more information, see Typed Links.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4711 4712 4713 4714 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 4711 def list_typed_link_facet_names(params = {}, = {}) req = build_request(:list_typed_link_facet_names, params) req.send_request() end |
#lookup_policy(params = {}) ⇒ Types::LookupPolicyResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4774 4775 4776 4777 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 4774 def lookup_policy(params = {}, = {}) req = build_request(:lookup_policy, params) req.send_request() end |
#publish_schema(params = {}) ⇒ Types::PublishSchemaResponse
Publishes a development schema with a major version and a recommended minor version.
4820 4821 4822 4823 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 4820 def publish_schema(params = {}, = {}) req = build_request(:publish_schema, params) req.send_request() end |
#put_schema_from_json(params = {}) ⇒ Types::PutSchemaFromJsonResponse
Allows a schema to be updated using JSON upload. Only available for development schemas. See JSON Schema Format for more information.
4857 4858 4859 4860 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 4857 def put_schema_from_json(params = {}, = {}) req = build_request(:put_schema_from_json, params) req.send_request() end |
#remove_facet_from_object(params = {}) ⇒ Struct
Removes the specified facet from the specified object.
4892 4893 4894 4895 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 4892 def remove_facet_from_object(params = {}, = {}) req = build_request(:remove_facet_from_object, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
An API operation for adding tags to a resource.
4924 4925 4926 4927 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 4924 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
An API operation for removing tags from a resource.
4951 4952 4953 4954 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 4951 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_facet(params = {}) ⇒ Struct
Does the following:
Adds new
Attributes
,Rules
, orObjectTypes
.Updates existing
Attributes
,Rules
, orObjectTypes
.Deletes existing
Attributes
,Rules
, orObjectTypes
.
5026 5027 5028 5029 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 5026 def update_facet(params = {}, = {}) req = build_request(:update_facet, params) req.send_request() end |
#update_link_attributes(params = {}) ⇒ Struct
Updates a given typed link’s attributes. Attributes to be updated must
not contribute to the typed link’s identity, as defined by its
IdentityAttributeOrder
.
5105 5106 5107 5108 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 5105 def update_link_attributes(params = {}, = {}) req = build_request(:update_link_attributes, params) req.send_request() end |
#update_object_attributes(params = {}) ⇒ Types::UpdateObjectAttributesResponse
Updates a given object's attributes.
5162 5163 5164 5165 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 5162 def update_object_attributes(params = {}, = {}) req = build_request(:update_object_attributes, params) req.send_request() end |
#update_schema(params = {}) ⇒ Types::UpdateSchemaResponse
Updates the schema name with a new name. Only development schema names can be updated.
5196 5197 5198 5199 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 5196 def update_schema(params = {}, = {}) req = build_request(:update_schema, params) req.send_request() end |
#update_typed_link_facet(params = {}) ⇒ Struct
Updates a TypedLinkFacet. For more information, see Typed Links.
5272 5273 5274 5275 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 5272 def update_typed_link_facet(params = {}, = {}) req = build_request(:update_typed_link_facet, params) req.send_request() end |
#upgrade_applied_schema(params = {}) ⇒ Types::UpgradeAppliedSchemaResponse
Upgrades a single directory in-place using the PublishedSchemaArn
with schema updates found in MinorVersion
. Backwards-compatible
minor version upgrades are instantaneously available for readers on
all objects in the directory. Note: This is a synchronous API call and
upgrades only one schema on a given directory per call. To upgrade
multiple directories from one schema, you would need to call this API
on each directory.
5320 5321 5322 5323 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 5320 def upgrade_applied_schema(params = {}, = {}) req = build_request(:upgrade_applied_schema, params) req.send_request() end |
#upgrade_published_schema(params = {}) ⇒ Types::UpgradePublishedSchemaResponse
Upgrades a published schema under a new minor version revision using
the current contents of DevelopmentSchemaArn
.
5367 5368 5369 5370 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 5367 def upgrade_published_schema(params = {}, = {}) req = build_request(:upgrade_published_schema, params) req.send_request() end |