Struct aws_sdk_chime::Client
source · pub struct Client { /* private fields */ }Expand description
Client for Amazon Chime
Client for invoking operations on Amazon Chime. Each operation on Amazon Chime 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_chime::Client::new(&config);Occasionally, SDKs may have additional service-specific 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_chime::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 AssociatePhoneNumbersWithVoiceConnector operation has
a Client::associate_phone_numbers_with_voice_connector, 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.associate_phone_numbers_with_voice_connector()
.voice_connector_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 associate_phone_number_with_user(
&self
) -> AssociatePhoneNumberWithUserFluentBuilder
pub fn associate_phone_number_with_user( &self ) -> AssociatePhoneNumberWithUserFluentBuilder
Constructs a fluent builder for the AssociatePhoneNumberWithUser operation.
- The fluent builder is configurable:
account_id(impl Into<String>)/set_account_id(Option<String>):
required: trueThe Amazon Chime account ID.
user_id(impl Into<String>)/set_user_id(Option<String>):
required: trueThe user ID.
e164_phone_number(impl Into<String>)/set_e164_phone_number(Option<String>):
required: trueThe phone number, in E.164 format.
- On success, responds with
AssociatePhoneNumberWithUserOutput - On failure, responds with
SdkError<AssociatePhoneNumberWithUserError>
source§impl Client
impl Client
sourcepub fn associate_phone_numbers_with_voice_connector(
&self
) -> AssociatePhoneNumbersWithVoiceConnectorFluentBuilder
👎Deprecated: Replaced by AssociatePhoneNumbersWithVoiceConnector in the Amazon Chime SDK Voice Namespace
pub fn associate_phone_numbers_with_voice_connector( &self ) -> AssociatePhoneNumbersWithVoiceConnectorFluentBuilder
Constructs a fluent builder for the AssociatePhoneNumbersWithVoiceConnector operation.
- The fluent builder is configurable:
voice_connector_id(impl Into<String>)/set_voice_connector_id(Option<String>):
required: trueThe Amazon Chime Voice Connector ID.
e164_phone_numbers(impl Into<String>)/set_e164_phone_numbers(Option<Vec::<String>>):
required: trueList of phone numbers, in E.164 format.
force_associate(bool)/set_force_associate(Option<bool>):
required: falseIf true, associates the provided phone numbers with the provided Amazon Chime Voice Connector and removes any previously existing associations. If false, does not associate any phone numbers that have previously existing associations.
- On success, responds with
AssociatePhoneNumbersWithVoiceConnectorOutputwith field(s):phone_number_errors(Option<Vec::<PhoneNumberError>>):If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.
- On failure, responds with
SdkError<AssociatePhoneNumbersWithVoiceConnectorError>
source§impl Client
impl Client
sourcepub fn associate_phone_numbers_with_voice_connector_group(
&self
) -> AssociatePhoneNumbersWithVoiceConnectorGroupFluentBuilder
👎Deprecated: Replaced by AssociatePhoneNumbersWithVoiceConnectorGroup in the Amazon Chime SDK Voice Namespace
pub fn associate_phone_numbers_with_voice_connector_group( &self ) -> AssociatePhoneNumbersWithVoiceConnectorGroupFluentBuilder
Constructs a fluent builder for the AssociatePhoneNumbersWithVoiceConnectorGroup operation.
- The fluent builder is configurable:
voice_connector_group_id(impl Into<String>)/set_voice_connector_group_id(Option<String>):
required: trueThe Amazon Chime Voice Connector group ID.
e164_phone_numbers(impl Into<String>)/set_e164_phone_numbers(Option<Vec::<String>>):
required: trueList of phone numbers, in E.164 format.
force_associate(bool)/set_force_associate(Option<bool>):
required: falseIf true, associates the provided phone numbers with the provided Amazon Chime Voice Connector Group and removes any previously existing associations. If false, does not associate any phone numbers that have previously existing associations.
- On success, responds with
AssociatePhoneNumbersWithVoiceConnectorGroupOutputwith field(s):phone_number_errors(Option<Vec::<PhoneNumberError>>):If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.
- On failure, responds with
SdkError<AssociatePhoneNumbersWithVoiceConnectorGroupError>
source§impl Client
impl Client
sourcepub fn associate_signin_delegate_groups_with_account(
&self
) -> AssociateSigninDelegateGroupsWithAccountFluentBuilder
pub fn associate_signin_delegate_groups_with_account( &self ) -> AssociateSigninDelegateGroupsWithAccountFluentBuilder
Constructs a fluent builder for the AssociateSigninDelegateGroupsWithAccount operation.
- The fluent builder is configurable:
account_id(impl Into<String>)/set_account_id(Option<String>):
required: trueThe Amazon Chime account ID.
signin_delegate_groups(SigninDelegateGroup)/set_signin_delegate_groups(Option<Vec::<SigninDelegateGroup>>):
required: trueThe sign-in delegate groups.
- On success, responds with
AssociateSigninDelegateGroupsWithAccountOutput - On failure, responds with
SdkError<AssociateSigninDelegateGroupsWithAccountError>
source§impl Client
impl Client
sourcepub fn batch_create_attendee(&self) -> BatchCreateAttendeeFluentBuilder
👎Deprecated: Replaced by BatchCreateAttendee in the Amazon Chime SDK Meetings Namespace
pub fn batch_create_attendee(&self) -> BatchCreateAttendeeFluentBuilder
Constructs a fluent builder for the BatchCreateAttendee operation.
- The fluent builder is configurable:
meeting_id(impl Into<String>)/set_meeting_id(Option<String>):
required: trueThe Amazon Chime SDK meeting ID.
attendees(CreateAttendeeRequestItem)/set_attendees(Option<Vec::<CreateAttendeeRequestItem>>):
required: trueThe request containing the attendees to create.
- On success, responds with
BatchCreateAttendeeOutputwith field(s):attendees(Option<Vec::<Attendee>>):The attendee information, including attendees IDs and join tokens.
errors(Option<Vec::<CreateAttendeeError>>):If the action fails for one or more of the attendees in the request, a list of the attendees is returned, along with error codes and error messages.
- On failure, responds with
SdkError<BatchCreateAttendeeError>
source§impl Client
impl Client
sourcepub fn batch_create_channel_membership(
&self
) -> BatchCreateChannelMembershipFluentBuilder
👎Deprecated: Replaced by BatchCreateChannelMembership in the Amazon Chime SDK Messaging Namespace
pub fn batch_create_channel_membership( &self ) -> BatchCreateChannelMembershipFluentBuilder
Constructs a fluent builder for the BatchCreateChannelMembership operation.
- The fluent builder is configurable:
channel_arn(impl Into<String>)/set_channel_arn(Option<String>):
required: trueThe ARN of the channel to which you’re adding users.
r#type(ChannelMembershipType)/set_type(Option<ChannelMembershipType>):
required: falseThe membership type of a user,
DEFAULTorHIDDEN. Default members are always returned as part ofListChannelMemberships. Hidden members are only returned if the type filter inListChannelMembershipsequalsHIDDEN. Otherwise hidden members are not returned. This is only supported by moderators.member_arns(impl Into<String>)/set_member_arns(Option<Vec::<String>>):
required: trueThe ARNs of the members you want to add to the channel.
chime_bearer(impl Into<String>)/set_chime_bearer(Option<String>):
required: falseThe
AppInstanceUserArnof the user that makes the API call.
- On success, responds with
BatchCreateChannelMembershipOutputwith field(s):batch_channel_memberships(Option<BatchChannelMemberships>):The list of channel memberships in the response.
errors(Option<Vec::<BatchCreateChannelMembershipError>>):If the action fails for one or more of the memberships in the request, a list of the memberships is returned, along with error codes and error messages.
- On failure, responds with
SdkError<BatchCreateChannelMembershipError>
source§impl Client
impl Client
sourcepub fn batch_create_room_membership(
&self
) -> BatchCreateRoomMembershipFluentBuilder
pub fn batch_create_room_membership( &self ) -> BatchCreateRoomMembershipFluentBuilder
Constructs a fluent builder for the BatchCreateRoomMembership operation.
- The fluent builder is configurable:
account_id(impl Into<String>)/set_account_id(Option<String>):
required: trueThe Amazon Chime account ID.
room_id(impl Into<String>)/set_room_id(Option<String>):
required: trueThe room ID.
membership_item_list(MembershipItem)/set_membership_item_list(Option<Vec::<MembershipItem>>):
required: trueThe list of membership items.
- On success, responds with
BatchCreateRoomMembershipOutputwith field(s):errors(Option<Vec::<MemberError>>):If the action fails for one or more of the member IDs in the request, a list of the member IDs is returned, along with error codes and error messages.
- On failure, responds with
SdkError<BatchCreateRoomMembershipError>
source§impl Client
impl Client
sourcepub fn batch_delete_phone_number(&self) -> BatchDeletePhoneNumberFluentBuilder
pub fn batch_delete_phone_number(&self) -> BatchDeletePhoneNumberFluentBuilder
Constructs a fluent builder for the BatchDeletePhoneNumber operation.
- The fluent builder is configurable:
phone_number_ids(impl Into<String>)/set_phone_number_ids(Option<Vec::<String>>):
required: trueList of phone number IDs.
- On success, responds with
BatchDeletePhoneNumberOutputwith field(s):phone_number_errors(Option<Vec::<PhoneNumberError>>):If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.
- On failure, responds with
SdkError<BatchDeletePhoneNumberError>
source§impl Client
impl Client
sourcepub fn batch_suspend_user(&self) -> BatchSuspendUserFluentBuilder
pub fn batch_suspend_user(&self) -> BatchSuspendUserFluentBuilder
Constructs a fluent builder for the BatchSuspendUser operation.
- The fluent builder is configurable:
account_id(impl Into<String>)/set_account_id(Option<String>):
required: trueThe Amazon Chime account ID.
user_id_list(impl Into<String>)/set_user_id_list(Option<Vec::<String>>):
required: trueThe request containing the user IDs to suspend.
- On success, responds with
BatchSuspendUserOutputwith field(s):user_errors(Option<Vec::<UserError>>):If the
BatchSuspendUseraction fails for one or more of the user IDs in the request, a list of the user IDs is returned, along with error codes and error messages.
- On failure, responds with
SdkError<BatchSuspendUserError>
source§impl Client
impl Client
sourcepub fn batch_unsuspend_user(&self) -> BatchUnsuspendUserFluentBuilder
pub fn batch_unsuspend_user(&self) -> BatchUnsuspendUserFluentBuilder
Constructs a fluent builder for the BatchUnsuspendUser operation.
- The fluent builder is configurable:
account_id(impl Into<String>)/set_account_id(Option<String>):
required: trueThe Amazon Chime account ID.
user_id_list(impl Into<String>)/set_user_id_list(Option<Vec::<String>>):
required: trueThe request containing the user IDs to unsuspend.
- On success, responds with
BatchUnsuspendUserOutputwith field(s):user_errors(Option<Vec::<UserError>>):If the
BatchUnsuspendUseraction fails for one or more of the user IDs in the request, a list of the user IDs is returned, along with error codes and error messages.
- On failure, responds with
SdkError<BatchUnsuspendUserError>
source§impl Client
impl Client
sourcepub fn batch_update_phone_number(&self) -> BatchUpdatePhoneNumberFluentBuilder
pub fn batch_update_phone_number(&self) -> BatchUpdatePhoneNumberFluentBuilder
Constructs a fluent builder for the BatchUpdatePhoneNumber operation.
- The fluent builder is configurable:
update_phone_number_request_items(UpdatePhoneNumberRequestItem)/set_update_phone_number_request_items(Option<Vec::<UpdatePhoneNumberRequestItem>>):
required: trueThe request containing the phone number IDs and product types or calling names to update.
- On success, responds with
BatchUpdatePhoneNumberOutputwith field(s):phone_number_errors(Option<Vec::<PhoneNumberError>>):If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.
- On failure, responds with
SdkError<BatchUpdatePhoneNumberError>
source§impl Client
impl Client
sourcepub fn batch_update_user(&self) -> BatchUpdateUserFluentBuilder
pub fn batch_update_user(&self) -> BatchUpdateUserFluentBuilder
Constructs a fluent builder for the BatchUpdateUser operation.
- The fluent builder is configurable:
account_id(impl Into<String>)/set_account_id(Option<String>):
required: trueThe Amazon Chime account ID.
update_user_request_items(UpdateUserRequestItem)/set_update_user_request_items(Option<Vec::<UpdateUserRequestItem>>):
required: trueThe request containing the user IDs and details to update.
- On success, responds with
BatchUpdateUserOutputwith field(s):user_errors(Option<Vec::<UserError>>):If the
BatchUpdateUseraction fails for one or more of the user IDs in the request, a list of the user IDs is returned, along with error codes and error messages.
- On failure, responds with
SdkError<BatchUpdateUserError>
source§impl Client
impl Client
sourcepub fn create_account(&self) -> CreateAccountFluentBuilder
pub fn create_account(&self) -> CreateAccountFluentBuilder
Constructs a fluent builder for the CreateAccount operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name of the Amazon Chime account.
- On success, responds with
CreateAccountOutputwith field(s):account(Option<Account>):The Amazon Chime account details.
- On failure, responds with
SdkError<CreateAccountError>
source§impl Client
impl Client
sourcepub fn create_app_instance(&self) -> CreateAppInstanceFluentBuilder
👎Deprecated: Replaced by CreateAppInstance in the Amazon Chime SDK Identity Namespace
pub fn create_app_instance(&self) -> CreateAppInstanceFluentBuilder
Constructs a fluent builder for the CreateAppInstance operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name of the
AppInstance.metadata(impl Into<String>)/set_metadata(Option<String>):
required: falseThe metadata of the
AppInstance. Limited to a 1KB string in UTF-8.client_request_token(impl Into<String>)/set_client_request_token(Option<String>):
required: trueThe
ClientRequestTokenof theAppInstance.tags(Tag)/set_tags(Option<Vec::<Tag>>):
required: falseTags assigned to the
AppInstance.
- On success, responds with
CreateAppInstanceOutputwith field(s):app_instance_arn(Option<String>):The Amazon Resource Number (ARN) of the
AppInstance.
- On failure, responds with
SdkError<CreateAppInstanceError>
source§impl Client
impl Client
sourcepub fn create_app_instance_admin(&self) -> CreateAppInstanceAdminFluentBuilder
👎Deprecated: Replaced by CreateAppInstanceAdmin in the Amazon Chime SDK Identity Namespace
pub fn create_app_instance_admin(&self) -> CreateAppInstanceAdminFluentBuilder
Constructs a fluent builder for the CreateAppInstanceAdmin operation.
- The fluent builder is configurable:
app_instance_admin_arn(impl Into<String>)/set_app_instance_admin_arn(Option<String>):
required: trueThe ARN of the administrator of the current
AppInstance.app_instance_arn(impl Into<String>)/set_app_instance_arn(Option<String>):
required: trueThe ARN of the
AppInstance.
- On success, responds with
CreateAppInstanceAdminOutputwith field(s):app_instance_admin(Option<Identity>):The name and ARN of the admin for the
AppInstance.app_instance_arn(Option<String>):The ARN of the of the admin for the
AppInstance.
- On failure, responds with
SdkError<CreateAppInstanceAdminError>
source§impl Client
impl Client
sourcepub fn create_app_instance_user(&self) -> CreateAppInstanceUserFluentBuilder
👎Deprecated: Replaced by CreateAppInstanceUser in the Amazon Chime SDK Identity Namespace
pub fn create_app_instance_user(&self) -> CreateAppInstanceUserFluentBuilder
Constructs a fluent builder for the CreateAppInstanceUser operation.
- The fluent builder is configurable:
app_instance_arn(impl Into<String>)/set_app_instance_arn(Option<String>):
required: trueThe ARN of the
AppInstancerequest.app_instance_user_id(impl Into<String>)/set_app_instance_user_id(Option<String>):
required: trueThe user ID of the
AppInstance.name(impl Into<String>)/set_name(Option<String>):
required: trueThe user’s name.
metadata(impl Into<String>)/set_metadata(Option<String>):
required: falseThe request’s metadata. Limited to a 1KB string in UTF-8.
client_request_token(impl Into<String>)/set_client_request_token(Option<String>):
required: trueThe token assigned to the user requesting an
AppInstance.tags(Tag)/set_tags(Option<Vec::<Tag>>):
required: falseTags assigned to the
AppInstanceUser.
- On success, responds with
CreateAppInstanceUserOutputwith field(s):app_instance_user_arn(Option<String>):The user’s ARN.
- On failure, responds with
SdkError<CreateAppInstanceUserError>
source§impl Client
impl Client
sourcepub fn create_attendee(&self) -> CreateAttendeeFluentBuilder
👎Deprecated: Replaced by CreateAttendee in the Amazon Chime SDK Meetings Namespace
pub fn create_attendee(&self) -> CreateAttendeeFluentBuilder
Constructs a fluent builder for the CreateAttendee operation.
- The fluent builder is configurable:
meeting_id(impl Into<String>)/set_meeting_id(Option<String>):
required: trueThe Amazon Chime SDK meeting ID.
external_user_id(impl Into<String>)/set_external_user_id(Option<String>):
required: trueThe Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.
tags(Tag)/set_tags(Option<Vec::<Tag>>):
required: falseThe tag key-value pairs.
- On success, responds with
CreateAttendeeOutputwith field(s):attendee(Option<Attendee>):The attendee information, including attendee ID and join token.
- On failure, responds with
SdkError<CreateAttendeeError>
source§impl Client
impl Client
sourcepub fn create_bot(&self) -> CreateBotFluentBuilder
pub fn create_bot(&self) -> CreateBotFluentBuilder
Constructs a fluent builder for the CreateBot operation.
- The fluent builder is configurable:
account_id(impl Into<String>)/set_account_id(Option<String>):
required: trueThe Amazon Chime account ID.
display_name(impl Into<String>)/set_display_name(Option<String>):
required: trueThe bot display name.
domain(impl Into<String>)/set_domain(Option<String>):
required: falseThe domain of the Amazon Chime Enterprise account.
- On success, responds with
CreateBotOutputwith field(s):bot(Option<Bot>):The bot details.
- On failure, responds with
SdkError<CreateBotError>
source§impl Client
impl Client
sourcepub fn create_channel(&self) -> CreateChannelFluentBuilder
👎Deprecated: Replaced by CreateChannel in the Amazon Chime SDK Messaging Namespace
pub fn create_channel(&self) -> CreateChannelFluentBuilder
Constructs a fluent builder for the CreateChannel operation.
- The fluent builder is configurable:
app_instance_arn(impl Into<String>)/set_app_instance_arn(Option<String>):
required: trueThe ARN of the channel request.
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name of the channel.
mode(ChannelMode)/set_mode(Option<ChannelMode>):
required: falseThe channel mode:
UNRESTRICTEDorRESTRICTED. Administrators, moderators, and channel members can add themselves and other members to unrestricted channels. Only administrators and moderators can add members to restricted channels.privacy(ChannelPrivacy)/set_privacy(Option<ChannelPrivacy>):
required: falseThe channel’s privacy level:
PUBLICorPRIVATE. Private channels aren’t discoverable by users outside the channel. Public channels are discoverable by anyone in theAppInstance.metadata(impl Into<String>)/set_metadata(Option<String>):
required: falseThe metadata of the creation request. Limited to 1KB and UTF-8.
client_request_token(impl Into<String>)/set_client_request_token(Option<String>):
required: trueThe client token for the request. An
Idempotencytoken.tags(Tag)/set_tags(Option<Vec::<Tag>>):
required: falseThe tags for the creation request.
chime_bearer(impl Into<String>)/set_chime_bearer(Option<String>):
required: falseThe
AppInstanceUserArnof the user that makes the API call.
- On success, responds with
CreateChannelOutputwith field(s):channel_arn(Option<String>):The ARN of the channel.
- On failure, responds with
SdkError<CreateChannelError>
source§impl Client
impl Client
sourcepub fn create_channel_ban(&self) -> CreateChannelBanFluentBuilder
👎Deprecated: Replaced by CreateChannelBan in the Amazon Chime SDK Messaging Namespace
pub fn create_channel_ban(&self) -> CreateChannelBanFluentBuilder
Constructs a fluent builder for the CreateChannelBan operation.
- The fluent builder is configurable:
channel_arn(impl Into<String>)/set_channel_arn(Option<String>):
required: trueThe ARN of the ban request.
member_arn(impl Into<String>)/set_member_arn(Option<String>):
required: trueThe ARN of the member being banned.
chime_bearer(impl Into<String>)/set_chime_bearer(Option<String>):
required: falseThe
AppInstanceUserArnof the user that makes the API call.
- On success, responds with
CreateChannelBanOutputwith field(s):channel_arn(Option<String>):The ARN of the response to the ban request.
member(Option<Identity>):The
ChannelArnandBannedIdentityof the member in the ban response.
- On failure, responds with
SdkError<CreateChannelBanError>
source§impl Client
impl Client
sourcepub fn create_channel_membership(&self) -> CreateChannelMembershipFluentBuilder
👎Deprecated: Replaced by CreateChannelMembership in the Amazon Chime SDK Messaging Namespace
pub fn create_channel_membership(&self) -> CreateChannelMembershipFluentBuilder
Constructs a fluent builder for the CreateChannelMembership operation.
- The fluent builder is configurable:
channel_arn(impl Into<String>)/set_channel_arn(Option<String>):
required: trueThe ARN of the channel to which you’re adding users.
member_arn(impl Into<String>)/set_member_arn(Option<String>):
required: trueThe ARN of the member you want to add to the channel.
r#type(ChannelMembershipType)/set_type(Option<ChannelMembershipType>):
required: trueThe membership type of a user,
DEFAULTorHIDDEN. Default members are always returned as part ofListChannelMemberships. Hidden members are only returned if the type filter inListChannelMembershipsequalsHIDDEN. Otherwise hidden members are not returned. This is only supported by moderators.chime_bearer(impl Into<String>)/set_chime_bearer(Option<String>):
required: falseThe
AppInstanceUserArnof the user that makes the API call.
- On success, responds with
CreateChannelMembershipOutputwith field(s):channel_arn(Option<String>):The ARN of the channel.
member(Option<Identity>):The ARN and metadata of the member being added.
- On failure, responds with
SdkError<CreateChannelMembershipError>
source§impl Client
impl Client
sourcepub fn create_channel_moderator(&self) -> CreateChannelModeratorFluentBuilder
👎Deprecated: Replaced by CreateChannelModerator in the Amazon Chime SDK Messaging Namespace
pub fn create_channel_moderator(&self) -> CreateChannelModeratorFluentBuilder
Constructs a fluent builder for the CreateChannelModerator operation.
- The fluent builder is configurable:
channel_arn(impl Into<String>)/set_channel_arn(Option<String>):
required: trueThe ARN of the channel.
channel_moderator_arn(impl Into<String>)/set_channel_moderator_arn(Option<String>):
required: trueThe ARN of the moderator.
chime_bearer(impl Into<String>)/set_chime_bearer(Option<String>):
required: falseThe
AppInstanceUserArnof the user that makes the API call.
- On success, responds with
CreateChannelModeratorOutputwith field(s):channel_arn(Option<String>):The ARN of the channel.
channel_moderator(Option<Identity>):The ARNs of the channel and the moderator.
- On failure, responds with
SdkError<CreateChannelModeratorError>
source§impl Client
impl Client
sourcepub fn create_media_capture_pipeline(
&self
) -> CreateMediaCapturePipelineFluentBuilder
👎Deprecated: Replaced by CreateMediaCapturePipeline in the Amazon Chime SDK Media Pipelines Namespace
pub fn create_media_capture_pipeline( &self ) -> CreateMediaCapturePipelineFluentBuilder
Constructs a fluent builder for the CreateMediaCapturePipeline operation.
- The fluent builder is configurable:
source_type(MediaPipelineSourceType)/set_source_type(Option<MediaPipelineSourceType>):
required: trueSource type from which the media artifacts will be captured. A Chime SDK Meeting is the only supported source.
source_arn(impl Into<String>)/set_source_arn(Option<String>):
required: trueARN of the source from which the media artifacts are captured.
sink_type(MediaPipelineSinkType)/set_sink_type(Option<MediaPipelineSinkType>):
required: trueDestination type to which the media artifacts are saved. You must use an S3 bucket.
sink_arn(impl Into<String>)/set_sink_arn(Option<String>):
required: trueThe ARN of the sink type.
client_request_token(impl Into<String>)/set_client_request_token(Option<String>):
required: falseThe unique identifier for the client request. The token makes the API request idempotent. Use a different token for different media pipeline requests.
chime_sdk_meeting_configuration(ChimeSdkMeetingConfiguration)/set_chime_sdk_meeting_configuration(Option<ChimeSdkMeetingConfiguration>):
required: falseThe configuration for a specified media capture pipeline.
SourceTypemust beChimeSdkMeeting.
- On success, responds with
CreateMediaCapturePipelineOutputwith field(s):media_capture_pipeline(Option<MediaCapturePipeline>):A media capture pipeline object, the ID, source type, source ARN, sink type, and sink ARN of a media capture pipeline object.
- On failure, responds with
SdkError<CreateMediaCapturePipelineError>
source§impl Client
impl Client
sourcepub fn create_meeting(&self) -> CreateMeetingFluentBuilder
👎Deprecated: Replaced by CreateMeeting in the Amazon Chime SDK Meetings Namespace
pub fn create_meeting(&self) -> CreateMeetingFluentBuilder
Constructs a fluent builder for the CreateMeeting operation.
- The fluent builder is configurable:
client_request_token(impl Into<String>)/set_client_request_token(Option<String>):
required: trueThe unique identifier for the client request. Use a different token for different meetings.
external_meeting_id(impl Into<String>)/set_external_meeting_id(Option<String>):
required: falseThe external meeting ID.
meeting_host_id(impl Into<String>)/set_meeting_host_id(Option<String>):
required: falseReserved.
media_region(impl Into<String>)/set_media_region(Option<String>):
required: falseThe Region in which to create the meeting. Default:
us-east-1.Available values:
af-south-1,ap-northeast-1,ap-northeast-2,ap-south-1,ap-southeast-1,ap-southeast-2,ca-central-1,eu-central-1,eu-north-1,eu-south-1,eu-west-1,eu-west-2,eu-west-3,sa-east-1,us-east-1,us-east-2,us-west-1,us-west-2.tags(Tag)/set_tags(Option<Vec::<Tag>>):
required: falseThe tag key-value pairs.
notifications_configuration(MeetingNotificationConfiguration)/set_notifications_configuration(Option<MeetingNotificationConfiguration>):
required: falseThe configuration for resource targets to receive notifications when meeting and attendee events occur.
- On success, responds with
CreateMeetingOutputwith field(s):meeting(Option<Meeting>):The meeting information, including the meeting ID and
MediaPlacement.
- On failure, responds with
SdkError<CreateMeetingError>
source§impl Client
impl Client
sourcepub fn create_meeting_dial_out(&self) -> CreateMeetingDialOutFluentBuilder
pub fn create_meeting_dial_out(&self) -> CreateMeetingDialOutFluentBuilder
Constructs a fluent builder for the CreateMeetingDialOut operation.
- The fluent builder is configurable:
meeting_id(impl Into<String>)/set_meeting_id(Option<String>):
required: trueThe Amazon Chime SDK meeting ID.
from_phone_number(impl Into<String>)/set_from_phone_number(Option<String>):
required: truePhone number used as the caller ID when the remote party receives a call.
to_phone_number(impl Into<String>)/set_to_phone_number(Option<String>):
required: truePhone number called when inviting someone to a meeting.
join_token(impl Into<String>)/set_join_token(Option<String>):
required: trueToken used by the Amazon Chime SDK attendee. Call the CreateAttendee action to get a join token.
- On success, responds with
CreateMeetingDialOutOutputwith field(s):transaction_id(Option<String>):Unique ID that tracks API calls.
- On failure, responds with
SdkError<CreateMeetingDialOutError>
source§impl Client
impl Client
sourcepub fn create_meeting_with_attendees(
&self
) -> CreateMeetingWithAttendeesFluentBuilder
👎Deprecated: Replaced by CreateMeetingWithAttendees in the Amazon Chime SDK Meetings Namespace
pub fn create_meeting_with_attendees( &self ) -> CreateMeetingWithAttendeesFluentBuilder
Constructs a fluent builder for the CreateMeetingWithAttendees operation.
- The fluent builder is configurable:
client_request_token(impl Into<String>)/set_client_request_token(Option<String>):
required: trueThe unique identifier for the client request. Use a different token for different meetings.
external_meeting_id(impl Into<String>)/set_external_meeting_id(Option<String>):
required: falseThe external meeting ID.
meeting_host_id(impl Into<String>)/set_meeting_host_id(Option<String>):
required: falseReserved.
media_region(impl Into<String>)/set_media_region(Option<String>):
required: falseThe Region in which to create the meeting. Default:
us-east-1.Available values:
af-south-1,ap-northeast-1,ap-northeast-2,ap-south-1,ap-southeast-1,ap-southeast-2,ca-central-1,eu-central-1,eu-north-1,eu-south-1,eu-west-1,eu-west-2,eu-west-3,sa-east-1,us-east-1,us-east-2,us-west-1,us-west-2.tags(Tag)/set_tags(Option<Vec::<Tag>>):
required: falseThe tag key-value pairs.
notifications_configuration(MeetingNotificationConfiguration)/set_notifications_configuration(Option<MeetingNotificationConfiguration>):
required: falseThe resource target configurations for receiving Amazon Chime SDK meeting and attendee event notifications. The Amazon Chime SDK supports resource targets located in the US East (N. Virginia) AWS Region (us-east-1).
attendees(CreateAttendeeRequestItem)/set_attendees(Option<Vec::<CreateAttendeeRequestItem>>):
required: falseThe request containing the attendees to create.
- On success, responds with
CreateMeetingWithAttendeesOutputwith field(s):meeting(Option<Meeting>):A meeting created using the Amazon Chime SDK.
attendees(Option<Vec::<Attendee>>):The attendee information, including attendees IDs and join tokens.
errors(Option<Vec::<CreateAttendeeError>>):If the action fails for one or more of the attendees in the request, a list of the attendees is returned, along with error codes and error messages.
- On failure, responds with
SdkError<CreateMeetingWithAttendeesError>
source§impl Client
impl Client
sourcepub fn create_phone_number_order(&self) -> CreatePhoneNumberOrderFluentBuilder
pub fn create_phone_number_order(&self) -> CreatePhoneNumberOrderFluentBuilder
Constructs a fluent builder for the CreatePhoneNumberOrder operation.
- The fluent builder is configurable:
product_type(PhoneNumberProductType)/set_product_type(Option<PhoneNumberProductType>):
required: trueThe phone number product type.
e164_phone_numbers(impl Into<String>)/set_e164_phone_numbers(Option<Vec::<String>>):
required: trueList of phone numbers, in E.164 format.
- On success, responds with
CreatePhoneNumberOrderOutputwith field(s):phone_number_order(Option<PhoneNumberOrder>):The phone number order details.
- On failure, responds with
SdkError<CreatePhoneNumberOrderError>
source§impl Client
impl Client
sourcepub fn create_proxy_session(&self) -> CreateProxySessionFluentBuilder
👎Deprecated: Replaced by CreateProxySession in the Amazon Chime SDK Voice Namespace
pub fn create_proxy_session(&self) -> CreateProxySessionFluentBuilder
Constructs a fluent builder for the CreateProxySession operation.
- The fluent builder is configurable:
voice_connector_id(impl Into<String>)/set_voice_connector_id(Option<String>):
required: trueThe Amazon Chime voice connector ID.
participant_phone_numbers(impl Into<String>)/set_participant_phone_numbers(Option<Vec::<String>>):
required: trueThe participant phone numbers.
name(impl Into<String>)/set_name(Option<String>):
required: falseThe name of the proxy session.
expiry_minutes(i32)/set_expiry_minutes(Option<i32>):
required: falseThe number of minutes allowed for the proxy session.
capabilities(Capability)/set_capabilities(Option<Vec::<Capability>>):
required: trueThe proxy session capabilities.
number_selection_behavior(NumberSelectionBehavior)/set_number_selection_behavior(Option<NumberSelectionBehavior>):
required: falseThe preference for proxy phone number reuse, or stickiness, between the same participants across sessions.
geo_match_level(GeoMatchLevel)/set_geo_match_level(Option<GeoMatchLevel>):
required: falseThe preference for matching the country or area code of the proxy phone number with that of the first participant.
geo_match_params(GeoMatchParams)/set_geo_match_params(Option<GeoMatchParams>):
required: falseThe country and area code for the proxy phone number.
- On success, responds with
CreateProxySessionOutputwith field(s):proxy_session(Option<ProxySession>):The proxy session details.
- On failure, responds with
SdkError<CreateProxySessionError>
source§impl Client
impl Client
sourcepub fn create_room(&self) -> CreateRoomFluentBuilder
pub fn create_room(&self) -> CreateRoomFluentBuilder
Constructs a fluent builder for the CreateRoom operation.
- The fluent builder is configurable:
account_id(impl Into<String>)/set_account_id(Option<String>):
required: trueThe Amazon Chime account ID.
name(impl Into<String>)/set_name(Option<String>):
required: trueThe room name.
client_request_token(impl Into<String>)/set_client_request_token(Option<String>):
required: falseThe idempotency token for the request.
- On success, responds with
CreateRoomOutputwith field(s):room(Option<Room>):The room details.
- On failure, responds with
SdkError<CreateRoomError>
source§impl Client
impl Client
sourcepub fn create_room_membership(&self) -> CreateRoomMembershipFluentBuilder
pub fn create_room_membership(&self) -> CreateRoomMembershipFluentBuilder
Constructs a fluent builder for the CreateRoomMembership operation.
- The fluent builder is configurable:
account_id(impl Into<String>)/set_account_id(Option<String>):
required: trueThe Amazon Chime account ID.
room_id(impl Into<String>)/set_room_id(Option<String>):
required: trueThe room ID.
member_id(impl Into<String>)/set_member_id(Option<String>):
required: trueThe Amazon Chime member ID (user ID or bot ID).
role(RoomMembershipRole)/set_role(Option<RoomMembershipRole>):
required: falseThe role of the member.
- On success, responds with
CreateRoomMembershipOutputwith field(s):room_membership(Option<RoomMembership>):The room membership details.
- On failure, responds with
SdkError<CreateRoomMembershipError>
source§impl Client
impl Client
sourcepub fn create_sip_media_application(
&self
) -> CreateSipMediaApplicationFluentBuilder
👎Deprecated: Replaced by CreateSipMediaApplication in the Amazon Chime SDK Voice Namespace
pub fn create_sip_media_application( &self ) -> CreateSipMediaApplicationFluentBuilder
Constructs a fluent builder for the CreateSipMediaApplication operation.
- The fluent builder is configurable:
aws_region(impl Into<String>)/set_aws_region(Option<String>):
required: trueThe AWS Region assigned to the SIP media application.
name(impl Into<String>)/set_name(Option<String>):
required: trueThe SIP media application name.
endpoints(SipMediaApplicationEndpoint)/set_endpoints(Option<Vec::<SipMediaApplicationEndpoint>>):
required: trueList of endpoints (Lambda Amazon Resource Names) specified for the SIP media application. Currently, only one endpoint is supported.
- On success, responds with
CreateSipMediaApplicationOutputwith field(s):sip_media_application(Option<SipMediaApplication>):The SIP media application details.
- On failure, responds with
SdkError<CreateSipMediaApplicationError>
source§impl Client
impl Client
sourcepub fn create_sip_media_application_call(
&self
) -> CreateSipMediaApplicationCallFluentBuilder
👎Deprecated: Replaced by CreateSipMediaApplicationCall in the Amazon Chime SDK Voice Namespace
pub fn create_sip_media_application_call( &self ) -> CreateSipMediaApplicationCallFluentBuilder
Constructs a fluent builder for the CreateSipMediaApplicationCall operation.
- The fluent builder is configurable:
from_phone_number(impl Into<String>)/set_from_phone_number(Option<String>):
required: trueThe phone number that a user calls from. This is a phone number in your Amazon Chime phone number inventory.
to_phone_number(impl Into<String>)/set_to_phone_number(Option<String>):
required: trueThe phone number that the service should call.
sip_media_application_id(impl Into<String>)/set_sip_media_application_id(Option<String>):
required: trueThe ID of the SIP media application.
sip_headers(impl Into<String>, impl Into<String>)/set_sip_headers(Option<HashMap::<String, String>>):
required: falseThe SIP headers added to an outbound call leg.
- On success, responds with
CreateSipMediaApplicationCallOutputwith field(s):sip_media_application_call(Option<SipMediaApplicationCall>):The actual call.
- On failure, responds with
SdkError<CreateSipMediaApplicationCallError>
source§impl Client
impl Client
sourcepub fn create_sip_rule(&self) -> CreateSipRuleFluentBuilder
👎Deprecated: Replaced by CreateSipRule in the Amazon Chime SDK Voice Namespace
pub fn create_sip_rule(&self) -> CreateSipRuleFluentBuilder
Constructs a fluent builder for the CreateSipRule operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name of the SIP rule.
trigger_type(SipRuleTriggerType)/set_trigger_type(Option<SipRuleTriggerType>):
required: trueThe type of trigger assigned to the SIP rule in
TriggerValue, currentlyRequestUriHostnameorToPhoneNumber.trigger_value(impl Into<String>)/set_trigger_value(Option<String>):
required: trueIf
TriggerTypeisRequestUriHostname, the value can be the outbound host name of an Amazon Chime Voice Connector. IfTriggerTypeisToPhoneNumber, the value can be a customer-owned phone number in the E164 format. TheSipMediaApplicationspecified in theSipRuleis triggered if the request URI in an incoming SIP request matches theRequestUriHostname, or if theToheader in the incoming SIP request matches theToPhoneNumbervalue.disabled(bool)/set_disabled(Option<bool>):
required: falseEnables or disables a rule. You must disable rules before you can delete them.
target_applications(SipRuleTargetApplication)/set_target_applications(Option<Vec::<SipRuleTargetApplication>>):
required: trueList of SIP media applications with priority and AWS Region. Only one SIP application per AWS Region can be used.
- On success, responds with
CreateSipRuleOutputwith field(s):sip_rule(Option<SipRule>):Returns the SIP rule information, including the rule ID, triggers, and target applications.
- On failure, responds with
SdkError<CreateSipRuleError>
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:
account_id(impl Into<String>)/set_account_id(Option<String>):
required: trueThe Amazon Chime account ID.
username(impl Into<String>)/set_username(Option<String>):
required: falseThe user name.
email(impl Into<String>)/set_email(Option<String>):
required: falseThe user’s email address.
user_type(UserType)/set_user_type(Option<UserType>):
required: falseThe user type.
- On success, responds with
CreateUserOutputwith field(s):user(Option<User>):The user on the Amazon Chime account.
- On failure, responds with
SdkError<CreateUserError>
source§impl Client
impl Client
sourcepub fn create_voice_connector(&self) -> CreateVoiceConnectorFluentBuilder
👎Deprecated: Replaced by CreateVoiceConnector in the Amazon Chime SDK Voice Namespace
pub fn create_voice_connector(&self) -> CreateVoiceConnectorFluentBuilder
Constructs a fluent builder for the CreateVoiceConnector operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name of the Amazon Chime Voice Connector.
aws_region(VoiceConnectorAwsRegion)/set_aws_region(Option<VoiceConnectorAwsRegion>):
required: falseThe AWS Region in which the Amazon Chime Voice Connector is created. Default value:
us-east-1.require_encryption(bool)/set_require_encryption(Option<bool>):
required: trueWhen enabled, requires encryption for the Amazon Chime Voice Connector.
- On success, responds with
CreateVoiceConnectorOutputwith field(s):voice_connector(Option<VoiceConnector>):The Amazon Chime Voice Connector details.
- On failure, responds with
SdkError<CreateVoiceConnectorError>
source§impl Client
impl Client
sourcepub fn create_voice_connector_group(
&self
) -> CreateVoiceConnectorGroupFluentBuilder
👎Deprecated: Replaced by CreateVoiceConnectorGroup in the Amazon Chime SDK Voice Namespace
pub fn create_voice_connector_group( &self ) -> CreateVoiceConnectorGroupFluentBuilder
Constructs a fluent builder for the CreateVoiceConnectorGroup operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name of the Amazon Chime Voice Connector group.
voice_connector_items(VoiceConnectorItem)/set_voice_connector_items(Option<Vec::<VoiceConnectorItem>>):
required: falseThe Amazon Chime Voice Connectors to route inbound calls to.
- On success, responds with
CreateVoiceConnectorGroupOutputwith field(s):voice_connector_group(Option<VoiceConnectorGroup>):The Amazon Chime Voice Connector group details.
- On failure, responds with
SdkError<CreateVoiceConnectorGroupError>
source§impl Client
impl Client
sourcepub fn delete_account(&self) -> DeleteAccountFluentBuilder
pub fn delete_account(&self) -> DeleteAccountFluentBuilder
Constructs a fluent builder for the DeleteAccount operation.
- The fluent builder is configurable:
account_id(impl Into<String>)/set_account_id(Option<String>):
required: trueThe Amazon Chime account ID.
- On success, responds with
DeleteAccountOutput - On failure, responds with
SdkError<DeleteAccountError>
source§impl Client
impl Client
sourcepub fn delete_app_instance(&self) -> DeleteAppInstanceFluentBuilder
👎Deprecated: Replaced by DeleteAppInstance in the Amazon Chime SDK Identity Namespace
pub fn delete_app_instance(&self) -> DeleteAppInstanceFluentBuilder
Constructs a fluent builder for the DeleteAppInstance operation.
- The fluent builder is configurable:
app_instance_arn(impl Into<String>)/set_app_instance_arn(Option<String>):
required: trueThe ARN of the
AppInstance.
- On success, responds with
DeleteAppInstanceOutput - On failure, responds with
SdkError<DeleteAppInstanceError>
source§impl Client
impl Client
sourcepub fn delete_app_instance_admin(&self) -> DeleteAppInstanceAdminFluentBuilder
👎Deprecated: Replaced by DeleteAppInstanceAdmin in the Amazon Chime SDK Identity Namespace
pub fn delete_app_instance_admin(&self) -> DeleteAppInstanceAdminFluentBuilder
Constructs a fluent builder for the DeleteAppInstanceAdmin operation.
- The fluent builder is configurable:
app_instance_admin_arn(impl Into<String>)/set_app_instance_admin_arn(Option<String>):
required: trueThe ARN of the
AppInstance’s administrator.app_instance_arn(impl Into<String>)/set_app_instance_arn(Option<String>):
required: trueThe ARN of the
AppInstance.
- On success, responds with
DeleteAppInstanceAdminOutput - On failure, responds with
SdkError<DeleteAppInstanceAdminError>
source§impl Client
impl Client
sourcepub fn delete_app_instance_streaming_configurations(
&self
) -> DeleteAppInstanceStreamingConfigurationsFluentBuilder
👎Deprecated: Replaced by DeleteAppInstanceStreamingConfigurations in the Amazon Chime SDK Messaging Namespace
pub fn delete_app_instance_streaming_configurations( &self ) -> DeleteAppInstanceStreamingConfigurationsFluentBuilder
Constructs a fluent builder for the DeleteAppInstanceStreamingConfigurations operation.
- The fluent builder is configurable:
app_instance_arn(impl Into<String>)/set_app_instance_arn(Option<String>):
required: trueThe ARN of the streaming configurations being deleted.
- On success, responds with
DeleteAppInstanceStreamingConfigurationsOutput - On failure, responds with
SdkError<DeleteAppInstanceStreamingConfigurationsError>
source§impl Client
impl Client
sourcepub fn delete_app_instance_user(&self) -> DeleteAppInstanceUserFluentBuilder
👎Deprecated: Replaced by DeleteAppInstanceUser in the Amazon Chime SDK Identity Namespace
pub fn delete_app_instance_user(&self) -> DeleteAppInstanceUserFluentBuilder
Constructs a fluent builder for the DeleteAppInstanceUser operation.
- The fluent builder is configurable:
app_instance_user_arn(impl Into<String>)/set_app_instance_user_arn(Option<String>):
required: trueThe ARN of the user request being deleted.
- On success, responds with
DeleteAppInstanceUserOutput - On failure, responds with
SdkError<DeleteAppInstanceUserError>
source§impl Client
impl Client
sourcepub fn delete_attendee(&self) -> DeleteAttendeeFluentBuilder
👎Deprecated: Replaced by DeleteAttendee in the Amazon Chime SDK Meetings Namespace
pub fn delete_attendee(&self) -> DeleteAttendeeFluentBuilder
Constructs a fluent builder for the DeleteAttendee operation.
- The fluent builder is configurable:
meeting_id(impl Into<String>)/set_meeting_id(Option<String>):
required: trueThe Amazon Chime SDK meeting ID.
attendee_id(impl Into<String>)/set_attendee_id(Option<String>):
required: trueThe Amazon Chime SDK attendee ID.
- On success, responds with
DeleteAttendeeOutput - On failure, responds with
SdkError<DeleteAttendeeError>
source§impl Client
impl Client
sourcepub fn delete_channel(&self) -> DeleteChannelFluentBuilder
👎Deprecated: Replaced by DeleteChannel in the Amazon Chime SDK Messaging Namespace
pub fn delete_channel(&self) -> DeleteChannelFluentBuilder
Constructs a fluent builder for the DeleteChannel operation.
- The fluent builder is configurable:
channel_arn(impl Into<String>)/set_channel_arn(Option<String>):
required: trueThe ARN of the channel being deleted.
chime_bearer(impl Into<String>)/set_chime_bearer(Option<String>):
required: falseThe
AppInstanceUserArnof the user that makes the API call.
- On success, responds with
DeleteChannelOutput - On failure, responds with
SdkError<DeleteChannelError>
source§impl Client
impl Client
sourcepub fn delete_channel_ban(&self) -> DeleteChannelBanFluentBuilder
👎Deprecated: Replaced by DeleteChannelBan in the Amazon Chime SDK Messaging Namespace
pub fn delete_channel_ban(&self) -> DeleteChannelBanFluentBuilder
Constructs a fluent builder for the DeleteChannelBan operation.
- The fluent builder is configurable:
channel_arn(impl Into<String>)/set_channel_arn(Option<String>):
required: trueThe ARN of the channel from which the
AppInstanceUserwas banned.member_arn(impl Into<String>)/set_member_arn(Option<String>):
required: trueThe ARN of the
AppInstanceUserthat you want to reinstate.chime_bearer(impl Into<String>)/set_chime_bearer(Option<String>):
required: falseThe
AppInstanceUserArnof the user that makes the API call.
- On success, responds with
DeleteChannelBanOutput - On failure, responds with
SdkError<DeleteChannelBanError>
source§impl Client
impl Client
sourcepub fn delete_channel_membership(&self) -> DeleteChannelMembershipFluentBuilder
👎Deprecated: Replaced by DeleteChannelMembership in the Amazon Chime SDK Messaging Namespace
pub fn delete_channel_membership(&self) -> DeleteChannelMembershipFluentBuilder
Constructs a fluent builder for the DeleteChannelMembership operation.
- The fluent builder is configurable:
channel_arn(impl Into<String>)/set_channel_arn(Option<String>):
required: trueThe ARN of the channel from which you want to remove the user.
member_arn(impl Into<String>)/set_member_arn(Option<String>):
required: trueThe ARN of the member that you’re removing from the channel.
chime_bearer(impl Into<String>)/set_chime_bearer(Option<String>):
required: falseThe
AppInstanceUserArnof the user that makes the API call.
- On success, responds with
DeleteChannelMembershipOutput - On failure, responds with
SdkError<DeleteChannelMembershipError>
source§impl Client
impl Client
sourcepub fn delete_channel_message(&self) -> DeleteChannelMessageFluentBuilder
👎Deprecated: Replaced by DeleteChannelMessage in the Amazon Chime SDK Messaging Namespace
pub fn delete_channel_message(&self) -> DeleteChannelMessageFluentBuilder
Constructs a fluent builder for the DeleteChannelMessage operation.
- The fluent builder is configurable:
channel_arn(impl Into<String>)/set_channel_arn(Option<String>):
required: trueThe ARN of the channel.
message_id(impl Into<String>)/set_message_id(Option<String>):
required: trueThe ID of the message being deleted.
chime_bearer(impl Into<String>)/set_chime_bearer(Option<String>):
required: falseThe
AppInstanceUserArnof the user that makes the API call.
- On success, responds with
DeleteChannelMessageOutput - On failure, responds with
SdkError<DeleteChannelMessageError>
source§impl Client
impl Client
sourcepub fn delete_channel_moderator(&self) -> DeleteChannelModeratorFluentBuilder
👎Deprecated: Replaced by DeleteChannelModerator in the Amazon Chime SDK Messaging Namespace
pub fn delete_channel_moderator(&self) -> DeleteChannelModeratorFluentBuilder
Constructs a fluent builder for the DeleteChannelModerator operation.
- The fluent builder is configurable:
channel_arn(impl Into<String>)/set_channel_arn(Option<String>):
required: trueThe ARN of the channel.
channel_moderator_arn(impl Into<String>)/set_channel_moderator_arn(Option<String>):
required: trueThe ARN of the moderator being deleted.
chime_bearer(impl Into<String>)/set_chime_bearer(Option<String>):
required: falseThe
AppInstanceUserArnof the user that makes the API call.
- On success, responds with
DeleteChannelModeratorOutput - On failure, responds with
SdkError<DeleteChannelModeratorError>
source§impl Client
impl Client
sourcepub fn delete_events_configuration(
&self
) -> DeleteEventsConfigurationFluentBuilder
pub fn delete_events_configuration( &self ) -> DeleteEventsConfigurationFluentBuilder
Constructs a fluent builder for the DeleteEventsConfiguration operation.
- The fluent builder is configurable:
account_id(impl Into<String>)/set_account_id(Option<String>):
required: trueThe Amazon Chime account ID.
bot_id(impl Into<String>)/set_bot_id(Option<String>):
required: trueThe bot ID.
- On success, responds with
DeleteEventsConfigurationOutput - On failure, responds with
SdkError<DeleteEventsConfigurationError>
source§impl Client
impl Client
sourcepub fn delete_media_capture_pipeline(
&self
) -> DeleteMediaCapturePipelineFluentBuilder
👎Deprecated: Replaced by DeleteMediaCapturePipeline in the Amazon Chime SDK Media Pipelines Namespace
pub fn delete_media_capture_pipeline( &self ) -> DeleteMediaCapturePipelineFluentBuilder
Constructs a fluent builder for the DeleteMediaCapturePipeline operation.
- The fluent builder is configurable:
media_pipeline_id(impl Into<String>)/set_media_pipeline_id(Option<String>):
required: trueThe ID of the media capture pipeline being deleted.
- On success, responds with
DeleteMediaCapturePipelineOutput - On failure, responds with
SdkError<DeleteMediaCapturePipelineError>
source§impl Client
impl Client
sourcepub fn delete_meeting(&self) -> DeleteMeetingFluentBuilder
👎Deprecated: Replaced by DeleteMeeting in the Amazon Chime SDK Meetings Namespace
pub fn delete_meeting(&self) -> DeleteMeetingFluentBuilder
Constructs a fluent builder for the DeleteMeeting operation.
- The fluent builder is configurable:
meeting_id(impl Into<String>)/set_meeting_id(Option<String>):
required: trueThe Amazon Chime SDK meeting ID.
- On success, responds with
DeleteMeetingOutput - On failure, responds with
SdkError<DeleteMeetingError>
source§impl Client
impl Client
sourcepub fn delete_phone_number(&self) -> DeletePhoneNumberFluentBuilder
pub fn delete_phone_number(&self) -> DeletePhoneNumberFluentBuilder
Constructs a fluent builder for the DeletePhoneNumber operation.
- The fluent builder is configurable:
phone_number_id(impl Into<String>)/set_phone_number_id(Option<String>):
required: trueThe phone number ID.
- On success, responds with
DeletePhoneNumberOutput - On failure, responds with
SdkError<DeletePhoneNumberError>
source§impl Client
impl Client
sourcepub fn delete_proxy_session(&self) -> DeleteProxySessionFluentBuilder
👎Deprecated: Replaced by DeleteProxySession in the Amazon Chime SDK Voice Namespace
pub fn delete_proxy_session(&self) -> DeleteProxySessionFluentBuilder
Constructs a fluent builder for the DeleteProxySession operation.
- The fluent builder is configurable:
voice_connector_id(impl Into<String>)/set_voice_connector_id(Option<String>):
required: trueThe Amazon Chime voice connector ID.
proxy_session_id(impl Into<String>)/set_proxy_session_id(Option<String>):
required: trueThe proxy session ID.
- On success, responds with
DeleteProxySessionOutput - On failure, responds with
SdkError<DeleteProxySessionError>
source§impl Client
impl Client
sourcepub fn delete_room(&self) -> DeleteRoomFluentBuilder
pub fn delete_room(&self) -> DeleteRoomFluentBuilder
Constructs a fluent builder for the DeleteRoom operation.
- The fluent builder is configurable:
account_id(impl Into<String>)/set_account_id(Option<String>):
required: trueThe Amazon Chime account ID.
room_id(impl Into<String>)/set_room_id(Option<String>):
required: trueThe chat room ID.
- On success, responds with
DeleteRoomOutput - On failure, responds with
SdkError<DeleteRoomError>
source§impl Client
impl Client
sourcepub fn delete_room_membership(&self) -> DeleteRoomMembershipFluentBuilder
pub fn delete_room_membership(&self) -> DeleteRoomMembershipFluentBuilder
Constructs a fluent builder for the DeleteRoomMembership operation.
- The fluent builder is configurable:
account_id(impl Into<String>)/set_account_id(Option<String>):
required: trueThe Amazon Chime account ID.
room_id(impl Into<String>)/set_room_id(Option<String>):
required: trueThe room ID.
member_id(impl Into<String>)/set_member_id(Option<String>):
required: trueThe member ID (user ID or bot ID).
- On success, responds with
DeleteRoomMembershipOutput - On failure, responds with
SdkError<DeleteRoomMembershipError>
source§impl Client
impl Client
sourcepub fn delete_sip_media_application(
&self
) -> DeleteSipMediaApplicationFluentBuilder
👎Deprecated: Replaced by DeleteSipMediaApplication in the Amazon Chime SDK Voice Namespace
pub fn delete_sip_media_application( &self ) -> DeleteSipMediaApplicationFluentBuilder
Constructs a fluent builder for the DeleteSipMediaApplication operation.
- The fluent builder is configurable:
sip_media_application_id(impl Into<String>)/set_sip_media_application_id(Option<String>):
required: trueThe SIP media application ID.
- On success, responds with
DeleteSipMediaApplicationOutput - On failure, responds with
SdkError<DeleteSipMediaApplicationError>
source§impl Client
impl Client
sourcepub fn delete_sip_rule(&self) -> DeleteSipRuleFluentBuilder
👎Deprecated: Replaced by DeleteSipRule in the Amazon Chime SDK Voice Namespace
pub fn delete_sip_rule(&self) -> DeleteSipRuleFluentBuilder
Constructs a fluent builder for the DeleteSipRule operation.
- The fluent builder is configurable:
sip_rule_id(impl Into<String>)/set_sip_rule_id(Option<String>):
required: trueThe SIP rule ID.
- On success, responds with
DeleteSipRuleOutput - On failure, responds with
SdkError<DeleteSipRuleError>
source§impl Client
impl Client
sourcepub fn delete_voice_connector(&self) -> DeleteVoiceConnectorFluentBuilder
👎Deprecated: Replaced by DeleteVoiceConnector in the Amazon Chime SDK Voice Namespace
pub fn delete_voice_connector(&self) -> DeleteVoiceConnectorFluentBuilder
Constructs a fluent builder for the DeleteVoiceConnector operation.
- The fluent builder is configurable:
voice_connector_id(impl Into<String>)/set_voice_connector_id(Option<String>):
required: trueThe Amazon Chime Voice Connector ID.
- On success, responds with
DeleteVoiceConnectorOutput - On failure, responds with
SdkError<DeleteVoiceConnectorError>
source§impl Client
impl Client
sourcepub fn delete_voice_connector_emergency_calling_configuration(
&self
) -> DeleteVoiceConnectorEmergencyCallingConfigurationFluentBuilder
👎Deprecated: Replaced by DeleteVoiceConnectorEmergencyCallingConfiguration in the Amazon Chime SDK Voice Namespace
pub fn delete_voice_connector_emergency_calling_configuration( &self ) -> DeleteVoiceConnectorEmergencyCallingConfigurationFluentBuilder
Constructs a fluent builder for the DeleteVoiceConnectorEmergencyCallingConfiguration operation.
- The fluent builder is configurable:
voice_connector_id(impl Into<String>)/set_voice_connector_id(Option<String>):
required: trueThe Amazon Chime Voice Connector ID.
- On success, responds with
DeleteVoiceConnectorEmergencyCallingConfigurationOutput - On failure, responds with
SdkError<DeleteVoiceConnectorEmergencyCallingConfigurationError>
source§impl Client
impl Client
sourcepub fn delete_voice_connector_group(
&self
) -> DeleteVoiceConnectorGroupFluentBuilder
👎Deprecated: Replaced by DeleteVoiceConnectorGroup in the Amazon Chime SDK Voice Namespace
pub fn delete_voice_connector_group( &self ) -> DeleteVoiceConnectorGroupFluentBuilder
Constructs a fluent builder for the DeleteVoiceConnectorGroup operation.
- The fluent builder is configurable:
voice_connector_group_id(impl Into<String>)/set_voice_connector_group_id(Option<String>):
required: trueThe Amazon Chime Voice Connector group ID.
- On success, responds with
DeleteVoiceConnectorGroupOutput - On failure, responds with
SdkError<DeleteVoiceConnectorGroupError>
source§impl Client
impl Client
sourcepub fn delete_voice_connector_origination(
&self
) -> DeleteVoiceConnectorOriginationFluentBuilder
👎Deprecated: Replaced by DeleteVoiceConnectorOrigination in the Amazon Chime SDK Voice Namespace
pub fn delete_voice_connector_origination( &self ) -> DeleteVoiceConnectorOriginationFluentBuilder
Constructs a fluent builder for the DeleteVoiceConnectorOrigination operation.
- The fluent builder is configurable:
voice_connector_id(impl Into<String>)/set_voice_connector_id(Option<String>):
required: trueThe Amazon Chime Voice Connector ID.
- On success, responds with
DeleteVoiceConnectorOriginationOutput - On failure, responds with
SdkError<DeleteVoiceConnectorOriginationError>
source§impl Client
impl Client
sourcepub fn delete_voice_connector_proxy(
&self
) -> DeleteVoiceConnectorProxyFluentBuilder
👎Deprecated: Replaced by DeleteVoiceConnectorProxy in the Amazon Chime SDK Voice Namespace
pub fn delete_voice_connector_proxy( &self ) -> DeleteVoiceConnectorProxyFluentBuilder
Constructs a fluent builder for the DeleteVoiceConnectorProxy operation.
- The fluent builder is configurable:
voice_connector_id(impl Into<String>)/set_voice_connector_id(Option<String>):
required: trueThe Amazon Chime Voice Connector ID.
- On success, responds with
DeleteVoiceConnectorProxyOutput - On failure, responds with
SdkError<DeleteVoiceConnectorProxyError>
source§impl Client
impl Client
sourcepub fn delete_voice_connector_streaming_configuration(
&self
) -> DeleteVoiceConnectorStreamingConfigurationFluentBuilder
👎Deprecated: Replaced by DeleteVoiceConnectorStreamingConfiguration in the Amazon Chime SDK Voice Namespace
pub fn delete_voice_connector_streaming_configuration( &self ) -> DeleteVoiceConnectorStreamingConfigurationFluentBuilder
Constructs a fluent builder for the DeleteVoiceConnectorStreamingConfiguration operation.
- The fluent builder is configurable:
voice_connector_id(impl Into<String>)/set_voice_connector_id(Option<String>):
required: trueThe Amazon Chime Voice Connector ID.
- On success, responds with
DeleteVoiceConnectorStreamingConfigurationOutput - On failure, responds with
SdkError<DeleteVoiceConnectorStreamingConfigurationError>
source§impl Client
impl Client
sourcepub fn delete_voice_connector_termination(
&self
) -> DeleteVoiceConnectorTerminationFluentBuilder
👎Deprecated: Replaced by DeleteVoiceConnectorTermination in the Amazon Chime SDK Voice Namespace
pub fn delete_voice_connector_termination( &self ) -> DeleteVoiceConnectorTerminationFluentBuilder
Constructs a fluent builder for the DeleteVoiceConnectorTermination operation.
- The fluent builder is configurable:
voice_connector_id(impl Into<String>)/set_voice_connector_id(Option<String>):
required: trueThe Amazon Chime Voice Connector ID.
- On success, responds with
DeleteVoiceConnectorTerminationOutput - On failure, responds with
SdkError<DeleteVoiceConnectorTerminationError>
source§impl Client
impl Client
sourcepub fn delete_voice_connector_termination_credentials(
&self
) -> DeleteVoiceConnectorTerminationCredentialsFluentBuilder
👎Deprecated: Replaced by DeleteVoiceConnectorTerminationCredentials in the Amazon Chime SDK Voice Namespace
pub fn delete_voice_connector_termination_credentials( &self ) -> DeleteVoiceConnectorTerminationCredentialsFluentBuilder
Constructs a fluent builder for the DeleteVoiceConnectorTerminationCredentials operation.
- The fluent builder is configurable:
voice_connector_id(impl Into<String>)/set_voice_connector_id(Option<String>):
required: trueThe Amazon Chime Voice Connector ID.
usernames(impl Into<String>)/set_usernames(Option<Vec::<String>>):
required: trueThe RFC2617 compliant username associated with the SIP credentials, in US-ASCII format.
- On success, responds with
DeleteVoiceConnectorTerminationCredentialsOutput - On failure, responds with
SdkError<DeleteVoiceConnectorTerminationCredentialsError>
source§impl Client
impl Client
sourcepub fn describe_app_instance(&self) -> DescribeAppInstanceFluentBuilder
👎Deprecated: Replaced by DescribeAppInstance in the Amazon Chime SDK Identity Namespace
pub fn describe_app_instance(&self) -> DescribeAppInstanceFluentBuilder
Constructs a fluent builder for the DescribeAppInstance operation.
- The fluent builder is configurable:
app_instance_arn(impl Into<String>)/set_app_instance_arn(Option<String>):
required: trueThe ARN of the
AppInstance.
- On success, responds with
DescribeAppInstanceOutputwith field(s):app_instance(Option<AppInstance>):The ARN, metadata, created and last-updated timestamps, and the name of the
AppInstance. All timestamps use epoch milliseconds.
- On failure, responds with
SdkError<DescribeAppInstanceError>
source§impl Client
impl Client
sourcepub fn describe_app_instance_admin(
&self
) -> DescribeAppInstanceAdminFluentBuilder
👎Deprecated: Replaced by DescribeAppInstanceAdmin in the Amazon Chime SDK Identity Namespace
pub fn describe_app_instance_admin( &self ) -> DescribeAppInstanceAdminFluentBuilder
Constructs a fluent builder for the DescribeAppInstanceAdmin operation.
- The fluent builder is configurable:
app_instance_admin_arn(impl Into<String>)/set_app_instance_admin_arn(Option<String>):
required: trueThe ARN of the
AppInstanceAdmin.app_instance_arn(impl Into<String>)/set_app_instance_arn(Option<String>):
required: trueThe ARN of the
AppInstance.
- On success, responds with
DescribeAppInstanceAdminOutputwith field(s):app_instance_admin(Option<AppInstanceAdmin>):The ARN and name of the
AppInstanceUser, the ARN of theAppInstance, and the created and last-updated timestamps. All timestamps use epoch milliseconds.
- On failure, responds with
SdkError<DescribeAppInstanceAdminError>
source§impl Client
impl Client
sourcepub fn describe_app_instance_user(&self) -> DescribeAppInstanceUserFluentBuilder
👎Deprecated: Replaced by DescribeAppInstanceUser in the Amazon Chime SDK Identity Namespace
pub fn describe_app_instance_user(&self) -> DescribeAppInstanceUserFluentBuilder
Constructs a fluent builder for the DescribeAppInstanceUser operation.
- The fluent builder is configurable:
app_instance_user_arn(impl Into<String>)/set_app_instance_user_arn(Option<String>):
required: trueThe ARN of the
AppInstanceUser.
- On success, responds with
DescribeAppInstanceUserOutputwith field(s):app_instance_user(Option<AppInstanceUser>):The name of the
AppInstanceUser.
- On failure, responds with
SdkError<DescribeAppInstanceUserError>
source§impl Client
impl Client
sourcepub fn describe_channel(&self) -> DescribeChannelFluentBuilder
👎Deprecated: Replaced by DescribeChannel in the Amazon Chime SDK Messaging Namespace
pub fn describe_channel(&self) -> DescribeChannelFluentBuilder
Constructs a fluent builder for the DescribeChannel operation.
- The fluent builder is configurable:
channel_arn(impl Into<String>)/set_channel_arn(Option<String>):
required: trueThe ARN of the channel.
chime_bearer(impl Into<String>)/set_chime_bearer(Option<String>):
required: falseThe
AppInstanceUserArnof the user that makes the API call.
- On success, responds with
DescribeChannelOutputwith field(s):channel(Option<Channel>):The channel details.
- On failure, responds with
SdkError<DescribeChannelError>
source§impl Client
impl Client
sourcepub fn describe_channel_ban(&self) -> DescribeChannelBanFluentBuilder
👎Deprecated: Replaced by DescribeChannelBan in the Amazon Chime SDK Messaging Namespace
pub fn describe_channel_ban(&self) -> DescribeChannelBanFluentBuilder
Constructs a fluent builder for the DescribeChannelBan operation.
- The fluent builder is configurable:
channel_arn(impl Into<String>)/set_channel_arn(Option<String>):
required: trueThe ARN of the channel from which the user is banned.
member_arn(impl Into<String>)/set_member_arn(Option<String>):
required: trueThe ARN of the member being banned.
chime_bearer(impl Into<String>)/set_chime_bearer(Option<String>):
required: falseThe
AppInstanceUserArnof the user that makes the API call.
- On success, responds with
DescribeChannelBanOutputwith field(s):channel_ban(Option<ChannelBan>):The details of the ban.
- On failure, responds with
SdkError<DescribeChannelBanError>
source§impl Client
impl Client
sourcepub fn describe_channel_membership(
&self
) -> DescribeChannelMembershipFluentBuilder
👎Deprecated: Replaced by DescribeChannelMembership in the Amazon Chime SDK Messaging Namespace
pub fn describe_channel_membership( &self ) -> DescribeChannelMembershipFluentBuilder
Constructs a fluent builder for the DescribeChannelMembership operation.
- The fluent builder is configurable:
channel_arn(impl Into<String>)/set_channel_arn(Option<String>):
required: trueThe ARN of the channel.
member_arn(impl Into<String>)/set_member_arn(Option<String>):
required: trueThe ARN of the member.
chime_bearer(impl Into<String>)/set_chime_bearer(Option<String>):
required: falseThe
AppInstanceUserArnof the user that makes the API call.
- On success, responds with
DescribeChannelMembershipOutputwith field(s):channel_membership(Option<ChannelMembership>):The details of the membership.
- On failure, responds with
SdkError<DescribeChannelMembershipError>
source§impl Client
impl Client
sourcepub fn describe_channel_membership_for_app_instance_user(
&self
) -> DescribeChannelMembershipForAppInstanceUserFluentBuilder
👎Deprecated: Replaced by DescribeChannelMembershipForAppInstanceUser in the Amazon Chime SDK Messaging Namespace
pub fn describe_channel_membership_for_app_instance_user( &self ) -> DescribeChannelMembershipForAppInstanceUserFluentBuilder
Constructs a fluent builder for the DescribeChannelMembershipForAppInstanceUser operation.
- The fluent builder is configurable:
channel_arn(impl Into<String>)/set_channel_arn(Option<String>):
required: trueThe ARN of the channel to which the user belongs.
app_instance_user_arn(impl Into<String>)/set_app_instance_user_arn(Option<String>):
required: trueThe ARN of the user in a channel.
chime_bearer(impl Into<String>)/set_chime_bearer(Option<String>):
required: falseThe
AppInstanceUserArnof the user that makes the API call.
- On success, responds with
DescribeChannelMembershipForAppInstanceUserOutputwith field(s):channel_membership(Option<ChannelMembershipForAppInstanceUserSummary>):The channel to which a user belongs.
- On failure, responds with
SdkError<DescribeChannelMembershipForAppInstanceUserError>
source§impl Client
impl Client
sourcepub fn describe_channel_moderated_by_app_instance_user(
&self
) -> DescribeChannelModeratedByAppInstanceUserFluentBuilder
👎Deprecated: Replaced by DescribeChannelModeratedByAppInstanceUser in the Amazon Chime SDK Messaging Namespace
pub fn describe_channel_moderated_by_app_instance_user( &self ) -> DescribeChannelModeratedByAppInstanceUserFluentBuilder
Constructs a fluent builder for the DescribeChannelModeratedByAppInstanceUser operation.
- The fluent builder is configurable:
channel_arn(impl Into<String>)/set_channel_arn(Option<String>):
required: trueThe ARN of the moderated channel.
app_instance_user_arn(impl Into<String>)/set_app_instance_user_arn(Option<String>):
required: trueThe ARN of the
AppInstanceUserin the moderated channel.chime_bearer(impl Into<String>)/set_chime_bearer(Option<String>):
required: falseThe
AppInstanceUserArnof the user that makes the API call.
- On success, responds with
DescribeChannelModeratedByAppInstanceUserOutputwith field(s):channel(Option<ChannelModeratedByAppInstanceUserSummary>):The moderated channel.
- On failure, responds with
SdkError<DescribeChannelModeratedByAppInstanceUserError>
source§impl Client
impl Client
sourcepub fn describe_channel_moderator(
&self
) -> DescribeChannelModeratorFluentBuilder
👎Deprecated: Replaced by DescribeChannelModerator in the Amazon Chime SDK Messaging Namespace
pub fn describe_channel_moderator( &self ) -> DescribeChannelModeratorFluentBuilder
Constructs a fluent builder for the DescribeChannelModerator operation.
- The fluent builder is configurable:
channel_arn(impl Into<String>)/set_channel_arn(Option<String>):
required: trueThe ARN of the channel.
channel_moderator_arn(impl Into<String>)/set_channel_moderator_arn(Option<String>):
required: trueThe ARN of the channel moderator.
chime_bearer(impl Into<String>)/set_chime_bearer(Option<String>):
required: falseThe
AppInstanceUserArnof the user that makes the API call.
- On success, responds with
DescribeChannelModeratorOutputwith field(s):channel_moderator(Option<ChannelModerator>):The details of the channel moderator.
- On failure, responds with
SdkError<DescribeChannelModeratorError>
source§impl Client
impl Client
sourcepub fn disassociate_phone_number_from_user(
&self
) -> DisassociatePhoneNumberFromUserFluentBuilder
pub fn disassociate_phone_number_from_user( &self ) -> DisassociatePhoneNumberFromUserFluentBuilder
Constructs a fluent builder for the DisassociatePhoneNumberFromUser operation.
- The fluent builder is configurable:
account_id(impl Into<String>)/set_account_id(Option<String>):
required: trueThe Amazon Chime account ID.
user_id(impl Into<String>)/set_user_id(Option<String>):
required: trueThe user ID.
- On success, responds with
DisassociatePhoneNumberFromUserOutput - On failure, responds with
SdkError<DisassociatePhoneNumberFromUserError>
source§impl Client
impl Client
sourcepub fn disassociate_phone_numbers_from_voice_connector(
&self
) -> DisassociatePhoneNumbersFromVoiceConnectorFluentBuilder
👎Deprecated: Replaced by DisassociatePhoneNumbersFromVoiceConnector in the Amazon Chime SDK Voice Namespace
pub fn disassociate_phone_numbers_from_voice_connector( &self ) -> DisassociatePhoneNumbersFromVoiceConnectorFluentBuilder
Constructs a fluent builder for the DisassociatePhoneNumbersFromVoiceConnector operation.
- The fluent builder is configurable:
voice_connector_id(impl Into<String>)/set_voice_connector_id(Option<String>):
required: trueThe Amazon Chime Voice Connector ID.
e164_phone_numbers(impl Into<String>)/set_e164_phone_numbers(Option<Vec::<String>>):
required: trueList of phone numbers, in E.164 format.
- On success, responds with
DisassociatePhoneNumbersFromVoiceConnectorOutputwith field(s):phone_number_errors(Option<Vec::<PhoneNumberError>>):If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.
- On failure, responds with
SdkError<DisassociatePhoneNumbersFromVoiceConnectorError>
source§impl Client
impl Client
sourcepub fn disassociate_phone_numbers_from_voice_connector_group(
&self
) -> DisassociatePhoneNumbersFromVoiceConnectorGroupFluentBuilder
👎Deprecated: Replaced by DisassociatePhoneNumbersFromVoiceConnectorGroup in the Amazon Chime SDK Voice Namespace
pub fn disassociate_phone_numbers_from_voice_connector_group( &self ) -> DisassociatePhoneNumbersFromVoiceConnectorGroupFluentBuilder
Constructs a fluent builder for the DisassociatePhoneNumbersFromVoiceConnectorGroup operation.
- The fluent builder is configurable:
voice_connector_group_id(impl Into<String>)/set_voice_connector_group_id(Option<String>):
required: trueThe Amazon Chime Voice Connector group ID.
e164_phone_numbers(impl Into<String>)/set_e164_phone_numbers(Option<Vec::<String>>):
required: trueList of phone numbers, in E.164 format.
- On success, responds with
DisassociatePhoneNumbersFromVoiceConnectorGroupOutputwith field(s):phone_number_errors(Option<Vec::<PhoneNumberError>>):If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.
- On failure, responds with
SdkError<DisassociatePhoneNumbersFromVoiceConnectorGroupError>
source§impl Client
impl Client
sourcepub fn disassociate_signin_delegate_groups_from_account(
&self
) -> DisassociateSigninDelegateGroupsFromAccountFluentBuilder
pub fn disassociate_signin_delegate_groups_from_account( &self ) -> DisassociateSigninDelegateGroupsFromAccountFluentBuilder
Constructs a fluent builder for the DisassociateSigninDelegateGroupsFromAccount operation.
- The fluent builder is configurable:
account_id(impl Into<String>)/set_account_id(Option<String>):
required: trueThe Amazon Chime account ID.
group_names(impl Into<String>)/set_group_names(Option<Vec::<String>>):
required: trueThe sign-in delegate group names.
- On success, responds with
DisassociateSigninDelegateGroupsFromAccountOutput - On failure, responds with
SdkError<DisassociateSigninDelegateGroupsFromAccountError>
source§impl Client
impl Client
sourcepub fn get_account(&self) -> GetAccountFluentBuilder
pub fn get_account(&self) -> GetAccountFluentBuilder
Constructs a fluent builder for the GetAccount operation.
- The fluent builder is configurable:
account_id(impl Into<String>)/set_account_id(Option<String>):
required: trueThe Amazon Chime account ID.
- On success, responds with
GetAccountOutputwith field(s):account(Option<Account>):The Amazon Chime account details.
- On failure, responds with
SdkError<GetAccountError>
source§impl Client
impl Client
sourcepub fn get_account_settings(&self) -> GetAccountSettingsFluentBuilder
pub fn get_account_settings(&self) -> GetAccountSettingsFluentBuilder
Constructs a fluent builder for the GetAccountSettings operation.
- The fluent builder is configurable:
account_id(impl Into<String>)/set_account_id(Option<String>):
required: trueThe Amazon Chime account ID.
- On success, responds with
GetAccountSettingsOutputwith field(s):account_settings(Option<AccountSettings>):The Amazon Chime account settings.
- On failure, responds with
SdkError<GetAccountSettingsError>
source§impl Client
impl Client
sourcepub fn get_app_instance_retention_settings(
&self
) -> GetAppInstanceRetentionSettingsFluentBuilder
👎Deprecated: Replaced by GetAppInstanceRetentionSettings in the Amazon Chime SDK Identity Namespace
pub fn get_app_instance_retention_settings( &self ) -> GetAppInstanceRetentionSettingsFluentBuilder
Constructs a fluent builder for the GetAppInstanceRetentionSettings operation.
- The fluent builder is configurable:
app_instance_arn(impl Into<String>)/set_app_instance_arn(Option<String>):
required: trueThe ARN of the
AppInstance.
- On success, responds with
GetAppInstanceRetentionSettingsOutputwith field(s):app_instance_retention_settings(Option<AppInstanceRetentionSettings>):The retention settings for the
AppInstance.initiate_deletion_timestamp(Option<DateTime>):The timestamp representing the time at which the specified items are retained, in Epoch Seconds.
- On failure, responds with
SdkError<GetAppInstanceRetentionSettingsError>
source§impl Client
impl Client
sourcepub fn get_app_instance_streaming_configurations(
&self
) -> GetAppInstanceStreamingConfigurationsFluentBuilder
👎Deprecated: Replaced by GetAppInstanceStreamingConfigurations in the Amazon Chime SDK Messaging Namespace
pub fn get_app_instance_streaming_configurations( &self ) -> GetAppInstanceStreamingConfigurationsFluentBuilder
Constructs a fluent builder for the GetAppInstanceStreamingConfigurations operation.
- The fluent builder is configurable:
app_instance_arn(impl Into<String>)/set_app_instance_arn(Option<String>):
required: trueThe ARN of the
AppInstance.
- On success, responds with
GetAppInstanceStreamingConfigurationsOutputwith field(s):app_instance_streaming_configurations(Option<Vec::<AppInstanceStreamingConfiguration>>):The streaming settings.
- On failure, responds with
SdkError<GetAppInstanceStreamingConfigurationsError>
source§impl Client
impl Client
sourcepub fn get_attendee(&self) -> GetAttendeeFluentBuilder
👎Deprecated: Replaced by GetAttendee in the Amazon Chime SDK Meetings Namespace
pub fn get_attendee(&self) -> GetAttendeeFluentBuilder
Constructs a fluent builder for the GetAttendee operation.
- The fluent builder is configurable:
meeting_id(impl Into<String>)/set_meeting_id(Option<String>):
required: trueThe Amazon Chime SDK meeting ID.
attendee_id(impl Into<String>)/set_attendee_id(Option<String>):
required: trueThe Amazon Chime SDK attendee ID.
- On success, responds with
GetAttendeeOutputwith field(s):attendee(Option<Attendee>):The Amazon Chime SDK attendee information.
- On failure, responds with
SdkError<GetAttendeeError>
source§impl Client
impl Client
sourcepub fn get_bot(&self) -> GetBotFluentBuilder
pub fn get_bot(&self) -> GetBotFluentBuilder
Constructs a fluent builder for the GetBot operation.
- The fluent builder is configurable:
account_id(impl Into<String>)/set_account_id(Option<String>):
required: trueThe Amazon Chime account ID.
bot_id(impl Into<String>)/set_bot_id(Option<String>):
required: trueThe bot ID.
- On success, responds with
GetBotOutputwith field(s):bot(Option<Bot>):The chat bot details.
- On failure, responds with
SdkError<GetBotError>
source§impl Client
impl Client
sourcepub fn get_channel_message(&self) -> GetChannelMessageFluentBuilder
👎Deprecated: Replaced by GetChannelMessage in the Amazon Chime SDK Messaging Namespace
pub fn get_channel_message(&self) -> GetChannelMessageFluentBuilder
Constructs a fluent builder for the GetChannelMessage operation.
- The fluent builder is configurable:
channel_arn(impl Into<String>)/set_channel_arn(Option<String>):
required: trueThe ARN of the channel.
message_id(impl Into<String>)/set_message_id(Option<String>):
required: trueThe ID of the message.
chime_bearer(impl Into<String>)/set_chime_bearer(Option<String>):
required: falseThe
AppInstanceUserArnof the user that makes the API call.
- On success, responds with
GetChannelMessageOutputwith field(s):channel_message(Option<ChannelMessage>):The details of and content in the message.
- On failure, responds with
SdkError<GetChannelMessageError>
source§impl Client
impl Client
sourcepub fn get_events_configuration(&self) -> GetEventsConfigurationFluentBuilder
pub fn get_events_configuration(&self) -> GetEventsConfigurationFluentBuilder
Constructs a fluent builder for the GetEventsConfiguration operation.
- The fluent builder is configurable:
account_id(impl Into<String>)/set_account_id(Option<String>):
required: trueThe Amazon Chime account ID.
bot_id(impl Into<String>)/set_bot_id(Option<String>):
required: trueThe bot ID.
- On success, responds with
GetEventsConfigurationOutputwith field(s):events_configuration(Option<EventsConfiguration>):The events configuration details.
- On failure, responds with
SdkError<GetEventsConfigurationError>
source§impl Client
impl Client
sourcepub fn get_global_settings(&self) -> GetGlobalSettingsFluentBuilder
pub fn get_global_settings(&self) -> GetGlobalSettingsFluentBuilder
Constructs a fluent builder for the GetGlobalSettings operation.
- The fluent builder takes no input, just
sendit. - On success, responds with
GetGlobalSettingsOutputwith field(s):business_calling(Option<BusinessCallingSettings>):The Amazon Chime Business Calling settings.
voice_connector(Option<VoiceConnectorSettings>):The Amazon Chime Voice Connector settings.
- On failure, responds with
SdkError<GetGlobalSettingsError>
source§impl Client
impl Client
sourcepub fn get_media_capture_pipeline(&self) -> GetMediaCapturePipelineFluentBuilder
👎Deprecated: Replaced by GetMediaCapturePipeline in the Amazon Chime SDK Media Pipelines Namespace
pub fn get_media_capture_pipeline(&self) -> GetMediaCapturePipelineFluentBuilder
Constructs a fluent builder for the GetMediaCapturePipeline operation.
- The fluent builder is configurable:
media_pipeline_id(impl Into<String>)/set_media_pipeline_id(Option<String>):
required: trueThe ID of the pipeline that you want to get.
- On success, responds with
GetMediaCapturePipelineOutputwith field(s):media_capture_pipeline(Option<MediaCapturePipeline>):The media capture pipeline object.
- On failure, responds with
SdkError<GetMediaCapturePipelineError>
source§impl Client
impl Client
sourcepub fn get_meeting(&self) -> GetMeetingFluentBuilder
👎Deprecated: Replaced by GetMeeting in the Amazon Chime SDK Meetings Namespace
pub fn get_meeting(&self) -> GetMeetingFluentBuilder
Constructs a fluent builder for the GetMeeting operation.
- The fluent builder is configurable:
meeting_id(impl Into<String>)/set_meeting_id(Option<String>):
required: trueThe Amazon Chime SDK meeting ID.
- On success, responds with
GetMeetingOutputwith field(s):meeting(Option<Meeting>):The Amazon Chime SDK meeting information.
- On failure, responds with
SdkError<GetMeetingError>
source§impl Client
impl Client
sourcepub fn get_messaging_session_endpoint(
&self
) -> GetMessagingSessionEndpointFluentBuilder
👎Deprecated: Replaced by GetMessagingSessionEndpoint in the Amazon Chime SDK Messaging Namespace
pub fn get_messaging_session_endpoint( &self ) -> GetMessagingSessionEndpointFluentBuilder
Constructs a fluent builder for the GetMessagingSessionEndpoint operation.
- The fluent builder takes no input, just
sendit. - On success, responds with
GetMessagingSessionEndpointOutputwith field(s):endpoint(Option<MessagingSessionEndpoint>):The endpoint returned in the response.
- On failure, responds with
SdkError<GetMessagingSessionEndpointError>
source§impl Client
impl Client
sourcepub fn get_phone_number(&self) -> GetPhoneNumberFluentBuilder
pub fn get_phone_number(&self) -> GetPhoneNumberFluentBuilder
Constructs a fluent builder for the GetPhoneNumber operation.
- The fluent builder is configurable:
phone_number_id(impl Into<String>)/set_phone_number_id(Option<String>):
required: trueThe phone number ID.
- On success, responds with
GetPhoneNumberOutputwith field(s):phone_number(Option<PhoneNumber>):The phone number details.
- On failure, responds with
SdkError<GetPhoneNumberError>
source§impl Client
impl Client
sourcepub fn get_phone_number_order(&self) -> GetPhoneNumberOrderFluentBuilder
pub fn get_phone_number_order(&self) -> GetPhoneNumberOrderFluentBuilder
Constructs a fluent builder for the GetPhoneNumberOrder operation.
- The fluent builder is configurable:
phone_number_order_id(impl Into<String>)/set_phone_number_order_id(Option<String>):
required: trueThe ID for the phone number order.
- On success, responds with
GetPhoneNumberOrderOutputwith field(s):phone_number_order(Option<PhoneNumberOrder>):The phone number order details.
- On failure, responds with
SdkError<GetPhoneNumberOrderError>
source§impl Client
impl Client
sourcepub fn get_phone_number_settings(&self) -> GetPhoneNumberSettingsFluentBuilder
pub fn get_phone_number_settings(&self) -> GetPhoneNumberSettingsFluentBuilder
Constructs a fluent builder for the GetPhoneNumberSettings operation.
- The fluent builder takes no input, just
sendit. - On success, responds with
GetPhoneNumberSettingsOutputwith field(s):calling_name(Option<String>):The default outbound calling name for the account.
calling_name_updated_timestamp(Option<DateTime>):The updated outbound calling name timestamp, in ISO 8601 format.
- On failure, responds with
SdkError<GetPhoneNumberSettingsError>
source§impl Client
impl Client
sourcepub fn get_proxy_session(&self) -> GetProxySessionFluentBuilder
👎Deprecated: Replaced by GetProxySession in the Amazon Chime SDK Voice Namespace
pub fn get_proxy_session(&self) -> GetProxySessionFluentBuilder
Constructs a fluent builder for the GetProxySession operation.
- The fluent builder is configurable:
voice_connector_id(impl Into<String>)/set_voice_connector_id(Option<String>):
required: trueThe Amazon Chime voice connector ID.
proxy_session_id(impl Into<String>)/set_proxy_session_id(Option<String>):
required: trueThe proxy session ID.
- On success, responds with
GetProxySessionOutputwith field(s):proxy_session(Option<ProxySession>):The proxy session details.
- On failure, responds with
SdkError<GetProxySessionError>
source§impl Client
impl Client
sourcepub fn get_retention_settings(&self) -> GetRetentionSettingsFluentBuilder
pub fn get_retention_settings(&self) -> GetRetentionSettingsFluentBuilder
Constructs a fluent builder for the GetRetentionSettings operation.
- The fluent builder is configurable:
account_id(impl Into<String>)/set_account_id(Option<String>):
required: trueThe Amazon Chime account ID.
- On success, responds with
GetRetentionSettingsOutputwith field(s):retention_settings(Option<RetentionSettings>):The retention settings.
initiate_deletion_timestamp(Option<DateTime>):The timestamp representing the time at which the specified items are permanently deleted, in ISO 8601 format.
- On failure, responds with
SdkError<GetRetentionSettingsError>
source§impl Client
impl Client
sourcepub fn get_room(&self) -> GetRoomFluentBuilder
pub fn get_room(&self) -> GetRoomFluentBuilder
Constructs a fluent builder for the GetRoom operation.
- The fluent builder is configurable:
account_id(impl Into<String>)/set_account_id(Option<String>):
required: trueThe Amazon Chime account ID.
room_id(impl Into<String>)/set_room_id(Option<String>):
required: trueThe room ID.
- On success, responds with
GetRoomOutputwith field(s):room(Option<Room>):The room details.
- On failure, responds with
SdkError<GetRoomError>
source§impl Client
impl Client
sourcepub fn get_sip_media_application(&self) -> GetSipMediaApplicationFluentBuilder
👎Deprecated: Replaced by GetSipMediaApplication in the Amazon Chime SDK Voice Namespace
pub fn get_sip_media_application(&self) -> GetSipMediaApplicationFluentBuilder
Constructs a fluent builder for the GetSipMediaApplication operation.
- The fluent builder is configurable:
sip_media_application_id(impl Into<String>)/set_sip_media_application_id(Option<String>):
required: trueThe SIP media application ID.
- On success, responds with
GetSipMediaApplicationOutputwith field(s):sip_media_application(Option<SipMediaApplication>):The SIP media application details.
- On failure, responds with
SdkError<GetSipMediaApplicationError>
source§impl Client
impl Client
sourcepub fn get_sip_media_application_logging_configuration(
&self
) -> GetSipMediaApplicationLoggingConfigurationFluentBuilder
👎Deprecated: Replaced by GetSipMediaApplicationLoggingConfiguration in the Amazon Chime SDK Voice Namespace
pub fn get_sip_media_application_logging_configuration( &self ) -> GetSipMediaApplicationLoggingConfigurationFluentBuilder
Constructs a fluent builder for the GetSipMediaApplicationLoggingConfiguration operation.
- The fluent builder is configurable:
sip_media_application_id(impl Into<String>)/set_sip_media_application_id(Option<String>):
required: trueThe SIP media application ID.
- On success, responds with
GetSipMediaApplicationLoggingConfigurationOutputwith field(s):sip_media_application_logging_configuration(Option<SipMediaApplicationLoggingConfiguration>):The actual logging configuration.
- On failure, responds with
SdkError<GetSipMediaApplicationLoggingConfigurationError>
source§impl Client
impl Client
sourcepub fn get_sip_rule(&self) -> GetSipRuleFluentBuilder
👎Deprecated: Replaced by GetSipRule in the Amazon Chime SDK Voice Namespace
pub fn get_sip_rule(&self) -> GetSipRuleFluentBuilder
Constructs a fluent builder for the GetSipRule operation.
- The fluent builder is configurable:
sip_rule_id(impl Into<String>)/set_sip_rule_id(Option<String>):
required: trueThe SIP rule ID.
- On success, responds with
GetSipRuleOutputwith field(s):sip_rule(Option<SipRule>):The SIP rule details.
- On failure, responds with
SdkError<GetSipRuleError>
source§impl Client
impl Client
sourcepub fn get_user(&self) -> GetUserFluentBuilder
pub fn get_user(&self) -> GetUserFluentBuilder
Constructs a fluent builder for the GetUser operation.
- The fluent builder is configurable:
account_id(impl Into<String>)/set_account_id(Option<String>):
required: trueThe Amazon Chime account ID.
user_id(impl Into<String>)/set_user_id(Option<String>):
required: trueThe user ID.
- On success, responds with
GetUserOutputwith field(s):user(Option<User>):The user details.
- On failure, responds with
SdkError<GetUserError>
source§impl Client
impl Client
sourcepub fn get_user_settings(&self) -> GetUserSettingsFluentBuilder
pub fn get_user_settings(&self) -> GetUserSettingsFluentBuilder
Constructs a fluent builder for the GetUserSettings operation.
- The fluent builder is configurable:
account_id(impl Into<String>)/set_account_id(Option<String>):
required: trueThe Amazon Chime account ID.
user_id(impl Into<String>)/set_user_id(Option<String>):
required: trueThe user ID.
- On success, responds with
GetUserSettingsOutputwith field(s):user_settings(Option<UserSettings>):The user settings.
- On failure, responds with
SdkError<GetUserSettingsError>
source§impl Client
impl Client
sourcepub fn get_voice_connector(&self) -> GetVoiceConnectorFluentBuilder
👎Deprecated: Replaced by GetVoiceConnector in the Amazon Chime SDK Voice Namespace
pub fn get_voice_connector(&self) -> GetVoiceConnectorFluentBuilder
Constructs a fluent builder for the GetVoiceConnector operation.
- The fluent builder is configurable:
voice_connector_id(impl Into<String>)/set_voice_connector_id(Option<String>):
required: trueThe Amazon Chime Voice Connector ID.
- On success, responds with
GetVoiceConnectorOutputwith field(s):voice_connector(Option<VoiceConnector>):The Amazon Chime Voice Connector details.
- On failure, responds with
SdkError<GetVoiceConnectorError>
source§impl Client
impl Client
sourcepub fn get_voice_connector_emergency_calling_configuration(
&self
) -> GetVoiceConnectorEmergencyCallingConfigurationFluentBuilder
👎Deprecated: Replaced by GetVoiceConnectorEmergencyCallingConfiguration in the Amazon Chime SDK Voice Namespace
pub fn get_voice_connector_emergency_calling_configuration( &self ) -> GetVoiceConnectorEmergencyCallingConfigurationFluentBuilder
Constructs a fluent builder for the GetVoiceConnectorEmergencyCallingConfiguration operation.
- The fluent builder is configurable:
voice_connector_id(impl Into<String>)/set_voice_connector_id(Option<String>):
required: trueThe Amazon Chime Voice Connector ID.
- On success, responds with
GetVoiceConnectorEmergencyCallingConfigurationOutputwith field(s):emergency_calling_configuration(Option<EmergencyCallingConfiguration>):The emergency calling configuration details.
- On failure, responds with
SdkError<GetVoiceConnectorEmergencyCallingConfigurationError>
source§impl Client
impl Client
sourcepub fn get_voice_connector_group(&self) -> GetVoiceConnectorGroupFluentBuilder
👎Deprecated: Replaced by GetVoiceConnectorGroup in the Amazon Chime SDK Voice Namespace
pub fn get_voice_connector_group(&self) -> GetVoiceConnectorGroupFluentBuilder
Constructs a fluent builder for the GetVoiceConnectorGroup operation.
- The fluent builder is configurable:
voice_connector_group_id(impl Into<String>)/set_voice_connector_group_id(Option<String>):
required: trueThe Amazon Chime Voice Connector group ID.
- On success, responds with
GetVoiceConnectorGroupOutputwith field(s):voice_connector_group(Option<VoiceConnectorGroup>):The Amazon Chime Voice Connector group details.
- On failure, responds with
SdkError<GetVoiceConnectorGroupError>
source§impl Client
impl Client
sourcepub fn get_voice_connector_logging_configuration(
&self
) -> GetVoiceConnectorLoggingConfigurationFluentBuilder
👎Deprecated: Replaced by GetVoiceConnectorLoggingConfiguration in the Amazon Chime SDK Voice Namespace
pub fn get_voice_connector_logging_configuration( &self ) -> GetVoiceConnectorLoggingConfigurationFluentBuilder
Constructs a fluent builder for the GetVoiceConnectorLoggingConfiguration operation.
- The fluent builder is configurable:
voice_connector_id(impl Into<String>)/set_voice_connector_id(Option<String>):
required: trueThe Amazon Chime Voice Connector ID.
- On success, responds with
GetVoiceConnectorLoggingConfigurationOutputwith field(s):logging_configuration(Option<LoggingConfiguration>):The logging configuration details.
- On failure, responds with
SdkError<GetVoiceConnectorLoggingConfigurationError>
source§impl Client
impl Client
sourcepub fn get_voice_connector_origination(
&self
) -> GetVoiceConnectorOriginationFluentBuilder
👎Deprecated: Replaced by GetVoiceConnectorOrigination in the Amazon Chime SDK Voice Namespace
pub fn get_voice_connector_origination( &self ) -> GetVoiceConnectorOriginationFluentBuilder
Constructs a fluent builder for the GetVoiceConnectorOrigination operation.
- The fluent builder is configurable:
voice_connector_id(impl Into<String>)/set_voice_connector_id(Option<String>):
required: trueThe Amazon Chime Voice Connector ID.
- On success, responds with
GetVoiceConnectorOriginationOutputwith field(s):origination(Option<Origination>):The origination setting details.
- On failure, responds with
SdkError<GetVoiceConnectorOriginationError>
source§impl Client
impl Client
sourcepub fn get_voice_connector_proxy(&self) -> GetVoiceConnectorProxyFluentBuilder
👎Deprecated: Replaced by GetVoiceConnectorProxy in the Amazon Chime SDK Voice Namespace
pub fn get_voice_connector_proxy(&self) -> GetVoiceConnectorProxyFluentBuilder
Constructs a fluent builder for the GetVoiceConnectorProxy operation.
- The fluent builder is configurable:
voice_connector_id(impl Into<String>)/set_voice_connector_id(Option<String>):
required: trueThe Amazon Chime voice connector ID.
- On success, responds with
GetVoiceConnectorProxyOutputwith field(s):proxy(Option<Proxy>):The proxy configuration details.
- On failure, responds with
SdkError<GetVoiceConnectorProxyError>
source§impl Client
impl Client
sourcepub fn get_voice_connector_streaming_configuration(
&self
) -> GetVoiceConnectorStreamingConfigurationFluentBuilder
👎Deprecated: Replaced by GetVoiceConnectorStreamingConfiguration in the Amazon Chime SDK Voice Namespace
pub fn get_voice_connector_streaming_configuration( &self ) -> GetVoiceConnectorStreamingConfigurationFluentBuilder
Constructs a fluent builder for the GetVoiceConnectorStreamingConfiguration operation.
- The fluent builder is configurable:
voice_connector_id(impl Into<String>)/set_voice_connector_id(Option<String>):
required: trueThe Amazon Chime Voice Connector ID.
- On success, responds with
GetVoiceConnectorStreamingConfigurationOutputwith field(s):streaming_configuration(Option<StreamingConfiguration>):The streaming configuration details.
- On failure, responds with
SdkError<GetVoiceConnectorStreamingConfigurationError>
source§impl Client
impl Client
sourcepub fn get_voice_connector_termination(
&self
) -> GetVoiceConnectorTerminationFluentBuilder
👎Deprecated: Replaced by GetVoiceConnectorTermination in the Amazon Chime SDK Voice Namespace
pub fn get_voice_connector_termination( &self ) -> GetVoiceConnectorTerminationFluentBuilder
Constructs a fluent builder for the GetVoiceConnectorTermination operation.
- The fluent builder is configurable:
voice_connector_id(impl Into<String>)/set_voice_connector_id(Option<String>):
required: trueThe Amazon Chime Voice Connector ID.
- On success, responds with
GetVoiceConnectorTerminationOutputwith field(s):termination(Option<Termination>):The termination setting details.
- On failure, responds with
SdkError<GetVoiceConnectorTerminationError>
source§impl Client
impl Client
sourcepub fn get_voice_connector_termination_health(
&self
) -> GetVoiceConnectorTerminationHealthFluentBuilder
👎Deprecated: Replaced by GetVoiceConnectorTerminationHealth in the Amazon Chime SDK Voice Namespace
pub fn get_voice_connector_termination_health( &self ) -> GetVoiceConnectorTerminationHealthFluentBuilder
Constructs a fluent builder for the GetVoiceConnectorTerminationHealth operation.
- The fluent builder is configurable:
voice_connector_id(impl Into<String>)/set_voice_connector_id(Option<String>):
required: trueThe Amazon Chime Voice Connector ID.
- On success, responds with
GetVoiceConnectorTerminationHealthOutputwith field(s):termination_health(Option<TerminationHealth>):The termination health details.
- On failure, responds with
SdkError<GetVoiceConnectorTerminationHealthError>
source§impl Client
impl Client
sourcepub fn invite_users(&self) -> InviteUsersFluentBuilder
pub fn invite_users(&self) -> InviteUsersFluentBuilder
Constructs a fluent builder for the InviteUsers operation.
- The fluent builder is configurable:
account_id(impl Into<String>)/set_account_id(Option<String>):
required: trueThe Amazon Chime account ID.
user_email_list(impl Into<String>)/set_user_email_list(Option<Vec::<String>>):
required: trueThe user email addresses to which to send the email invitation.
user_type(UserType)/set_user_type(Option<UserType>):
required: falseThe user type.
- On success, responds with
InviteUsersOutputwith field(s):invites(Option<Vec::<Invite>>):The email invitation details.
- On failure, responds with
SdkError<InviteUsersError>
source§impl Client
impl Client
sourcepub fn list_accounts(&self) -> ListAccountsFluentBuilder
pub fn list_accounts(&self) -> ListAccountsFluentBuilder
Constructs a fluent builder for the ListAccounts operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):
required: falseAmazon Chime account name prefix with which to filter results.
user_email(impl Into<String>)/set_user_email(Option<String>):
required: falseUser email address with which to filter results.
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseThe token to use to retrieve the next page of results.
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of results to return in a single call. Defaults to 100.
- On success, responds with
ListAccountsOutputwith field(s):accounts(Option<Vec::<Account>>):List of Amazon Chime accounts and account details.
next_token(Option<String>):The token to use to retrieve the next page of results.
- On failure, responds with
SdkError<ListAccountsError>
source§impl Client
impl Client
sourcepub fn list_app_instance_admins(&self) -> ListAppInstanceAdminsFluentBuilder
👎Deprecated: Replaced by ListAppInstanceAdmins in the Amazon Chime SDK Identity Namespace
pub fn list_app_instance_admins(&self) -> ListAppInstanceAdminsFluentBuilder
Constructs a fluent builder for the ListAppInstanceAdmins operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
app_instance_arn(impl Into<String>)/set_app_instance_arn(Option<String>):
required: trueThe ARN of the
AppInstance.max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of administrators that you want to return.
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseThe token returned from previous API requests until the number of administrators is reached.
- On success, responds with
ListAppInstanceAdminsOutputwith field(s):app_instance_arn(Option<String>):The ARN of the
AppInstance.app_instance_admins(Option<Vec::<AppInstanceAdminSummary>>):The information for each administrator.
next_token(Option<String>):The token returned from previous API requests until the number of administrators is reached.
- On failure, responds with
SdkError<ListAppInstanceAdminsError>
source§impl Client
impl Client
sourcepub fn list_app_instance_users(&self) -> ListAppInstanceUsersFluentBuilder
👎Deprecated: Replaced by ListAppInstanceUsers in the Amazon Chime SDK Identity Namespace
pub fn list_app_instance_users(&self) -> ListAppInstanceUsersFluentBuilder
Constructs a fluent builder for the ListAppInstanceUsers operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
app_instance_arn(impl Into<String>)/set_app_instance_arn(Option<String>):
required: trueThe ARN of the
AppInstance.max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of requests that you want returned.
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseThe token passed by previous API calls until all requested users are returned.
- On success, responds with
ListAppInstanceUsersOutputwith field(s):app_instance_arn(Option<String>):The ARN of the
AppInstance.app_instance_users(Option<Vec::<AppInstanceUserSummary>>):The information for each requested
AppInstanceUser.next_token(Option<String>):The token passed by previous API calls until all requested users are returned.
- On failure, responds with
SdkError<ListAppInstanceUsersError>
source§impl Client
impl Client
sourcepub fn list_app_instances(&self) -> ListAppInstancesFluentBuilder
👎Deprecated: Replaced by ListAppInstances in the Amazon Chime SDK Identity Namespace
pub fn list_app_instances(&self) -> ListAppInstancesFluentBuilder
Constructs a fluent builder for the ListAppInstances operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of
AppInstances that you want to return.next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseThe token passed by previous API requests until you reach the maximum number of
AppInstances.
- On success, responds with
ListAppInstancesOutputwith field(s):app_instances(Option<Vec::<AppInstanceSummary>>):The information for each
AppInstance.next_token(Option<String>):The token passed by previous API requests until the maximum number of
AppInstances is reached.
- On failure, responds with
SdkError<ListAppInstancesError>
source§impl Client
impl Client
👎Deprecated: Attendee Tags are not supported in the Amazon Chime SDK Meetings Namespace. Update your application to remove calls to this API.
Constructs a fluent builder for the ListAttendeeTags operation.
- The fluent builder is configurable:
meeting_id(impl Into<String>)/set_meeting_id(Option<String>):
required: trueThe Amazon Chime SDK meeting ID.
attendee_id(impl Into<String>)/set_attendee_id(Option<String>):
required: trueThe Amazon Chime SDK attendee ID.
- On success, responds with
ListAttendeeTagsOutputwith field(s):tags(Option<Vec::<Tag>>):A list of tag key-value pairs.
- On failure, responds with
SdkError<ListAttendeeTagsError>
source§impl Client
impl Client
sourcepub fn list_attendees(&self) -> ListAttendeesFluentBuilder
👎Deprecated: Replaced by ListAttendees in the Amazon Chime SDK Meetings Namespace
pub fn list_attendees(&self) -> ListAttendeesFluentBuilder
Constructs a fluent builder for the ListAttendees operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
meeting_id(impl Into<String>)/set_meeting_id(Option<String>):
required: trueThe Amazon Chime SDK meeting ID.
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseThe token to use to retrieve the next page of results.
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of results to return in a single call.
- On success, responds with
ListAttendeesOutputwith field(s):attendees(Option<Vec::<Attendee>>):The Amazon Chime SDK attendee information.
next_token(Option<String>):The token to use to retrieve the next page of results.
- On failure, responds with
SdkError<ListAttendeesError>
source§impl Client
impl Client
sourcepub fn list_bots(&self) -> ListBotsFluentBuilder
pub fn list_bots(&self) -> ListBotsFluentBuilder
Constructs a fluent builder for the ListBots operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
account_id(impl Into<String>)/set_account_id(Option<String>):
required: trueThe Amazon Chime account ID.
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of results to return in a single call. The default is 10.
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseThe token to use to retrieve the next page of results.
- On success, responds with
ListBotsOutputwith field(s):bots(Option<Vec::<Bot>>):List of bots and bot details.
next_token(Option<String>):The token to use to retrieve the next page of results.
- On failure, responds with
SdkError<ListBotsError>
source§impl Client
impl Client
sourcepub fn list_channel_bans(&self) -> ListChannelBansFluentBuilder
👎Deprecated: Replaced by ListChannelBans in the Amazon Chime SDK Messaging Namespace
pub fn list_channel_bans(&self) -> ListChannelBansFluentBuilder
Constructs a fluent builder for the ListChannelBans operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
channel_arn(impl Into<String>)/set_channel_arn(Option<String>):
required: trueThe ARN of the channel.
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of bans that you want returned.
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseThe token passed by previous API calls until all requested bans are returned.
chime_bearer(impl Into<String>)/set_chime_bearer(Option<String>):
required: falseThe
AppInstanceUserArnof the user that makes the API call.
- On success, responds with
ListChannelBansOutputwith field(s):channel_arn(Option<String>):The ARN of the channel.
next_token(Option<String>):The token passed by previous API calls until all requested bans are returned.
channel_bans(Option<Vec::<ChannelBanSummary>>):The information for each requested ban.
- On failure, responds with
SdkError<ListChannelBansError>
source§impl Client
impl Client
sourcepub fn list_channel_memberships(&self) -> ListChannelMembershipsFluentBuilder
👎Deprecated: Replaced by ListChannelMemberships in the Amazon Chime SDK Messaging Namespace
pub fn list_channel_memberships(&self) -> ListChannelMembershipsFluentBuilder
Constructs a fluent builder for the ListChannelMemberships operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
channel_arn(impl Into<String>)/set_channel_arn(Option<String>):
required: trueThe maximum number of channel memberships that you want returned.
r#type(ChannelMembershipType)/set_type(Option<ChannelMembershipType>):
required: falseThe membership type of a user,
DEFAULTorHIDDEN. Default members are always returned as part ofListChannelMemberships. Hidden members are only returned if the type filter inListChannelMembershipsequalsHIDDEN. Otherwise hidden members are not returned.max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of channel memberships that you want returned.
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseThe token passed by previous API calls until all requested channel memberships are returned.
chime_bearer(impl Into<String>)/set_chime_bearer(Option<String>):
required: falseThe
AppInstanceUserArnof the user that makes the API call.
- On success, responds with
ListChannelMembershipsOutputwith field(s):channel_arn(Option<String>):The ARN of the channel.
channel_memberships(Option<Vec::<ChannelMembershipSummary>>):The information for the requested channel memberships.
next_token(Option<String>):The token passed by previous API calls until all requested channel memberships are returned.
- On failure, responds with
SdkError<ListChannelMembershipsError>
source§impl Client
impl Client
sourcepub fn list_channel_memberships_for_app_instance_user(
&self
) -> ListChannelMembershipsForAppInstanceUserFluentBuilder
👎Deprecated: Replaced by ListChannelMembershipsForAppInstanceUser in the Amazon Chime SDK Messaging Namespace
pub fn list_channel_memberships_for_app_instance_user( &self ) -> ListChannelMembershipsForAppInstanceUserFluentBuilder
Constructs a fluent builder for the ListChannelMembershipsForAppInstanceUser operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
app_instance_user_arn(impl Into<String>)/set_app_instance_user_arn(Option<String>):
required: falseThe ARN of the
AppInstanceUsersmax_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of users that you want returned.
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseThe token returned from previous API requests until the number of channel memberships is reached.
chime_bearer(impl Into<String>)/set_chime_bearer(Option<String>):
required: falseThe
AppInstanceUserArnof the user that makes the API call.
- On success, responds with
ListChannelMembershipsForAppInstanceUserOutputwith field(s):channel_memberships(Option<Vec::<ChannelMembershipForAppInstanceUserSummary>>):The information for the requested channel memberships.
next_token(Option<String>):The token passed by previous API calls until all requested users are returned.
- On failure, responds with
SdkError<ListChannelMembershipsForAppInstanceUserError>
source§impl Client
impl Client
sourcepub fn list_channel_messages(&self) -> ListChannelMessagesFluentBuilder
👎Deprecated: Replaced by ListChannelMessages in the Amazon Chime SDK Messaging Namespace
pub fn list_channel_messages(&self) -> ListChannelMessagesFluentBuilder
Constructs a fluent builder for the ListChannelMessages operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
channel_arn(impl Into<String>)/set_channel_arn(Option<String>):
required: trueThe ARN of the channel.
sort_order(SortOrder)/set_sort_order(Option<SortOrder>):
required: falseThe order in which you want messages sorted. Default is Descending, based on time created.
not_before(DateTime)/set_not_before(Option<DateTime>):
required: falseThe initial or starting time stamp for your requested messages.
not_after(DateTime)/set_not_after(Option<DateTime>):
required: falseThe final or ending time stamp for your requested messages.
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of messages that you want returned.
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseThe token passed by previous API calls until all requested messages are returned.
chime_bearer(impl Into<String>)/set_chime_bearer(Option<String>):
required: falseThe
AppInstanceUserArnof the user that makes the API call.
- On success, responds with
ListChannelMessagesOutputwith field(s):channel_arn(Option<String>):The ARN of the channel containing the requested messages.
next_token(Option<String>):The token passed by previous API calls until all requested messages are returned.
channel_messages(Option<Vec::<ChannelMessageSummary>>):The information about, and content of, each requested message.
- On failure, responds with
SdkError<ListChannelMessagesError>
source§impl Client
impl Client
sourcepub fn list_channel_moderators(&self) -> ListChannelModeratorsFluentBuilder
👎Deprecated: Replaced by ListChannelModerators in the Amazon Chime SDK Messaging Namespace
pub fn list_channel_moderators(&self) -> ListChannelModeratorsFluentBuilder
Constructs a fluent builder for the ListChannelModerators operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
channel_arn(impl Into<String>)/set_channel_arn(Option<String>):
required: trueThe ARN of the channel.
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of moderators that you want returned.
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseThe token passed by previous API calls until all requested moderators are returned.
chime_bearer(impl Into<String>)/set_chime_bearer(Option<String>):
required: falseThe
AppInstanceUserArnof the user that makes the API call.
- On success, responds with
ListChannelModeratorsOutputwith field(s):channel_arn(Option<String>):The ARN of the channel.
next_token(Option<String>):The token passed by previous API calls until all requested moderators are returned.
channel_moderators(Option<Vec::<ChannelModeratorSummary>>):The information about and names of each moderator.
- On failure, responds with
SdkError<ListChannelModeratorsError>
source§impl Client
impl Client
sourcepub fn list_channels(&self) -> ListChannelsFluentBuilder
👎Deprecated: Replaced by ListChannels in the Amazon Chime SDK Messaging Namespace
pub fn list_channels(&self) -> ListChannelsFluentBuilder
Constructs a fluent builder for the ListChannels operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
app_instance_arn(impl Into<String>)/set_app_instance_arn(Option<String>):
required: trueThe ARN of the
AppInstance.privacy(ChannelPrivacy)/set_privacy(Option<ChannelPrivacy>):
required: falseThe privacy setting.
PUBLICretrieves all the public channels.PRIVATEretrieves private channels. Only anAppInstanceAdmincan retrieve private channels.max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of channels that you want to return.
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseThe token passed by previous API calls until all requested channels are returned.
chime_bearer(impl Into<String>)/set_chime_bearer(Option<String>):
required: falseThe
AppInstanceUserArnof the user that makes the API call.
- On success, responds with
ListChannelsOutputwith field(s):channels(Option<Vec::<ChannelSummary>>):The information about each channel.
next_token(Option<String>):The token returned from previous API requests until the number of channels is reached.
- On failure, responds with
SdkError<ListChannelsError>
source§impl Client
impl Client
sourcepub fn list_channels_moderated_by_app_instance_user(
&self
) -> ListChannelsModeratedByAppInstanceUserFluentBuilder
👎Deprecated: Replaced by ListChannelsModeratedByAppInstanceUser in the Amazon Chime SDK Messaging Namespace
pub fn list_channels_moderated_by_app_instance_user( &self ) -> ListChannelsModeratedByAppInstanceUserFluentBuilder
Constructs a fluent builder for the ListChannelsModeratedByAppInstanceUser operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
app_instance_user_arn(impl Into<String>)/set_app_instance_user_arn(Option<String>):
required: falseThe ARN of the user in the moderated channel.
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of channels in the request.
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseThe token returned from previous API requests until the number of channels moderated by the user is reached.
chime_bearer(impl Into<String>)/set_chime_bearer(Option<String>):
required: falseThe
AppInstanceUserArnof the user that makes the API call.
- On success, responds with
ListChannelsModeratedByAppInstanceUserOutputwith field(s):channels(Option<Vec::<ChannelModeratedByAppInstanceUserSummary>>):The moderated channels in the request.
next_token(Option<String>):The token returned from previous API requests until the number of channels moderated by the user is reached.
- On failure, responds with
SdkError<ListChannelsModeratedByAppInstanceUserError>
source§impl Client
impl Client
sourcepub fn list_media_capture_pipelines(
&self
) -> ListMediaCapturePipelinesFluentBuilder
👎Deprecated: Replaced by ListMediaCapturePipelines in the Amazon Chime SDK Media Pipelines Namespace
pub fn list_media_capture_pipelines( &self ) -> ListMediaCapturePipelinesFluentBuilder
Constructs a fluent builder for the ListMediaCapturePipelines 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 token used to retrieve the next page of results.
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of results to return in a single call. Valid Range: 1 - 99.
- On success, responds with
ListMediaCapturePipelinesOutputwith field(s):media_capture_pipelines(Option<Vec::<MediaCapturePipeline>>):The media capture pipeline objects in the list.
next_token(Option<String>):The token used to retrieve the next page of results.
- On failure, responds with
SdkError<ListMediaCapturePipelinesError>
source§impl Client
impl Client
👎Deprecated: Use ListTagsForResource in the Amazon Chime SDK Meetings Namespace.
Constructs a fluent builder for the ListMeetingTags operation.
- The fluent builder is configurable:
meeting_id(impl Into<String>)/set_meeting_id(Option<String>):
required: trueThe Amazon Chime SDK meeting ID.
- On success, responds with
ListMeetingTagsOutputwith field(s):tags(Option<Vec::<Tag>>):A list of tag key-value pairs.
- On failure, responds with
SdkError<ListMeetingTagsError>
source§impl Client
impl Client
sourcepub fn list_meetings(&self) -> ListMeetingsFluentBuilder
👎Deprecated: ListMeetings is not supported in the Amazon Chime SDK Meetings Namespace. Update your application to remove calls to this API.
pub fn list_meetings(&self) -> ListMeetingsFluentBuilder
Constructs a fluent builder for the ListMeetings 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 token to use to retrieve the next page of results.
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of results to return in a single call.
- On success, responds with
ListMeetingsOutputwith field(s):meetings(Option<Vec::<Meeting>>):The Amazon Chime SDK meeting information.
next_token(Option<String>):The token to use to retrieve the next page of results.
- On failure, responds with
SdkError<ListMeetingsError>
source§impl Client
impl Client
sourcepub fn list_phone_number_orders(&self) -> ListPhoneNumberOrdersFluentBuilder
pub fn list_phone_number_orders(&self) -> ListPhoneNumberOrdersFluentBuilder
Constructs a fluent builder for the ListPhoneNumberOrders 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 token to use to retrieve the next page of results.
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of results to return in a single call.
- On success, responds with
ListPhoneNumberOrdersOutputwith field(s):phone_number_orders(Option<Vec::<PhoneNumberOrder>>):The phone number order details.
next_token(Option<String>):The token to use to retrieve the next page of results.
- On failure, responds with
SdkError<ListPhoneNumberOrdersError>
source§impl Client
impl Client
sourcepub fn list_phone_numbers(&self) -> ListPhoneNumbersFluentBuilder
pub fn list_phone_numbers(&self) -> ListPhoneNumbersFluentBuilder
Constructs a fluent builder for the ListPhoneNumbers operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
status(PhoneNumberStatus)/set_status(Option<PhoneNumberStatus>):
required: falseThe phone number status.
product_type(PhoneNumberProductType)/set_product_type(Option<PhoneNumberProductType>):
required: falseThe phone number product type.
filter_name(PhoneNumberAssociationName)/set_filter_name(Option<PhoneNumberAssociationName>):
required: falseThe filter to use to limit the number of results.
filter_value(impl Into<String>)/set_filter_value(Option<String>):
required: falseThe value to use for the filter.
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of results to return in a single call.
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseThe token to use to retrieve the next page of results.
- On success, responds with
ListPhoneNumbersOutputwith field(s):phone_numbers(Option<Vec::<PhoneNumber>>):The phone number details.
next_token(Option<String>):The token to use to retrieve the next page of results.
- On failure, responds with
SdkError<ListPhoneNumbersError>
source§impl Client
impl Client
sourcepub fn list_proxy_sessions(&self) -> ListProxySessionsFluentBuilder
👎Deprecated: Replaced by ListProxySessions in the Amazon Chime SDK Voice Namespace
pub fn list_proxy_sessions(&self) -> ListProxySessionsFluentBuilder
Constructs a fluent builder for the ListProxySessions operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
voice_connector_id(impl Into<String>)/set_voice_connector_id(Option<String>):
required: trueThe Amazon Chime voice connector ID.
status(ProxySessionStatus)/set_status(Option<ProxySessionStatus>):
required: falseThe proxy session status.
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseThe token to use to retrieve the next page of results.
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of results to return in a single call.
- On success, responds with
ListProxySessionsOutputwith field(s):proxy_sessions(Option<Vec::<ProxySession>>):The proxy session details.
next_token(Option<String>):The token to use to retrieve the next page of results.
- On failure, responds with
SdkError<ListProxySessionsError>
source§impl Client
impl Client
sourcepub fn list_room_memberships(&self) -> ListRoomMembershipsFluentBuilder
pub fn list_room_memberships(&self) -> ListRoomMembershipsFluentBuilder
Constructs a fluent builder for the ListRoomMemberships operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
account_id(impl Into<String>)/set_account_id(Option<String>):
required: trueThe Amazon Chime account ID.
room_id(impl Into<String>)/set_room_id(Option<String>):
required: trueThe room ID.
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of results to return in a single call.
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseThe token to use to retrieve the next page of results.
- On success, responds with
ListRoomMembershipsOutputwith field(s):room_memberships(Option<Vec::<RoomMembership>>):The room membership details.
next_token(Option<String>):The token to use to retrieve the next page of results.
- On failure, responds with
SdkError<ListRoomMembershipsError>
source§impl Client
impl Client
sourcepub fn list_rooms(&self) -> ListRoomsFluentBuilder
pub fn list_rooms(&self) -> ListRoomsFluentBuilder
Constructs a fluent builder for the ListRooms operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
account_id(impl Into<String>)/set_account_id(Option<String>):
required: trueThe Amazon Chime account ID.
member_id(impl Into<String>)/set_member_id(Option<String>):
required: falseThe member ID (user ID or bot ID).
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of results to return in a single call.
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseThe token to use to retrieve the next page of results.
- On success, responds with
ListRoomsOutputwith field(s):rooms(Option<Vec::<Room>>):The room details.
next_token(Option<String>):The token to use to retrieve the next page of results.
- On failure, responds with
SdkError<ListRoomsError>
source§impl Client
impl Client
sourcepub fn list_sip_media_applications(
&self
) -> ListSipMediaApplicationsFluentBuilder
👎Deprecated: Replaced by ListSipMediaApplications in the Amazon Chime SDK Voice Namespace
pub fn list_sip_media_applications( &self ) -> ListSipMediaApplicationsFluentBuilder
Constructs a fluent builder for the ListSipMediaApplications operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of results to return in a single call. Defaults to 100.
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseThe token to use to retrieve the next page of results.
- On success, responds with
ListSipMediaApplicationsOutputwith field(s):sip_media_applications(Option<Vec::<SipMediaApplication>>):List of SIP media applications and application details.
next_token(Option<String>):The token to use to retrieve the next page of results.
- On failure, responds with
SdkError<ListSipMediaApplicationsError>
source§impl Client
impl Client
sourcepub fn list_sip_rules(&self) -> ListSipRulesFluentBuilder
👎Deprecated: Replaced by ListSipRules in the Amazon Chime SDK Voice Namespace
pub fn list_sip_rules(&self) -> ListSipRulesFluentBuilder
Constructs a fluent builder for the ListSipRules operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
sip_media_application_id(impl Into<String>)/set_sip_media_application_id(Option<String>):
required: falseThe SIP media application ID.
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of results to return in a single call. Defaults to 100.
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseThe token to use to retrieve the next page of results.
- On success, responds with
ListSipRulesOutputwith field(s):sip_rules(Option<Vec::<SipRule>>):List of SIP rules and rule details.
next_token(Option<String>):The token to use to retrieve the next page of results.
- On failure, responds with
SdkError<ListSipRulesError>
source§impl Client
impl Client
sourcepub fn list_supported_phone_number_countries(
&self
) -> ListSupportedPhoneNumberCountriesFluentBuilder
pub fn list_supported_phone_number_countries( &self ) -> ListSupportedPhoneNumberCountriesFluentBuilder
Constructs a fluent builder for the ListSupportedPhoneNumberCountries operation.
- The fluent builder is configurable:
product_type(PhoneNumberProductType)/set_product_type(Option<PhoneNumberProductType>):
required: trueThe phone number product type.
- On success, responds with
ListSupportedPhoneNumberCountriesOutputwith field(s):phone_number_countries(Option<Vec::<PhoneNumberCountry>>):The supported phone number countries.
- On failure, responds with
SdkError<ListSupportedPhoneNumberCountriesError>
source§impl Client
impl Client
👎Deprecated: Replaced by ListTagsForResource in the Amazon Chime SDK Voice, Amazon Chime SDK Meetings, Amazon Chime SDK Identity, Amazon Chime SDK Messaging, and Amazon Chime SDK Media Pipelines Namespaces
Constructs a fluent builder for the ListTagsForResource operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)/set_resource_arn(Option<String>):
required: trueThe resource ARN.
- On success, responds with
ListTagsForResourceOutputwith field(s):tags(Option<Vec::<Tag>>):A list of tag-key value pairs.
- On failure, responds with
SdkError<ListTagsForResourceError>
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:
account_id(impl Into<String>)/set_account_id(Option<String>):
required: trueThe Amazon Chime account ID.
user_email(impl Into<String>)/set_user_email(Option<String>):
required: falseOptional. The user email address used to filter results. Maximum 1.
user_type(UserType)/set_user_type(Option<UserType>):
required: falseThe user type.
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of results to return in a single call. Defaults to 100.
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseThe token to use to retrieve the next page of results.
- On success, responds with
ListUsersOutputwith field(s):users(Option<Vec::<User>>):List of users and user details.
next_token(Option<String>):The token to use to retrieve the next page of results.
- On failure, responds with
SdkError<ListUsersError>
source§impl Client
impl Client
sourcepub fn list_voice_connector_groups(
&self
) -> ListVoiceConnectorGroupsFluentBuilder
👎Deprecated: Replaced by ListVoiceConnectorGroups in the Amazon Chime SDK Voice Namespace
pub fn list_voice_connector_groups( &self ) -> ListVoiceConnectorGroupsFluentBuilder
Constructs a fluent builder for the ListVoiceConnectorGroups 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 token to use to retrieve the next page of results.
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of results to return in a single call.
- On success, responds with
ListVoiceConnectorGroupsOutputwith field(s):voice_connector_groups(Option<Vec::<VoiceConnectorGroup>>):The details of the Amazon Chime Voice Connector groups.
next_token(Option<String>):The token to use to retrieve the next page of results.
- On failure, responds with
SdkError<ListVoiceConnectorGroupsError>
source§impl Client
impl Client
sourcepub fn list_voice_connector_termination_credentials(
&self
) -> ListVoiceConnectorTerminationCredentialsFluentBuilder
👎Deprecated: Replaced by ListVoiceConnectorTerminationCredentials in the Amazon Chime SDK Voice Namespace
pub fn list_voice_connector_termination_credentials( &self ) -> ListVoiceConnectorTerminationCredentialsFluentBuilder
Constructs a fluent builder for the ListVoiceConnectorTerminationCredentials operation.
- The fluent builder is configurable:
voice_connector_id(impl Into<String>)/set_voice_connector_id(Option<String>):
required: trueThe Amazon Chime Voice Connector ID.
- On success, responds with
ListVoiceConnectorTerminationCredentialsOutputwith field(s):usernames(Option<Vec::<String>>):A list of user names.
- On failure, responds with
SdkError<ListVoiceConnectorTerminationCredentialsError>
source§impl Client
impl Client
sourcepub fn list_voice_connectors(&self) -> ListVoiceConnectorsFluentBuilder
👎Deprecated: Replaced by ListVoiceConnectors in the Amazon Chime SDK Voice Namespace
pub fn list_voice_connectors(&self) -> ListVoiceConnectorsFluentBuilder
Constructs a fluent builder for the ListVoiceConnectors 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 token to use to retrieve the next page of results.
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of results to return in a single call.
- On success, responds with
ListVoiceConnectorsOutputwith field(s):voice_connectors(Option<Vec::<VoiceConnector>>):The details of the Amazon Chime Voice Connectors.
next_token(Option<String>):The token to use to retrieve the next page of results.
- On failure, responds with
SdkError<ListVoiceConnectorsError>
source§impl Client
impl Client
sourcepub fn logout_user(&self) -> LogoutUserFluentBuilder
pub fn logout_user(&self) -> LogoutUserFluentBuilder
Constructs a fluent builder for the LogoutUser operation.
- The fluent builder is configurable:
account_id(impl Into<String>)/set_account_id(Option<String>):
required: trueThe Amazon Chime account ID.
user_id(impl Into<String>)/set_user_id(Option<String>):
required: trueThe user ID.
- On success, responds with
LogoutUserOutput - On failure, responds with
SdkError<LogoutUserError>
source§impl Client
impl Client
sourcepub fn put_app_instance_retention_settings(
&self
) -> PutAppInstanceRetentionSettingsFluentBuilder
👎Deprecated: Replaced by PutAppInstanceRetentionSettings in the Amazon Chime SDK Identity Namespace
pub fn put_app_instance_retention_settings( &self ) -> PutAppInstanceRetentionSettingsFluentBuilder
Constructs a fluent builder for the PutAppInstanceRetentionSettings operation.
- The fluent builder is configurable:
app_instance_arn(impl Into<String>)/set_app_instance_arn(Option<String>):
required: trueThe ARN of the
AppInstance.app_instance_retention_settings(AppInstanceRetentionSettings)/set_app_instance_retention_settings(Option<AppInstanceRetentionSettings>):
required: trueThe time in days to retain data. Data type: number.
- On success, responds with
PutAppInstanceRetentionSettingsOutputwith field(s):app_instance_retention_settings(Option<AppInstanceRetentionSettings>):The time in days to retain data. Data type: number.
initiate_deletion_timestamp(Option<DateTime>):The time at which the API deletes data.
- On failure, responds with
SdkError<PutAppInstanceRetentionSettingsError>
source§impl Client
impl Client
sourcepub fn put_app_instance_streaming_configurations(
&self
) -> PutAppInstanceStreamingConfigurationsFluentBuilder
👎Deprecated: Replaced by PutAppInstanceStreamingConfigurations in the Amazon Chime SDK Messaging Namespace
pub fn put_app_instance_streaming_configurations( &self ) -> PutAppInstanceStreamingConfigurationsFluentBuilder
Constructs a fluent builder for the PutAppInstanceStreamingConfigurations operation.
- The fluent builder is configurable:
app_instance_arn(impl Into<String>)/set_app_instance_arn(Option<String>):
required: trueThe ARN of the
AppInstance.app_instance_streaming_configurations(AppInstanceStreamingConfiguration)/set_app_instance_streaming_configurations(Option<Vec::<AppInstanceStreamingConfiguration>>):
required: trueThe streaming configurations set for an
AppInstance.
- On success, responds with
PutAppInstanceStreamingConfigurationsOutputwith field(s):app_instance_streaming_configurations(Option<Vec::<AppInstanceStreamingConfiguration>>):The streaming configurations of an
AppInstance.
- On failure, responds with
SdkError<PutAppInstanceStreamingConfigurationsError>
source§impl Client
impl Client
sourcepub fn put_events_configuration(&self) -> PutEventsConfigurationFluentBuilder
pub fn put_events_configuration(&self) -> PutEventsConfigurationFluentBuilder
Constructs a fluent builder for the PutEventsConfiguration operation.
- The fluent builder is configurable:
account_id(impl Into<String>)/set_account_id(Option<String>):
required: trueThe Amazon Chime account ID.
bot_id(impl Into<String>)/set_bot_id(Option<String>):
required: trueThe bot ID.
outbound_events_https_endpoint(impl Into<String>)/set_outbound_events_https_endpoint(Option<String>):
required: falseHTTPS endpoint that allows the bot to receive outgoing events.
lambda_function_arn(impl Into<String>)/set_lambda_function_arn(Option<String>):
required: falseLambda function ARN that allows the bot to receive outgoing events.
- On success, responds with
PutEventsConfigurationOutputwith field(s):events_configuration(Option<EventsConfiguration>):The configuration that allows a bot to receive outgoing events. Can be an HTTPS endpoint or an AWS Lambda function ARN.
- On failure, responds with
SdkError<PutEventsConfigurationError>
source§impl Client
impl Client
sourcepub fn put_retention_settings(&self) -> PutRetentionSettingsFluentBuilder
pub fn put_retention_settings(&self) -> PutRetentionSettingsFluentBuilder
Constructs a fluent builder for the PutRetentionSettings operation.
- The fluent builder is configurable:
account_id(impl Into<String>)/set_account_id(Option<String>):
required: trueThe Amazon Chime account ID.
retention_settings(RetentionSettings)/set_retention_settings(Option<RetentionSettings>):
required: trueThe retention settings.
- On success, responds with
PutRetentionSettingsOutputwith field(s):retention_settings(Option<RetentionSettings>):The retention settings.
initiate_deletion_timestamp(Option<DateTime>):The timestamp representing the time at which the specified items are permanently deleted, in ISO 8601 format.
- On failure, responds with
SdkError<PutRetentionSettingsError>
source§impl Client
impl Client
sourcepub fn put_sip_media_application_logging_configuration(
&self
) -> PutSipMediaApplicationLoggingConfigurationFluentBuilder
👎Deprecated: Replaced by PutSipMediaApplicationLoggingConfiguration in the Amazon Chime SDK Voice Namespace
pub fn put_sip_media_application_logging_configuration( &self ) -> PutSipMediaApplicationLoggingConfigurationFluentBuilder
Constructs a fluent builder for the PutSipMediaApplicationLoggingConfiguration operation.
- The fluent builder is configurable:
sip_media_application_id(impl Into<String>)/set_sip_media_application_id(Option<String>):
required: trueThe SIP media application ID.
sip_media_application_logging_configuration(SipMediaApplicationLoggingConfiguration)/set_sip_media_application_logging_configuration(Option<SipMediaApplicationLoggingConfiguration>):
required: falseThe actual logging configuration.
- On success, responds with
PutSipMediaApplicationLoggingConfigurationOutputwith field(s):sip_media_application_logging_configuration(Option<SipMediaApplicationLoggingConfiguration>):The logging configuration of the SIP media application.
- On failure, responds with
SdkError<PutSipMediaApplicationLoggingConfigurationError>
source§impl Client
impl Client
sourcepub fn put_voice_connector_emergency_calling_configuration(
&self
) -> PutVoiceConnectorEmergencyCallingConfigurationFluentBuilder
👎Deprecated: Replaced by PutVoiceConnectorEmergencyCallingConfiguration in the Amazon Chime SDK Voice Namespace
pub fn put_voice_connector_emergency_calling_configuration( &self ) -> PutVoiceConnectorEmergencyCallingConfigurationFluentBuilder
Constructs a fluent builder for the PutVoiceConnectorEmergencyCallingConfiguration operation.
- The fluent builder is configurable:
voice_connector_id(impl Into<String>)/set_voice_connector_id(Option<String>):
required: trueThe Amazon Chime Voice Connector ID.
emergency_calling_configuration(EmergencyCallingConfiguration)/set_emergency_calling_configuration(Option<EmergencyCallingConfiguration>):
required: trueThe emergency calling configuration details.
- On success, responds with
PutVoiceConnectorEmergencyCallingConfigurationOutputwith field(s):emergency_calling_configuration(Option<EmergencyCallingConfiguration>):The emergency calling configuration details.
- On failure, responds with
SdkError<PutVoiceConnectorEmergencyCallingConfigurationError>
source§impl Client
impl Client
sourcepub fn put_voice_connector_logging_configuration(
&self
) -> PutVoiceConnectorLoggingConfigurationFluentBuilder
👎Deprecated: Replaced by PutVoiceConnectorLoggingConfiguration in the Amazon Chime SDK Voice Namespace
pub fn put_voice_connector_logging_configuration( &self ) -> PutVoiceConnectorLoggingConfigurationFluentBuilder
Constructs a fluent builder for the PutVoiceConnectorLoggingConfiguration operation.
- The fluent builder is configurable:
voice_connector_id(impl Into<String>)/set_voice_connector_id(Option<String>):
required: trueThe Amazon Chime Voice Connector ID.
logging_configuration(LoggingConfiguration)/set_logging_configuration(Option<LoggingConfiguration>):
required: trueThe logging configuration details to add.
- On success, responds with
PutVoiceConnectorLoggingConfigurationOutputwith field(s):logging_configuration(Option<LoggingConfiguration>):The updated logging configuration details.
- On failure, responds with
SdkError<PutVoiceConnectorLoggingConfigurationError>
source§impl Client
impl Client
sourcepub fn put_voice_connector_origination(
&self
) -> PutVoiceConnectorOriginationFluentBuilder
👎Deprecated: Replaced by PutVoiceConnectorOrigination in the Amazon Chime SDK Voice Namespace
pub fn put_voice_connector_origination( &self ) -> PutVoiceConnectorOriginationFluentBuilder
Constructs a fluent builder for the PutVoiceConnectorOrigination operation.
- The fluent builder is configurable:
voice_connector_id(impl Into<String>)/set_voice_connector_id(Option<String>):
required: trueThe Amazon Chime Voice Connector ID.
origination(Origination)/set_origination(Option<Origination>):
required: trueThe origination setting details to add.
- On success, responds with
PutVoiceConnectorOriginationOutputwith field(s):origination(Option<Origination>):The updated origination setting details.
- On failure, responds with
SdkError<PutVoiceConnectorOriginationError>
source§impl Client
impl Client
sourcepub fn put_voice_connector_proxy(&self) -> PutVoiceConnectorProxyFluentBuilder
👎Deprecated: Replaced by PutVoiceConnectorProxy in the Amazon Chime SDK Voice Namespace
pub fn put_voice_connector_proxy(&self) -> PutVoiceConnectorProxyFluentBuilder
Constructs a fluent builder for the PutVoiceConnectorProxy operation.
- The fluent builder is configurable:
voice_connector_id(impl Into<String>)/set_voice_connector_id(Option<String>):
required: trueThe Amazon Chime voice connector ID.
default_session_expiry_minutes(i32)/set_default_session_expiry_minutes(Option<i32>):
required: trueThe default number of minutes allowed for proxy sessions.
phone_number_pool_countries(impl Into<String>)/set_phone_number_pool_countries(Option<Vec::<String>>):
required: trueThe countries for proxy phone numbers to be selected from.
fall_back_phone_number(impl Into<String>)/set_fall_back_phone_number(Option<String>):
required: falseThe phone number to route calls to after a proxy session expires.
disabled(bool)/set_disabled(Option<bool>):
required: falseWhen true, stops proxy sessions from being created on the specified Amazon Chime Voice Connector.
- On success, responds with
PutVoiceConnectorProxyOutputwith field(s):proxy(Option<Proxy>):The proxy configuration details.
- On failure, responds with
SdkError<PutVoiceConnectorProxyError>
source§impl Client
impl Client
sourcepub fn put_voice_connector_streaming_configuration(
&self
) -> PutVoiceConnectorStreamingConfigurationFluentBuilder
👎Deprecated: Replaced by PutVoiceConnectorStreamingConfiguration in the Amazon Chime SDK Voice Namespace
pub fn put_voice_connector_streaming_configuration( &self ) -> PutVoiceConnectorStreamingConfigurationFluentBuilder
Constructs a fluent builder for the PutVoiceConnectorStreamingConfiguration operation.
- The fluent builder is configurable:
voice_connector_id(impl Into<String>)/set_voice_connector_id(Option<String>):
required: trueThe Amazon Chime Voice Connector ID.
streaming_configuration(StreamingConfiguration)/set_streaming_configuration(Option<StreamingConfiguration>):
required: trueThe streaming configuration details to add.
- On success, responds with
PutVoiceConnectorStreamingConfigurationOutputwith field(s):streaming_configuration(Option<StreamingConfiguration>):The updated streaming configuration details.
- On failure, responds with
SdkError<PutVoiceConnectorStreamingConfigurationError>
source§impl Client
impl Client
sourcepub fn put_voice_connector_termination(
&self
) -> PutVoiceConnectorTerminationFluentBuilder
👎Deprecated: Replaced by PutVoiceConnectorTermination in the Amazon Chime SDK Voice Namespace
pub fn put_voice_connector_termination( &self ) -> PutVoiceConnectorTerminationFluentBuilder
Constructs a fluent builder for the PutVoiceConnectorTermination operation.
- The fluent builder is configurable:
voice_connector_id(impl Into<String>)/set_voice_connector_id(Option<String>):
required: trueThe Amazon Chime Voice Connector ID.
termination(Termination)/set_termination(Option<Termination>):
required: trueThe termination setting details to add.
- On success, responds with
PutVoiceConnectorTerminationOutputwith field(s):termination(Option<Termination>):The updated termination setting details.
- On failure, responds with
SdkError<PutVoiceConnectorTerminationError>
source§impl Client
impl Client
sourcepub fn put_voice_connector_termination_credentials(
&self
) -> PutVoiceConnectorTerminationCredentialsFluentBuilder
👎Deprecated: Replaced by PutVoiceConnectorTerminationCredentials in the Amazon Chime SDK Voice Namespace
pub fn put_voice_connector_termination_credentials( &self ) -> PutVoiceConnectorTerminationCredentialsFluentBuilder
Constructs a fluent builder for the PutVoiceConnectorTerminationCredentials operation.
- The fluent builder is configurable:
voice_connector_id(impl Into<String>)/set_voice_connector_id(Option<String>):
required: trueThe Amazon Chime Voice Connector ID.
credentials(Credential)/set_credentials(Option<Vec::<Credential>>):
required: falseThe termination SIP credentials.
- On success, responds with
PutVoiceConnectorTerminationCredentialsOutput - On failure, responds with
SdkError<PutVoiceConnectorTerminationCredentialsError>
source§impl Client
impl Client
sourcepub fn redact_channel_message(&self) -> RedactChannelMessageFluentBuilder
👎Deprecated: Replaced by RedactChannelMessage in the Amazon Chime SDK Messaging Namespace
pub fn redact_channel_message(&self) -> RedactChannelMessageFluentBuilder
Constructs a fluent builder for the RedactChannelMessage operation.
- The fluent builder is configurable:
channel_arn(impl Into<String>)/set_channel_arn(Option<String>):
required: trueThe ARN of the channel containing the messages that you want to redact.
message_id(impl Into<String>)/set_message_id(Option<String>):
required: trueThe ID of the message being redacted.
chime_bearer(impl Into<String>)/set_chime_bearer(Option<String>):
required: falseThe
AppInstanceUserArnof the user that makes the API call.
- On success, responds with
RedactChannelMessageOutputwith field(s):channel_arn(Option<String>):The ARN of the channel containing the messages that you want to redact.
message_id(Option<String>):The ID of the message being redacted.
- On failure, responds with
SdkError<RedactChannelMessageError>
source§impl Client
impl Client
sourcepub fn redact_conversation_message(
&self
) -> RedactConversationMessageFluentBuilder
pub fn redact_conversation_message( &self ) -> RedactConversationMessageFluentBuilder
Constructs a fluent builder for the RedactConversationMessage operation.
- The fluent builder is configurable:
account_id(impl Into<String>)/set_account_id(Option<String>):
required: trueThe Amazon Chime account ID.
conversation_id(impl Into<String>)/set_conversation_id(Option<String>):
required: trueThe conversation ID.
message_id(impl Into<String>)/set_message_id(Option<String>):
required: trueThe message ID.
- On success, responds with
RedactConversationMessageOutput - On failure, responds with
SdkError<RedactConversationMessageError>
source§impl Client
impl Client
sourcepub fn redact_room_message(&self) -> RedactRoomMessageFluentBuilder
pub fn redact_room_message(&self) -> RedactRoomMessageFluentBuilder
Constructs a fluent builder for the RedactRoomMessage operation.
- The fluent builder is configurable:
account_id(impl Into<String>)/set_account_id(Option<String>):
required: trueThe Amazon Chime account ID.
room_id(impl Into<String>)/set_room_id(Option<String>):
required: trueThe room ID.
message_id(impl Into<String>)/set_message_id(Option<String>):
required: trueThe message ID.
- On success, responds with
RedactRoomMessageOutput - On failure, responds with
SdkError<RedactRoomMessageError>
source§impl Client
impl Client
sourcepub fn regenerate_security_token(&self) -> RegenerateSecurityTokenFluentBuilder
pub fn regenerate_security_token(&self) -> RegenerateSecurityTokenFluentBuilder
Constructs a fluent builder for the RegenerateSecurityToken operation.
- The fluent builder is configurable:
account_id(impl Into<String>)/set_account_id(Option<String>):
required: trueThe Amazon Chime account ID.
bot_id(impl Into<String>)/set_bot_id(Option<String>):
required: trueThe bot ID.
- On success, responds with
RegenerateSecurityTokenOutputwith field(s):bot(Option<Bot>):A resource that allows Enterprise account administrators to configure an interface that receives events from Amazon Chime.
- On failure, responds with
SdkError<RegenerateSecurityTokenError>
source§impl Client
impl Client
sourcepub fn reset_personal_pin(&self) -> ResetPersonalPINFluentBuilder
pub fn reset_personal_pin(&self) -> ResetPersonalPINFluentBuilder
Constructs a fluent builder for the ResetPersonalPIN operation.
- The fluent builder is configurable:
account_id(impl Into<String>)/set_account_id(Option<String>):
required: trueThe Amazon Chime account ID.
user_id(impl Into<String>)/set_user_id(Option<String>):
required: trueThe user ID.
- On success, responds with
ResetPersonalPinOutputwith field(s):user(Option<User>):The user details and new personal meeting PIN.
- On failure, responds with
SdkError<ResetPersonalPINError>
source§impl Client
impl Client
sourcepub fn restore_phone_number(&self) -> RestorePhoneNumberFluentBuilder
pub fn restore_phone_number(&self) -> RestorePhoneNumberFluentBuilder
Constructs a fluent builder for the RestorePhoneNumber operation.
- The fluent builder is configurable:
phone_number_id(impl Into<String>)/set_phone_number_id(Option<String>):
required: trueThe phone number.
- On success, responds with
RestorePhoneNumberOutputwith field(s):phone_number(Option<PhoneNumber>):The phone number details.
- On failure, responds with
SdkError<RestorePhoneNumberError>
source§impl Client
impl Client
sourcepub fn search_available_phone_numbers(
&self
) -> SearchAvailablePhoneNumbersFluentBuilder
pub fn search_available_phone_numbers( &self ) -> SearchAvailablePhoneNumbersFluentBuilder
Constructs a fluent builder for the SearchAvailablePhoneNumbers operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
area_code(impl Into<String>)/set_area_code(Option<String>):
required: falseThe area code used to filter results. Only applies to the US.
city(impl Into<String>)/set_city(Option<String>):
required: falseThe city used to filter results. Only applies to the US.
country(impl Into<String>)/set_country(Option<String>):
required: falseThe country used to filter results. Defaults to the US Format: ISO 3166-1 alpha-2.
state(impl Into<String>)/set_state(Option<String>):
required: falseThe state used to filter results. Required only if you provide
City. Only applies to the US.toll_free_prefix(impl Into<String>)/set_toll_free_prefix(Option<String>):
required: falseThe toll-free prefix that you use to filter results. Only applies to the US.
phone_number_type(PhoneNumberType)/set_phone_number_type(Option<PhoneNumberType>):
required: falseThe phone number type used to filter results. Required for non-US numbers.
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of results to return in a single call.
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseThe token used to retrieve the next page of results.
- On success, responds with
SearchAvailablePhoneNumbersOutputwith field(s):e164_phone_numbers(Option<Vec::<String>>):List of phone numbers, in E.164 format.
next_token(Option<String>):The token used to retrieve the next page of search results.
- On failure, responds with
SdkError<SearchAvailablePhoneNumbersError>
source§impl Client
impl Client
sourcepub fn send_channel_message(&self) -> SendChannelMessageFluentBuilder
👎Deprecated: Replaced by SendChannelMessage in the Amazon Chime SDK Messaging Namespace
pub fn send_channel_message(&self) -> SendChannelMessageFluentBuilder
Constructs a fluent builder for the SendChannelMessage operation.
- The fluent builder is configurable:
channel_arn(impl Into<String>)/set_channel_arn(Option<String>):
required: trueThe ARN of the channel.
content(impl Into<String>)/set_content(Option<String>):
required: trueThe content of the message.
r#type(ChannelMessageType)/set_type(Option<ChannelMessageType>):
required: trueThe type of message,
STANDARDorCONTROL.persistence(ChannelMessagePersistenceType)/set_persistence(Option<ChannelMessagePersistenceType>):
required: trueBoolean that controls whether the message is persisted on the back end. Required.
metadata(impl Into<String>)/set_metadata(Option<String>):
required: falseThe optional metadata for each message.
client_request_token(impl Into<String>)/set_client_request_token(Option<String>):
required: trueThe
Idempotencytoken for each client request.chime_bearer(impl Into<String>)/set_chime_bearer(Option<String>):
required: falseThe
AppInstanceUserArnof the user that makes the API call.
- On success, responds with
SendChannelMessageOutputwith field(s):channel_arn(Option<String>):The ARN of the channel.
message_id(Option<String>):The ID string assigned to each message.
- On failure, responds with
SdkError<SendChannelMessageError>
source§impl Client
impl Client
sourcepub fn start_meeting_transcription(
&self
) -> StartMeetingTranscriptionFluentBuilder
👎Deprecated: Replaced by StartMeetingTranscription in the Amazon Chime SDK Meetings Namespace
pub fn start_meeting_transcription( &self ) -> StartMeetingTranscriptionFluentBuilder
Constructs a fluent builder for the StartMeetingTranscription operation.
- The fluent builder is configurable:
meeting_id(impl Into<String>)/set_meeting_id(Option<String>):
required: trueThe unique ID of the meeting being transcribed.
transcription_configuration(TranscriptionConfiguration)/set_transcription_configuration(Option<TranscriptionConfiguration>):
required: trueThe configuration for the current transcription operation. Must contain
EngineTranscribeSettingsorEngineTranscribeMedicalSettings.
- On success, responds with
StartMeetingTranscriptionOutput - On failure, responds with
SdkError<StartMeetingTranscriptionError>
source§impl Client
impl Client
sourcepub fn stop_meeting_transcription(
&self
) -> StopMeetingTranscriptionFluentBuilder
👎Deprecated: Replaced by StopMeetingTranscription in the Amazon Chime SDK Meetings Namespace
pub fn stop_meeting_transcription( &self ) -> StopMeetingTranscriptionFluentBuilder
Constructs a fluent builder for the StopMeetingTranscription operation.
- The fluent builder is configurable:
meeting_id(impl Into<String>)/set_meeting_id(Option<String>):
required: trueThe unique ID of the meeting for which you stop transcription.
- On success, responds with
StopMeetingTranscriptionOutput - On failure, responds with
SdkError<StopMeetingTranscriptionError>
source§impl Client
impl Client
sourcepub fn tag_attendee(&self) -> TagAttendeeFluentBuilder
👎Deprecated: Attendee Tags are not supported in the Amazon Chime SDK Meetings Namespace. Update your application to remove calls to this API.
pub fn tag_attendee(&self) -> TagAttendeeFluentBuilder
Constructs a fluent builder for the TagAttendee operation.
- The fluent builder is configurable:
meeting_id(impl Into<String>)/set_meeting_id(Option<String>):
required: trueThe Amazon Chime SDK meeting ID.
attendee_id(impl Into<String>)/set_attendee_id(Option<String>):
required: trueThe Amazon Chime SDK attendee ID.
tags(Tag)/set_tags(Option<Vec::<Tag>>):
required: trueThe tag key-value pairs.
- On success, responds with
TagAttendeeOutput - On failure, responds with
SdkError<TagAttendeeError>
source§impl Client
impl Client
sourcepub fn tag_meeting(&self) -> TagMeetingFluentBuilder
👎Deprecated: Use TagResource in the Amazon Chime SDK Meetings Namespace.
pub fn tag_meeting(&self) -> TagMeetingFluentBuilder
Constructs a fluent builder for the TagMeeting operation.
- The fluent builder is configurable:
meeting_id(impl Into<String>)/set_meeting_id(Option<String>):
required: trueThe Amazon Chime SDK meeting ID.
tags(Tag)/set_tags(Option<Vec::<Tag>>):
required: trueThe tag key-value pairs.
- On success, responds with
TagMeetingOutput - On failure, responds with
SdkError<TagMeetingError>
source§impl Client
impl Client
sourcepub fn tag_resource(&self) -> TagResourceFluentBuilder
👎Deprecated: Replaced by TagResource in the Amazon Chime SDK Voice, Amazon Chime SDK Meetings, Amazon Chime SDK Identity, Amazon Chime SDK Messaging, and Amazon Chime SDK Media Pipelines Namespaces
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 resource ARN.
tags(Tag)/set_tags(Option<Vec::<Tag>>):
required: trueThe tag key-value pairs.
- On success, responds with
TagResourceOutput - On failure, responds with
SdkError<TagResourceError>
source§impl Client
impl Client
sourcepub fn untag_attendee(&self) -> UntagAttendeeFluentBuilder
👎Deprecated: Attendee Tags are not supported in the Amazon Chime SDK Meetings Namespace. Update your application to remove calls to this API.
pub fn untag_attendee(&self) -> UntagAttendeeFluentBuilder
Constructs a fluent builder for the UntagAttendee operation.
- The fluent builder is configurable:
meeting_id(impl Into<String>)/set_meeting_id(Option<String>):
required: trueThe Amazon Chime SDK meeting ID.
attendee_id(impl Into<String>)/set_attendee_id(Option<String>):
required: trueThe Amazon Chime SDK attendee ID.
tag_keys(impl Into<String>)/set_tag_keys(Option<Vec::<String>>):
required: trueThe tag keys.
- On success, responds with
UntagAttendeeOutput - On failure, responds with
SdkError<UntagAttendeeError>
source§impl Client
impl Client
sourcepub fn untag_meeting(&self) -> UntagMeetingFluentBuilder
👎Deprecated: Use UntagResource in the Amazon Chime SDK Meetings Namespace.
pub fn untag_meeting(&self) -> UntagMeetingFluentBuilder
Constructs a fluent builder for the UntagMeeting operation.
- The fluent builder is configurable:
meeting_id(impl Into<String>)/set_meeting_id(Option<String>):
required: trueThe Amazon Chime SDK meeting ID.
tag_keys(impl Into<String>)/set_tag_keys(Option<Vec::<String>>):
required: trueThe tag keys.
- On success, responds with
UntagMeetingOutput - On failure, responds with
SdkError<UntagMeetingError>
source§impl Client
impl Client
sourcepub fn untag_resource(&self) -> UntagResourceFluentBuilder
👎Deprecated: Replaced by UntagResource in the Amazon Chime SDK Voice, Amazon Chime SDK Meetings, Amazon Chime SDK Identity, Amazon Chime SDK Messaging, and Amazon Chime SDK Media Pipelines Namespaces
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 resource ARN.
tag_keys(impl Into<String>)/set_tag_keys(Option<Vec::<String>>):
required: trueThe tag keys.
- On success, responds with
UntagResourceOutput - On failure, responds with
SdkError<UntagResourceError>
source§impl Client
impl Client
sourcepub fn update_account(&self) -> UpdateAccountFluentBuilder
pub fn update_account(&self) -> UpdateAccountFluentBuilder
Constructs a fluent builder for the UpdateAccount operation.
- The fluent builder is configurable:
account_id(impl Into<String>)/set_account_id(Option<String>):
required: trueThe Amazon Chime account ID.
name(impl Into<String>)/set_name(Option<String>):
required: falseThe new name for the specified Amazon Chime account.
default_license(License)/set_default_license(Option<License>):
required: falseThe default license applied when you add users to an Amazon Chime account.
- On success, responds with
UpdateAccountOutputwith field(s):account(Option<Account>):The updated Amazon Chime account details.
- On failure, responds with
SdkError<UpdateAccountError>
source§impl Client
impl Client
sourcepub fn update_account_settings(&self) -> UpdateAccountSettingsFluentBuilder
pub fn update_account_settings(&self) -> UpdateAccountSettingsFluentBuilder
Constructs a fluent builder for the UpdateAccountSettings operation.
- The fluent builder is configurable:
account_id(impl Into<String>)/set_account_id(Option<String>):
required: trueThe Amazon Chime account ID.
account_settings(AccountSettings)/set_account_settings(Option<AccountSettings>):
required: trueThe Amazon Chime account settings to update.
- On success, responds with
UpdateAccountSettingsOutput - On failure, responds with
SdkError<UpdateAccountSettingsError>
source§impl Client
impl Client
sourcepub fn update_app_instance(&self) -> UpdateAppInstanceFluentBuilder
👎Deprecated: Replaced by UpdateAppInstance in the Amazon Chime SDK Identity Namespace
pub fn update_app_instance(&self) -> UpdateAppInstanceFluentBuilder
Constructs a fluent builder for the UpdateAppInstance operation.
- The fluent builder is configurable:
app_instance_arn(impl Into<String>)/set_app_instance_arn(Option<String>):
required: trueThe ARN of the
AppInstance.name(impl Into<String>)/set_name(Option<String>):
required: trueThe name that you want to change.
metadata(impl Into<String>)/set_metadata(Option<String>):
required: falseThe metadata that you want to change.
- On success, responds with
UpdateAppInstanceOutputwith field(s):app_instance_arn(Option<String>):The ARN of the
AppInstance.
- On failure, responds with
SdkError<UpdateAppInstanceError>
source§impl Client
impl Client
sourcepub fn update_app_instance_user(&self) -> UpdateAppInstanceUserFluentBuilder
👎Deprecated: Replaced by UpdateAppInstanceUser in the Amazon Chime SDK Identity Namespace
pub fn update_app_instance_user(&self) -> UpdateAppInstanceUserFluentBuilder
Constructs a fluent builder for the UpdateAppInstanceUser operation.
- The fluent builder is configurable:
app_instance_user_arn(impl Into<String>)/set_app_instance_user_arn(Option<String>):
required: trueThe ARN of the
AppInstanceUser.name(impl Into<String>)/set_name(Option<String>):
required: trueThe name of the
AppInstanceUser.metadata(impl Into<String>)/set_metadata(Option<String>):
required: falseThe metadata of the
AppInstanceUser.
- On success, responds with
UpdateAppInstanceUserOutputwith field(s):app_instance_user_arn(Option<String>):The ARN of the
AppInstanceUser.
- On failure, responds with
SdkError<UpdateAppInstanceUserError>
source§impl Client
impl Client
sourcepub fn update_bot(&self) -> UpdateBotFluentBuilder
pub fn update_bot(&self) -> UpdateBotFluentBuilder
Constructs a fluent builder for the UpdateBot operation.
- The fluent builder is configurable:
account_id(impl Into<String>)/set_account_id(Option<String>):
required: trueThe Amazon Chime account ID.
bot_id(impl Into<String>)/set_bot_id(Option<String>):
required: trueThe bot ID.
disabled(bool)/set_disabled(Option<bool>):
required: falseWhen true, stops the specified bot from running in your account.
- On success, responds with
UpdateBotOutputwith field(s):bot(Option<Bot>):The updated bot details.
- On failure, responds with
SdkError<UpdateBotError>
source§impl Client
impl Client
sourcepub fn update_channel(&self) -> UpdateChannelFluentBuilder
👎Deprecated: Replaced by UpdateChannel in the Amazon Chime SDK Messaging Namespace
pub fn update_channel(&self) -> UpdateChannelFluentBuilder
Constructs a fluent builder for the UpdateChannel operation.
- The fluent builder is configurable:
channel_arn(impl Into<String>)/set_channel_arn(Option<String>):
required: trueThe ARN of the channel.
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name of the channel.
mode(ChannelMode)/set_mode(Option<ChannelMode>):
required: trueThe mode of the update request.
metadata(impl Into<String>)/set_metadata(Option<String>):
required: falseThe metadata for the update request.
chime_bearer(impl Into<String>)/set_chime_bearer(Option<String>):
required: falseThe
AppInstanceUserArnof the user that makes the API call.
- On success, responds with
UpdateChannelOutputwith field(s):channel_arn(Option<String>):The ARN of the channel.
- On failure, responds with
SdkError<UpdateChannelError>
source§impl Client
impl Client
sourcepub fn update_channel_message(&self) -> UpdateChannelMessageFluentBuilder
👎Deprecated: Replaced by UpdateChannelMessage in the Amazon Chime SDK Messaging Namespace
pub fn update_channel_message(&self) -> UpdateChannelMessageFluentBuilder
Constructs a fluent builder for the UpdateChannelMessage operation.
- The fluent builder is configurable:
channel_arn(impl Into<String>)/set_channel_arn(Option<String>):
required: trueThe ARN of the channel.
message_id(impl Into<String>)/set_message_id(Option<String>):
required: trueThe ID string of the message being updated.
content(impl Into<String>)/set_content(Option<String>):
required: falseThe content of the message being updated.
metadata(impl Into<String>)/set_metadata(Option<String>):
required: falseThe metadata of the message being updated.
chime_bearer(impl Into<String>)/set_chime_bearer(Option<String>):
required: falseThe
AppInstanceUserArnof the user that makes the API call.
- On success, responds with
UpdateChannelMessageOutputwith field(s):channel_arn(Option<String>):The ARN of the channel.
message_id(Option<String>):The ID string of the message being updated.
- On failure, responds with
SdkError<UpdateChannelMessageError>
source§impl Client
impl Client
sourcepub fn update_channel_read_marker(&self) -> UpdateChannelReadMarkerFluentBuilder
👎Deprecated: Replaced by UpdateChannelReadMarker in the Amazon Chime SDK Messaging Namespace
pub fn update_channel_read_marker(&self) -> UpdateChannelReadMarkerFluentBuilder
Constructs a fluent builder for the UpdateChannelReadMarker operation.
- The fluent builder is configurable:
channel_arn(impl Into<String>)/set_channel_arn(Option<String>):
required: trueThe ARN of the channel.
chime_bearer(impl Into<String>)/set_chime_bearer(Option<String>):
required: falseThe
AppInstanceUserArnof the user that makes the API call.
- On success, responds with
UpdateChannelReadMarkerOutputwith field(s):channel_arn(Option<String>):The ARN of the channel.
- On failure, responds with
SdkError<UpdateChannelReadMarkerError>
source§impl Client
impl Client
sourcepub fn update_global_settings(&self) -> UpdateGlobalSettingsFluentBuilder
pub fn update_global_settings(&self) -> UpdateGlobalSettingsFluentBuilder
Constructs a fluent builder for the UpdateGlobalSettings operation.
- The fluent builder is configurable:
business_calling(BusinessCallingSettings)/set_business_calling(Option<BusinessCallingSettings>):
required: falseThe Amazon Chime Business Calling settings.
voice_connector(VoiceConnectorSettings)/set_voice_connector(Option<VoiceConnectorSettings>):
required: falseThe Amazon Chime Voice Connector settings.
- On success, responds with
UpdateGlobalSettingsOutput - On failure, responds with
SdkError<UpdateGlobalSettingsError>
source§impl Client
impl Client
sourcepub fn update_phone_number(&self) -> UpdatePhoneNumberFluentBuilder
pub fn update_phone_number(&self) -> UpdatePhoneNumberFluentBuilder
Constructs a fluent builder for the UpdatePhoneNumber operation.
- The fluent builder is configurable:
phone_number_id(impl Into<String>)/set_phone_number_id(Option<String>):
required: trueThe phone number ID.
product_type(PhoneNumberProductType)/set_product_type(Option<PhoneNumberProductType>):
required: falseThe product type.
calling_name(impl Into<String>)/set_calling_name(Option<String>):
required: falseThe outbound calling name associated with the phone number.
- On success, responds with
UpdatePhoneNumberOutputwith field(s):phone_number(Option<PhoneNumber>):The updated phone number details.
- On failure, responds with
SdkError<UpdatePhoneNumberError>
source§impl Client
impl Client
sourcepub fn update_phone_number_settings(
&self
) -> UpdatePhoneNumberSettingsFluentBuilder
pub fn update_phone_number_settings( &self ) -> UpdatePhoneNumberSettingsFluentBuilder
Constructs a fluent builder for the UpdatePhoneNumberSettings operation.
- The fluent builder is configurable:
calling_name(impl Into<String>)/set_calling_name(Option<String>):
required: trueThe default outbound calling name for the account.
- On success, responds with
UpdatePhoneNumberSettingsOutput - On failure, responds with
SdkError<UpdatePhoneNumberSettingsError>
source§impl Client
impl Client
sourcepub fn update_proxy_session(&self) -> UpdateProxySessionFluentBuilder
👎Deprecated: Replaced by UpdateProxySession in the Amazon Chime SDK Voice Namespace
pub fn update_proxy_session(&self) -> UpdateProxySessionFluentBuilder
Constructs a fluent builder for the UpdateProxySession operation.
- The fluent builder is configurable:
voice_connector_id(impl Into<String>)/set_voice_connector_id(Option<String>):
required: trueThe Amazon Chime voice connector ID.
proxy_session_id(impl Into<String>)/set_proxy_session_id(Option<String>):
required: trueThe proxy session ID.
capabilities(Capability)/set_capabilities(Option<Vec::<Capability>>):
required: trueThe proxy session capabilities.
expiry_minutes(i32)/set_expiry_minutes(Option<i32>):
required: falseThe number of minutes allowed for the proxy session.
- On success, responds with
UpdateProxySessionOutputwith field(s):proxy_session(Option<ProxySession>):The proxy session details.
- On failure, responds with
SdkError<UpdateProxySessionError>
source§impl Client
impl Client
sourcepub fn update_room(&self) -> UpdateRoomFluentBuilder
pub fn update_room(&self) -> UpdateRoomFluentBuilder
Constructs a fluent builder for the UpdateRoom operation.
- The fluent builder is configurable:
account_id(impl Into<String>)/set_account_id(Option<String>):
required: trueThe Amazon Chime account ID.
room_id(impl Into<String>)/set_room_id(Option<String>):
required: trueThe room ID.
name(impl Into<String>)/set_name(Option<String>):
required: falseThe room name.
- On success, responds with
UpdateRoomOutputwith field(s):room(Option<Room>):The room details.
- On failure, responds with
SdkError<UpdateRoomError>
source§impl Client
impl Client
sourcepub fn update_room_membership(&self) -> UpdateRoomMembershipFluentBuilder
pub fn update_room_membership(&self) -> UpdateRoomMembershipFluentBuilder
Constructs a fluent builder for the UpdateRoomMembership operation.
- The fluent builder is configurable:
account_id(impl Into<String>)/set_account_id(Option<String>):
required: trueThe Amazon Chime account ID.
room_id(impl Into<String>)/set_room_id(Option<String>):
required: trueThe room ID.
member_id(impl Into<String>)/set_member_id(Option<String>):
required: trueThe member ID.
role(RoomMembershipRole)/set_role(Option<RoomMembershipRole>):
required: falseThe role of the member.
- On success, responds with
UpdateRoomMembershipOutputwith field(s):room_membership(Option<RoomMembership>):The room membership details.
- On failure, responds with
SdkError<UpdateRoomMembershipError>
source§impl Client
impl Client
sourcepub fn update_sip_media_application(
&self
) -> UpdateSipMediaApplicationFluentBuilder
👎Deprecated: Replaced by UpdateSipMediaApplication in the Amazon Chime SDK Voice Namespace
pub fn update_sip_media_application( &self ) -> UpdateSipMediaApplicationFluentBuilder
Constructs a fluent builder for the UpdateSipMediaApplication operation.
- The fluent builder is configurable:
sip_media_application_id(impl Into<String>)/set_sip_media_application_id(Option<String>):
required: trueThe SIP media application ID.
name(impl Into<String>)/set_name(Option<String>):
required: falseThe new name for the specified SIP media application.
endpoints(SipMediaApplicationEndpoint)/set_endpoints(Option<Vec::<SipMediaApplicationEndpoint>>):
required: falseThe new set of endpoints for the specified SIP media application.
- On success, responds with
UpdateSipMediaApplicationOutputwith field(s):sip_media_application(Option<SipMediaApplication>):The updated SIP media application details.
- On failure, responds with
SdkError<UpdateSipMediaApplicationError>
source§impl Client
impl Client
sourcepub fn update_sip_media_application_call(
&self
) -> UpdateSipMediaApplicationCallFluentBuilder
👎Deprecated: Replaced by UpdateSipMediaApplicationCall in the Amazon Chime SDK Voice Namespace
pub fn update_sip_media_application_call( &self ) -> UpdateSipMediaApplicationCallFluentBuilder
Constructs a fluent builder for the UpdateSipMediaApplicationCall operation.
- The fluent builder is configurable:
sip_media_application_id(impl Into<String>)/set_sip_media_application_id(Option<String>):
required: trueThe ID of the SIP media application handling the call.
transaction_id(impl Into<String>)/set_transaction_id(Option<String>):
required: trueThe ID of the call transaction.
arguments(impl Into<String>, impl Into<String>)/set_arguments(Option<HashMap::<String, String>>):
required: trueArguments made available to the Lambda function as part of the
CALL_UPDATE_REQUESTEDevent. Can contain 0-20 key-value pairs.
- On success, responds with
UpdateSipMediaApplicationCallOutputwith field(s):sip_media_application_call(Option<SipMediaApplicationCall>):A
Callinstance for a SIP media application.
- On failure, responds with
SdkError<UpdateSipMediaApplicationCallError>
source§impl Client
impl Client
sourcepub fn update_sip_rule(&self) -> UpdateSipRuleFluentBuilder
👎Deprecated: Replaced by UpdateSipRule in the Amazon Chime SDK Voice Namespace
pub fn update_sip_rule(&self) -> UpdateSipRuleFluentBuilder
Constructs a fluent builder for the UpdateSipRule operation.
- The fluent builder is configurable:
sip_rule_id(impl Into<String>)/set_sip_rule_id(Option<String>):
required: trueThe SIP rule ID.
name(impl Into<String>)/set_name(Option<String>):
required: trueThe new name for the specified SIP rule.
disabled(bool)/set_disabled(Option<bool>):
required: falseThe new value specified to indicate whether the rule is disabled.
target_applications(SipRuleTargetApplication)/set_target_applications(Option<Vec::<SipRuleTargetApplication>>):
required: falseThe new value of the list of target applications.
- On success, responds with
UpdateSipRuleOutputwith field(s):sip_rule(Option<SipRule>):Updated SIP rule details.
- On failure, responds with
SdkError<UpdateSipRuleError>
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:
account_id(impl Into<String>)/set_account_id(Option<String>):
required: trueThe Amazon Chime account ID.
user_id(impl Into<String>)/set_user_id(Option<String>):
required: trueThe user ID.
license_type(License)/set_license_type(Option<License>):
required: falseThe user license type to update. This must be a supported license type for the Amazon Chime account that the user belongs to.
user_type(UserType)/set_user_type(Option<UserType>):
required: falseThe user type.
alexa_for_business_metadata(AlexaForBusinessMetadata)/set_alexa_for_business_metadata(Option<AlexaForBusinessMetadata>):
required: falseThe Alexa for Business metadata.
- On success, responds with
UpdateUserOutputwith field(s):user(Option<User>):The updated user details.
- On failure, responds with
SdkError<UpdateUserError>
source§impl Client
impl Client
sourcepub fn update_user_settings(&self) -> UpdateUserSettingsFluentBuilder
pub fn update_user_settings(&self) -> UpdateUserSettingsFluentBuilder
Constructs a fluent builder for the UpdateUserSettings operation.
- The fluent builder is configurable:
account_id(impl Into<String>)/set_account_id(Option<String>):
required: trueThe Amazon Chime account ID.
user_id(impl Into<String>)/set_user_id(Option<String>):
required: trueThe user ID.
user_settings(UserSettings)/set_user_settings(Option<UserSettings>):
required: trueThe user settings to update.
- On success, responds with
UpdateUserSettingsOutput - On failure, responds with
SdkError<UpdateUserSettingsError>
source§impl Client
impl Client
sourcepub fn update_voice_connector(&self) -> UpdateVoiceConnectorFluentBuilder
👎Deprecated: Replaced by UpdateVoiceConnector in the Amazon Chime SDK Voice Namespace
pub fn update_voice_connector(&self) -> UpdateVoiceConnectorFluentBuilder
Constructs a fluent builder for the UpdateVoiceConnector operation.
- The fluent builder is configurable:
voice_connector_id(impl Into<String>)/set_voice_connector_id(Option<String>):
required: trueThe Amazon Chime Voice Connector ID.
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name of the Amazon Chime Voice Connector.
require_encryption(bool)/set_require_encryption(Option<bool>):
required: trueWhen enabled, requires encryption for the Amazon Chime Voice Connector.
- On success, responds with
UpdateVoiceConnectorOutputwith field(s):voice_connector(Option<VoiceConnector>):The updated Amazon Chime Voice Connector details.
- On failure, responds with
SdkError<UpdateVoiceConnectorError>
source§impl Client
impl Client
sourcepub fn update_voice_connector_group(
&self
) -> UpdateVoiceConnectorGroupFluentBuilder
👎Deprecated: Replaced by UpdateVoiceConnectorGroup in the Amazon Chime SDK Voice Namespace
pub fn update_voice_connector_group( &self ) -> UpdateVoiceConnectorGroupFluentBuilder
Constructs a fluent builder for the UpdateVoiceConnectorGroup operation.
- The fluent builder is configurable:
voice_connector_group_id(impl Into<String>)/set_voice_connector_group_id(Option<String>):
required: trueThe Amazon Chime Voice Connector group ID.
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name of the Amazon Chime Voice Connector group.
voice_connector_items(VoiceConnectorItem)/set_voice_connector_items(Option<Vec::<VoiceConnectorItem>>):
required: trueThe
VoiceConnectorItemsto associate with the group.
- On success, responds with
UpdateVoiceConnectorGroupOutputwith field(s):voice_connector_group(Option<VoiceConnectorGroup>):The updated Amazon Chime Voice Connector group details.
- On failure, responds with
SdkError<UpdateVoiceConnectorGroupError>
source§impl Client
impl Client
sourcepub fn validate_e911_address(&self) -> ValidateE911AddressFluentBuilder
👎Deprecated: Replaced by ValidateE911Address in the Amazon Chime SDK Voice Namespace
pub fn validate_e911_address(&self) -> ValidateE911AddressFluentBuilder
Constructs a fluent builder for the ValidateE911Address operation.
- The fluent builder is configurable:
aws_account_id(impl Into<String>)/set_aws_account_id(Option<String>):
required: trueThe AWS account ID.
street_number(impl Into<String>)/set_street_number(Option<String>):
required: trueThe address street number, such as
200or2121.street_info(impl Into<String>)/set_street_info(Option<String>):
required: trueThe address street information, such as
8th Avenue.city(impl Into<String>)/set_city(Option<String>):
required: trueThe address city, such as
Portland.state(impl Into<String>)/set_state(Option<String>):
required: trueThe address state, such as
ME.country(impl Into<String>)/set_country(Option<String>):
required: trueThe address country, such as
US.postal_code(impl Into<String>)/set_postal_code(Option<String>):
required: trueThe address postal code, such as
04352.
- On success, responds with
ValidateE911AddressOutputwith field(s):validation_result(i32):Number indicating the result of address validation.
0means the address was perfect as is and successfully validated.1means the address was corrected.2means the address sent was not close enough and was not validated.address_external_id(Option<String>):The ID that represents the address.
address(Option<Address>):The validated address.
candidate_address_list(Option<Vec::<CandidateAddress>>):The list of address suggestions.
- On failure, responds with
SdkError<ValidateE911AddressError>
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_implconfigured. - Identity caching is enabled without a
sleep_implandtime_sourceconfigured. - No
behavior_versionis 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_configis missing an async sleep implementation. If you experience this panic, set thesleep_implon the Config passed into this function to fix it. - This method will panic if the
sdk_configis missing an HTTP connector. If you experience this panic, set thehttp_connectoron the Config passed into this function to fix it. - This method will panic if no
BehaviorVersionis provided. If you experience this panic, setbehavior_versionon the Config or enable thebehavior-version-latestCargo feature.