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.
440 441 442 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 440 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.
498 499 500 501 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 498 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.
536 537 538 539 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 536 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
586 587 588 589 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 586 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.
623 624 625 626 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 623 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.
664 665 666 667 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 664 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.
743 744 745 746 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 743 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.
1098 1099 1100 1101 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 1098 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.
1403 1404 1405 1406 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 1403 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.
1451 1452 1453 1454 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 1451 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.
1547 1548 1549 1550 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 1547 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.
1606 1607 1608 1609 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 1606 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.
1680 1681 1682 1683 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 1680 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.
1722 1723 1724 1725 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 1722 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.
1779 1780 1781 1782 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 1779 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.
1809 1810 1811 1812 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 1809 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.
1838 1839 1840 1841 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 1838 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.
1874 1875 1876 1877 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 1874 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.
1904 1905 1906 1907 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 1904 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.
1935 1936 1937 1938 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 1935 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.
1976 1977 1978 1979 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 1976 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.
2017 2018 2019 2020 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 2017 def detach_object(params = {}, = {}) req = build_request(:detach_object, params) req.send_request() end |
#detach_policy(params = {}) ⇒ Struct
Detaches a policy from an object.
2053 2054 2055 2056 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 2053 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.
2108 2109 2110 2111 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 2108 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.
2138 2139 2140 2141 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 2138 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.
2167 2168 2169 2170 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 2167 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.
2196 2197 2198 2199 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 2196 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.
2227 2228 2229 2230 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 2227 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.
2264 2265 2266 2267 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 2264 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.
2342 2343 2344 2345 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 2342 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.
2404 2405 2406 2407 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 2404 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.
2446 2447 2448 2449 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 2446 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.
2481 2482 2483 2484 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 2481 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.
2520 2521 2522 2523 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 2520 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.
2567 2568 2569 2570 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 2567 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.
2627 2628 2629 2630 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 2627 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.
2665 2666 2667 2668 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 2665 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.
2710 2711 2712 2713 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 2710 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.
2769 2770 2771 2772 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 2769 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.
2810 2811 2812 2813 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 2810 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.
2914 2915 2916 2917 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 2914 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.
3010 3011 3012 3013 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 3010 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.
3054 3055 3056 3057 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 3054 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.
3125 3126 3127 3128 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 3125 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.
3182 3183 3184 3185 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 3182 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.
3247 3248 3249 3250 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 3247 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.
3313 3314 3315 3316 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 3313 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.
3369 3370 3371 3372 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 3369 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.
3474 3475 3476 3477 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 3474 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.
3530 3531 3532 3533 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 3530 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.
3574 3575 3576 3577 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 3574 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.
3622 3623 3624 3625 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 3622 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.
3685 3686 3687 3688 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 3685 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.
3732 3733 3734 3735 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 3732 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.
3795 3796 3797 3798 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 3795 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.
3841 3842 3843 3844 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 3841 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.
3878 3879 3880 3881 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 3878 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.
3913 3914 3915 3916 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 3913 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.
3945 3946 3947 3948 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 3945 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.
3972 3973 3974 3975 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 3972 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
.
4047 4048 4049 4050 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 4047 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
.
4126 4127 4128 4129 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 4126 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.
4183 4184 4185 4186 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 4183 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.
4217 4218 4219 4220 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 4217 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.
4293 4294 4295 4296 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 4293 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.
4341 4342 4343 4344 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 4341 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
.
4388 4389 4390 4391 |
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/client.rb', line 4388 def upgrade_published_schema(params = {}, = {}) req = build_request(:upgrade_published_schema, params) req.send_request() end |