Struct aws_sdk_clouddirectory::Client
source · pub struct Client { /* private fields */ }
Expand description
Client for Amazon CloudDirectory
Client for invoking operations on Amazon CloudDirectory. Each operation on Amazon CloudDirectory is a method on this
this struct. .send()
MUST be invoked on the generated operations to dispatch the request to the service.
§Constructing a Client
A Config
is required to construct a client. For most use cases, the aws-config
crate should be used to automatically resolve this config using
aws_config::load_from_env()
, since this will resolve an SdkConfig
which can be shared
across multiple different AWS SDK clients. This config resolution process can be customized
by calling aws_config::from_env()
instead, which returns a ConfigLoader
that uses
the builder pattern to customize the default config.
In the simplest case, creating a client looks as follows:
let config = aws_config::load_from_env().await;
let client = aws_sdk_clouddirectory::Client::new(&config);
Occasionally, SDKs may have additional service-specific values that can be set on the Config
that
is absent from SdkConfig
, or slightly different settings for a specific client may be desired.
The Config
struct implements From<&SdkConfig>
, so setting these specific settings can be
done as follows:
let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_clouddirectory::config::Builder::from(&sdk_config)
.some_service_specific_setting("value")
.build();
See the aws-config
docs and Config
for more information on customizing configuration.
Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.
§Using the Client
A client has a function for every operation that can be performed by the service.
For example, the AddFacetToObject
operation has
a Client::add_facet_to_object
, function which returns a builder for that operation.
The fluent builder ultimately has a send()
function that returns an async future that
returns a result, as illustrated below:
let result = client.add_facet_to_object()
.directory_arn("example")
.send()
.await;
The underlying HTTP requests that get made by this can be modified with the customize_operation
function on the fluent builder. See the customize
module for more
information.
Implementations§
source§impl Client
impl Client
sourcepub fn add_facet_to_object(&self) -> AddFacetToObjectFluentBuilder
pub fn add_facet_to_object(&self) -> AddFacetToObjectFluentBuilder
Constructs a fluent builder for the AddFacetToObject
operation.
- The fluent builder is configurable:
directory_arn(impl Into<String>)
/set_directory_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) that is associated with the
Directory
where the object resides. For more information, seearns
.schema_facet(SchemaFacet)
/set_schema_facet(Option<SchemaFacet>)
:
required: trueIdentifiers for the facet that you are adding to the object. See
SchemaFacet
for details.object_attribute_list(AttributeKeyAndValue)
/set_object_attribute_list(Option<Vec::<AttributeKeyAndValue>>)
:
required: falseAttributes on the facet that you are adding to the object.
object_reference(ObjectReference)
/set_object_reference(Option<ObjectReference>)
:
required: trueA reference to the object you are adding the specified facet to.
- On success, responds with
AddFacetToObjectOutput
- On failure, responds with
SdkError<AddFacetToObjectError>
source§impl Client
impl Client
sourcepub fn apply_schema(&self) -> ApplySchemaFluentBuilder
pub fn apply_schema(&self) -> ApplySchemaFluentBuilder
Constructs a fluent builder for the ApplySchema
operation.
- The fluent builder is configurable:
published_schema_arn(impl Into<String>)
/set_published_schema_arn(Option<String>)
:
required: truePublished schema Amazon Resource Name (ARN) that needs to be copied. For more information, see
arns
.directory_arn(impl Into<String>)
/set_directory_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) that is associated with the
Directory
into which the schema is copied. For more information, seearns
.
- On success, responds with
ApplySchemaOutput
with field(s):applied_schema_arn(Option<String>)
:The applied schema ARN that is associated with the copied schema in the
Directory
. You can use this ARN to describe the schema information applied on this directory. For more information, seearns
.directory_arn(Option<String>)
:The ARN that is associated with the
Directory
. For more information, seearns
.
- On failure, responds with
SdkError<ApplySchemaError>
source§impl Client
impl Client
sourcepub fn attach_object(&self) -> AttachObjectFluentBuilder
pub fn attach_object(&self) -> AttachObjectFluentBuilder
Constructs a fluent builder for the AttachObject
operation.
- The fluent builder is configurable:
directory_arn(impl Into<String>)
/set_directory_arn(Option<String>)
:
required: trueAmazon Resource Name (ARN) that is associated with the
Directory
where both objects reside. For more information, seearns
.parent_reference(ObjectReference)
/set_parent_reference(Option<ObjectReference>)
:
required: trueThe parent object reference.
child_reference(ObjectReference)
/set_child_reference(Option<ObjectReference>)
:
required: trueThe child object reference to be attached to the object.
link_name(impl Into<String>)
/set_link_name(Option<String>)
:
required: trueThe link name with which the child object is attached to the parent.
- On success, responds with
AttachObjectOutput
with field(s):attached_object_identifier(Option<String>)
:The attached
ObjectIdentifier
, which is the childObjectIdentifier
.
- On failure, responds with
SdkError<AttachObjectError>
source§impl Client
impl Client
sourcepub fn attach_policy(&self) -> AttachPolicyFluentBuilder
pub fn attach_policy(&self) -> AttachPolicyFluentBuilder
Constructs a fluent builder for the AttachPolicy
operation.
- The fluent builder is configurable:
directory_arn(impl Into<String>)
/set_directory_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) that is associated with the
Directory
where both objects reside. For more information, seearns
.policy_reference(ObjectReference)
/set_policy_reference(Option<ObjectReference>)
:
required: trueThe reference that is associated with the policy object.
object_reference(ObjectReference)
/set_object_reference(Option<ObjectReference>)
:
required: trueThe reference that identifies the object to which the policy will be attached.
- On success, responds with
AttachPolicyOutput
- On failure, responds with
SdkError<AttachPolicyError>
source§impl Client
impl Client
sourcepub fn attach_to_index(&self) -> AttachToIndexFluentBuilder
pub fn attach_to_index(&self) -> AttachToIndexFluentBuilder
Constructs a fluent builder for the AttachToIndex
operation.
- The fluent builder is configurable:
directory_arn(impl Into<String>)
/set_directory_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the directory where the object and index exist.
index_reference(ObjectReference)
/set_index_reference(Option<ObjectReference>)
:
required: trueA reference to the index that you are attaching the object to.
target_reference(ObjectReference)
/set_target_reference(Option<ObjectReference>)
:
required: trueA reference to the object that you are attaching to the index.
- On success, responds with
AttachToIndexOutput
with field(s):attached_object_identifier(Option<String>)
:The
ObjectIdentifier
of the object that was attached to the index.
- On failure, responds with
SdkError<AttachToIndexError>
source§impl Client
impl Client
sourcepub fn attach_typed_link(&self) -> AttachTypedLinkFluentBuilder
pub fn attach_typed_link(&self) -> AttachTypedLinkFluentBuilder
Constructs a fluent builder for the AttachTypedLink
operation.
- The fluent builder is configurable:
directory_arn(impl Into<String>)
/set_directory_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the directory where you want to attach the typed link.
source_object_reference(ObjectReference)
/set_source_object_reference(Option<ObjectReference>)
:
required: trueIdentifies the source object that the typed link will attach to.
target_object_reference(ObjectReference)
/set_target_object_reference(Option<ObjectReference>)
:
required: trueIdentifies the target object that the typed link will attach to.
typed_link_facet(TypedLinkSchemaAndFacetName)
/set_typed_link_facet(Option<TypedLinkSchemaAndFacetName>)
:
required: trueIdentifies the typed link facet that is associated with the typed link.
attributes(AttributeNameAndValue)
/set_attributes(Option<Vec::<AttributeNameAndValue>>)
:
required: trueA set of attributes that are associated with the typed link.
- On success, responds with
AttachTypedLinkOutput
with field(s):typed_link_specifier(Option<TypedLinkSpecifier>)
:Returns a typed link specifier as output.
- On failure, responds with
SdkError<AttachTypedLinkError>
source§impl Client
impl Client
sourcepub fn batch_read(&self) -> BatchReadFluentBuilder
pub fn batch_read(&self) -> BatchReadFluentBuilder
Constructs a fluent builder for the BatchRead
operation.
- The fluent builder is configurable:
directory_arn(impl Into<String>)
/set_directory_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) that is associated with the
Directory
. For more information, seearns
.operations(BatchReadOperation)
/set_operations(Option<Vec::<BatchReadOperation>>)
:
required: trueA list of operations that are part of the batch.
consistency_level(ConsistencyLevel)
/set_consistency_level(Option<ConsistencyLevel>)
:
required: falseRepresents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.
- On success, responds with
BatchReadOutput
with field(s):responses(Option<Vec::<BatchReadOperationResponse>>)
:A list of all the responses for each batch read.
- On failure, responds with
SdkError<BatchReadError>
source§impl Client
impl Client
sourcepub fn batch_write(&self) -> BatchWriteFluentBuilder
pub fn batch_write(&self) -> BatchWriteFluentBuilder
Constructs a fluent builder for the BatchWrite
operation.
- The fluent builder is configurable:
directory_arn(impl Into<String>)
/set_directory_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) that is associated with the
Directory
. For more information, seearns
.operations(BatchWriteOperation)
/set_operations(Option<Vec::<BatchWriteOperation>>)
:
required: trueA list of operations that are part of the batch.
- On success, responds with
BatchWriteOutput
with field(s):responses(Option<Vec::<BatchWriteOperationResponse>>)
:A list of all the responses for each batch write.
- On failure, responds with
SdkError<BatchWriteError>
source§impl Client
impl Client
sourcepub fn create_directory(&self) -> CreateDirectoryFluentBuilder
pub fn create_directory(&self) -> CreateDirectoryFluentBuilder
Constructs a fluent builder for the CreateDirectory
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the
Directory
. Should be unique per account, per region.schema_arn(impl Into<String>)
/set_schema_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the published schema that will be copied into the data
Directory
. For more information, seearns
.
- On success, responds with
CreateDirectoryOutput
with field(s):directory_arn(String)
:The ARN that is associated with the
Directory
. For more information, seearns
.name(String)
:The name of the
Directory
.object_identifier(String)
:The root object node of the created directory.
applied_schema_arn(String)
:The ARN of the published schema in the
Directory
. Once a published schema is copied into the directory, it has its own ARN, which is referred to applied schema ARN. For more information, seearns
.
- On failure, responds with
SdkError<CreateDirectoryError>
source§impl Client
impl Client
sourcepub fn create_facet(&self) -> CreateFacetFluentBuilder
pub fn create_facet(&self) -> CreateFacetFluentBuilder
Constructs a fluent builder for the CreateFacet
operation.
- The fluent builder is configurable:
schema_arn(impl Into<String>)
/set_schema_arn(Option<String>)
:
required: trueThe schema ARN in which the new
Facet
will be created. For more information, seearns
.name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the
Facet
, which is unique for a given schema.attributes(FacetAttribute)
/set_attributes(Option<Vec::<FacetAttribute>>)
:
required: falseThe attributes that are associated with the
Facet
.object_type(ObjectType)
/set_object_type(Option<ObjectType>)
:
required: falseSpecifies whether a given object created from this facet is of type node, leaf node, policy or index.
-
Node: Can have multiple children but one parent.
-
Leaf node: Cannot have children but can have multiple parents.
-
Policy: Allows you to store a policy document and policy type. For more information, see Policies.
-
Index: Can be created with the Index API.
-
facet_style(FacetStyle)
/set_facet_style(Option<FacetStyle>)
:
required: falseThere are two different styles that you can define on any given facet,
Static
andDynamic
. For static facets, all attributes must be defined in the schema. For dynamic facets, attributes can be defined during data plane operations.
- On success, responds with
CreateFacetOutput
- On failure, responds with
SdkError<CreateFacetError>
source§impl Client
impl Client
sourcepub fn create_index(&self) -> CreateIndexFluentBuilder
pub fn create_index(&self) -> CreateIndexFluentBuilder
Constructs a fluent builder for the CreateIndex
operation.
- The fluent builder is configurable:
directory_arn(impl Into<String>)
/set_directory_arn(Option<String>)
:
required: trueThe ARN of the directory where the index should be created.
ordered_indexed_attribute_list(AttributeKey)
/set_ordered_indexed_attribute_list(Option<Vec::<AttributeKey>>)
:
required: trueSpecifies the attributes that should be indexed on. Currently only a single attribute is supported.
is_unique(bool)
/set_is_unique(Option<bool>)
:
required: trueIndicates whether the attribute that is being indexed has unique values or not.
parent_reference(ObjectReference)
/set_parent_reference(Option<ObjectReference>)
:
required: falseA reference to the parent object that contains the index object.
link_name(impl Into<String>)
/set_link_name(Option<String>)
:
required: falseThe name of the link between the parent object and the index object.
- On success, responds with
CreateIndexOutput
with field(s):object_identifier(Option<String>)
:The
ObjectIdentifier
of the index created by this operation.
- On failure, responds with
SdkError<CreateIndexError>
source§impl Client
impl Client
sourcepub fn create_object(&self) -> CreateObjectFluentBuilder
pub fn create_object(&self) -> CreateObjectFluentBuilder
Constructs a fluent builder for the CreateObject
operation.
- The fluent builder is configurable:
directory_arn(impl Into<String>)
/set_directory_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) that is associated with the
Directory
in which the object will be created. For more information, seearns
.schema_facets(SchemaFacet)
/set_schema_facets(Option<Vec::<SchemaFacet>>)
:
required: trueA list of schema facets to be associated with the object. Do not provide minor version components. See
SchemaFacet
for details.object_attribute_list(AttributeKeyAndValue)
/set_object_attribute_list(Option<Vec::<AttributeKeyAndValue>>)
:
required: falseThe attribute map whose attribute ARN contains the key and attribute value as the map value.
parent_reference(ObjectReference)
/set_parent_reference(Option<ObjectReference>)
:
required: falseIf specified, the parent reference to which this object will be attached.
link_name(impl Into<String>)
/set_link_name(Option<String>)
:
required: falseThe name of link that is used to attach this object to a parent.
- On success, responds with
CreateObjectOutput
with field(s):object_identifier(Option<String>)
:The identifier that is associated with the object.
- On failure, responds with
SdkError<CreateObjectError>
source§impl Client
impl Client
sourcepub fn create_schema(&self) -> CreateSchemaFluentBuilder
pub fn create_schema(&self) -> CreateSchemaFluentBuilder
Constructs a fluent builder for the CreateSchema
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name that is associated with the schema. This is unique to each account and in each region.
- On success, responds with
CreateSchemaOutput
with field(s):schema_arn(Option<String>)
:The Amazon Resource Name (ARN) that is associated with the schema. For more information, see
arns
.
- On failure, responds with
SdkError<CreateSchemaError>
source§impl Client
impl Client
sourcepub fn create_typed_link_facet(&self) -> CreateTypedLinkFacetFluentBuilder
pub fn create_typed_link_facet(&self) -> CreateTypedLinkFacetFluentBuilder
Constructs a fluent builder for the CreateTypedLinkFacet
operation.
- The fluent builder is configurable:
schema_arn(impl Into<String>)
/set_schema_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) that is associated with the schema. For more information, see
arns
.facet(TypedLinkFacet)
/set_facet(Option<TypedLinkFacet>)
:
required: trueFacet
structure that is associated with the typed link facet.
- On success, responds with
CreateTypedLinkFacetOutput
- On failure, responds with
SdkError<CreateTypedLinkFacetError>
source§impl Client
impl Client
sourcepub fn delete_directory(&self) -> DeleteDirectoryFluentBuilder
pub fn delete_directory(&self) -> DeleteDirectoryFluentBuilder
Constructs a fluent builder for the DeleteDirectory
operation.
- The fluent builder is configurable:
directory_arn(impl Into<String>)
/set_directory_arn(Option<String>)
:
required: trueThe ARN of the directory to delete.
- On success, responds with
DeleteDirectoryOutput
with field(s):directory_arn(String)
:The ARN of the deleted directory.
- On failure, responds with
SdkError<DeleteDirectoryError>
source§impl Client
impl Client
sourcepub fn delete_facet(&self) -> DeleteFacetFluentBuilder
pub fn delete_facet(&self) -> DeleteFacetFluentBuilder
Constructs a fluent builder for the DeleteFacet
operation.
- The fluent builder is configurable:
schema_arn(impl Into<String>)
/set_schema_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) that is associated with the
Facet
. For more information, seearns
.name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the facet to delete.
- On success, responds with
DeleteFacetOutput
- On failure, responds with
SdkError<DeleteFacetError>
source§impl Client
impl Client
sourcepub fn delete_object(&self) -> DeleteObjectFluentBuilder
pub fn delete_object(&self) -> DeleteObjectFluentBuilder
Constructs a fluent builder for the DeleteObject
operation.
- The fluent builder is configurable:
directory_arn(impl Into<String>)
/set_directory_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) that is associated with the
Directory
where the object resides. For more information, seearns
.object_reference(ObjectReference)
/set_object_reference(Option<ObjectReference>)
:
required: trueA reference that identifies the object.
- On success, responds with
DeleteObjectOutput
- On failure, responds with
SdkError<DeleteObjectError>
source§impl Client
impl Client
sourcepub fn delete_schema(&self) -> DeleteSchemaFluentBuilder
pub fn delete_schema(&self) -> DeleteSchemaFluentBuilder
Constructs a fluent builder for the DeleteSchema
operation.
- The fluent builder is configurable:
schema_arn(impl Into<String>)
/set_schema_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the development schema. For more information, see
arns
.
- On success, responds with
DeleteSchemaOutput
with field(s):schema_arn(Option<String>)
:The input ARN that is returned as part of the response. For more information, see
arns
.
- On failure, responds with
SdkError<DeleteSchemaError>
source§impl Client
impl Client
sourcepub fn delete_typed_link_facet(&self) -> DeleteTypedLinkFacetFluentBuilder
pub fn delete_typed_link_facet(&self) -> DeleteTypedLinkFacetFluentBuilder
Constructs a fluent builder for the DeleteTypedLinkFacet
operation.
- The fluent builder is configurable:
schema_arn(impl Into<String>)
/set_schema_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) that is associated with the schema. For more information, see
arns
.name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe unique name of the typed link facet.
- On success, responds with
DeleteTypedLinkFacetOutput
- On failure, responds with
SdkError<DeleteTypedLinkFacetError>
source§impl Client
impl Client
sourcepub fn detach_from_index(&self) -> DetachFromIndexFluentBuilder
pub fn detach_from_index(&self) -> DetachFromIndexFluentBuilder
Constructs a fluent builder for the DetachFromIndex
operation.
- The fluent builder is configurable:
directory_arn(impl Into<String>)
/set_directory_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the directory the index and object exist in.
index_reference(ObjectReference)
/set_index_reference(Option<ObjectReference>)
:
required: trueA reference to the index object.
target_reference(ObjectReference)
/set_target_reference(Option<ObjectReference>)
:
required: trueA reference to the object being detached from the index.
- On success, responds with
DetachFromIndexOutput
with field(s):detached_object_identifier(Option<String>)
:The
ObjectIdentifier
of the object that was detached from the index.
- On failure, responds with
SdkError<DetachFromIndexError>
source§impl Client
impl Client
sourcepub fn detach_object(&self) -> DetachObjectFluentBuilder
pub fn detach_object(&self) -> DetachObjectFluentBuilder
Constructs a fluent builder for the DetachObject
operation.
- The fluent builder is configurable:
directory_arn(impl Into<String>)
/set_directory_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) that is associated with the
Directory
where objects reside. For more information, seearns
.parent_reference(ObjectReference)
/set_parent_reference(Option<ObjectReference>)
:
required: trueThe parent reference from which the object with the specified link name is detached.
link_name(impl Into<String>)
/set_link_name(Option<String>)
:
required: trueThe link name associated with the object that needs to be detached.
- On success, responds with
DetachObjectOutput
with field(s):detached_object_identifier(Option<String>)
:The
ObjectIdentifier
that was detached from the object.
- On failure, responds with
SdkError<DetachObjectError>
source§impl Client
impl Client
sourcepub fn detach_policy(&self) -> DetachPolicyFluentBuilder
pub fn detach_policy(&self) -> DetachPolicyFluentBuilder
Constructs a fluent builder for the DetachPolicy
operation.
- The fluent builder is configurable:
directory_arn(impl Into<String>)
/set_directory_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) that is associated with the
Directory
where both objects reside. For more information, seearns
.policy_reference(ObjectReference)
/set_policy_reference(Option<ObjectReference>)
:
required: trueReference that identifies the policy object.
object_reference(ObjectReference)
/set_object_reference(Option<ObjectReference>)
:
required: trueReference that identifies the object whose policy object will be detached.
- On success, responds with
DetachPolicyOutput
- On failure, responds with
SdkError<DetachPolicyError>
source§impl Client
impl Client
sourcepub fn detach_typed_link(&self) -> DetachTypedLinkFluentBuilder
pub fn detach_typed_link(&self) -> DetachTypedLinkFluentBuilder
Constructs a fluent builder for the DetachTypedLink
operation.
- The fluent builder is configurable:
directory_arn(impl Into<String>)
/set_directory_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the directory where you want to detach the typed link.
typed_link_specifier(TypedLinkSpecifier)
/set_typed_link_specifier(Option<TypedLinkSpecifier>)
:
required: trueUsed to accept a typed link specifier as input.
- On success, responds with
DetachTypedLinkOutput
- On failure, responds with
SdkError<DetachTypedLinkError>
source§impl Client
impl Client
sourcepub fn disable_directory(&self) -> DisableDirectoryFluentBuilder
pub fn disable_directory(&self) -> DisableDirectoryFluentBuilder
Constructs a fluent builder for the DisableDirectory
operation.
- The fluent builder is configurable:
directory_arn(impl Into<String>)
/set_directory_arn(Option<String>)
:
required: trueThe ARN of the directory to disable.
- On success, responds with
DisableDirectoryOutput
with field(s):directory_arn(String)
:The ARN of the directory that has been disabled.
- On failure, responds with
SdkError<DisableDirectoryError>
source§impl Client
impl Client
sourcepub fn enable_directory(&self) -> EnableDirectoryFluentBuilder
pub fn enable_directory(&self) -> EnableDirectoryFluentBuilder
Constructs a fluent builder for the EnableDirectory
operation.
- The fluent builder is configurable:
directory_arn(impl Into<String>)
/set_directory_arn(Option<String>)
:
required: trueThe ARN of the directory to enable.
- On success, responds with
EnableDirectoryOutput
with field(s):directory_arn(String)
:The ARN of the enabled directory.
- On failure, responds with
SdkError<EnableDirectoryError>
source§impl Client
impl Client
sourcepub fn get_applied_schema_version(&self) -> GetAppliedSchemaVersionFluentBuilder
pub fn get_applied_schema_version(&self) -> GetAppliedSchemaVersionFluentBuilder
Constructs a fluent builder for the GetAppliedSchemaVersion
operation.
- The fluent builder is configurable:
schema_arn(impl Into<String>)
/set_schema_arn(Option<String>)
:
required: trueThe ARN of the applied schema.
- On success, responds with
GetAppliedSchemaVersionOutput
with field(s):applied_schema_arn(Option<String>)
:Current applied schema ARN, including the minor version in use if one was provided.
- On failure, responds with
SdkError<GetAppliedSchemaVersionError>
source§impl Client
impl Client
sourcepub fn get_directory(&self) -> GetDirectoryFluentBuilder
pub fn get_directory(&self) -> GetDirectoryFluentBuilder
Constructs a fluent builder for the GetDirectory
operation.
- The fluent builder is configurable:
directory_arn(impl Into<String>)
/set_directory_arn(Option<String>)
:
required: trueThe ARN of the directory.
- On success, responds with
GetDirectoryOutput
with field(s):directory(Option<Directory>)
:Metadata about the directory.
- On failure, responds with
SdkError<GetDirectoryError>
source§impl Client
impl Client
sourcepub fn get_facet(&self) -> GetFacetFluentBuilder
pub fn get_facet(&self) -> GetFacetFluentBuilder
Constructs a fluent builder for the GetFacet
operation.
- The fluent builder is configurable:
schema_arn(impl Into<String>)
/set_schema_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) that is associated with the
Facet
. For more information, seearns
.name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the facet to retrieve.
- On success, responds with
GetFacetOutput
with field(s):facet(Option<Facet>)
:The
Facet
structure that is associated with the facet.
- On failure, responds with
SdkError<GetFacetError>
source§impl Client
impl Client
sourcepub fn get_link_attributes(&self) -> GetLinkAttributesFluentBuilder
pub fn get_link_attributes(&self) -> GetLinkAttributesFluentBuilder
Constructs a fluent builder for the GetLinkAttributes
operation.
- The fluent builder is configurable:
directory_arn(impl Into<String>)
/set_directory_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) that is associated with the Directory where the typed link resides. For more information, see
arns
or Typed Links.typed_link_specifier(TypedLinkSpecifier)
/set_typed_link_specifier(Option<TypedLinkSpecifier>)
:
required: trueAllows a typed link specifier to be accepted as input.
attribute_names(impl Into<String>)
/set_attribute_names(Option<Vec::<String>>)
:
required: trueA list of attribute names whose values will be retrieved.
consistency_level(ConsistencyLevel)
/set_consistency_level(Option<ConsistencyLevel>)
:
required: falseThe consistency level at which to retrieve the attributes on a typed link.
- On success, responds with
GetLinkAttributesOutput
with field(s):attributes(Option<Vec::<AttributeKeyAndValue>>)
:The attributes that are associated with the typed link.
- On failure, responds with
SdkError<GetLinkAttributesError>
source§impl Client
impl Client
sourcepub fn get_object_attributes(&self) -> GetObjectAttributesFluentBuilder
pub fn get_object_attributes(&self) -> GetObjectAttributesFluentBuilder
Constructs a fluent builder for the GetObjectAttributes
operation.
- The fluent builder is configurable:
directory_arn(impl Into<String>)
/set_directory_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) that is associated with the
Directory
where the object resides.object_reference(ObjectReference)
/set_object_reference(Option<ObjectReference>)
:
required: trueReference that identifies the object whose attributes will be retrieved.
consistency_level(ConsistencyLevel)
/set_consistency_level(Option<ConsistencyLevel>)
:
required: falseThe consistency level at which to retrieve the attributes on an object.
schema_facet(SchemaFacet)
/set_schema_facet(Option<SchemaFacet>)
:
required: trueIdentifier for the facet whose attributes will be retrieved. See
SchemaFacet
for details.attribute_names(impl Into<String>)
/set_attribute_names(Option<Vec::<String>>)
:
required: trueList of attribute names whose values will be retrieved.
- On success, responds with
GetObjectAttributesOutput
with field(s):attributes(Option<Vec::<AttributeKeyAndValue>>)
:The attributes that are associated with the object.
- On failure, responds with
SdkError<GetObjectAttributesError>
source§impl Client
impl Client
sourcepub fn get_object_information(&self) -> GetObjectInformationFluentBuilder
pub fn get_object_information(&self) -> GetObjectInformationFluentBuilder
Constructs a fluent builder for the GetObjectInformation
operation.
- The fluent builder is configurable:
directory_arn(impl Into<String>)
/set_directory_arn(Option<String>)
:
required: trueThe ARN of the directory being retrieved.
object_reference(ObjectReference)
/set_object_reference(Option<ObjectReference>)
:
required: trueA reference to the object.
consistency_level(ConsistencyLevel)
/set_consistency_level(Option<ConsistencyLevel>)
:
required: falseThe consistency level at which to retrieve the object information.
- On success, responds with
GetObjectInformationOutput
with field(s):schema_facets(Option<Vec::<SchemaFacet>>)
:The facets attached to the specified object. Although the response does not include minor version information, the most recently applied minor version of each Facet is in effect. See
GetAppliedSchemaVersion
for details.object_identifier(Option<String>)
:The
ObjectIdentifier
of the specified object.
- On failure, responds with
SdkError<GetObjectInformationError>
source§impl Client
impl Client
sourcepub fn get_schema_as_json(&self) -> GetSchemaAsJsonFluentBuilder
pub fn get_schema_as_json(&self) -> GetSchemaAsJsonFluentBuilder
Constructs a fluent builder for the GetSchemaAsJson
operation.
- The fluent builder is configurable:
schema_arn(impl Into<String>)
/set_schema_arn(Option<String>)
:
required: trueThe ARN of the schema to retrieve.
- On success, responds with
GetSchemaAsJsonOutput
with field(s):name(Option<String>)
:The name of the retrieved schema.
document(Option<String>)
:The JSON representation of the schema document.
- On failure, responds with
SdkError<GetSchemaAsJsonError>
source§impl Client
impl Client
sourcepub fn get_typed_link_facet_information(
&self
) -> GetTypedLinkFacetInformationFluentBuilder
pub fn get_typed_link_facet_information( &self ) -> GetTypedLinkFacetInformationFluentBuilder
Constructs a fluent builder for the GetTypedLinkFacetInformation
operation.
- The fluent builder is configurable:
schema_arn(impl Into<String>)
/set_schema_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) that is associated with the schema. For more information, see
arns
.name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe unique name of the typed link facet.
- On success, responds with
GetTypedLinkFacetInformationOutput
with field(s):identity_attribute_order(Option<Vec::<String>>)
:The order of identity attributes for the facet, from most significant to least significant. The ability to filter typed links considers the order that the attributes are defined on the typed link facet. When providing ranges to typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range. Filters are interpreted in the order of the attributes on the typed link facet, not the order in which they are supplied to any API calls. For more information about identity attributes, see Typed Links.
- On failure, responds with
SdkError<GetTypedLinkFacetInformationError>
source§impl Client
impl Client
sourcepub fn list_applied_schema_arns(&self) -> ListAppliedSchemaArnsFluentBuilder
pub fn list_applied_schema_arns(&self) -> ListAppliedSchemaArnsFluentBuilder
Constructs a fluent builder for the ListAppliedSchemaArns
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
directory_arn(impl Into<String>)
/set_directory_arn(Option<String>)
:
required: trueThe ARN of the directory you are listing.
schema_arn(impl Into<String>)
/set_schema_arn(Option<String>)
:
required: falseThe response for
ListAppliedSchemaArns
when this parameter is used will list all minor version ARNs for a major version.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe pagination token.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to retrieve.
- On success, responds with
ListAppliedSchemaArnsOutput
with field(s):schema_arns(Option<Vec::<String>>)
:The ARNs of schemas that are applied to the directory.
next_token(Option<String>)
:The pagination token.
- On failure, responds with
SdkError<ListAppliedSchemaArnsError>
source§impl Client
impl Client
sourcepub fn list_attached_indices(&self) -> ListAttachedIndicesFluentBuilder
pub fn list_attached_indices(&self) -> ListAttachedIndicesFluentBuilder
Constructs a fluent builder for the ListAttachedIndices
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
directory_arn(impl Into<String>)
/set_directory_arn(Option<String>)
:
required: trueThe ARN of the directory.
target_reference(ObjectReference)
/set_target_reference(Option<ObjectReference>)
:
required: trueA reference to the object that has indices attached.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe pagination token.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to retrieve.
consistency_level(ConsistencyLevel)
/set_consistency_level(Option<ConsistencyLevel>)
:
required: falseThe consistency level to use for this operation.
- On success, responds with
ListAttachedIndicesOutput
with field(s):index_attachments(Option<Vec::<IndexAttachment>>)
:The indices attached to the specified object.
next_token(Option<String>)
:The pagination token.
- On failure, responds with
SdkError<ListAttachedIndicesError>
source§impl Client
impl Client
sourcepub fn list_development_schema_arns(
&self
) -> ListDevelopmentSchemaArnsFluentBuilder
pub fn list_development_schema_arns( &self ) -> ListDevelopmentSchemaArnsFluentBuilder
Constructs a fluent builder for the ListDevelopmentSchemaArns
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe pagination token.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to retrieve.
- On success, responds with
ListDevelopmentSchemaArnsOutput
with field(s):schema_arns(Option<Vec::<String>>)
:The ARNs of retrieved development schemas.
next_token(Option<String>)
:The pagination token.
- On failure, responds with
SdkError<ListDevelopmentSchemaArnsError>
source§impl Client
impl Client
sourcepub fn list_directories(&self) -> ListDirectoriesFluentBuilder
pub fn list_directories(&self) -> ListDirectoriesFluentBuilder
Constructs a fluent builder for the ListDirectories
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe pagination token.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to retrieve.
state(DirectoryState)
/set_state(Option<DirectoryState>)
:
required: falseThe state of the directories in the list. Can be either Enabled, Disabled, or Deleted.
- On success, responds with
ListDirectoriesOutput
with field(s):directories(Vec::<Directory>)
:Lists all directories that are associated with your account in pagination fashion.
next_token(Option<String>)
:The pagination token.
- On failure, responds with
SdkError<ListDirectoriesError>
source§impl Client
impl Client
sourcepub fn list_facet_attributes(&self) -> ListFacetAttributesFluentBuilder
pub fn list_facet_attributes(&self) -> ListFacetAttributesFluentBuilder
Constructs a fluent builder for the ListFacetAttributes
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
schema_arn(impl Into<String>)
/set_schema_arn(Option<String>)
:
required: trueThe ARN of the schema where the facet resides.
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the facet whose attributes will be retrieved.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe pagination token.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to retrieve.
- On success, responds with
ListFacetAttributesOutput
with field(s):attributes(Option<Vec::<FacetAttribute>>)
:The attributes attached to the facet.
next_token(Option<String>)
:The pagination token.
- On failure, responds with
SdkError<ListFacetAttributesError>
source§impl Client
impl Client
sourcepub fn list_facet_names(&self) -> ListFacetNamesFluentBuilder
pub fn list_facet_names(&self) -> ListFacetNamesFluentBuilder
Constructs a fluent builder for the ListFacetNames
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
schema_arn(impl Into<String>)
/set_schema_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) to retrieve facet names from.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe pagination token.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to retrieve.
- On success, responds with
ListFacetNamesOutput
with field(s):facet_names(Option<Vec::<String>>)
:The names of facets that exist within the schema.
next_token(Option<String>)
:The pagination token.
- On failure, responds with
SdkError<ListFacetNamesError>
source§impl Client
impl Client
sourcepub fn list_incoming_typed_links(&self) -> ListIncomingTypedLinksFluentBuilder
pub fn list_incoming_typed_links(&self) -> ListIncomingTypedLinksFluentBuilder
Constructs a fluent builder for the ListIncomingTypedLinks
operation.
- The fluent builder is configurable:
directory_arn(impl Into<String>)
/set_directory_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the directory where you want to list the typed links.
object_reference(ObjectReference)
/set_object_reference(Option<ObjectReference>)
:
required: trueReference that identifies the object whose attributes will be listed.
filter_attribute_ranges(TypedLinkAttributeRange)
/set_filter_attribute_ranges(Option<Vec::<TypedLinkAttributeRange>>)
:
required: falseProvides range filters for multiple attributes. When providing ranges to typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range.
filter_typed_link(TypedLinkSchemaAndFacetName)
/set_filter_typed_link(Option<TypedLinkSchemaAndFacetName>)
:
required: falseFilters are interpreted in the order of the attributes on the typed link facet, not the order in which they are supplied to any API calls.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe pagination token.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to retrieve.
consistency_level(ConsistencyLevel)
/set_consistency_level(Option<ConsistencyLevel>)
:
required: falseThe consistency level to execute the request at.
- On success, responds with
ListIncomingTypedLinksOutput
with field(s):link_specifiers(Option<Vec::<TypedLinkSpecifier>>)
:Returns one or more typed link specifiers as output.
next_token(Option<String>)
:The pagination token.
- On failure, responds with
SdkError<ListIncomingTypedLinksError>
source§impl Client
impl Client
sourcepub fn list_index(&self) -> ListIndexFluentBuilder
pub fn list_index(&self) -> ListIndexFluentBuilder
Constructs a fluent builder for the ListIndex
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
directory_arn(impl Into<String>)
/set_directory_arn(Option<String>)
:
required: trueThe ARN of the directory that the index exists in.
ranges_on_indexed_values(ObjectAttributeRange)
/set_ranges_on_indexed_values(Option<Vec::<ObjectAttributeRange>>)
:
required: falseSpecifies the ranges of indexed values that you want to query.
index_reference(ObjectReference)
/set_index_reference(Option<ObjectReference>)
:
required: trueThe reference to the index to list.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of objects in a single page to retrieve from the index during a request. For more information, see Amazon Cloud Directory Limits.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe pagination token.
consistency_level(ConsistencyLevel)
/set_consistency_level(Option<ConsistencyLevel>)
:
required: falseThe consistency level to execute the request at.
- On success, responds with
ListIndexOutput
with field(s):index_attachments(Option<Vec::<IndexAttachment>>)
:The objects and indexed values attached to the index.
next_token(Option<String>)
:The pagination token.
- On failure, responds with
SdkError<ListIndexError>
source§impl Client
impl Client
sourcepub fn list_managed_schema_arns(&self) -> ListManagedSchemaArnsFluentBuilder
pub fn list_managed_schema_arns(&self) -> ListManagedSchemaArnsFluentBuilder
Constructs a fluent builder for the ListManagedSchemaArns
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
schema_arn(impl Into<String>)
/set_schema_arn(Option<String>)
:
required: falseThe response for ListManagedSchemaArns. When this parameter is used, all minor version ARNs for a major version are listed.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe pagination token.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to retrieve.
- On success, responds with
ListManagedSchemaArnsOutput
with field(s):schema_arns(Option<Vec::<String>>)
:The ARNs for all AWS managed schemas.
next_token(Option<String>)
:The pagination token.
- On failure, responds with
SdkError<ListManagedSchemaArnsError>
source§impl Client
impl Client
sourcepub fn list_object_attributes(&self) -> ListObjectAttributesFluentBuilder
pub fn list_object_attributes(&self) -> ListObjectAttributesFluentBuilder
Constructs a fluent builder for the ListObjectAttributes
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
directory_arn(impl Into<String>)
/set_directory_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) that is associated with the
Directory
where the object resides. For more information, seearns
.object_reference(ObjectReference)
/set_object_reference(Option<ObjectReference>)
:
required: trueThe reference that identifies the object whose attributes will be listed.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe pagination token.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of items to be retrieved in a single call. This is an approximate number.
consistency_level(ConsistencyLevel)
/set_consistency_level(Option<ConsistencyLevel>)
:
required: falseRepresents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.
facet_filter(SchemaFacet)
/set_facet_filter(Option<SchemaFacet>)
:
required: falseUsed to filter the list of object attributes that are associated with a certain facet.
- On success, responds with
ListObjectAttributesOutput
with field(s):attributes(Option<Vec::<AttributeKeyAndValue>>)
:Attributes map that is associated with the object.
AttributeArn
is the key, and attribute value is the value.next_token(Option<String>)
:The pagination token.
- On failure, responds with
SdkError<ListObjectAttributesError>
source§impl Client
impl Client
sourcepub fn list_object_children(&self) -> ListObjectChildrenFluentBuilder
pub fn list_object_children(&self) -> ListObjectChildrenFluentBuilder
Constructs a fluent builder for the ListObjectChildren
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
directory_arn(impl Into<String>)
/set_directory_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) that is associated with the
Directory
where the object resides. For more information, seearns
.object_reference(ObjectReference)
/set_object_reference(Option<ObjectReference>)
:
required: trueThe reference that identifies the object for which child objects are being listed.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe pagination token.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of items to be retrieved in a single call. This is an approximate number.
consistency_level(ConsistencyLevel)
/set_consistency_level(Option<ConsistencyLevel>)
:
required: falseRepresents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.
- On success, responds with
ListObjectChildrenOutput
with field(s):children(Option<HashMap::<String, String>>)
:Children structure, which is a map with key as the
LinkName
andObjectIdentifier
as the value.next_token(Option<String>)
:The pagination token.
- On failure, responds with
SdkError<ListObjectChildrenError>
source§impl Client
impl Client
sourcepub fn list_object_parent_paths(&self) -> ListObjectParentPathsFluentBuilder
pub fn list_object_parent_paths(&self) -> ListObjectParentPathsFluentBuilder
Constructs a fluent builder for the ListObjectParentPaths
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
directory_arn(impl Into<String>)
/set_directory_arn(Option<String>)
:
required: trueThe ARN of the directory to which the parent path applies.
object_reference(ObjectReference)
/set_object_reference(Option<ObjectReference>)
:
required: trueThe reference that identifies the object whose parent paths are listed.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe pagination token.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of items to be retrieved in a single call. This is an approximate number.
- On success, responds with
ListObjectParentPathsOutput
with field(s):path_to_object_identifiers_list(Option<Vec::<PathToObjectIdentifiers>>)
:Returns the path to the
ObjectIdentifiers
that are associated with the directory.next_token(Option<String>)
:The pagination token.
- On failure, responds with
SdkError<ListObjectParentPathsError>
source§impl Client
impl Client
sourcepub fn list_object_parents(&self) -> ListObjectParentsFluentBuilder
pub fn list_object_parents(&self) -> ListObjectParentsFluentBuilder
Constructs a fluent builder for the ListObjectParents
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
directory_arn(impl Into<String>)
/set_directory_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) that is associated with the
Directory
where the object resides. For more information, seearns
.object_reference(ObjectReference)
/set_object_reference(Option<ObjectReference>)
:
required: trueThe reference that identifies the object for which parent objects are being listed.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe pagination token.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of items to be retrieved in a single call. This is an approximate number.
consistency_level(ConsistencyLevel)
/set_consistency_level(Option<ConsistencyLevel>)
:
required: falseRepresents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.
include_all_links_to_each_parent(bool)
/set_include_all_links_to_each_parent(Option<bool>)
:
required: falseWhen set to True, returns all
ListObjectParentsResponse$ParentLinks
. There could be multiple links between a parent-child pair.
- On success, responds with
ListObjectParentsOutput
with field(s):parents(Option<HashMap::<String, String>>)
:The parent structure, which is a map with key as the
ObjectIdentifier
and LinkName as the value.next_token(Option<String>)
:The pagination token.
parent_links(Option<Vec::<ObjectIdentifierAndLinkNameTuple>>)
:Returns a list of parent reference and LinkName Tuples.
- On failure, responds with
SdkError<ListObjectParentsError>
source§impl Client
impl Client
sourcepub fn list_object_policies(&self) -> ListObjectPoliciesFluentBuilder
pub fn list_object_policies(&self) -> ListObjectPoliciesFluentBuilder
Constructs a fluent builder for the ListObjectPolicies
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
directory_arn(impl Into<String>)
/set_directory_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) that is associated with the
Directory
where objects reside. For more information, seearns
.object_reference(ObjectReference)
/set_object_reference(Option<ObjectReference>)
:
required: trueReference that identifies the object for which policies will be listed.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe pagination token.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of items to be retrieved in a single call. This is an approximate number.
consistency_level(ConsistencyLevel)
/set_consistency_level(Option<ConsistencyLevel>)
:
required: falseRepresents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.
- On success, responds with
ListObjectPoliciesOutput
with field(s):attached_policy_ids(Option<Vec::<String>>)
:A list of policy
ObjectIdentifiers
, that are attached to the object.next_token(Option<String>)
:The pagination token.
- On failure, responds with
SdkError<ListObjectPoliciesError>
source§impl Client
impl Client
sourcepub fn list_outgoing_typed_links(&self) -> ListOutgoingTypedLinksFluentBuilder
pub fn list_outgoing_typed_links(&self) -> ListOutgoingTypedLinksFluentBuilder
Constructs a fluent builder for the ListOutgoingTypedLinks
operation.
- The fluent builder is configurable:
directory_arn(impl Into<String>)
/set_directory_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the directory where you want to list the typed links.
object_reference(ObjectReference)
/set_object_reference(Option<ObjectReference>)
:
required: trueA reference that identifies the object whose attributes will be listed.
filter_attribute_ranges(TypedLinkAttributeRange)
/set_filter_attribute_ranges(Option<Vec::<TypedLinkAttributeRange>>)
:
required: falseProvides range filters for multiple attributes. When providing ranges to typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range.
filter_typed_link(TypedLinkSchemaAndFacetName)
/set_filter_typed_link(Option<TypedLinkSchemaAndFacetName>)
:
required: falseFilters are interpreted in the order of the attributes defined on the typed link facet, not the order they are supplied to any API calls.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe pagination token.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to retrieve.
consistency_level(ConsistencyLevel)
/set_consistency_level(Option<ConsistencyLevel>)
:
required: falseThe consistency level to execute the request at.
- On success, responds with
ListOutgoingTypedLinksOutput
with field(s):typed_link_specifiers(Option<Vec::<TypedLinkSpecifier>>)
:Returns a typed link specifier as output.
next_token(Option<String>)
:The pagination token.
- On failure, responds with
SdkError<ListOutgoingTypedLinksError>
source§impl Client
impl Client
sourcepub fn list_policy_attachments(&self) -> ListPolicyAttachmentsFluentBuilder
pub fn list_policy_attachments(&self) -> ListPolicyAttachmentsFluentBuilder
Constructs a fluent builder for the ListPolicyAttachments
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
directory_arn(impl Into<String>)
/set_directory_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) that is associated with the
Directory
where objects reside. For more information, seearns
.policy_reference(ObjectReference)
/set_policy_reference(Option<ObjectReference>)
:
required: trueThe reference that identifies the policy object.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe pagination token.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of items to be retrieved in a single call. This is an approximate number.
consistency_level(ConsistencyLevel)
/set_consistency_level(Option<ConsistencyLevel>)
:
required: falseRepresents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.
- On success, responds with
ListPolicyAttachmentsOutput
with field(s):object_identifiers(Option<Vec::<String>>)
:A list of
ObjectIdentifiers
to which the policy is attached.next_token(Option<String>)
:The pagination token.
- On failure, responds with
SdkError<ListPolicyAttachmentsError>
source§impl Client
impl Client
sourcepub fn list_published_schema_arns(&self) -> ListPublishedSchemaArnsFluentBuilder
pub fn list_published_schema_arns(&self) -> ListPublishedSchemaArnsFluentBuilder
Constructs a fluent builder for the ListPublishedSchemaArns
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
schema_arn(impl Into<String>)
/set_schema_arn(Option<String>)
:
required: falseThe response for
ListPublishedSchemaArns
when this parameter is used will list all minor version ARNs for a major version.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe pagination token.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to retrieve.
- On success, responds with
ListPublishedSchemaArnsOutput
with field(s):schema_arns(Option<Vec::<String>>)
:The ARNs of published schemas.
next_token(Option<String>)
:The pagination token.
- On failure, responds with
SdkError<ListPublishedSchemaArnsError>
source§impl Client
impl Client
Constructs a fluent builder for the ListTagsForResource
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the resource. Tagging is only supported for directories.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe pagination token. This is for future use. Currently pagination is not supported for tagging.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe
MaxResults
parameter sets the maximum number of results returned in a single page. This is for future use and is not supported currently.
- On success, responds with
ListTagsForResourceOutput
with field(s):tags(Option<Vec::<Tag>>)
:A list of tag key value pairs that are associated with the response.
next_token(Option<String>)
:The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- On failure, responds with
SdkError<ListTagsForResourceError>
source§impl Client
impl Client
sourcepub fn list_typed_link_facet_attributes(
&self
) -> ListTypedLinkFacetAttributesFluentBuilder
pub fn list_typed_link_facet_attributes( &self ) -> ListTypedLinkFacetAttributesFluentBuilder
Constructs a fluent builder for the ListTypedLinkFacetAttributes
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
schema_arn(impl Into<String>)
/set_schema_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) that is associated with the schema. For more information, see
arns
.name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe unique name of the typed link facet.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe pagination token.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to retrieve.
- On success, responds with
ListTypedLinkFacetAttributesOutput
with field(s):attributes(Option<Vec::<TypedLinkAttributeDefinition>>)
:An ordered set of attributes associate with the typed link.
next_token(Option<String>)
:The pagination token.
- On failure, responds with
SdkError<ListTypedLinkFacetAttributesError>
source§impl Client
impl Client
sourcepub fn list_typed_link_facet_names(
&self
) -> ListTypedLinkFacetNamesFluentBuilder
pub fn list_typed_link_facet_names( &self ) -> ListTypedLinkFacetNamesFluentBuilder
Constructs a fluent builder for the ListTypedLinkFacetNames
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
schema_arn(impl Into<String>)
/set_schema_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) that is associated with the schema. For more information, see
arns
.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe pagination token.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to retrieve.
- On success, responds with
ListTypedLinkFacetNamesOutput
with field(s):facet_names(Option<Vec::<String>>)
:The names of typed link facets that exist within the schema.
next_token(Option<String>)
:The pagination token.
- On failure, responds with
SdkError<ListTypedLinkFacetNamesError>
source§impl Client
impl Client
sourcepub fn lookup_policy(&self) -> LookupPolicyFluentBuilder
pub fn lookup_policy(&self) -> LookupPolicyFluentBuilder
Constructs a fluent builder for the LookupPolicy
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
directory_arn(impl Into<String>)
/set_directory_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) that is associated with the
Directory
. For more information, seearns
.object_reference(ObjectReference)
/set_object_reference(Option<ObjectReference>)
:
required: trueReference that identifies the object whose policies will be looked up.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe token to request the next page of results.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of items to be retrieved in a single call. This is an approximate number.
- On success, responds with
LookupPolicyOutput
with field(s):policy_to_path_list(Option<Vec::<PolicyToPath>>)
:Provides list of path to policies. Policies contain
PolicyId
,ObjectIdentifier
, andPolicyType
. For more information, see Policies.next_token(Option<String>)
:The pagination token.
- On failure, responds with
SdkError<LookupPolicyError>
source§impl Client
impl Client
sourcepub fn publish_schema(&self) -> PublishSchemaFluentBuilder
pub fn publish_schema(&self) -> PublishSchemaFluentBuilder
Constructs a fluent builder for the PublishSchema
operation.
- The fluent builder is configurable:
development_schema_arn(impl Into<String>)
/set_development_schema_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) that is associated with the development schema. For more information, see
arns
.version(impl Into<String>)
/set_version(Option<String>)
:
required: trueThe major version under which the schema will be published. Schemas have both a major and minor version associated with them.
minor_version(impl Into<String>)
/set_minor_version(Option<String>)
:
required: falseThe minor version under which the schema will be published. This parameter is recommended. Schemas have both a major and minor version associated with them.
name(impl Into<String>)
/set_name(Option<String>)
:
required: falseThe new name under which the schema will be published. If this is not provided, the development schema is considered.
- On success, responds with
PublishSchemaOutput
with field(s):published_schema_arn(Option<String>)
:The ARN that is associated with the published schema. For more information, see
arns
.
- On failure, responds with
SdkError<PublishSchemaError>
source§impl Client
impl Client
sourcepub fn put_schema_from_json(&self) -> PutSchemaFromJsonFluentBuilder
pub fn put_schema_from_json(&self) -> PutSchemaFromJsonFluentBuilder
Constructs a fluent builder for the PutSchemaFromJson
operation.
- The fluent builder is configurable:
schema_arn(impl Into<String>)
/set_schema_arn(Option<String>)
:
required: trueThe ARN of the schema to update.
document(impl Into<String>)
/set_document(Option<String>)
:
required: trueThe replacement JSON schema.
- On success, responds with
PutSchemaFromJsonOutput
with field(s):arn(Option<String>)
:The ARN of the schema to update.
- On failure, responds with
SdkError<PutSchemaFromJsonError>
source§impl Client
impl Client
sourcepub fn remove_facet_from_object(&self) -> RemoveFacetFromObjectFluentBuilder
pub fn remove_facet_from_object(&self) -> RemoveFacetFromObjectFluentBuilder
Constructs a fluent builder for the RemoveFacetFromObject
operation.
- The fluent builder is configurable:
directory_arn(impl Into<String>)
/set_directory_arn(Option<String>)
:
required: trueThe ARN of the directory in which the object resides.
schema_facet(SchemaFacet)
/set_schema_facet(Option<SchemaFacet>)
:
required: trueThe facet to remove. See
SchemaFacet
for details.object_reference(ObjectReference)
/set_object_reference(Option<ObjectReference>)
:
required: trueA reference to the object to remove the facet from.
- On success, responds with
RemoveFacetFromObjectOutput
- On failure, responds with
SdkError<RemoveFacetFromObjectError>
source§impl Client
impl Client
sourcepub fn tag_resource(&self) -> TagResourceFluentBuilder
pub fn tag_resource(&self) -> TagResourceFluentBuilder
Constructs a fluent builder for the TagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the resource. Tagging is only supported for directories.
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: trueA list of tag key-value pairs.
- On success, responds with
TagResourceOutput
- On failure, responds with
SdkError<TagResourceError>
source§impl Client
impl Client
sourcepub fn untag_resource(&self) -> UntagResourceFluentBuilder
pub fn untag_resource(&self) -> UntagResourceFluentBuilder
Constructs a fluent builder for the UntagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the resource. Tagging is only supported for directories.
tag_keys(impl Into<String>)
/set_tag_keys(Option<Vec::<String>>)
:
required: trueKeys of the tag that need to be removed from the resource.
- On success, responds with
UntagResourceOutput
- On failure, responds with
SdkError<UntagResourceError>
source§impl Client
impl Client
sourcepub fn update_facet(&self) -> UpdateFacetFluentBuilder
pub fn update_facet(&self) -> UpdateFacetFluentBuilder
Constructs a fluent builder for the UpdateFacet
operation.
- The fluent builder is configurable:
schema_arn(impl Into<String>)
/set_schema_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) that is associated with the
Facet
. For more information, seearns
.name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the facet.
attribute_updates(FacetAttributeUpdate)
/set_attribute_updates(Option<Vec::<FacetAttributeUpdate>>)
:
required: falseList of attributes that need to be updated in a given schema
Facet
. Each attribute is followed byAttributeAction
, which specifies the type of update operation to perform.object_type(ObjectType)
/set_object_type(Option<ObjectType>)
:
required: falseThe object type that is associated with the facet. See
CreateFacetRequest$ObjectType
for more details.
- On success, responds with
UpdateFacetOutput
- On failure, responds with
SdkError<UpdateFacetError>
source§impl Client
impl Client
sourcepub fn update_link_attributes(&self) -> UpdateLinkAttributesFluentBuilder
pub fn update_link_attributes(&self) -> UpdateLinkAttributesFluentBuilder
Constructs a fluent builder for the UpdateLinkAttributes
operation.
- The fluent builder is configurable:
directory_arn(impl Into<String>)
/set_directory_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) that is associated with the Directory where the updated typed link resides. For more information, see
arns
or Typed Links.typed_link_specifier(TypedLinkSpecifier)
/set_typed_link_specifier(Option<TypedLinkSpecifier>)
:
required: trueAllows a typed link specifier to be accepted as input.
attribute_updates(LinkAttributeUpdate)
/set_attribute_updates(Option<Vec::<LinkAttributeUpdate>>)
:
required: trueThe attributes update structure.
- On success, responds with
UpdateLinkAttributesOutput
- On failure, responds with
SdkError<UpdateLinkAttributesError>
source§impl Client
impl Client
sourcepub fn update_object_attributes(&self) -> UpdateObjectAttributesFluentBuilder
pub fn update_object_attributes(&self) -> UpdateObjectAttributesFluentBuilder
Constructs a fluent builder for the UpdateObjectAttributes
operation.
- The fluent builder is configurable:
directory_arn(impl Into<String>)
/set_directory_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) that is associated with the
Directory
where the object resides. For more information, seearns
.object_reference(ObjectReference)
/set_object_reference(Option<ObjectReference>)
:
required: trueThe reference that identifies the object.
attribute_updates(ObjectAttributeUpdate)
/set_attribute_updates(Option<Vec::<ObjectAttributeUpdate>>)
:
required: trueThe attributes update structure.
- On success, responds with
UpdateObjectAttributesOutput
with field(s):object_identifier(Option<String>)
:The
ObjectIdentifier
of the updated object.
- On failure, responds with
SdkError<UpdateObjectAttributesError>
source§impl Client
impl Client
sourcepub fn update_schema(&self) -> UpdateSchemaFluentBuilder
pub fn update_schema(&self) -> UpdateSchemaFluentBuilder
Constructs a fluent builder for the UpdateSchema
operation.
- The fluent builder is configurable:
schema_arn(impl Into<String>)
/set_schema_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the development schema. For more information, see
arns
.name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the schema.
- On success, responds with
UpdateSchemaOutput
with field(s):schema_arn(Option<String>)
:The ARN that is associated with the updated schema. For more information, see
arns
.
- On failure, responds with
SdkError<UpdateSchemaError>
source§impl Client
impl Client
sourcepub fn update_typed_link_facet(&self) -> UpdateTypedLinkFacetFluentBuilder
pub fn update_typed_link_facet(&self) -> UpdateTypedLinkFacetFluentBuilder
Constructs a fluent builder for the UpdateTypedLinkFacet
operation.
- The fluent builder is configurable:
schema_arn(impl Into<String>)
/set_schema_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) that is associated with the schema. For more information, see
arns
.name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe unique name of the typed link facet.
attribute_updates(TypedLinkFacetAttributeUpdate)
/set_attribute_updates(Option<Vec::<TypedLinkFacetAttributeUpdate>>)
:
required: trueAttributes update structure.
identity_attribute_order(impl Into<String>)
/set_identity_attribute_order(Option<Vec::<String>>)
:
required: trueThe order of identity attributes for the facet, from most significant to least significant. The ability to filter typed links considers the order that the attributes are defined on the typed link facet. When providing ranges to a typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range. Filters are interpreted in the order of the attributes on the typed link facet, not the order in which they are supplied to any API calls. For more information about identity attributes, see Typed Links.
- On success, responds with
UpdateTypedLinkFacetOutput
- On failure, responds with
SdkError<UpdateTypedLinkFacetError>
source§impl Client
impl Client
sourcepub fn upgrade_applied_schema(&self) -> UpgradeAppliedSchemaFluentBuilder
pub fn upgrade_applied_schema(&self) -> UpgradeAppliedSchemaFluentBuilder
Constructs a fluent builder for the UpgradeAppliedSchema
operation.
- The fluent builder is configurable:
published_schema_arn(impl Into<String>)
/set_published_schema_arn(Option<String>)
:
required: trueThe revision of the published schema to upgrade the directory to.
directory_arn(impl Into<String>)
/set_directory_arn(Option<String>)
:
required: trueThe ARN for the directory to which the upgraded schema will be applied.
dry_run(bool)
/set_dry_run(Option<bool>)
:
required: falseUsed for testing whether the major version schemas are backward compatible or not. If schema compatibility fails, an exception would be thrown else the call would succeed but no changes will be saved. This parameter is optional.
- On success, responds with
UpgradeAppliedSchemaOutput
with field(s):upgraded_schema_arn(Option<String>)
:The ARN of the upgraded schema that is returned as part of the response.
directory_arn(Option<String>)
:The ARN of the directory that is returned as part of the response.
- On failure, responds with
SdkError<UpgradeAppliedSchemaError>
source§impl Client
impl Client
sourcepub fn upgrade_published_schema(&self) -> UpgradePublishedSchemaFluentBuilder
pub fn upgrade_published_schema(&self) -> UpgradePublishedSchemaFluentBuilder
Constructs a fluent builder for the UpgradePublishedSchema
operation.
- The fluent builder is configurable:
development_schema_arn(impl Into<String>)
/set_development_schema_arn(Option<String>)
:
required: trueThe ARN of the development schema with the changes used for the upgrade.
published_schema_arn(impl Into<String>)
/set_published_schema_arn(Option<String>)
:
required: trueThe ARN of the published schema to be upgraded.
minor_version(impl Into<String>)
/set_minor_version(Option<String>)
:
required: trueIdentifies the minor version of the published schema that will be created. This parameter is NOT optional.
dry_run(bool)
/set_dry_run(Option<bool>)
:
required: falseUsed for testing whether the Development schema provided is backwards compatible, or not, with the publish schema provided by the user to be upgraded. If schema compatibility fails, an exception would be thrown else the call would succeed. This parameter is optional and defaults to false.
- On success, responds with
UpgradePublishedSchemaOutput
with field(s):upgraded_schema_arn(Option<String>)
:The ARN of the upgraded schema that is returned as part of the response.
- On failure, responds with
SdkError<UpgradePublishedSchemaError>
source§impl Client
impl Client
sourcepub fn from_conf(conf: Config) -> Self
pub fn from_conf(conf: Config) -> Self
Creates a new client from the service Config
.
§Panics
This method will panic in the following cases:
- Retries or timeouts are enabled without a
sleep_impl
configured. - Identity caching is enabled without a
sleep_impl
andtime_source
configured. - No
behavior_version
is provided.
The panic message for each of these will have instructions on how to resolve them.
source§impl Client
impl Client
sourcepub fn new(sdk_config: &SdkConfig) -> Self
pub fn new(sdk_config: &SdkConfig) -> Self
Creates a new client from an SDK Config.
§Panics
- This method will panic if the
sdk_config
is missing an async sleep implementation. If you experience this panic, set thesleep_impl
on the Config passed into this function to fix it. - This method will panic if the
sdk_config
is missing an HTTP connector. If you experience this panic, set thehttp_connector
on the Config passed into this function to fix it. - This method will panic if no
BehaviorVersion
is provided. If you experience this panic, setbehavior_version
on the Config or enable thebehavior-version-latest
Cargo feature.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for Client
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more