Struct aws_sdk_identitystore::Client
source · pub struct Client { /* private fields */ }
Expand description
Client for AWS SSO Identity Store
Client for invoking operations on AWS SSO Identity Store. Each operation on AWS SSO Identity Store 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_identitystore::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_identitystore::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 GetGroupId
operation has
a Client::get_group_id
, 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.get_group_id()
.identity_store_id("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 create_group(&self) -> CreateGroupFluentBuilder
pub fn create_group(&self) -> CreateGroupFluentBuilder
Constructs a fluent builder for the CreateGroup
operation.
- The fluent builder is configurable:
identity_store_id(impl Into<String>)
/set_identity_store_id(Option<String>)
:
required: trueThe globally unique identifier for the identity store.
display_name(impl Into<String>)
/set_display_name(Option<String>)
:
required: falseA string containing the name of the group. This value is commonly displayed when the group is referenced.
Administrator
andAWSAdministrators
are reserved names and can’t be used for users or groups.description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA string containing the description of the group.
- On success, responds with
CreateGroupOutput
with field(s):group_id(String)
:The identifier of the newly created group in the identity store.
identity_store_id(String)
:The globally unique identifier for the identity store.
- On failure, responds with
SdkError<CreateGroupError>
source§impl Client
impl Client
sourcepub fn create_group_membership(&self) -> CreateGroupMembershipFluentBuilder
pub fn create_group_membership(&self) -> CreateGroupMembershipFluentBuilder
Constructs a fluent builder for the CreateGroupMembership
operation.
- The fluent builder is configurable:
identity_store_id(impl Into<String>)
/set_identity_store_id(Option<String>)
:
required: trueThe globally unique identifier for the identity store.
group_id(impl Into<String>)
/set_group_id(Option<String>)
:
required: trueThe identifier for a group in the identity store.
member_id(MemberId)
/set_member_id(Option<MemberId>)
:
required: trueAn object that contains the identifier of a group member. Setting the
UserID
field to the specific identifier for a user indicates that the user is a member of the group.
- On success, responds with
CreateGroupMembershipOutput
with field(s):membership_id(String)
:The identifier for a newly created
GroupMembership
in an identity store.identity_store_id(String)
:The globally unique identifier for the identity store.
- On failure, responds with
SdkError<CreateGroupMembershipError>
source§impl Client
impl Client
sourcepub fn create_user(&self) -> CreateUserFluentBuilder
pub fn create_user(&self) -> CreateUserFluentBuilder
Constructs a fluent builder for the CreateUser
operation.
- The fluent builder is configurable:
identity_store_id(impl Into<String>)
/set_identity_store_id(Option<String>)
:
required: trueThe globally unique identifier for the identity store.
user_name(impl Into<String>)
/set_user_name(Option<String>)
:
required: falseA unique string used to identify the user. The length limit is 128 characters. This value can consist of letters, accented characters, symbols, numbers, and punctuation. This value is specified at the time the user is created and stored as an attribute of the user object in the identity store.
Administrator
andAWSAdministrators
are reserved names and can’t be used for users or groups.name(Name)
/set_name(Option<Name>)
:
required: falseAn object containing the name of the user.
display_name(impl Into<String>)
/set_display_name(Option<String>)
:
required: falseA string containing the name of the user. This value is typically formatted for display when the user is referenced. For example, “John Doe.”
nick_name(impl Into<String>)
/set_nick_name(Option<String>)
:
required: falseA string containing an alternate name for the user.
profile_url(impl Into<String>)
/set_profile_url(Option<String>)
:
required: falseA string containing a URL that might be associated with the user.
emails(Email)
/set_emails(Option<Vec::<Email>>)
:
required: falseA list of
Email
objects containing email addresses associated with the user.addresses(Address)
/set_addresses(Option<Vec::<Address>>)
:
required: falseA list of
Address
objects containing addresses associated with the user.phone_numbers(PhoneNumber)
/set_phone_numbers(Option<Vec::<PhoneNumber>>)
:
required: falseA list of
PhoneNumber
objects containing phone numbers associated with the user.user_type(impl Into<String>)
/set_user_type(Option<String>)
:
required: falseA string indicating the type of user. Possible values are left unspecified. The value can vary based on your specific use case.
title(impl Into<String>)
/set_title(Option<String>)
:
required: falseA string containing the title of the user. Possible values are left unspecified. The value can vary based on your specific use case.
preferred_language(impl Into<String>)
/set_preferred_language(Option<String>)
:
required: falseA string containing the preferred language of the user. For example, “American English” or “en-us.”
locale(impl Into<String>)
/set_locale(Option<String>)
:
required: falseA string containing the geographical region or location of the user.
timezone(impl Into<String>)
/set_timezone(Option<String>)
:
required: falseA string containing the time zone of the user.
- On success, responds with
CreateUserOutput
with field(s):user_id(String)
:The identifier of the newly created user in the identity store.
identity_store_id(String)
:The globally unique identifier for the identity store.
- On failure, responds with
SdkError<CreateUserError>
source§impl Client
impl Client
sourcepub fn delete_group(&self) -> DeleteGroupFluentBuilder
pub fn delete_group(&self) -> DeleteGroupFluentBuilder
Constructs a fluent builder for the DeleteGroup
operation.
- The fluent builder is configurable:
identity_store_id(impl Into<String>)
/set_identity_store_id(Option<String>)
:
required: trueThe globally unique identifier for the identity store.
group_id(impl Into<String>)
/set_group_id(Option<String>)
:
required: trueThe identifier for a group in the identity store.
- On success, responds with
DeleteGroupOutput
- On failure, responds with
SdkError<DeleteGroupError>
source§impl Client
impl Client
sourcepub fn delete_group_membership(&self) -> DeleteGroupMembershipFluentBuilder
pub fn delete_group_membership(&self) -> DeleteGroupMembershipFluentBuilder
Constructs a fluent builder for the DeleteGroupMembership
operation.
- The fluent builder is configurable:
identity_store_id(impl Into<String>)
/set_identity_store_id(Option<String>)
:
required: trueThe globally unique identifier for the identity store.
membership_id(impl Into<String>)
/set_membership_id(Option<String>)
:
required: trueThe identifier for a
GroupMembership
in an identity store.
- On success, responds with
DeleteGroupMembershipOutput
- On failure, responds with
SdkError<DeleteGroupMembershipError>
source§impl Client
impl Client
sourcepub fn delete_user(&self) -> DeleteUserFluentBuilder
pub fn delete_user(&self) -> DeleteUserFluentBuilder
Constructs a fluent builder for the DeleteUser
operation.
- The fluent builder is configurable:
identity_store_id(impl Into<String>)
/set_identity_store_id(Option<String>)
:
required: trueThe globally unique identifier for the identity store.
user_id(impl Into<String>)
/set_user_id(Option<String>)
:
required: trueThe identifier for a user in the identity store.
- On success, responds with
DeleteUserOutput
- On failure, responds with
SdkError<DeleteUserError>
source§impl Client
impl Client
sourcepub fn describe_group(&self) -> DescribeGroupFluentBuilder
pub fn describe_group(&self) -> DescribeGroupFluentBuilder
Constructs a fluent builder for the DescribeGroup
operation.
- The fluent builder is configurable:
identity_store_id(impl Into<String>)
/set_identity_store_id(Option<String>)
:
required: trueThe globally unique identifier for the identity store, such as
d-1234567890
. In this example,d-
is a fixed prefix, and1234567890
is a randomly generated string that contains numbers and lower case letters. This value is generated at the time that a new identity store is created.group_id(impl Into<String>)
/set_group_id(Option<String>)
:
required: trueThe identifier for a group in the identity store.
- On success, responds with
DescribeGroupOutput
with field(s):group_id(String)
:The identifier for a group in the identity store.
display_name(Option<String>)
:The group’s display name value. The length limit is 1,024 characters. This value can consist of letters, accented characters, symbols, numbers, punctuation, tab, new line, carriage return, space, and nonbreaking space in this attribute. This value is specified at the time that the group is created and stored as an attribute of the group object in the identity store.
external_ids(Option<Vec::<ExternalId>>)
:A list of
ExternalId
objects that contains the identifiers issued to this resource by an external identity provider.description(Option<String>)
:A string containing a description of the group.
identity_store_id(String)
:The globally unique identifier for the identity store.
- On failure, responds with
SdkError<DescribeGroupError>
source§impl Client
impl Client
sourcepub fn describe_group_membership(&self) -> DescribeGroupMembershipFluentBuilder
pub fn describe_group_membership(&self) -> DescribeGroupMembershipFluentBuilder
Constructs a fluent builder for the DescribeGroupMembership
operation.
- The fluent builder is configurable:
identity_store_id(impl Into<String>)
/set_identity_store_id(Option<String>)
:
required: trueThe globally unique identifier for the identity store.
membership_id(impl Into<String>)
/set_membership_id(Option<String>)
:
required: trueThe identifier for a
GroupMembership
in an identity store.
- On success, responds with
DescribeGroupMembershipOutput
with field(s):identity_store_id(String)
:The globally unique identifier for the identity store.
membership_id(String)
:The identifier for a
GroupMembership
in an identity store.group_id(String)
:The identifier for a group in the identity store.
member_id(Option<MemberId>)
:An object containing the identifier of a group member.
- On failure, responds with
SdkError<DescribeGroupMembershipError>
source§impl Client
impl Client
sourcepub fn describe_user(&self) -> DescribeUserFluentBuilder
pub fn describe_user(&self) -> DescribeUserFluentBuilder
Constructs a fluent builder for the DescribeUser
operation.
- The fluent builder is configurable:
identity_store_id(impl Into<String>)
/set_identity_store_id(Option<String>)
:
required: trueThe globally unique identifier for the identity store, such as
d-1234567890
. In this example,d-
is a fixed prefix, and1234567890
is a randomly generated string that contains numbers and lower case letters. This value is generated at the time that a new identity store is created.user_id(impl Into<String>)
/set_user_id(Option<String>)
:
required: trueThe identifier for a user in the identity store.
- On success, responds with
DescribeUserOutput
with field(s):user_name(Option<String>)
:A unique string used to identify the user. The length limit is 128 characters. This value can consist of letters, accented characters, symbols, numbers, and punctuation. This value is specified at the time the user is created and stored as an attribute of the user object in the identity store.
user_id(String)
:The identifier for a user in the identity store.
external_ids(Option<Vec::<ExternalId>>)
:A list of
ExternalId
objects that contains the identifiers issued to this resource by an external identity provider.name(Option<Name>)
:The name of the user.
display_name(Option<String>)
:The display name of the user.
nick_name(Option<String>)
:An alternative descriptive name for the user.
profile_url(Option<String>)
:A URL link for the user’s profile.
emails(Option<Vec::<Email>>)
:The email address of the user.
addresses(Option<Vec::<Address>>)
:The physical address of the user.
phone_numbers(Option<Vec::<PhoneNumber>>)
:A list of
PhoneNumber
objects associated with a user.user_type(Option<String>)
:A string indicating the type of user.
title(Option<String>)
:A string containing the title of the user.
preferred_language(Option<String>)
:The preferred language of the user.
locale(Option<String>)
:A string containing the geographical region or location of the user.
timezone(Option<String>)
:The time zone for a user.
identity_store_id(String)
:The globally unique identifier for the identity store.
- On failure, responds with
SdkError<DescribeUserError>
source§impl Client
impl Client
sourcepub fn get_group_id(&self) -> GetGroupIdFluentBuilder
pub fn get_group_id(&self) -> GetGroupIdFluentBuilder
Constructs a fluent builder for the GetGroupId
operation.
- The fluent builder is configurable:
identity_store_id(impl Into<String>)
/set_identity_store_id(Option<String>)
:
required: trueThe globally unique identifier for the identity store.
alternate_identifier(AlternateIdentifier)
/set_alternate_identifier(Option<AlternateIdentifier>)
:
required: trueA unique identifier for a user or group that is not the primary identifier. This value can be an identifier from an external identity provider (IdP) that is associated with the user, the group, or a unique attribute. For the unique attribute, the only valid path is
displayName
.
- On success, responds with
GetGroupIdOutput
with field(s):group_id(String)
:The identifier for a group in the identity store.
identity_store_id(String)
:The globally unique identifier for the identity store.
- On failure, responds with
SdkError<GetGroupIdError>
source§impl Client
impl Client
sourcepub fn get_group_membership_id(&self) -> GetGroupMembershipIdFluentBuilder
pub fn get_group_membership_id(&self) -> GetGroupMembershipIdFluentBuilder
Constructs a fluent builder for the GetGroupMembershipId
operation.
- The fluent builder is configurable:
identity_store_id(impl Into<String>)
/set_identity_store_id(Option<String>)
:
required: trueThe globally unique identifier for the identity store.
group_id(impl Into<String>)
/set_group_id(Option<String>)
:
required: trueThe identifier for a group in the identity store.
member_id(MemberId)
/set_member_id(Option<MemberId>)
:
required: trueAn object that contains the identifier of a group member. Setting the
UserID
field to the specific identifier for a user indicates that the user is a member of the group.
- On success, responds with
GetGroupMembershipIdOutput
with field(s):membership_id(String)
:The identifier for a
GroupMembership
in an identity store.identity_store_id(String)
:The globally unique identifier for the identity store.
- On failure, responds with
SdkError<GetGroupMembershipIdError>
source§impl Client
impl Client
sourcepub fn get_user_id(&self) -> GetUserIdFluentBuilder
pub fn get_user_id(&self) -> GetUserIdFluentBuilder
Constructs a fluent builder for the GetUserId
operation.
- The fluent builder is configurable:
identity_store_id(impl Into<String>)
/set_identity_store_id(Option<String>)
:
required: trueThe globally unique identifier for the identity store.
alternate_identifier(AlternateIdentifier)
/set_alternate_identifier(Option<AlternateIdentifier>)
:
required: trueA unique identifier for a user or group that is not the primary identifier. This value can be an identifier from an external identity provider (IdP) that is associated with the user, the group, or a unique attribute. For the unique attribute, the only valid paths are
userName
andemails.value
.
- On success, responds with
GetUserIdOutput
with field(s):user_id(String)
:The identifier for a user in the identity store.
identity_store_id(String)
:The globally unique identifier for the identity store.
- On failure, responds with
SdkError<GetUserIdError>
source§impl Client
impl Client
sourcepub fn is_member_in_groups(&self) -> IsMemberInGroupsFluentBuilder
pub fn is_member_in_groups(&self) -> IsMemberInGroupsFluentBuilder
Constructs a fluent builder for the IsMemberInGroups
operation.
- The fluent builder is configurable:
identity_store_id(impl Into<String>)
/set_identity_store_id(Option<String>)
:
required: trueThe globally unique identifier for the identity store.
member_id(MemberId)
/set_member_id(Option<MemberId>)
:
required: trueAn object containing the identifier of a group member.
group_ids(impl Into<String>)
/set_group_ids(Option<Vec::<String>>)
:
required: trueA list of identifiers for groups in the identity store.
- On success, responds with
IsMemberInGroupsOutput
with field(s):results(Vec::<GroupMembershipExistenceResult>)
:A list containing the results of membership existence checks.
- On failure, responds with
SdkError<IsMemberInGroupsError>
source§impl Client
impl Client
sourcepub fn list_group_memberships(&self) -> ListGroupMembershipsFluentBuilder
pub fn list_group_memberships(&self) -> ListGroupMembershipsFluentBuilder
Constructs a fluent builder for the ListGroupMemberships
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
identity_store_id(impl Into<String>)
/set_identity_store_id(Option<String>)
:
required: trueThe globally unique identifier for the identity store.
group_id(impl Into<String>)
/set_group_id(Option<String>)
:
required: trueThe identifier for a group in the identity store.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to be returned per request. This parameter is used in all
List
requests to specify how many results to return in one page.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe pagination token used for the
ListUsers
,ListGroups
andListGroupMemberships
API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.
- On success, responds with
ListGroupMembershipsOutput
with field(s):group_memberships(Vec::<GroupMembership>)
:A list of
GroupMembership
objects in the group.next_token(Option<String>)
:The pagination token used for the
ListUsers
,ListGroups
, andListGroupMemberships
API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.
- On failure, responds with
SdkError<ListGroupMembershipsError>
source§impl Client
impl Client
sourcepub fn list_group_memberships_for_member(
&self
) -> ListGroupMembershipsForMemberFluentBuilder
pub fn list_group_memberships_for_member( &self ) -> ListGroupMembershipsForMemberFluentBuilder
Constructs a fluent builder for the ListGroupMembershipsForMember
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
identity_store_id(impl Into<String>)
/set_identity_store_id(Option<String>)
:
required: trueThe globally unique identifier for the identity store.
member_id(MemberId)
/set_member_id(Option<MemberId>)
:
required: trueAn object that contains the identifier of a group member. Setting the
UserID
field to the specific identifier for a user indicates that the user is a member of the group.max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to be returned per request. This parameter is used in the
ListUsers
andListGroups
requests to specify how many results to return in one page. The length limit is 50 characters.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe pagination token used for the
ListUsers
,ListGroups
, andListGroupMemberships
API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.
- On success, responds with
ListGroupMembershipsForMemberOutput
with field(s):group_memberships(Vec::<GroupMembership>)
:A list of
GroupMembership
objects in the group for a specified member.next_token(Option<String>)
:The pagination token used for the
ListUsers
,ListGroups
, andListGroupMemberships
API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.
- On failure, responds with
SdkError<ListGroupMembershipsForMemberError>
source§impl Client
impl Client
sourcepub fn list_groups(&self) -> ListGroupsFluentBuilder
pub fn list_groups(&self) -> ListGroupsFluentBuilder
Constructs a fluent builder for the ListGroups
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
identity_store_id(impl Into<String>)
/set_identity_store_id(Option<String>)
:
required: trueThe globally unique identifier for the identity store, such as
d-1234567890
. In this example,d-
is a fixed prefix, and1234567890
is a randomly generated string that contains numbers and lower case letters. This value is generated at the time that a new identity store is created.max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to be returned per request. This parameter is used in the
ListUsers
andListGroups
requests to specify how many results to return in one page. The length limit is 50 characters.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe pagination token used for the
ListUsers
andListGroups
API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.filters(Filter)
/set_filters(Option<Vec::<Filter>>)
:
required: falseA list of
Filter
objects, which is used in theListUsers
andListGroups
requests.
- On success, responds with
ListGroupsOutput
with field(s):groups(Vec::<Group>)
:A list of
Group
objects in the identity store.next_token(Option<String>)
:The pagination token used for the
ListUsers
andListGroups
API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it1 is used in the API request to search for the next page.
- On failure, responds with
SdkError<ListGroupsError>
source§impl Client
impl Client
sourcepub fn list_users(&self) -> ListUsersFluentBuilder
pub fn list_users(&self) -> ListUsersFluentBuilder
Constructs a fluent builder for the ListUsers
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
identity_store_id(impl Into<String>)
/set_identity_store_id(Option<String>)
:
required: trueThe globally unique identifier for the identity store, such as
d-1234567890
. In this example,d-
is a fixed prefix, and1234567890
is a randomly generated string that contains numbers and lower case letters. This value is generated at the time that a new identity store is created.max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to be returned per request. This parameter is used in the
ListUsers
andListGroups
requests to specify how many results to return in one page. The length limit is 50 characters.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe pagination token used for the
ListUsers
andListGroups
API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.filters(Filter)
/set_filters(Option<Vec::<Filter>>)
:
required: falseA list of
Filter
objects, which is used in theListUsers
andListGroups
requests.
- On success, responds with
ListUsersOutput
with field(s):users(Vec::<User>)
:A list of
User
objects in the identity store.next_token(Option<String>)
:The pagination token used for the
ListUsers
andListGroups
API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.
- On failure, responds with
SdkError<ListUsersError>
source§impl Client
impl Client
sourcepub fn update_group(&self) -> UpdateGroupFluentBuilder
pub fn update_group(&self) -> UpdateGroupFluentBuilder
Constructs a fluent builder for the UpdateGroup
operation.
- The fluent builder is configurable:
identity_store_id(impl Into<String>)
/set_identity_store_id(Option<String>)
:
required: trueThe globally unique identifier for the identity store.
group_id(impl Into<String>)
/set_group_id(Option<String>)
:
required: trueThe identifier for a group in the identity store.
operations(AttributeOperation)
/set_operations(Option<Vec::<AttributeOperation>>)
:
required: trueA list of
AttributeOperation
objects to apply to the requested group. These operations might add, replace, or remove an attribute.
- On success, responds with
UpdateGroupOutput
- On failure, responds with
SdkError<UpdateGroupError>
source§impl Client
impl Client
sourcepub fn update_user(&self) -> UpdateUserFluentBuilder
pub fn update_user(&self) -> UpdateUserFluentBuilder
Constructs a fluent builder for the UpdateUser
operation.
- The fluent builder is configurable:
identity_store_id(impl Into<String>)
/set_identity_store_id(Option<String>)
:
required: trueThe globally unique identifier for the identity store.
user_id(impl Into<String>)
/set_user_id(Option<String>)
:
required: trueThe identifier for a user in the identity store.
operations(AttributeOperation)
/set_operations(Option<Vec::<AttributeOperation>>)
:
required: trueA list of
AttributeOperation
objects to apply to the requested user. These operations might add, replace, or remove an attribute.
- On success, responds with
UpdateUserOutput
- On failure, responds with
SdkError<UpdateUserError>
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