Struct aws_sdk_chime::client::Client
source · [−]pub struct Client<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* 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.
Examples
Constructing a client and invoking an operation
// create a shared configuration. This can be used & shared between multiple service clients.
let shared_config = aws_config::load_from_env().await;
let client = aws_sdk_chime::Client::new(&shared_config);
// invoke an operation
/* let rsp = client
.<operation_name>().
.<param>("some value")
.send().await; */
Constructing a client with custom configuration
use aws_config::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_chime::config::Builder::from(&shared_config)
.retry_config(RetryConfig::disabled())
.build();
let client = aws_sdk_chime::Client::from_conf(config);
Implementations
impl<C, M, R> Client<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
impl<C, M, R> Client<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
pub fn associate_phone_numbers_with_voice_connector(
&self
) -> AssociatePhoneNumbersWithVoiceConnector<C, M, R>
pub fn associate_phone_numbers_with_voice_connector(
&self
) -> AssociatePhoneNumbersWithVoiceConnector<C, M, R>
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>)
:The Amazon Chime Voice Connector ID.
e164_phone_numbers(Vec<String>)
/set_e164_phone_numbers(Option<Vec<String>>)
:List of phone numbers, in E.164 format.
force_associate(bool)
/set_force_associate(Option<bool>)
:If 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
AssociatePhoneNumbersWithVoiceConnectorOutput
with 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>
pub fn associate_phone_numbers_with_voice_connector_group(
&self
) -> AssociatePhoneNumbersWithVoiceConnectorGroup<C, M, R>
pub fn associate_phone_numbers_with_voice_connector_group(
&self
) -> AssociatePhoneNumbersWithVoiceConnectorGroup<C, M, R>
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>)
:The Amazon Chime Voice Connector group ID.
e164_phone_numbers(Vec<String>)
/set_e164_phone_numbers(Option<Vec<String>>)
:List of phone numbers, in E.164 format.
force_associate(bool)
/set_force_associate(Option<bool>)
:If 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
AssociatePhoneNumbersWithVoiceConnectorGroupOutput
with 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>
Constructs a fluent builder for the AssociatePhoneNumberWithUser
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The Amazon Chime account ID.
user_id(impl Into<String>)
/set_user_id(Option<String>)
:The user ID.
e164_phone_number(impl Into<String>)
/set_e164_phone_number(Option<String>)
:The phone number, in E.164 format.
- On success, responds with
AssociatePhoneNumberWithUserOutput
- On failure, responds with
SdkError<AssociatePhoneNumberWithUserError>
pub fn associate_signin_delegate_groups_with_account(
&self
) -> AssociateSigninDelegateGroupsWithAccount<C, M, R>
pub fn associate_signin_delegate_groups_with_account(
&self
) -> AssociateSigninDelegateGroupsWithAccount<C, M, R>
Constructs a fluent builder for the AssociateSigninDelegateGroupsWithAccount
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The Amazon Chime account ID.
signin_delegate_groups(Vec<SigninDelegateGroup>)
/set_signin_delegate_groups(Option<Vec<SigninDelegateGroup>>)
:The sign-in delegate groups.
- On success, responds with
AssociateSigninDelegateGroupsWithAccountOutput
- On failure, responds with
SdkError<AssociateSigninDelegateGroupsWithAccountError>
Constructs a fluent builder for the BatchCreateAttendee
operation.
- The fluent builder is configurable:
meeting_id(impl Into<String>)
/set_meeting_id(Option<String>)
:The Amazon Chime SDK meeting ID.
attendees(Vec<CreateAttendeeRequestItem>)
/set_attendees(Option<Vec<CreateAttendeeRequestItem>>)
:The request containing the attendees to create.
- On success, responds with
BatchCreateAttendeeOutput
with 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>
Constructs a fluent builder for the BatchCreateChannelMembership
operation.
- The fluent builder is configurable:
channel_arn(impl Into<String>)
/set_channel_arn(Option<String>)
:The ARN of the channel to which you’re adding users.
r#type(ChannelMembershipType)
/set_type(Option<ChannelMembershipType>)
:The membership type of a user,
DEFAULT
orHIDDEN
. Default members are always returned as part ofListChannelMemberships
. Hidden members are only returned if the type filter inListChannelMemberships
equalsHIDDEN
. Otherwise hidden members are not returned. This is only supported by moderators.member_arns(Vec<String>)
/set_member_arns(Option<Vec<String>>)
:The ARNs of the members you want to add to the channel.
chime_bearer(impl Into<String>)
/set_chime_bearer(Option<String>)
:The
AppInstanceUserArn
of the user that makes the API call.
- On success, responds with
BatchCreateChannelMembershipOutput
with 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>
Constructs a fluent builder for the BatchCreateRoomMembership
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The Amazon Chime account ID.
room_id(impl Into<String>)
/set_room_id(Option<String>)
:The room ID.
membership_item_list(Vec<MembershipItem>)
/set_membership_item_list(Option<Vec<MembershipItem>>)
:The list of membership items.
- On success, responds with
BatchCreateRoomMembershipOutput
with 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>
Constructs a fluent builder for the BatchDeletePhoneNumber
operation.
- The fluent builder is configurable:
phone_number_ids(Vec<String>)
/set_phone_number_ids(Option<Vec<String>>)
:List of phone number IDs.
- On success, responds with
BatchDeletePhoneNumberOutput
with 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>
Constructs a fluent builder for the BatchSuspendUser
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The Amazon Chime account ID.
user_id_list(Vec<String>)
/set_user_id_list(Option<Vec<String>>)
:The request containing the user IDs to suspend.
- On success, responds with
BatchSuspendUserOutput
with field(s):user_errors(Option<Vec<UserError>>)
:If the
BatchSuspendUser
action 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>
Constructs a fluent builder for the BatchUnsuspendUser
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The Amazon Chime account ID.
user_id_list(Vec<String>)
/set_user_id_list(Option<Vec<String>>)
:The request containing the user IDs to unsuspend.
- On success, responds with
BatchUnsuspendUserOutput
with field(s):user_errors(Option<Vec<UserError>>)
:If the
BatchUnsuspendUser
action 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>
Constructs a fluent builder for the BatchUpdatePhoneNumber
operation.
- The fluent builder is configurable:
update_phone_number_request_items(Vec<UpdatePhoneNumberRequestItem>)
/set_update_phone_number_request_items(Option<Vec<UpdatePhoneNumberRequestItem>>)
:The request containing the phone number IDs and product types or calling names to update.
- On success, responds with
BatchUpdatePhoneNumberOutput
with 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>
Constructs a fluent builder for the BatchUpdateUser
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The Amazon Chime account ID.
update_user_request_items(Vec<UpdateUserRequestItem>)
/set_update_user_request_items(Option<Vec<UpdateUserRequestItem>>)
:The request containing the user IDs and details to update.
- On success, responds with
BatchUpdateUserOutput
with field(s):user_errors(Option<Vec<UserError>>)
:If the
BatchUpdateUser
action 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>
Constructs a fluent builder for the CreateAccount
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:The name of the Amazon Chime account.
- On success, responds with
CreateAccountOutput
with field(s):account(Option<Account>)
:The Amazon Chime account details.
- On failure, responds with
SdkError<CreateAccountError>
Constructs a fluent builder for the CreateAppInstance
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:The name of the
AppInstance
.metadata(impl Into<String>)
/set_metadata(Option<String>)
:The metadata of the
AppInstance
. Limited to a 1KB string in UTF-8.client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
:The
ClientRequestToken
of theAppInstance
.tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:Tags assigned to the
AppInstanceUser
.
- On success, responds with
CreateAppInstanceOutput
with field(s):app_instance_arn(Option<String>)
:The Amazon Resource Number (ARN) of the
AppInstance
.
- On failure, responds with
SdkError<CreateAppInstanceError>
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>)
:The ARN of the administrator of the current
AppInstance
.app_instance_arn(impl Into<String>)
/set_app_instance_arn(Option<String>)
:The ARN of the
AppInstance
.
- On success, responds with
CreateAppInstanceAdminOutput
with 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>
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>)
:The ARN of the
AppInstance
request.app_instance_user_id(impl Into<String>)
/set_app_instance_user_id(Option<String>)
:The user ID of the
AppInstance
.name(impl Into<String>)
/set_name(Option<String>)
:The user’s name.
metadata(impl Into<String>)
/set_metadata(Option<String>)
:The request’s metadata. Limited to a 1KB string in UTF-8.
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
:The token assigned to the user requesting an
AppInstance
.tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:Tags assigned to the
AppInstanceUser
.
- On success, responds with
CreateAppInstanceUserOutput
with field(s):app_instance_user_arn(Option<String>)
:The user’s ARN.
- On failure, responds with
SdkError<CreateAppInstanceUserError>
Constructs a fluent builder for the CreateAttendee
operation.
- The fluent builder is configurable:
meeting_id(impl Into<String>)
/set_meeting_id(Option<String>)
:The Amazon Chime SDK meeting ID.
external_user_id(impl Into<String>)
/set_external_user_id(Option<String>)
:The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:The tag key-value pairs.
- On success, responds with
CreateAttendeeOutput
with field(s):attendee(Option<Attendee>)
:The attendee information, including attendee ID and join token.
- On failure, responds with
SdkError<CreateAttendeeError>
Constructs a fluent builder for the CreateBot
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The Amazon Chime account ID.
display_name(impl Into<String>)
/set_display_name(Option<String>)
:The bot display name.
domain(impl Into<String>)
/set_domain(Option<String>)
:The domain of the Amazon Chime Enterprise account.
- On success, responds with
CreateBotOutput
with field(s):bot(Option<Bot>)
:The bot details.
- On failure, responds with
SdkError<CreateBotError>
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>)
:The ARN of the channel request.
name(impl Into<String>)
/set_name(Option<String>)
:The name of the channel.
mode(ChannelMode)
/set_mode(Option<ChannelMode>)
:The channel mode:
UNRESTRICTED
orRESTRICTED
. 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>)
:The channel’s privacy level:
PUBLIC
orPRIVATE
. 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>)
:The metadata of the creation request. Limited to 1KB and UTF-8.
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
:The client token for the request. An
Idempotency
token.tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:The tags for the creation request.
chime_bearer(impl Into<String>)
/set_chime_bearer(Option<String>)
:The
AppInstanceUserArn
of the user that makes the API call.
- On success, responds with
CreateChannelOutput
with field(s):channel_arn(Option<String>)
:The ARN of the channel.
- On failure, responds with
SdkError<CreateChannelError>
Constructs a fluent builder for the CreateChannelBan
operation.
- The fluent builder is configurable:
channel_arn(impl Into<String>)
/set_channel_arn(Option<String>)
:The ARN of the ban request.
member_arn(impl Into<String>)
/set_member_arn(Option<String>)
:The ARN of the member being banned.
chime_bearer(impl Into<String>)
/set_chime_bearer(Option<String>)
:The
AppInstanceUserArn
of the user that makes the API call.
- On success, responds with
CreateChannelBanOutput
with field(s):channel_arn(Option<String>)
:The ARN of the response to the ban request.
member(Option<Identity>)
:The
ChannelArn
andBannedIdentity
of the member in the ban response.
- On failure, responds with
SdkError<CreateChannelBanError>
Constructs a fluent builder for the CreateChannelMembership
operation.
- The fluent builder is configurable:
channel_arn(impl Into<String>)
/set_channel_arn(Option<String>)
:The ARN of the channel to which you’re adding users.
member_arn(impl Into<String>)
/set_member_arn(Option<String>)
:The ARN of the member you want to add to the channel.
r#type(ChannelMembershipType)
/set_type(Option<ChannelMembershipType>)
:The membership type of a user,
DEFAULT
orHIDDEN
. Default members are always returned as part ofListChannelMemberships
. Hidden members are only returned if the type filter inListChannelMemberships
equalsHIDDEN
. Otherwise hidden members are not returned. This is only supported by moderators.chime_bearer(impl Into<String>)
/set_chime_bearer(Option<String>)
:The
AppInstanceUserArn
of the user that makes the API call.
- On success, responds with
CreateChannelMembershipOutput
with 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>
Constructs a fluent builder for the CreateChannelModerator
operation.
- The fluent builder is configurable:
channel_arn(impl Into<String>)
/set_channel_arn(Option<String>)
:The ARN of the channel.
channel_moderator_arn(impl Into<String>)
/set_channel_moderator_arn(Option<String>)
:The ARN of the moderator.
chime_bearer(impl Into<String>)
/set_chime_bearer(Option<String>)
:The
AppInstanceUserArn
of the user that makes the API call.
- On success, responds with
CreateChannelModeratorOutput
with 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>
Constructs a fluent builder for the CreateMediaCapturePipeline
operation.
- The fluent builder is configurable:
source_type(MediaPipelineSourceType)
/set_source_type(Option<MediaPipelineSourceType>)
:Source 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>)
:ARN of the source from which the media artifacts are captured.
sink_type(MediaPipelineSinkType)
/set_sink_type(Option<MediaPipelineSinkType>)
:Destination type to which the media artifacts are saved. You must use an S3 bucket.
sink_arn(impl Into<String>)
/set_sink_arn(Option<String>)
:The ARN of the sink type.
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
:The token assigned to the client making the pipeline request.
chime_sdk_meeting_configuration(ChimeSdkMeetingConfiguration)
/set_chime_sdk_meeting_configuration(Option<ChimeSdkMeetingConfiguration>)
:The configuration for a specified media capture pipeline.
SourceType
must beChimeSdkMeeting
.
- On success, responds with
CreateMediaCapturePipelineOutput
with 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>
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>)
:The 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>)
:The external meeting ID.
meeting_host_id(impl Into<String>)
/set_meeting_host_id(Option<String>)
:Reserved.
media_region(impl Into<String>)
/set_media_region(Option<String>)
:The 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(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:The tag key-value pairs.
notifications_configuration(MeetingNotificationConfiguration)
/set_notifications_configuration(Option<MeetingNotificationConfiguration>)
:The configuration for resource targets to receive notifications when meeting and attendee events occur.
- On success, responds with
CreateMeetingOutput
with field(s):meeting(Option<Meeting>)
:The meeting information, including the meeting ID and
MediaPlacement
.
- On failure, responds with
SdkError<CreateMeetingError>
Constructs a fluent builder for the CreateMeetingDialOut
operation.
- The fluent builder is configurable:
meeting_id(impl Into<String>)
/set_meeting_id(Option<String>)
:The Amazon Chime SDK meeting ID.
from_phone_number(impl Into<String>)
/set_from_phone_number(Option<String>)
:Phone 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>)
:Phone number called when inviting someone to a meeting.
join_token(impl Into<String>)
/set_join_token(Option<String>)
:Token used by the Amazon Chime SDK attendee. Call the CreateAttendee action to get a join token.
- On success, responds with
CreateMeetingDialOutOutput
with field(s):transaction_id(Option<String>)
:Unique ID that tracks API calls.
- On failure, responds with
SdkError<CreateMeetingDialOutError>
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>)
:The 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>)
:The external meeting ID.
meeting_host_id(impl Into<String>)
/set_meeting_host_id(Option<String>)
:Reserved.
media_region(impl Into<String>)
/set_media_region(Option<String>)
:The 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(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:The tag key-value pairs.
notifications_configuration(MeetingNotificationConfiguration)
/set_notifications_configuration(Option<MeetingNotificationConfiguration>)
:The 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(Vec<CreateAttendeeRequestItem>)
/set_attendees(Option<Vec<CreateAttendeeRequestItem>>)
:The request containing the attendees to create.
- On success, responds with
CreateMeetingWithAttendeesOutput
with 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>
Constructs a fluent builder for the CreatePhoneNumberOrder
operation.
- The fluent builder is configurable:
product_type(PhoneNumberProductType)
/set_product_type(Option<PhoneNumberProductType>)
:The phone number product type.
e164_phone_numbers(Vec<String>)
/set_e164_phone_numbers(Option<Vec<String>>)
:List of phone numbers, in E.164 format.
- On success, responds with
CreatePhoneNumberOrderOutput
with field(s):phone_number_order(Option<PhoneNumberOrder>)
:The phone number order details.
- On failure, responds with
SdkError<CreatePhoneNumberOrderError>
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>)
:The Amazon Chime voice connector ID.
participant_phone_numbers(Vec<String>)
/set_participant_phone_numbers(Option<Vec<String>>)
:The participant phone numbers.
name(impl Into<String>)
/set_name(Option<String>)
:The name of the proxy session.
expiry_minutes(i32)
/set_expiry_minutes(Option<i32>)
:The number of minutes allowed for the proxy session.
capabilities(Vec<Capability>)
/set_capabilities(Option<Vec<Capability>>)
:The proxy session capabilities.
number_selection_behavior(NumberSelectionBehavior)
/set_number_selection_behavior(Option<NumberSelectionBehavior>)
:The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.
geo_match_level(GeoMatchLevel)
/set_geo_match_level(Option<GeoMatchLevel>)
:The 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>)
:The country and area code for the proxy phone number.
- On success, responds with
CreateProxySessionOutput
with field(s):proxy_session(Option<ProxySession>)
:The proxy session details.
- On failure, responds with
SdkError<CreateProxySessionError>
Constructs a fluent builder for the CreateRoom
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The Amazon Chime account ID.
name(impl Into<String>)
/set_name(Option<String>)
:The room name.
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
:The idempotency token for the request.
- On success, responds with
CreateRoomOutput
with field(s):room(Option<Room>)
:The room details.
- On failure, responds with
SdkError<CreateRoomError>
Constructs a fluent builder for the CreateRoomMembership
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The Amazon Chime account ID.
room_id(impl Into<String>)
/set_room_id(Option<String>)
:The room ID.
member_id(impl Into<String>)
/set_member_id(Option<String>)
:The Amazon Chime member ID (user ID or bot ID).
role(RoomMembershipRole)
/set_role(Option<RoomMembershipRole>)
:The role of the member.
- On success, responds with
CreateRoomMembershipOutput
with field(s):room_membership(Option<RoomMembership>)
:The room membership details.
- On failure, responds with
SdkError<CreateRoomMembershipError>
Constructs a fluent builder for the CreateSipMediaApplication
operation.
- The fluent builder is configurable:
aws_region(impl Into<String>)
/set_aws_region(Option<String>)
:The AWS Region assigned to the SIP media application.
name(impl Into<String>)
/set_name(Option<String>)
:The SIP media application name.
endpoints(Vec<SipMediaApplicationEndpoint>)
/set_endpoints(Option<Vec<SipMediaApplicationEndpoint>>)
:List of endpoints (Lambda Amazon Resource Names) specified for the SIP media application. Currently, only one endpoint is supported.
- On success, responds with
CreateSipMediaApplicationOutput
with field(s):sip_media_application(Option<SipMediaApplication>)
:The SIP media application details.
- On failure, responds with
SdkError<CreateSipMediaApplicationError>
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>)
:The 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>)
:The phone number that the service should call.
sip_media_application_id(impl Into<String>)
/set_sip_media_application_id(Option<String>)
:The ID of the SIP media application.
sip_headers(HashMap<String, String>)
/set_sip_headers(Option<HashMap<String, String>>)
:The SIP headers added to an outbound call leg.
- On success, responds with
CreateSipMediaApplicationCallOutput
with field(s):sip_media_application_call(Option<SipMediaApplicationCall>)
:The actual call.
- On failure, responds with
SdkError<CreateSipMediaApplicationCallError>
Constructs a fluent builder for the CreateSipRule
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:The name of the SIP rule.
trigger_type(SipRuleTriggerType)
/set_trigger_type(Option<SipRuleTriggerType>)
:The type of trigger assigned to the SIP rule in
TriggerValue
, currentlyRequestUriHostname
orToPhoneNumber
.trigger_value(impl Into<String>)
/set_trigger_value(Option<String>)
:If
TriggerType
isRequestUriHostname
, the value can be the outbound host name of an Amazon Chime Voice Connector. IfTriggerType
isToPhoneNumber
, the value can be a customer-owned phone number in the E164 format. TheSipMediaApplication
specified in theSipRule
is triggered if the request URI in an incoming SIP request matches theRequestUriHostname
, or if theTo
header in the incoming SIP request matches theToPhoneNumber
value.disabled(bool)
/set_disabled(Option<bool>)
:Enables or disables a rule. You must disable rules before you can delete them.
target_applications(Vec<SipRuleTargetApplication>)
/set_target_applications(Option<Vec<SipRuleTargetApplication>>)
:List of SIP media applications with priority and AWS Region. Only one SIP application per AWS Region can be used.
- On success, responds with
CreateSipRuleOutput
with 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>
Constructs a fluent builder for the CreateUser
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The Amazon Chime account ID.
username(impl Into<String>)
/set_username(Option<String>)
:The user name.
email(impl Into<String>)
/set_email(Option<String>)
:The user’s email address.
user_type(UserType)
/set_user_type(Option<UserType>)
:The user type.
- On success, responds with
CreateUserOutput
with field(s):user(Option<User>)
:The user on the Amazon Chime account.
- On failure, responds with
SdkError<CreateUserError>
Constructs a fluent builder for the CreateVoiceConnector
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:The name of the Amazon Chime Voice Connector.
aws_region(VoiceConnectorAwsRegion)
/set_aws_region(Option<VoiceConnectorAwsRegion>)
:The AWS Region in which the Amazon Chime Voice Connector is created. Default value:
us-east-1
.require_encryption(bool)
/set_require_encryption(Option<bool>)
:When enabled, requires encryption for the Amazon Chime Voice Connector.
- On success, responds with
CreateVoiceConnectorOutput
with field(s):voice_connector(Option<VoiceConnector>)
:The Amazon Chime Voice Connector details.
- On failure, responds with
SdkError<CreateVoiceConnectorError>
Constructs a fluent builder for the CreateVoiceConnectorGroup
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:The name of the Amazon Chime Voice Connector group.
voice_connector_items(Vec<VoiceConnectorItem>)
/set_voice_connector_items(Option<Vec<VoiceConnectorItem>>)
:The Amazon Chime Voice Connectors to route inbound calls to.
- On success, responds with
CreateVoiceConnectorGroupOutput
with field(s):voice_connector_group(Option<VoiceConnectorGroup>)
:The Amazon Chime Voice Connector group details.
- On failure, responds with
SdkError<CreateVoiceConnectorGroupError>
Constructs a fluent builder for the DeleteAccount
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The Amazon Chime account ID.
- On success, responds with
DeleteAccountOutput
- On failure, responds with
SdkError<DeleteAccountError>
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>)
:The ARN of the
AppInstance
.
- On success, responds with
DeleteAppInstanceOutput
- On failure, responds with
SdkError<DeleteAppInstanceError>
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>)
:The ARN of the
AppInstance
’s administrator.app_instance_arn(impl Into<String>)
/set_app_instance_arn(Option<String>)
:The ARN of the
AppInstance
.
- On success, responds with
DeleteAppInstanceAdminOutput
- On failure, responds with
SdkError<DeleteAppInstanceAdminError>
pub fn delete_app_instance_streaming_configurations(
&self
) -> DeleteAppInstanceStreamingConfigurations<C, M, R>
pub fn delete_app_instance_streaming_configurations(
&self
) -> DeleteAppInstanceStreamingConfigurations<C, M, R>
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>)
:The ARN of the streaming configurations being deleted.
- On success, responds with
DeleteAppInstanceStreamingConfigurationsOutput
- On failure, responds with
SdkError<DeleteAppInstanceStreamingConfigurationsError>
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>)
:The ARN of the user request being deleted.
- On success, responds with
DeleteAppInstanceUserOutput
- On failure, responds with
SdkError<DeleteAppInstanceUserError>
Constructs a fluent builder for the DeleteAttendee
operation.
- The fluent builder is configurable:
meeting_id(impl Into<String>)
/set_meeting_id(Option<String>)
:The Amazon Chime SDK meeting ID.
attendee_id(impl Into<String>)
/set_attendee_id(Option<String>)
:The Amazon Chime SDK attendee ID.
- On success, responds with
DeleteAttendeeOutput
- On failure, responds with
SdkError<DeleteAttendeeError>
Constructs a fluent builder for the DeleteChannel
operation.
- The fluent builder is configurable:
channel_arn(impl Into<String>)
/set_channel_arn(Option<String>)
:The ARN of the channel being deleted.
chime_bearer(impl Into<String>)
/set_chime_bearer(Option<String>)
:The
AppInstanceUserArn
of the user that makes the API call.
- On success, responds with
DeleteChannelOutput
- On failure, responds with
SdkError<DeleteChannelError>
Constructs a fluent builder for the DeleteChannelBan
operation.
- The fluent builder is configurable:
channel_arn(impl Into<String>)
/set_channel_arn(Option<String>)
:The ARN of the channel from which the
AppInstanceUser
was banned.member_arn(impl Into<String>)
/set_member_arn(Option<String>)
:The ARN of the
AppInstanceUser
that you want to reinstate.chime_bearer(impl Into<String>)
/set_chime_bearer(Option<String>)
:The
AppInstanceUserArn
of the user that makes the API call.
- On success, responds with
DeleteChannelBanOutput
- On failure, responds with
SdkError<DeleteChannelBanError>
Constructs a fluent builder for the DeleteChannelMembership
operation.
- The fluent builder is configurable:
channel_arn(impl Into<String>)
/set_channel_arn(Option<String>)
:The ARN of the channel from which you want to remove the user.
member_arn(impl Into<String>)
/set_member_arn(Option<String>)
:The ARN of the member that you’re removing from the channel.
chime_bearer(impl Into<String>)
/set_chime_bearer(Option<String>)
:The
AppInstanceUserArn
of the user that makes the API call.
- On success, responds with
DeleteChannelMembershipOutput
- On failure, responds with
SdkError<DeleteChannelMembershipError>
Constructs a fluent builder for the DeleteChannelMessage
operation.
- The fluent builder is configurable:
channel_arn(impl Into<String>)
/set_channel_arn(Option<String>)
:The ARN of the channel.
message_id(impl Into<String>)
/set_message_id(Option<String>)
:The ID of the message being deleted.
chime_bearer(impl Into<String>)
/set_chime_bearer(Option<String>)
:The
AppInstanceUserArn
of the user that makes the API call.
- On success, responds with
DeleteChannelMessageOutput
- On failure, responds with
SdkError<DeleteChannelMessageError>
Constructs a fluent builder for the DeleteChannelModerator
operation.
- The fluent builder is configurable:
channel_arn(impl Into<String>)
/set_channel_arn(Option<String>)
:The ARN of the channel.
channel_moderator_arn(impl Into<String>)
/set_channel_moderator_arn(Option<String>)
:The ARN of the moderator being deleted.
chime_bearer(impl Into<String>)
/set_chime_bearer(Option<String>)
:The
AppInstanceUserArn
of the user that makes the API call.
- On success, responds with
DeleteChannelModeratorOutput
- On failure, responds with
SdkError<DeleteChannelModeratorError>
Constructs a fluent builder for the DeleteEventsConfiguration
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The Amazon Chime account ID.
bot_id(impl Into<String>)
/set_bot_id(Option<String>)
:The bot ID.
- On success, responds with
DeleteEventsConfigurationOutput
- On failure, responds with
SdkError<DeleteEventsConfigurationError>
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>)
:The ID of the media capture pipeline being deleted.
- On success, responds with
DeleteMediaCapturePipelineOutput
- On failure, responds with
SdkError<DeleteMediaCapturePipelineError>
Constructs a fluent builder for the DeleteMeeting
operation.
- The fluent builder is configurable:
meeting_id(impl Into<String>)
/set_meeting_id(Option<String>)
:The Amazon Chime SDK meeting ID.
- On success, responds with
DeleteMeetingOutput
- On failure, responds with
SdkError<DeleteMeetingError>
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>)
:The phone number ID.
- On success, responds with
DeletePhoneNumberOutput
- On failure, responds with
SdkError<DeletePhoneNumberError>
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>)
:The Amazon Chime voice connector ID.
proxy_session_id(impl Into<String>)
/set_proxy_session_id(Option<String>)
:The proxy session ID.
- On success, responds with
DeleteProxySessionOutput
- On failure, responds with
SdkError<DeleteProxySessionError>
Constructs a fluent builder for the DeleteRoom
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The Amazon Chime account ID.
room_id(impl Into<String>)
/set_room_id(Option<String>)
:The chat room ID.
- On success, responds with
DeleteRoomOutput
- On failure, responds with
SdkError<DeleteRoomError>
Constructs a fluent builder for the DeleteRoomMembership
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The Amazon Chime account ID.
room_id(impl Into<String>)
/set_room_id(Option<String>)
:The room ID.
member_id(impl Into<String>)
/set_member_id(Option<String>)
:The member ID (user ID or bot ID).
- On success, responds with
DeleteRoomMembershipOutput
- On failure, responds with
SdkError<DeleteRoomMembershipError>
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>)
:The SIP media application ID.
- On success, responds with
DeleteSipMediaApplicationOutput
- On failure, responds with
SdkError<DeleteSipMediaApplicationError>
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>)
:The SIP rule ID.
- On success, responds with
DeleteSipRuleOutput
- On failure, responds with
SdkError<DeleteSipRuleError>
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>)
:The Amazon Chime Voice Connector ID.
- On success, responds with
DeleteVoiceConnectorOutput
- On failure, responds with
SdkError<DeleteVoiceConnectorError>
pub fn delete_voice_connector_emergency_calling_configuration(
&self
) -> DeleteVoiceConnectorEmergencyCallingConfiguration<C, M, R>
pub fn delete_voice_connector_emergency_calling_configuration(
&self
) -> DeleteVoiceConnectorEmergencyCallingConfiguration<C, M, R>
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>)
:The Amazon Chime Voice Connector ID.
- On success, responds with
DeleteVoiceConnectorEmergencyCallingConfigurationOutput
- On failure, responds with
SdkError<DeleteVoiceConnectorEmergencyCallingConfigurationError>
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>)
:The Amazon Chime Voice Connector group ID.
- On success, responds with
DeleteVoiceConnectorGroupOutput
- On failure, responds with
SdkError<DeleteVoiceConnectorGroupError>
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>)
:The Amazon Chime Voice Connector ID.
- On success, responds with
DeleteVoiceConnectorOriginationOutput
- On failure, responds with
SdkError<DeleteVoiceConnectorOriginationError>
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>)
:The Amazon Chime Voice Connector ID.
- On success, responds with
DeleteVoiceConnectorProxyOutput
- On failure, responds with
SdkError<DeleteVoiceConnectorProxyError>
pub fn delete_voice_connector_streaming_configuration(
&self
) -> DeleteVoiceConnectorStreamingConfiguration<C, M, R>
pub fn delete_voice_connector_streaming_configuration(
&self
) -> DeleteVoiceConnectorStreamingConfiguration<C, M, R>
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>)
:The Amazon Chime Voice Connector ID.
- On success, responds with
DeleteVoiceConnectorStreamingConfigurationOutput
- On failure, responds with
SdkError<DeleteVoiceConnectorStreamingConfigurationError>
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>)
:The Amazon Chime Voice Connector ID.
- On success, responds with
DeleteVoiceConnectorTerminationOutput
- On failure, responds with
SdkError<DeleteVoiceConnectorTerminationError>
pub fn delete_voice_connector_termination_credentials(
&self
) -> DeleteVoiceConnectorTerminationCredentials<C, M, R>
pub fn delete_voice_connector_termination_credentials(
&self
) -> DeleteVoiceConnectorTerminationCredentials<C, M, R>
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>)
:The Amazon Chime Voice Connector ID.
usernames(Vec<String>)
/set_usernames(Option<Vec<String>>)
:The RFC2617 compliant username associated with the SIP credentials, in US-ASCII format.
- On success, responds with
DeleteVoiceConnectorTerminationCredentialsOutput
- On failure, responds with
SdkError<DeleteVoiceConnectorTerminationCredentialsError>
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>)
:The ARN of the
AppInstance
.
- On success, responds with
DescribeAppInstanceOutput
with 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>
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>)
:The ARN of the
AppInstanceAdmin
.app_instance_arn(impl Into<String>)
/set_app_instance_arn(Option<String>)
:The ARN of the
AppInstance
.
- On success, responds with
DescribeAppInstanceAdminOutput
with 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>
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>)
:The ARN of the
AppInstanceUser
.
- On success, responds with
DescribeAppInstanceUserOutput
with field(s):app_instance_user(Option<AppInstanceUser>)
:The name of the
AppInstanceUser
.
- On failure, responds with
SdkError<DescribeAppInstanceUserError>
Constructs a fluent builder for the DescribeChannel
operation.
- The fluent builder is configurable:
channel_arn(impl Into<String>)
/set_channel_arn(Option<String>)
:The ARN of the channel.
chime_bearer(impl Into<String>)
/set_chime_bearer(Option<String>)
:The
AppInstanceUserArn
of the user that makes the API call.
- On success, responds with
DescribeChannelOutput
with field(s):channel(Option<Channel>)
:The channel details.
- On failure, responds with
SdkError<DescribeChannelError>
Constructs a fluent builder for the DescribeChannelBan
operation.
- The fluent builder is configurable:
channel_arn(impl Into<String>)
/set_channel_arn(Option<String>)
:The ARN of the channel from which the user is banned.
member_arn(impl Into<String>)
/set_member_arn(Option<String>)
:The ARN of the member being banned.
chime_bearer(impl Into<String>)
/set_chime_bearer(Option<String>)
:The
AppInstanceUserArn
of the user that makes the API call.
- On success, responds with
DescribeChannelBanOutput
with field(s):channel_ban(Option<ChannelBan>)
:The details of the ban.
- On failure, responds with
SdkError<DescribeChannelBanError>
Constructs a fluent builder for the DescribeChannelMembership
operation.
- The fluent builder is configurable:
channel_arn(impl Into<String>)
/set_channel_arn(Option<String>)
:The ARN of the channel.
member_arn(impl Into<String>)
/set_member_arn(Option<String>)
:The ARN of the member.
chime_bearer(impl Into<String>)
/set_chime_bearer(Option<String>)
:The
AppInstanceUserArn
of the user that makes the API call.
- On success, responds with
DescribeChannelMembershipOutput
with field(s):channel_membership(Option<ChannelMembership>)
:The details of the membership.
- On failure, responds with
SdkError<DescribeChannelMembershipError>
pub fn describe_channel_membership_for_app_instance_user(
&self
) -> DescribeChannelMembershipForAppInstanceUser<C, M, R>
pub fn describe_channel_membership_for_app_instance_user(
&self
) -> DescribeChannelMembershipForAppInstanceUser<C, M, R>
Constructs a fluent builder for the DescribeChannelMembershipForAppInstanceUser
operation.
- The fluent builder is configurable:
channel_arn(impl Into<String>)
/set_channel_arn(Option<String>)
:The ARN of the channel to which the user belongs.
app_instance_user_arn(impl Into<String>)
/set_app_instance_user_arn(Option<String>)
:The ARN of the user in a channel.
chime_bearer(impl Into<String>)
/set_chime_bearer(Option<String>)
:The
AppInstanceUserArn
of the user that makes the API call.
- On success, responds with
DescribeChannelMembershipForAppInstanceUserOutput
with field(s):channel_membership(Option<ChannelMembershipForAppInstanceUserSummary>)
:The channel to which a user belongs.
- On failure, responds with
SdkError<DescribeChannelMembershipForAppInstanceUserError>
pub fn describe_channel_moderated_by_app_instance_user(
&self
) -> DescribeChannelModeratedByAppInstanceUser<C, M, R>
pub fn describe_channel_moderated_by_app_instance_user(
&self
) -> DescribeChannelModeratedByAppInstanceUser<C, M, R>
Constructs a fluent builder for the DescribeChannelModeratedByAppInstanceUser
operation.
- The fluent builder is configurable:
channel_arn(impl Into<String>)
/set_channel_arn(Option<String>)
:The ARN of the moderated channel.
app_instance_user_arn(impl Into<String>)
/set_app_instance_user_arn(Option<String>)
:The ARN of the
AppInstanceUser
in the moderated channel.chime_bearer(impl Into<String>)
/set_chime_bearer(Option<String>)
:The
AppInstanceUserArn
of the user that makes the API call.
- On success, responds with
DescribeChannelModeratedByAppInstanceUserOutput
with field(s):channel(Option<ChannelModeratedByAppInstanceUserSummary>)
:The moderated channel.
- On failure, responds with
SdkError<DescribeChannelModeratedByAppInstanceUserError>
Constructs a fluent builder for the DescribeChannelModerator
operation.
- The fluent builder is configurable:
channel_arn(impl Into<String>)
/set_channel_arn(Option<String>)
:The ARN of the channel.
channel_moderator_arn(impl Into<String>)
/set_channel_moderator_arn(Option<String>)
:The ARN of the channel moderator.
chime_bearer(impl Into<String>)
/set_chime_bearer(Option<String>)
:The
AppInstanceUserArn
of the user that makes the API call.
- On success, responds with
DescribeChannelModeratorOutput
with field(s):channel_moderator(Option<ChannelModerator>)
:The details of the channel moderator.
- On failure, responds with
SdkError<DescribeChannelModeratorError>
pub fn disassociate_phone_number_from_user(
&self
) -> DisassociatePhoneNumberFromUser<C, M, R>
pub fn disassociate_phone_number_from_user(
&self
) -> DisassociatePhoneNumberFromUser<C, M, R>
Constructs a fluent builder for the DisassociatePhoneNumberFromUser
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The Amazon Chime account ID.
user_id(impl Into<String>)
/set_user_id(Option<String>)
:The user ID.
- On success, responds with
DisassociatePhoneNumberFromUserOutput
- On failure, responds with
SdkError<DisassociatePhoneNumberFromUserError>
pub fn disassociate_phone_numbers_from_voice_connector(
&self
) -> DisassociatePhoneNumbersFromVoiceConnector<C, M, R>
pub fn disassociate_phone_numbers_from_voice_connector(
&self
) -> DisassociatePhoneNumbersFromVoiceConnector<C, M, R>
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>)
:The Amazon Chime Voice Connector ID.
e164_phone_numbers(Vec<String>)
/set_e164_phone_numbers(Option<Vec<String>>)
:List of phone numbers, in E.164 format.
- On success, responds with
DisassociatePhoneNumbersFromVoiceConnectorOutput
with 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>
pub fn disassociate_phone_numbers_from_voice_connector_group(
&self
) -> DisassociatePhoneNumbersFromVoiceConnectorGroup<C, M, R>
pub fn disassociate_phone_numbers_from_voice_connector_group(
&self
) -> DisassociatePhoneNumbersFromVoiceConnectorGroup<C, M, R>
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>)
:The Amazon Chime Voice Connector group ID.
e164_phone_numbers(Vec<String>)
/set_e164_phone_numbers(Option<Vec<String>>)
:List of phone numbers, in E.164 format.
- On success, responds with
DisassociatePhoneNumbersFromVoiceConnectorGroupOutput
with 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>
pub fn disassociate_signin_delegate_groups_from_account(
&self
) -> DisassociateSigninDelegateGroupsFromAccount<C, M, R>
pub fn disassociate_signin_delegate_groups_from_account(
&self
) -> DisassociateSigninDelegateGroupsFromAccount<C, M, R>
Constructs a fluent builder for the DisassociateSigninDelegateGroupsFromAccount
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The Amazon Chime account ID.
group_names(Vec<String>)
/set_group_names(Option<Vec<String>>)
:The sign-in delegate group names.
- On success, responds with
DisassociateSigninDelegateGroupsFromAccountOutput
- On failure, responds with
SdkError<DisassociateSigninDelegateGroupsFromAccountError>
Constructs a fluent builder for the GetAccount
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The Amazon Chime account ID.
- On success, responds with
GetAccountOutput
with field(s):account(Option<Account>)
:The Amazon Chime account details.
- On failure, responds with
SdkError<GetAccountError>
Constructs a fluent builder for the GetAccountSettings
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The Amazon Chime account ID.
- On success, responds with
GetAccountSettingsOutput
with field(s):account_settings(Option<AccountSettings>)
:The Amazon Chime account settings.
- On failure, responds with
SdkError<GetAccountSettingsError>
pub fn get_app_instance_retention_settings(
&self
) -> GetAppInstanceRetentionSettings<C, M, R>
pub fn get_app_instance_retention_settings(
&self
) -> GetAppInstanceRetentionSettings<C, M, R>
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>)
:The ARN of the
AppInstance
.
- On success, responds with
GetAppInstanceRetentionSettingsOutput
with 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>
pub fn get_app_instance_streaming_configurations(
&self
) -> GetAppInstanceStreamingConfigurations<C, M, R>
pub fn get_app_instance_streaming_configurations(
&self
) -> GetAppInstanceStreamingConfigurations<C, M, R>
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>)
:The ARN of the
AppInstance
.
- On success, responds with
GetAppInstanceStreamingConfigurationsOutput
with field(s):app_instance_streaming_configurations(Option<Vec<AppInstanceStreamingConfiguration>>)
:The streaming settings.
- On failure, responds with
SdkError<GetAppInstanceStreamingConfigurationsError>
Constructs a fluent builder for the GetAttendee
operation.
- The fluent builder is configurable:
meeting_id(impl Into<String>)
/set_meeting_id(Option<String>)
:The Amazon Chime SDK meeting ID.
attendee_id(impl Into<String>)
/set_attendee_id(Option<String>)
:The Amazon Chime SDK attendee ID.
- On success, responds with
GetAttendeeOutput
with field(s):attendee(Option<Attendee>)
:The Amazon Chime SDK attendee information.
- On failure, responds with
SdkError<GetAttendeeError>
Constructs a fluent builder for the GetBot
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The Amazon Chime account ID.
bot_id(impl Into<String>)
/set_bot_id(Option<String>)
:The bot ID.
- On success, responds with
GetBotOutput
with field(s):bot(Option<Bot>)
:The chat bot details.
- On failure, responds with
SdkError<GetBotError>
Constructs a fluent builder for the GetChannelMessage
operation.
- The fluent builder is configurable:
channel_arn(impl Into<String>)
/set_channel_arn(Option<String>)
:The ARN of the channel.
message_id(impl Into<String>)
/set_message_id(Option<String>)
:The ID of the message.
chime_bearer(impl Into<String>)
/set_chime_bearer(Option<String>)
:The
AppInstanceUserArn
of the user that makes the API call.
- On success, responds with
GetChannelMessageOutput
with field(s):channel_message(Option<ChannelMessage>)
:The details of and content in the message.
- On failure, responds with
SdkError<GetChannelMessageError>
Constructs a fluent builder for the GetEventsConfiguration
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The Amazon Chime account ID.
bot_id(impl Into<String>)
/set_bot_id(Option<String>)
:The bot ID.
- On success, responds with
GetEventsConfigurationOutput
with field(s):events_configuration(Option<EventsConfiguration>)
:The events configuration details.
- On failure, responds with
SdkError<GetEventsConfigurationError>
Constructs a fluent builder for the GetGlobalSettings
operation.
- The fluent builder takes no input, just
send
it. - On success, responds with
GetGlobalSettingsOutput
with 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>
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>)
:The ID of the pipeline that you want to get.
- On success, responds with
GetMediaCapturePipelineOutput
with field(s):media_capture_pipeline(Option<MediaCapturePipeline>)
:The media capture pipeline object.
- On failure, responds with
SdkError<GetMediaCapturePipelineError>
Constructs a fluent builder for the GetMeeting
operation.
- The fluent builder is configurable:
meeting_id(impl Into<String>)
/set_meeting_id(Option<String>)
:The Amazon Chime SDK meeting ID.
- On success, responds with
GetMeetingOutput
with field(s):meeting(Option<Meeting>)
:The Amazon Chime SDK meeting information.
- On failure, responds with
SdkError<GetMeetingError>
Constructs a fluent builder for the GetMessagingSessionEndpoint
operation.
- The fluent builder takes no input, just
send
it. - On success, responds with
GetMessagingSessionEndpointOutput
with field(s):endpoint(Option<MessagingSessionEndpoint>)
:The endpoint returned in the response.
- On failure, responds with
SdkError<GetMessagingSessionEndpointError>
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>)
:The phone number ID.
- On success, responds with
GetPhoneNumberOutput
with field(s):phone_number(Option<PhoneNumber>)
:The phone number details.
- On failure, responds with
SdkError<GetPhoneNumberError>
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>)
:The ID for the phone number order.
- On success, responds with
GetPhoneNumberOrderOutput
with field(s):phone_number_order(Option<PhoneNumberOrder>)
:The phone number order details.
- On failure, responds with
SdkError<GetPhoneNumberOrderError>
Constructs a fluent builder for the GetPhoneNumberSettings
operation.
- The fluent builder takes no input, just
send
it. - On success, responds with
GetPhoneNumberSettingsOutput
with 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>
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>)
:The Amazon Chime voice connector ID.
proxy_session_id(impl Into<String>)
/set_proxy_session_id(Option<String>)
:The proxy session ID.
- On success, responds with
GetProxySessionOutput
with field(s):proxy_session(Option<ProxySession>)
:The proxy session details.
- On failure, responds with
SdkError<GetProxySessionError>
Constructs a fluent builder for the GetRetentionSettings
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The Amazon Chime account ID.
- On success, responds with
GetRetentionSettingsOutput
with 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>
Constructs a fluent builder for the GetRoom
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The Amazon Chime account ID.
room_id(impl Into<String>)
/set_room_id(Option<String>)
:The room ID.
- On success, responds with
GetRoomOutput
with field(s):room(Option<Room>)
:The room details.
- On failure, responds with
SdkError<GetRoomError>
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>)
:The SIP media application ID.
- On success, responds with
GetSipMediaApplicationOutput
with field(s):sip_media_application(Option<SipMediaApplication>)
:The SIP media application details.
- On failure, responds with
SdkError<GetSipMediaApplicationError>
pub fn get_sip_media_application_logging_configuration(
&self
) -> GetSipMediaApplicationLoggingConfiguration<C, M, R>
pub fn get_sip_media_application_logging_configuration(
&self
) -> GetSipMediaApplicationLoggingConfiguration<C, M, R>
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>)
:The SIP media application ID.
- On success, responds with
GetSipMediaApplicationLoggingConfigurationOutput
with field(s):sip_media_application_logging_configuration(Option<SipMediaApplicationLoggingConfiguration>)
:The actual logging configuration.
- On failure, responds with
SdkError<GetSipMediaApplicationLoggingConfigurationError>
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>)
:The SIP rule ID.
- On success, responds with
GetSipRuleOutput
with field(s):sip_rule(Option<SipRule>)
:The SIP rule details.
- On failure, responds with
SdkError<GetSipRuleError>
Constructs a fluent builder for the GetUser
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The Amazon Chime account ID.
user_id(impl Into<String>)
/set_user_id(Option<String>)
:The user ID.
- On success, responds with
GetUserOutput
with field(s):user(Option<User>)
:The user details.
- On failure, responds with
SdkError<GetUserError>
Constructs a fluent builder for the GetUserSettings
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The Amazon Chime account ID.
user_id(impl Into<String>)
/set_user_id(Option<String>)
:The user ID.
- On success, responds with
GetUserSettingsOutput
with field(s):user_settings(Option<UserSettings>)
:The user settings.
- On failure, responds with
SdkError<GetUserSettingsError>
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>)
:The Amazon Chime Voice Connector ID.
- On success, responds with
GetVoiceConnectorOutput
with field(s):voice_connector(Option<VoiceConnector>)
:The Amazon Chime Voice Connector details.
- On failure, responds with
SdkError<GetVoiceConnectorError>
pub fn get_voice_connector_emergency_calling_configuration(
&self
) -> GetVoiceConnectorEmergencyCallingConfiguration<C, M, R>
pub fn get_voice_connector_emergency_calling_configuration(
&self
) -> GetVoiceConnectorEmergencyCallingConfiguration<C, M, R>
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>)
:The Amazon Chime Voice Connector ID.
- On success, responds with
GetVoiceConnectorEmergencyCallingConfigurationOutput
with field(s):emergency_calling_configuration(Option<EmergencyCallingConfiguration>)
:The emergency calling configuration details.
- On failure, responds with
SdkError<GetVoiceConnectorEmergencyCallingConfigurationError>
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>)
:The Amazon Chime Voice Connector group ID.
- On success, responds with
GetVoiceConnectorGroupOutput
with field(s):voice_connector_group(Option<VoiceConnectorGroup>)
:The Amazon Chime Voice Connector group details.
- On failure, responds with
SdkError<GetVoiceConnectorGroupError>
pub fn get_voice_connector_logging_configuration(
&self
) -> GetVoiceConnectorLoggingConfiguration<C, M, R>
pub fn get_voice_connector_logging_configuration(
&self
) -> GetVoiceConnectorLoggingConfiguration<C, M, R>
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>)
:The Amazon Chime Voice Connector ID.
- On success, responds with
GetVoiceConnectorLoggingConfigurationOutput
with field(s):logging_configuration(Option<LoggingConfiguration>)
:The logging configuration details.
- On failure, responds with
SdkError<GetVoiceConnectorLoggingConfigurationError>
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>)
:The Amazon Chime Voice Connector ID.
- On success, responds with
GetVoiceConnectorOriginationOutput
with field(s):origination(Option<Origination>)
:The origination setting details.
- On failure, responds with
SdkError<GetVoiceConnectorOriginationError>
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>)
:The Amazon Chime voice connector ID.
- On success, responds with
GetVoiceConnectorProxyOutput
with field(s):proxy(Option<Proxy>)
:The proxy configuration details.
- On failure, responds with
SdkError<GetVoiceConnectorProxyError>
pub fn get_voice_connector_streaming_configuration(
&self
) -> GetVoiceConnectorStreamingConfiguration<C, M, R>
pub fn get_voice_connector_streaming_configuration(
&self
) -> GetVoiceConnectorStreamingConfiguration<C, M, R>
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>)
:The Amazon Chime Voice Connector ID.
- On success, responds with
GetVoiceConnectorStreamingConfigurationOutput
with field(s):streaming_configuration(Option<StreamingConfiguration>)
:The streaming configuration details.
- On failure, responds with
SdkError<GetVoiceConnectorStreamingConfigurationError>
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>)
:The Amazon Chime Voice Connector ID.
- On success, responds with
GetVoiceConnectorTerminationOutput
with field(s):termination(Option<Termination>)
:The termination setting details.
- On failure, responds with
SdkError<GetVoiceConnectorTerminationError>
pub fn get_voice_connector_termination_health(
&self
) -> GetVoiceConnectorTerminationHealth<C, M, R>
pub fn get_voice_connector_termination_health(
&self
) -> GetVoiceConnectorTerminationHealth<C, M, R>
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>)
:The Amazon Chime Voice Connector ID.
- On success, responds with
GetVoiceConnectorTerminationHealthOutput
with field(s):termination_health(Option<TerminationHealth>)
:The termination health details.
- On failure, responds with
SdkError<GetVoiceConnectorTerminationHealthError>
Constructs a fluent builder for the InviteUsers
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The Amazon Chime account ID.
user_email_list(Vec<String>)
/set_user_email_list(Option<Vec<String>>)
:The user email addresses to which to send the email invitation.
user_type(UserType)
/set_user_type(Option<UserType>)
:The user type.
- On success, responds with
InviteUsersOutput
with field(s):invites(Option<Vec<Invite>>)
:The email invitation details.
- On failure, responds with
SdkError<InviteUsersError>
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>)
:Amazon Chime account name prefix with which to filter results.
user_email(impl Into<String>)
/set_user_email(Option<String>)
:User email address with which to filter results.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token to use to retrieve the next page of results.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to return in a single call. Defaults to 100.
- On success, responds with
ListAccountsOutput
with 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>
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>)
:The ARN of the
AppInstance
.max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of administrators that you want to return.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token returned from previous API requests until the number of administrators is reached.
- On success, responds with
ListAppInstanceAdminsOutput
with 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>
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>)
:The maximum number of
AppInstance
s that you want to return.next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token passed by previous API requests until you reach the maximum number of
AppInstance
s.
- On success, responds with
ListAppInstancesOutput
with 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
AppInstance
s is reached.
- On failure, responds with
SdkError<ListAppInstancesError>
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>)
:The ARN of the
AppInstance
.max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of requests that you want returned.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token passed by previous API calls until all requested users are returned.
- On success, responds with
ListAppInstanceUsersOutput
with 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>
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>)
:The Amazon Chime SDK meeting ID.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token to use to retrieve the next page of results.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to return in a single call.
- On success, responds with
ListAttendeesOutput
with 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>
Constructs a fluent builder for the ListAttendeeTags
operation.
- The fluent builder is configurable:
meeting_id(impl Into<String>)
/set_meeting_id(Option<String>)
:The Amazon Chime SDK meeting ID.
attendee_id(impl Into<String>)
/set_attendee_id(Option<String>)
:The Amazon Chime SDK attendee ID.
- On success, responds with
ListAttendeeTagsOutput
with field(s):tags(Option<Vec<Tag>>)
:A list of tag key-value pairs.
- On failure, responds with
SdkError<ListAttendeeTagsError>
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>)
:The Amazon Chime account ID.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to return in a single call. The default is 10.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token to use to retrieve the next page of results.
- On success, responds with
ListBotsOutput
with 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>
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>)
:The ARN of the channel.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of bans that you want returned.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token passed by previous API calls until all requested bans are returned.
chime_bearer(impl Into<String>)
/set_chime_bearer(Option<String>)
:The
AppInstanceUserArn
of the user that makes the API call.
- On success, responds with
ListChannelBansOutput
with 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>
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>)
:The maximum number of channel memberships that you want returned.
r#type(ChannelMembershipType)
/set_type(Option<ChannelMembershipType>)
:The membership type of a user,
DEFAULT
orHIDDEN
. Default members are always returned as part ofListChannelMemberships
. Hidden members are only returned if the type filter inListChannelMemberships
equalsHIDDEN
. Otherwise hidden members are not returned.max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of channel memberships that you want returned.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token passed by previous API calls until all requested channel memberships are returned.
chime_bearer(impl Into<String>)
/set_chime_bearer(Option<String>)
:The
AppInstanceUserArn
of the user that makes the API call.
- On success, responds with
ListChannelMembershipsOutput
with 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>
pub fn list_channel_memberships_for_app_instance_user(
&self
) -> ListChannelMembershipsForAppInstanceUser<C, M, R>
pub fn list_channel_memberships_for_app_instance_user(
&self
) -> ListChannelMembershipsForAppInstanceUser<C, M, R>
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>)
:The ARN of the
AppInstanceUser
smax_results(i32)
/set_max_results(Option<i32>)
:The maximum number of users that you want returned.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token returned from previous API requests until the number of channel memberships is reached.
chime_bearer(impl Into<String>)
/set_chime_bearer(Option<String>)
:The
AppInstanceUserArn
of the user that makes the API call.
- On success, responds with
ListChannelMembershipsForAppInstanceUserOutput
with field(s):channel_memberships(Option<Vec<ChannelMembershipForAppInstanceUserSummary>>)
:The token passed by previous API calls until all requested users are returned.
next_token(Option<String>)
:The token passed by previous API calls until all requested users are returned.
- On failure, responds with
SdkError<ListChannelMembershipsForAppInstanceUserError>
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>)
:The ARN of the channel.
sort_order(SortOrder)
/set_sort_order(Option<SortOrder>)
:The order in which you want messages sorted. Default is Descending, based on time created.
not_before(DateTime)
/set_not_before(Option<DateTime>)
:The initial or starting time stamp for your requested messages.
not_after(DateTime)
/set_not_after(Option<DateTime>)
:The final or ending time stamp for your requested messages.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of messages that you want returned.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token passed by previous API calls until all requested messages are returned.
chime_bearer(impl Into<String>)
/set_chime_bearer(Option<String>)
:The
AppInstanceUserArn
of the user that makes the API call.
- On success, responds with
ListChannelMessagesOutput
with 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>
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>)
:The ARN of the channel.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of moderators that you want returned.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token passed by previous API calls until all requested moderators are returned.
chime_bearer(impl Into<String>)
/set_chime_bearer(Option<String>)
:The
AppInstanceUserArn
of the user that makes the API call.
- On success, responds with
ListChannelModeratorsOutput
with 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>
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>)
:The ARN of the
AppInstance
.privacy(ChannelPrivacy)
/set_privacy(Option<ChannelPrivacy>)
:The privacy setting.
PUBLIC
retrieves all the public channels.PRIVATE
retrieves private channels. Only anAppInstanceAdmin
can retrieve private channels.max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of channels that you want to return.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token passed by previous API calls until all requested channels are returned.
chime_bearer(impl Into<String>)
/set_chime_bearer(Option<String>)
:The
AppInstanceUserArn
of the user that makes the API call.
- On success, responds with
ListChannelsOutput
with 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>
pub fn list_channels_moderated_by_app_instance_user(
&self
) -> ListChannelsModeratedByAppInstanceUser<C, M, R>
pub fn list_channels_moderated_by_app_instance_user(
&self
) -> ListChannelsModeratedByAppInstanceUser<C, M, R>
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>)
:The ARN of the user in the moderated channel.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of channels in the request.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The 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>)
:The
AppInstanceUserArn
of the user that makes the API call.
- On success, responds with
ListChannelsModeratedByAppInstanceUserOutput
with 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>
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>)
:The token used to retrieve the next page of results.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to return in a single call. Valid Range: 1 - 99.
- On success, responds with
ListMediaCapturePipelinesOutput
with 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>
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>)
:The token to use to retrieve the next page of results.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to return in a single call.
- On success, responds with
ListMeetingsOutput
with 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>
Constructs a fluent builder for the ListMeetingTags
operation.
- The fluent builder is configurable:
meeting_id(impl Into<String>)
/set_meeting_id(Option<String>)
:The Amazon Chime SDK meeting ID.
- On success, responds with
ListMeetingTagsOutput
with field(s):tags(Option<Vec<Tag>>)
:A list of tag key-value pairs.
- On failure, responds with
SdkError<ListMeetingTagsError>
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>)
:The token to use to retrieve the next page of results.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to return in a single call.
- On success, responds with
ListPhoneNumberOrdersOutput
with 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>
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>)
:The phone number status.
product_type(PhoneNumberProductType)
/set_product_type(Option<PhoneNumberProductType>)
:The phone number product type.
filter_name(PhoneNumberAssociationName)
/set_filter_name(Option<PhoneNumberAssociationName>)
:The filter to use to limit the number of results.
filter_value(impl Into<String>)
/set_filter_value(Option<String>)
:The value to use for the filter.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to return in a single call.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token to use to retrieve the next page of results.
- On success, responds with
ListPhoneNumbersOutput
with 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>
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>)
:The Amazon Chime voice connector ID.
status(ProxySessionStatus)
/set_status(Option<ProxySessionStatus>)
:The proxy session status.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token to use to retrieve the next page of results.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to return in a single call.
- On success, responds with
ListProxySessionsOutput
with 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>
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>)
:The Amazon Chime account ID.
room_id(impl Into<String>)
/set_room_id(Option<String>)
:The room ID.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to return in a single call.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token to use to retrieve the next page of results.
- On success, responds with
ListRoomMembershipsOutput
with 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>
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>)
:The Amazon Chime account ID.
member_id(impl Into<String>)
/set_member_id(Option<String>)
:The member ID (user ID or bot ID).
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to return in a single call.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token to use to retrieve the next page of results.
- On success, responds with
ListRoomsOutput
with 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>
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>)
:The maximum number of results to return in a single call. Defaults to 100.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token to use to retrieve the next page of results.
- On success, responds with
ListSipMediaApplicationsOutput
with 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>
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>)
:The SIP media application ID.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to return in a single call. Defaults to 100.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token to use to retrieve the next page of results.
- On success, responds with
ListSipRulesOutput
with 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>
pub fn list_supported_phone_number_countries(
&self
) -> ListSupportedPhoneNumberCountries<C, M, R>
pub fn list_supported_phone_number_countries(
&self
) -> ListSupportedPhoneNumberCountries<C, M, R>
Constructs a fluent builder for the ListSupportedPhoneNumberCountries
operation.
- The fluent builder is configurable:
product_type(PhoneNumberProductType)
/set_product_type(Option<PhoneNumberProductType>)
:The phone number product type.
- On success, responds with
ListSupportedPhoneNumberCountriesOutput
with field(s):phone_number_countries(Option<Vec<PhoneNumberCountry>>)
:The supported phone number countries.
- On failure, responds with
SdkError<ListSupportedPhoneNumberCountriesError>
Constructs a fluent builder for the ListTagsForResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:The resource ARN.
- On success, responds with
ListTagsForResourceOutput
with field(s):tags(Option<Vec<Tag>>)
:A list of tag-key value pairs.
- On failure, responds with
SdkError<ListTagsForResourceError>
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>)
:The Amazon Chime account ID.
user_email(impl Into<String>)
/set_user_email(Option<String>)
:Optional. The user email address used to filter results. Maximum 1.
user_type(UserType)
/set_user_type(Option<UserType>)
:The user type.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to return in a single call. Defaults to 100.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token to use to retrieve the next page of results.
- On success, responds with
ListUsersOutput
with 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>
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>)
:The token to use to retrieve the next page of results.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to return in a single call.
- On success, responds with
ListVoiceConnectorGroupsOutput
with 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>
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>)
:The token to use to retrieve the next page of results.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to return in a single call.
- On success, responds with
ListVoiceConnectorsOutput
with 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>
pub fn list_voice_connector_termination_credentials(
&self
) -> ListVoiceConnectorTerminationCredentials<C, M, R>
pub fn list_voice_connector_termination_credentials(
&self
) -> ListVoiceConnectorTerminationCredentials<C, M, R>
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>)
:The Amazon Chime Voice Connector ID.
- On success, responds with
ListVoiceConnectorTerminationCredentialsOutput
with field(s):usernames(Option<Vec<String>>)
:A list of user names.
- On failure, responds with
SdkError<ListVoiceConnectorTerminationCredentialsError>
Constructs a fluent builder for the LogoutUser
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The Amazon Chime account ID.
user_id(impl Into<String>)
/set_user_id(Option<String>)
:The user ID.
- On success, responds with
LogoutUserOutput
- On failure, responds with
SdkError<LogoutUserError>
pub fn put_app_instance_retention_settings(
&self
) -> PutAppInstanceRetentionSettings<C, M, R>
pub fn put_app_instance_retention_settings(
&self
) -> PutAppInstanceRetentionSettings<C, M, R>
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>)
:The ARN of the
AppInstance
.app_instance_retention_settings(AppInstanceRetentionSettings)
/set_app_instance_retention_settings(Option<AppInstanceRetentionSettings>)
:The time in days to retain data. Data type: number.
- On success, responds with
PutAppInstanceRetentionSettingsOutput
with 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>
pub fn put_app_instance_streaming_configurations(
&self
) -> PutAppInstanceStreamingConfigurations<C, M, R>
pub fn put_app_instance_streaming_configurations(
&self
) -> PutAppInstanceStreamingConfigurations<C, M, R>
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>)
:The ARN of the
AppInstance
.app_instance_streaming_configurations(Vec<AppInstanceStreamingConfiguration>)
/set_app_instance_streaming_configurations(Option<Vec<AppInstanceStreamingConfiguration>>)
:The streaming configurations set for an
AppInstance
.
- On success, responds with
PutAppInstanceStreamingConfigurationsOutput
with field(s):app_instance_streaming_configurations(Option<Vec<AppInstanceStreamingConfiguration>>)
:The streaming configurations of an
AppInstance
.
- On failure, responds with
SdkError<PutAppInstanceStreamingConfigurationsError>
Constructs a fluent builder for the PutEventsConfiguration
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The Amazon Chime account ID.
bot_id(impl Into<String>)
/set_bot_id(Option<String>)
:The bot ID.
outbound_events_https_endpoint(impl Into<String>)
/set_outbound_events_https_endpoint(Option<String>)
:HTTPS endpoint that allows the bot to receive outgoing events.
lambda_function_arn(impl Into<String>)
/set_lambda_function_arn(Option<String>)
:Lambda function ARN that allows the bot to receive outgoing events.
- On success, responds with
PutEventsConfigurationOutput
with field(s):events_configuration(Option<EventsConfiguration>)
:The configuration that allows a bot to receive outgoing events. Can be either an HTTPS endpoint or a Lambda function ARN.
- On failure, responds with
SdkError<PutEventsConfigurationError>
Constructs a fluent builder for the PutRetentionSettings
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The Amazon Chime account ID.
retention_settings(RetentionSettings)
/set_retention_settings(Option<RetentionSettings>)
:The retention settings.
- On success, responds with
PutRetentionSettingsOutput
with 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>
pub fn put_sip_media_application_logging_configuration(
&self
) -> PutSipMediaApplicationLoggingConfiguration<C, M, R>
pub fn put_sip_media_application_logging_configuration(
&self
) -> PutSipMediaApplicationLoggingConfiguration<C, M, R>
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>)
:The SIP media application ID.
sip_media_application_logging_configuration(SipMediaApplicationLoggingConfiguration)
/set_sip_media_application_logging_configuration(Option<SipMediaApplicationLoggingConfiguration>)
:The actual logging configuration.
- On success, responds with
PutSipMediaApplicationLoggingConfigurationOutput
with field(s):sip_media_application_logging_configuration(Option<SipMediaApplicationLoggingConfiguration>)
:Logging configuration of the SIP media application.
- On failure, responds with
SdkError<PutSipMediaApplicationLoggingConfigurationError>
pub fn put_voice_connector_emergency_calling_configuration(
&self
) -> PutVoiceConnectorEmergencyCallingConfiguration<C, M, R>
pub fn put_voice_connector_emergency_calling_configuration(
&self
) -> PutVoiceConnectorEmergencyCallingConfiguration<C, M, R>
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>)
:The Amazon Chime Voice Connector ID.
emergency_calling_configuration(EmergencyCallingConfiguration)
/set_emergency_calling_configuration(Option<EmergencyCallingConfiguration>)
:The emergency calling configuration details.
- On success, responds with
PutVoiceConnectorEmergencyCallingConfigurationOutput
with field(s):emergency_calling_configuration(Option<EmergencyCallingConfiguration>)
:The emergency calling configuration details.
- On failure, responds with
SdkError<PutVoiceConnectorEmergencyCallingConfigurationError>
pub fn put_voice_connector_logging_configuration(
&self
) -> PutVoiceConnectorLoggingConfiguration<C, M, R>
pub fn put_voice_connector_logging_configuration(
&self
) -> PutVoiceConnectorLoggingConfiguration<C, M, R>
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>)
:The Amazon Chime Voice Connector ID.
logging_configuration(LoggingConfiguration)
/set_logging_configuration(Option<LoggingConfiguration>)
:The logging configuration details to add.
- On success, responds with
PutVoiceConnectorLoggingConfigurationOutput
with field(s):logging_configuration(Option<LoggingConfiguration>)
:The updated logging configuration details.
- On failure, responds with
SdkError<PutVoiceConnectorLoggingConfigurationError>
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>)
:The Amazon Chime Voice Connector ID.
origination(Origination)
/set_origination(Option<Origination>)
:The origination setting details to add.
- On success, responds with
PutVoiceConnectorOriginationOutput
with field(s):origination(Option<Origination>)
:The updated origination setting details.
- On failure, responds with
SdkError<PutVoiceConnectorOriginationError>
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>)
:The Amazon Chime voice connector ID.
default_session_expiry_minutes(i32)
/set_default_session_expiry_minutes(Option<i32>)
:The default number of minutes allowed for proxy sessions.
phone_number_pool_countries(Vec<String>)
/set_phone_number_pool_countries(Option<Vec<String>>)
:The countries for proxy phone numbers to be selected from.
fall_back_phone_number(impl Into<String>)
/set_fall_back_phone_number(Option<String>)
:The phone number to route calls to after a proxy session expires.
disabled(bool)
/set_disabled(Option<bool>)
:When true, stops proxy sessions from being created on the specified Amazon Chime Voice Connector.
- On success, responds with
PutVoiceConnectorProxyOutput
with field(s):proxy(Option<Proxy>)
:The proxy configuration details.
- On failure, responds with
SdkError<PutVoiceConnectorProxyError>
pub fn put_voice_connector_streaming_configuration(
&self
) -> PutVoiceConnectorStreamingConfiguration<C, M, R>
pub fn put_voice_connector_streaming_configuration(
&self
) -> PutVoiceConnectorStreamingConfiguration<C, M, R>
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>)
:The Amazon Chime Voice Connector ID.
streaming_configuration(StreamingConfiguration)
/set_streaming_configuration(Option<StreamingConfiguration>)
:The streaming configuration details to add.
- On success, responds with
PutVoiceConnectorStreamingConfigurationOutput
with field(s):streaming_configuration(Option<StreamingConfiguration>)
:The updated streaming configuration details.
- On failure, responds with
SdkError<PutVoiceConnectorStreamingConfigurationError>
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>)
:The Amazon Chime Voice Connector ID.
termination(Termination)
/set_termination(Option<Termination>)
:The termination setting details to add.
- On success, responds with
PutVoiceConnectorTerminationOutput
with field(s):termination(Option<Termination>)
:The updated termination setting details.
- On failure, responds with
SdkError<PutVoiceConnectorTerminationError>
pub fn put_voice_connector_termination_credentials(
&self
) -> PutVoiceConnectorTerminationCredentials<C, M, R>
pub fn put_voice_connector_termination_credentials(
&self
) -> PutVoiceConnectorTerminationCredentials<C, M, R>
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>)
:The Amazon Chime Voice Connector ID.
credentials(Vec<Credential>)
/set_credentials(Option<Vec<Credential>>)
:The termination SIP credentials.
- On success, responds with
PutVoiceConnectorTerminationCredentialsOutput
- On failure, responds with
SdkError<PutVoiceConnectorTerminationCredentialsError>
Constructs a fluent builder for the RedactChannelMessage
operation.
- The fluent builder is configurable:
channel_arn(impl Into<String>)
/set_channel_arn(Option<String>)
:The ARN of the channel containing the messages that you want to redact.
message_id(impl Into<String>)
/set_message_id(Option<String>)
:The ID of the message being redacted.
chime_bearer(impl Into<String>)
/set_chime_bearer(Option<String>)
:The
AppInstanceUserArn
of the user that makes the API call.
- On success, responds with
RedactChannelMessageOutput
with 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>
Constructs a fluent builder for the RedactConversationMessage
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The Amazon Chime account ID.
conversation_id(impl Into<String>)
/set_conversation_id(Option<String>)
:The conversation ID.
message_id(impl Into<String>)
/set_message_id(Option<String>)
:The message ID.
- On success, responds with
RedactConversationMessageOutput
- On failure, responds with
SdkError<RedactConversationMessageError>
Constructs a fluent builder for the RedactRoomMessage
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The Amazon Chime account ID.
room_id(impl Into<String>)
/set_room_id(Option<String>)
:The room ID.
message_id(impl Into<String>)
/set_message_id(Option<String>)
:The message ID.
- On success, responds with
RedactRoomMessageOutput
- On failure, responds with
SdkError<RedactRoomMessageError>
Constructs a fluent builder for the RegenerateSecurityToken
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The Amazon Chime account ID.
bot_id(impl Into<String>)
/set_bot_id(Option<String>)
:The bot ID.
- On success, responds with
RegenerateSecurityTokenOutput
with field(s):bot(Option<Bot>)
:A resource that allows Enterprise account administrators to configure an interface to receive events from Amazon Chime.
- On failure, responds with
SdkError<RegenerateSecurityTokenError>
Constructs a fluent builder for the ResetPersonalPIN
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The Amazon Chime account ID.
user_id(impl Into<String>)
/set_user_id(Option<String>)
:The user ID.
- On success, responds with
ResetPersonalPinOutput
with field(s):user(Option<User>)
:The user details and new personal meeting PIN.
- On failure, responds with
SdkError<ResetPersonalPINError>
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>)
:The phone number.
- On success, responds with
RestorePhoneNumberOutput
with field(s):phone_number(Option<PhoneNumber>)
:The phone number details.
- On failure, responds with
SdkError<RestorePhoneNumberError>
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>)
:The area code used to filter results. Only applies to the US.
city(impl Into<String>)
/set_city(Option<String>)
:The city used to filter results. Only applies to the US.
country(impl Into<String>)
/set_country(Option<String>)
:The country used to filter results. Defaults to the US Format: ISO 3166-1 alpha-2.
state(impl Into<String>)
/set_state(Option<String>)
:The 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>)
:The toll-free prefix that you use to filter results. Only applies to the US.
phone_number_type(PhoneNumberType)
/set_phone_number_type(Option<PhoneNumberType>)
:The phone number type used to filter results. Required for non-US numbers.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to return in a single call.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token used to retrieve the next page of results.
- On success, responds with
SearchAvailablePhoneNumbersOutput
with 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>
Constructs a fluent builder for the SendChannelMessage
operation.
- The fluent builder is configurable:
channel_arn(impl Into<String>)
/set_channel_arn(Option<String>)
:The ARN of the channel.
content(impl Into<String>)
/set_content(Option<String>)
:The content of the message.
r#type(ChannelMessageType)
/set_type(Option<ChannelMessageType>)
:The type of message,
STANDARD
orCONTROL
.persistence(ChannelMessagePersistenceType)
/set_persistence(Option<ChannelMessagePersistenceType>)
:Boolean that controls whether the message is persisted on the back end. Required.
metadata(impl Into<String>)
/set_metadata(Option<String>)
:The optional metadata for each message.
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
:The
Idempotency
token for each client request.chime_bearer(impl Into<String>)
/set_chime_bearer(Option<String>)
:The
AppInstanceUserArn
of the user that makes the API call.
- On success, responds with
SendChannelMessageOutput
with 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>
Constructs a fluent builder for the StartMeetingTranscription
operation.
- The fluent builder is configurable:
meeting_id(impl Into<String>)
/set_meeting_id(Option<String>)
:The unique ID of the meeting being transcribed.
transcription_configuration(TranscriptionConfiguration)
/set_transcription_configuration(Option<TranscriptionConfiguration>)
:The configuration for the current transcription operation. Must contain
EngineTranscribeSettings
orEngineTranscribeMedicalSettings
.
- On success, responds with
StartMeetingTranscriptionOutput
- On failure, responds with
SdkError<StartMeetingTranscriptionError>
Constructs a fluent builder for the StopMeetingTranscription
operation.
- The fluent builder is configurable:
meeting_id(impl Into<String>)
/set_meeting_id(Option<String>)
:The unique ID of the meeting for which you stop transcription.
- On success, responds with
StopMeetingTranscriptionOutput
- On failure, responds with
SdkError<StopMeetingTranscriptionError>
Constructs a fluent builder for the TagAttendee
operation.
- The fluent builder is configurable:
meeting_id(impl Into<String>)
/set_meeting_id(Option<String>)
:The Amazon Chime SDK meeting ID.
attendee_id(impl Into<String>)
/set_attendee_id(Option<String>)
:The Amazon Chime SDK attendee ID.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:The tag key-value pairs.
- On success, responds with
TagAttendeeOutput
- On failure, responds with
SdkError<TagAttendeeError>
Constructs a fluent builder for the TagMeeting
operation.
- The fluent builder is configurable:
meeting_id(impl Into<String>)
/set_meeting_id(Option<String>)
:The Amazon Chime SDK meeting ID.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:The tag key-value pairs.
- On success, responds with
TagMeetingOutput
- On failure, responds with
SdkError<TagMeetingError>
Constructs a fluent builder for the TagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:The resource ARN.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:The tag key-value pairs.
- On success, responds with
TagResourceOutput
- On failure, responds with
SdkError<TagResourceError>
Constructs a fluent builder for the UntagAttendee
operation.
- The fluent builder is configurable:
meeting_id(impl Into<String>)
/set_meeting_id(Option<String>)
:The Amazon Chime SDK meeting ID.
attendee_id(impl Into<String>)
/set_attendee_id(Option<String>)
:The Amazon Chime SDK attendee ID.
tag_keys(Vec<String>)
/set_tag_keys(Option<Vec<String>>)
:The tag keys.
- On success, responds with
UntagAttendeeOutput
- On failure, responds with
SdkError<UntagAttendeeError>
Constructs a fluent builder for the UntagMeeting
operation.
- The fluent builder is configurable:
meeting_id(impl Into<String>)
/set_meeting_id(Option<String>)
:The Amazon Chime SDK meeting ID.
tag_keys(Vec<String>)
/set_tag_keys(Option<Vec<String>>)
:The tag keys.
- On success, responds with
UntagMeetingOutput
- On failure, responds with
SdkError<UntagMeetingError>
Constructs a fluent builder for the UntagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:The resource ARN.
tag_keys(Vec<String>)
/set_tag_keys(Option<Vec<String>>)
:The tag keys.
- On success, responds with
UntagResourceOutput
- On failure, responds with
SdkError<UntagResourceError>
Constructs a fluent builder for the UpdateAccount
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The Amazon Chime account ID.
name(impl Into<String>)
/set_name(Option<String>)
:The new name for the specified Amazon Chime account.
default_license(License)
/set_default_license(Option<License>)
:The default license applied when you add users to an Amazon Chime account.
- On success, responds with
UpdateAccountOutput
with field(s):account(Option<Account>)
:The updated Amazon Chime account details.
- On failure, responds with
SdkError<UpdateAccountError>
Constructs a fluent builder for the UpdateAccountSettings
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The Amazon Chime account ID.
account_settings(AccountSettings)
/set_account_settings(Option<AccountSettings>)
:The Amazon Chime account settings to update.
- On success, responds with
UpdateAccountSettingsOutput
- On failure, responds with
SdkError<UpdateAccountSettingsError>
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>)
:The ARN of the
AppInstance
.name(impl Into<String>)
/set_name(Option<String>)
:The name that you want to change.
metadata(impl Into<String>)
/set_metadata(Option<String>)
:The metadata that you want to change.
- On success, responds with
UpdateAppInstanceOutput
with field(s):app_instance_arn(Option<String>)
:The ARN of the
AppInstance
.
- On failure, responds with
SdkError<UpdateAppInstanceError>
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>)
:The ARN of the
AppInstanceUser
.name(impl Into<String>)
/set_name(Option<String>)
:The name of the
AppInstanceUser
.metadata(impl Into<String>)
/set_metadata(Option<String>)
:The metadata of the
AppInstanceUser
.
- On success, responds with
UpdateAppInstanceUserOutput
with field(s):app_instance_user_arn(Option<String>)
:The ARN of the
AppInstanceUser
.
- On failure, responds with
SdkError<UpdateAppInstanceUserError>
Constructs a fluent builder for the UpdateBot
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The Amazon Chime account ID.
bot_id(impl Into<String>)
/set_bot_id(Option<String>)
:The bot ID.
disabled(bool)
/set_disabled(Option<bool>)
:When true, stops the specified bot from running in your account.
- On success, responds with
UpdateBotOutput
with field(s):bot(Option<Bot>)
:The updated bot details.
- On failure, responds with
SdkError<UpdateBotError>
Constructs a fluent builder for the UpdateChannel
operation.
- The fluent builder is configurable:
channel_arn(impl Into<String>)
/set_channel_arn(Option<String>)
:The ARN of the channel.
name(impl Into<String>)
/set_name(Option<String>)
:The name of the channel.
mode(ChannelMode)
/set_mode(Option<ChannelMode>)
:The mode of the update request.
metadata(impl Into<String>)
/set_metadata(Option<String>)
:The metadata for the update request.
chime_bearer(impl Into<String>)
/set_chime_bearer(Option<String>)
:The
AppInstanceUserArn
of the user that makes the API call.
- On success, responds with
UpdateChannelOutput
with field(s):channel_arn(Option<String>)
:The ARN of the channel.
- On failure, responds with
SdkError<UpdateChannelError>
Constructs a fluent builder for the UpdateChannelMessage
operation.
- The fluent builder is configurable:
channel_arn(impl Into<String>)
/set_channel_arn(Option<String>)
:The ARN of the channel.
message_id(impl Into<String>)
/set_message_id(Option<String>)
:The ID string of the message being updated.
content(impl Into<String>)
/set_content(Option<String>)
:The content of the message being updated.
metadata(impl Into<String>)
/set_metadata(Option<String>)
:The metadata of the message being updated.
chime_bearer(impl Into<String>)
/set_chime_bearer(Option<String>)
:The
AppInstanceUserArn
of the user that makes the API call.
- On success, responds with
UpdateChannelMessageOutput
with 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>
Constructs a fluent builder for the UpdateChannelReadMarker
operation.
- The fluent builder is configurable:
channel_arn(impl Into<String>)
/set_channel_arn(Option<String>)
:The ARN of the channel.
chime_bearer(impl Into<String>)
/set_chime_bearer(Option<String>)
:The
AppInstanceUserArn
of the user that makes the API call.
- On success, responds with
UpdateChannelReadMarkerOutput
with field(s):channel_arn(Option<String>)
:The ARN of the channel.
- On failure, responds with
SdkError<UpdateChannelReadMarkerError>
Constructs a fluent builder for the UpdateGlobalSettings
operation.
- The fluent builder is configurable:
business_calling(BusinessCallingSettings)
/set_business_calling(Option<BusinessCallingSettings>)
:The Amazon Chime Business Calling settings.
voice_connector(VoiceConnectorSettings)
/set_voice_connector(Option<VoiceConnectorSettings>)
:The Amazon Chime Voice Connector settings.
- On success, responds with
UpdateGlobalSettingsOutput
- On failure, responds with
SdkError<UpdateGlobalSettingsError>
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>)
:The phone number ID.
product_type(PhoneNumberProductType)
/set_product_type(Option<PhoneNumberProductType>)
:The product type.
calling_name(impl Into<String>)
/set_calling_name(Option<String>)
:The outbound calling name associated with the phone number.
- On success, responds with
UpdatePhoneNumberOutput
with field(s):phone_number(Option<PhoneNumber>)
:The updated phone number details.
- On failure, responds with
SdkError<UpdatePhoneNumberError>
Constructs a fluent builder for the UpdatePhoneNumberSettings
operation.
- The fluent builder is configurable:
calling_name(impl Into<String>)
/set_calling_name(Option<String>)
:The default outbound calling name for the account.
- On success, responds with
UpdatePhoneNumberSettingsOutput
- On failure, responds with
SdkError<UpdatePhoneNumberSettingsError>
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>)
:The Amazon Chime voice connector ID.
proxy_session_id(impl Into<String>)
/set_proxy_session_id(Option<String>)
:The proxy session ID.
capabilities(Vec<Capability>)
/set_capabilities(Option<Vec<Capability>>)
:The proxy session capabilities.
expiry_minutes(i32)
/set_expiry_minutes(Option<i32>)
:The number of minutes allowed for the proxy session.
- On success, responds with
UpdateProxySessionOutput
with field(s):proxy_session(Option<ProxySession>)
:The proxy session details.
- On failure, responds with
SdkError<UpdateProxySessionError>
Constructs a fluent builder for the UpdateRoom
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The Amazon Chime account ID.
room_id(impl Into<String>)
/set_room_id(Option<String>)
:The room ID.
name(impl Into<String>)
/set_name(Option<String>)
:The room name.
- On success, responds with
UpdateRoomOutput
with field(s):room(Option<Room>)
:The room details.
- On failure, responds with
SdkError<UpdateRoomError>
Constructs a fluent builder for the UpdateRoomMembership
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The Amazon Chime account ID.
room_id(impl Into<String>)
/set_room_id(Option<String>)
:The room ID.
member_id(impl Into<String>)
/set_member_id(Option<String>)
:The member ID.
role(RoomMembershipRole)
/set_role(Option<RoomMembershipRole>)
:The role of the member.
- On success, responds with
UpdateRoomMembershipOutput
with field(s):room_membership(Option<RoomMembership>)
:The room membership details.
- On failure, responds with
SdkError<UpdateRoomMembershipError>
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>)
:The SIP media application ID.
name(impl Into<String>)
/set_name(Option<String>)
:The new name for the specified SIP media application.
endpoints(Vec<SipMediaApplicationEndpoint>)
/set_endpoints(Option<Vec<SipMediaApplicationEndpoint>>)
:The new set of endpoints for the specified SIP media application.
- On success, responds with
UpdateSipMediaApplicationOutput
with field(s):sip_media_application(Option<SipMediaApplication>)
:The updated SIP media application details.
- On failure, responds with
SdkError<UpdateSipMediaApplicationError>
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>)
:The ID of the SIP media application handling the call.
transaction_id(impl Into<String>)
/set_transaction_id(Option<String>)
:The ID of the call transaction.
arguments(HashMap<String, String>)
/set_arguments(Option<HashMap<String, String>>)
:Arguments made available to the Lambda function as part of the
CALL_UPDATE_REQUESTED
event. Can contain 0-20 key-value pairs.
- On success, responds with
UpdateSipMediaApplicationCallOutput
with field(s):sip_media_application_call(Option<SipMediaApplicationCall>)
:A
Call
instance for a SIP media application.
- On failure, responds with
SdkError<UpdateSipMediaApplicationCallError>
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>)
:The SIP rule ID.
name(impl Into<String>)
/set_name(Option<String>)
:The new name for the specified SIP rule.
disabled(bool)
/set_disabled(Option<bool>)
:The new value specified to indicate whether the rule is disabled.
target_applications(Vec<SipRuleTargetApplication>)
/set_target_applications(Option<Vec<SipRuleTargetApplication>>)
:The new value of the list of target applications.
- On success, responds with
UpdateSipRuleOutput
with field(s):sip_rule(Option<SipRule>)
:Updated SIP rule details.
- On failure, responds with
SdkError<UpdateSipRuleError>
Constructs a fluent builder for the UpdateUser
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The Amazon Chime account ID.
user_id(impl Into<String>)
/set_user_id(Option<String>)
:The user ID.
license_type(License)
/set_license_type(Option<License>)
:The 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>)
:The user type.
alexa_for_business_metadata(AlexaForBusinessMetadata)
/set_alexa_for_business_metadata(Option<AlexaForBusinessMetadata>)
:The Alexa for Business metadata.
- On success, responds with
UpdateUserOutput
with field(s):user(Option<User>)
:The updated user details.
- On failure, responds with
SdkError<UpdateUserError>
Constructs a fluent builder for the UpdateUserSettings
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:The Amazon Chime account ID.
user_id(impl Into<String>)
/set_user_id(Option<String>)
:The user ID.
user_settings(UserSettings)
/set_user_settings(Option<UserSettings>)
:The user settings to update.
- On success, responds with
UpdateUserSettingsOutput
- On failure, responds with
SdkError<UpdateUserSettingsError>
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>)
:The Amazon Chime Voice Connector ID.
name(impl Into<String>)
/set_name(Option<String>)
:The name of the Amazon Chime Voice Connector.
require_encryption(bool)
/set_require_encryption(Option<bool>)
:When enabled, requires encryption for the Amazon Chime Voice Connector.
- On success, responds with
UpdateVoiceConnectorOutput
with field(s):voice_connector(Option<VoiceConnector>)
:The updated Amazon Chime Voice Connector details.
- On failure, responds with
SdkError<UpdateVoiceConnectorError>
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>)
:The Amazon Chime Voice Connector group ID.
name(impl Into<String>)
/set_name(Option<String>)
:The name of the Amazon Chime Voice Connector group.
voice_connector_items(Vec<VoiceConnectorItem>)
/set_voice_connector_items(Option<Vec<VoiceConnectorItem>>)
:The
VoiceConnectorItems
to associate with the group.
- On success, responds with
UpdateVoiceConnectorGroupOutput
with field(s):voice_connector_group(Option<VoiceConnectorGroup>)
:The updated Amazon Chime Voice Connector group details.
- On failure, responds with
SdkError<UpdateVoiceConnectorGroupError>
Creates a client with the given service config and connector override.
Trait Implementations
Auto Trait Implementations
impl<C = DynConnector, M = DefaultMiddleware, R = Standard> !RefUnwindSafe for Client<C, M, R>
impl<C = DynConnector, M = DefaultMiddleware, R = Standard> !UnwindSafe for Client<C, M, R>
Blanket Implementations
Mutably borrows from an owned value. Read more
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more