Chime

This page documents function available when using the Chime module, created with @service Chime.

Index

Documentation

Main.Chime.associate_phone_number_with_userMethod
associate_phone_number_with_user(e164_phone_number, account_id, user_id)
associate_phone_number_with_user(e164_phone_number, account_id, user_id, params::Dict{String,<:Any})

Associates a phone number with the specified Amazon Chime user.

Arguments

  • e164_phone_number: The phone number, in E.164 format.
  • account_id: The Amazon Chime account ID.
  • user_id: The user ID.
Main.Chime.associate_phone_numbers_with_voice_connectorMethod
associate_phone_numbers_with_voice_connector(e164_phone_numbers, voice_connector_id)
associate_phone_numbers_with_voice_connector(e164_phone_numbers, voice_connector_id, params::Dict{String,<:Any})

Associates phone numbers with the specified Amazon Chime Voice Connector.

Arguments

  • e164_phone_numbers: List of phone numbers, in E.164 format.
  • voice_connector_id: The Amazon Chime Voice Connector ID.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ForceAssociate": 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.
Main.Chime.associate_phone_numbers_with_voice_connector_groupMethod
associate_phone_numbers_with_voice_connector_group(e164_phone_numbers, voice_connector_group_id)
associate_phone_numbers_with_voice_connector_group(e164_phone_numbers, voice_connector_group_id, params::Dict{String,<:Any})

Associates phone numbers with the specified Amazon Chime Voice Connector group.

Arguments

  • e164_phone_numbers: List of phone numbers, in E.164 format.
  • voice_connector_group_id: The Amazon Chime Voice Connector group ID.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ForceAssociate": 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.
Main.Chime.associate_signin_delegate_groups_with_accountMethod
associate_signin_delegate_groups_with_account(signin_delegate_groups, account_id)
associate_signin_delegate_groups_with_account(signin_delegate_groups, account_id, params::Dict{String,<:Any})

Associates the specified sign-in delegate groups with the specified Amazon Chime account.

Arguments

  • signin_delegate_groups: The sign-in delegate groups.
  • account_id: The Amazon Chime account ID.
Main.Chime.batch_create_attendeeMethod
batch_create_attendee(attendees, meeting_id)
batch_create_attendee(attendees, meeting_id, params::Dict{String,<:Any})

Creates up to 100 new attendees for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide.

Arguments

  • attendees: The request containing the attendees to create.
  • meeting_id: The Amazon Chime SDK meeting ID.
Main.Chime.batch_create_channel_membershipMethod
batch_create_channel_membership(member_arns, channel_arn)
batch_create_channel_membership(member_arns, channel_arn, params::Dict{String,<:Any})

Adds a specified number of users to a channel.

Arguments

  • member_arns: The ARNs of the members you want to add to the channel.
  • channel_arn: The ARN of the channel to which you're adding users.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Type": The membership type of a user, DEFAULT or HIDDEN. Default members are always returned as part of ListChannelMemberships. Hidden members are only returned if the type filter in ListChannelMemberships equals HIDDEN. Otherwise hidden members are not returned. This is only supported by moderators.
  • "x-amz-chime-bearer": The AppInstanceUserArn of the user that makes the API call.
Main.Chime.batch_create_room_membershipMethod
batch_create_room_membership(membership_item_list, account_id, room_id)
batch_create_room_membership(membership_item_list, account_id, room_id, params::Dict{String,<:Any})

Adds up to 50 members to a chat room in an Amazon Chime Enterprise account. Members can be users or bots. The member role designates whether the member is a chat room administrator or a general chat room member.

Arguments

  • membership_item_list: The list of membership items.
  • account_id: The Amazon Chime account ID.
  • room_id: The room ID.
Main.Chime.batch_delete_phone_numberMethod
batch_delete_phone_number(phone_number_ids)
batch_delete_phone_number(phone_number_ids, params::Dict{String,<:Any})

Moves phone numbers into the Deletion queue. Phone numbers must be disassociated from any users or Amazon Chime Voice Connectors before they can be deleted. Phone numbers remain in the Deletion queue for 7 days before they are deleted permanently.

Arguments

  • phone_number_ids: List of phone number IDs.
Main.Chime.batch_suspend_userMethod
batch_suspend_user(user_id_list, account_id)
batch_suspend_user(user_id_list, account_id, params::Dict{String,<:Any})

Suspends up to 50 users from a Team or EnterpriseLWA Amazon Chime account. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide. Users suspended from a Team account are disassociated from the account,but they can continue to use Amazon Chime as free users. To remove the suspension from suspended Team account users, invite them to the Team account again. You can use the InviteUsers action to do so. Users suspended from an EnterpriseLWA account are immediately signed out of Amazon Chime and can no longer sign in. To remove the suspension from suspended EnterpriseLWA account users, use the BatchUnsuspendUser action. To sign out users without suspending them, use the LogoutUser action.

Arguments

  • user_id_list: The request containing the user IDs to suspend.
  • account_id: The Amazon Chime account ID.
Main.Chime.batch_unsuspend_userMethod
batch_unsuspend_user(user_id_list, account_id)
batch_unsuspend_user(user_id_list, account_id, params::Dict{String,<:Any})

Removes the suspension from up to 50 previously suspended users for the specified Amazon Chime EnterpriseLWA account. Only users on EnterpriseLWA accounts can be unsuspended using this action. For more information about different account types, see Managing Your Amazon Chime Accounts in the account types, in the Amazon Chime Administration Guide. Previously suspended users who are unsuspended using this action are returned to Registered status. Users who are not previously suspended are ignored.

Arguments

  • user_id_list: The request containing the user IDs to unsuspend.
  • account_id: The Amazon Chime account ID.
Main.Chime.batch_update_phone_numberMethod
batch_update_phone_number(update_phone_number_request_items)
batch_update_phone_number(update_phone_number_request_items, params::Dict{String,<:Any})

Updates phone number product types or calling names. You can update one attribute at a time for each UpdatePhoneNumberRequestItem. For example, you can update the product type or the calling name. For toll-free numbers, you cannot use the Amazon Chime Business Calling product type. For numbers outside the U.S., you must use the Amazon Chime SIP Media Application Dial-In product type. Updates to outbound calling names can take up to 72 hours to complete. Pending updates to outbound calling names must be complete before you can request another update.

Arguments

  • update_phone_number_request_items: The request containing the phone number IDs and product types or calling names to update.
Main.Chime.batch_update_userMethod
batch_update_user(update_user_request_items, account_id)
batch_update_user(update_user_request_items, account_id, params::Dict{String,<:Any})

Updates user details within the UpdateUserRequestItem object for up to 20 users for the specified Amazon Chime account. Currently, only LicenseType updates are supported for this action.

Arguments

  • update_user_request_items: The request containing the user IDs and details to update.
  • account_id: The Amazon Chime account ID.
Main.Chime.create_accountMethod
create_account(name)
create_account(name, params::Dict{String,<:Any})

Creates an Amazon Chime account under the administrator's AWS account. Only Team account types are currently supported for this action. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.

Arguments

  • name: The name of the Amazon Chime account.
Main.Chime.create_app_instanceMethod
create_app_instance(client_request_token, name)
create_app_instance(client_request_token, name, params::Dict{String,<:Any})

Creates an Amazon Chime SDK messaging AppInstance under an AWS account. Only SDK messaging customers use this API. CreateAppInstance supports idempotency behavior as described in the AWS API Standard.

Arguments

  • client_request_token: The ClientRequestToken of the AppInstance.
  • name: The name of the AppInstance.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Metadata": The metadata of the AppInstance. Limited to a 1KB string in UTF-8.
  • "Tags": Tags assigned to the AppInstance.
Main.Chime.create_app_instance_adminMethod
create_app_instance_admin(app_instance_admin_arn, app_instance_arn)
create_app_instance_admin(app_instance_admin_arn, app_instance_arn, params::Dict{String,<:Any})

Promotes an AppInstanceUser to an AppInstanceAdmin. The promoted user can perform the following actions. ChannelModerator actions across all channels in the AppInstance. DeleteChannelMessage actions. Only an AppInstanceUser can be promoted to an AppInstanceAdmin role.

Arguments

  • app_instance_admin_arn: The ARN of the administrator of the current AppInstance.
  • app_instance_arn: The ARN of the AppInstance.
Main.Chime.create_app_instance_userMethod
create_app_instance_user(app_instance_arn, app_instance_user_id, client_request_token, name)
create_app_instance_user(app_instance_arn, app_instance_user_id, client_request_token, name, params::Dict{String,<:Any})

Creates a user under an Amazon Chime AppInstance. The request consists of a unique appInstanceUserId and Name for that user.

Arguments

  • app_instance_arn: The ARN of the AppInstance request.
  • app_instance_user_id: The user ID of the AppInstance.
  • client_request_token: The token assigned to the user requesting an AppInstance.
  • name: The user's name.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Metadata": The request's metadata. Limited to a 1KB string in UTF-8.
  • "Tags": Tags assigned to the AppInstanceUser.
Main.Chime.create_attendeeMethod
create_attendee(external_user_id, meeting_id)
create_attendee(external_user_id, meeting_id, params::Dict{String,<:Any})

Creates a new attendee for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide.

Arguments

  • external_user_id: The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.
  • meeting_id: The Amazon Chime SDK meeting ID.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Tags": The tag key-value pairs.
Main.Chime.create_botMethod
create_bot(display_name, account_id)
create_bot(display_name, account_id, params::Dict{String,<:Any})

Creates a bot for an Amazon Chime Enterprise account.

Arguments

  • display_name: The bot display name.
  • account_id: The Amazon Chime account ID.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Domain": The domain of the Amazon Chime Enterprise account.
Main.Chime.create_channelMethod
create_channel(app_instance_arn, client_request_token, name)
create_channel(app_instance_arn, client_request_token, name, params::Dict{String,<:Any})

Creates a channel to which you can add users and send messages. Restriction: You can't change a channel's privacy. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

Arguments

  • app_instance_arn: The ARN of the channel request.
  • client_request_token: The client token for the request. An Idempotency token.
  • name: The name of the channel.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Metadata": The metadata of the creation request. Limited to 1KB and UTF-8.
  • "Mode": The channel mode: UNRESTRICTED or RESTRICTED. 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": The channel's privacy level: PUBLIC or PRIVATE. Private channels aren't discoverable by users outside the channel. Public channels are discoverable by anyone in the AppInstance.
  • "Tags": The tags for the creation request.
  • "x-amz-chime-bearer": The AppInstanceUserArn of the user that makes the API call.
Main.Chime.create_channel_banMethod
create_channel_ban(member_arn, channel_arn)
create_channel_ban(member_arn, channel_arn, params::Dict{String,<:Any})

Permanently bans a member from a channel. Moderators can't add banned members to a channel. To undo a ban, you first have to DeleteChannelBan, and then CreateChannelMembership. Bans are cleaned up when you delete users or channels. If you ban a user who is already part of a channel, that user is automatically kicked from the channel. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

Arguments

  • member_arn: The ARN of the member being banned.
  • channel_arn: The ARN of the ban request.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "x-amz-chime-bearer": The AppInstanceUserArn of the user that makes the API call.
Main.Chime.create_channel_membershipMethod
create_channel_membership(member_arn, type, channel_arn)
create_channel_membership(member_arn, type, channel_arn, params::Dict{String,<:Any})

Adds a user to a channel. The InvitedBy response field is derived from the request header. A channel member can: List messages Send messages Receive messages Edit their own messages Leave the channel Privacy settings impact this action as follows: Public Channels: You do not need to be a member to list messages, but you must be a member to send messages. Private Channels: You must be a member to list or send messages. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

Arguments

  • member_arn: The ARN of the member you want to add to the channel.
  • type: The membership type of a user, DEFAULT or HIDDEN. Default members are always returned as part of ListChannelMemberships. Hidden members are only returned if the type filter in ListChannelMemberships equals HIDDEN. Otherwise hidden members are not returned. This is only supported by moderators.
  • channel_arn: The ARN of the channel to which you're adding users.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "x-amz-chime-bearer": The AppInstanceUserArn of the user that makes the API call.
Main.Chime.create_channel_moderatorMethod
create_channel_moderator(channel_moderator_arn, channel_arn)
create_channel_moderator(channel_moderator_arn, channel_arn, params::Dict{String,<:Any})

Creates a new ChannelModerator. A channel moderator can: Add and remove other members of the channel. Add and remove other moderators of the channel. Add and remove user bans for the channel. Redact messages in the channel. List messages in the channel. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

Arguments

  • channel_moderator_arn: The ARN of the moderator.
  • channel_arn: The ARN of the channel.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "x-amz-chime-bearer": The AppInstanceUserArn of the user that makes the API call.
Main.Chime.create_media_capture_pipelineMethod
create_media_capture_pipeline(sink_arn, sink_type, source_arn, source_type)
create_media_capture_pipeline(sink_arn, sink_type, source_arn, source_type, params::Dict{String,<:Any})

Creates a media capture pipeline.

Arguments

  • sink_arn: The ARN of the sink type.
  • sink_type: Destination type to which the media artifacts are saved. You must use an S3 bucket.
  • source_arn: ARN of the source from which the media artifacts are captured.
  • source_type: Source type from which the media artifacts will be captured. A Chime SDK Meeting is the only supported source.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ChimeSdkMeetingConfiguration": The configuration for a specified media capture pipeline. SourceType must be ChimeSdkMeeting.
  • "ClientRequestToken": The unique identifier for the client request. The token makes the API request idempotent. Use a different token for different media pipeline requests.
Main.Chime.create_meetingMethod
create_meeting(client_request_token)
create_meeting(client_request_token, params::Dict{String,<:Any})

Creates a new Amazon Chime SDK meeting in the specified media Region with no initial attendees. For more information about specifying media Regions, see Amazon Chime SDK Media Regions in the Amazon Chime SDK Developer Guide . For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide .

Arguments

  • client_request_token: The unique identifier for the client request. Use a different token for different meetings.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ExternalMeetingId": The external meeting ID.
  • "MediaRegion": 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 .
  • "MeetingHostId": Reserved.
  • "NotificationsConfiguration": The configuration for resource targets to receive notifications when meeting and attendee events occur.
  • "Tags": The tag key-value pairs.
Main.Chime.create_meeting_dial_outMethod
create_meeting_dial_out(from_phone_number, join_token, to_phone_number, meeting_id)
create_meeting_dial_out(from_phone_number, join_token, to_phone_number, meeting_id, params::Dict{String,<:Any})

Uses the join token and call metadata in a meeting request (From number, To number, and so forth) to initiate an outbound call to a public switched telephone network (PSTN) and join them into a Chime meeting. Also ensures that the From number belongs to the customer. To play welcome audio or implement an interactive voice response (IVR), use the CreateSipMediaApplicationCall action with the corresponding SIP media application ID.

Arguments

  • from_phone_number: Phone number used as the caller ID when the remote party receives a call.
  • join_token: Token used by the Amazon Chime SDK attendee. Call the CreateAttendee action to get a join token.
  • to_phone_number: Phone number called when inviting someone to a meeting.
  • meeting_id: The Amazon Chime SDK meeting ID.
Main.Chime.create_meeting_with_attendeesMethod
create_meeting_with_attendees(client_request_token)
create_meeting_with_attendees(client_request_token, params::Dict{String,<:Any})

Creates a new Amazon Chime SDK meeting in the specified media Region, with attendees. For more information about specifying media Regions, see Amazon Chime SDK Media Regions in the Amazon Chime SDK Developer Guide . For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide .

Arguments

  • client_request_token: The unique identifier for the client request. Use a different token for different meetings.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Attendees": The request containing the attendees to create.
  • "ExternalMeetingId": The external meeting ID.
  • "MediaRegion": 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 .
  • "MeetingHostId": Reserved.
  • "NotificationsConfiguration": 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).
  • "Tags": The tag key-value pairs.
Main.Chime.create_phone_number_orderMethod
create_phone_number_order(e164_phone_numbers, product_type)
create_phone_number_order(e164_phone_numbers, product_type, params::Dict{String,<:Any})

Creates an order for phone numbers to be provisioned. For toll-free numbers, you cannot use the Amazon Chime Business Calling product type. For numbers outside the U.S., you must use the Amazon Chime SIP Media Application Dial-In product type.

Arguments

  • e164_phone_numbers: List of phone numbers, in E.164 format.
  • product_type: The phone number product type.
Main.Chime.create_proxy_sessionMethod
create_proxy_session(capabilities, participant_phone_numbers, voice_connector_id)
create_proxy_session(capabilities, participant_phone_numbers, voice_connector_id, params::Dict{String,<:Any})

Creates a proxy session on the specified Amazon Chime Voice Connector for the specified participant phone numbers.

Arguments

  • capabilities: The proxy session capabilities.
  • participant_phone_numbers: The participant phone numbers.
  • voice_connector_id: The Amazon Chime voice connector ID.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ExpiryMinutes": The number of minutes allowed for the proxy session.
  • "GeoMatchLevel": The preference for matching the country or area code of the proxy phone number with that of the first participant.
  • "GeoMatchParams": The country and area code for the proxy phone number.
  • "Name": The name of the proxy session.
  • "NumberSelectionBehavior": The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.
Main.Chime.create_roomMethod
create_room(name, account_id)
create_room(name, account_id, params::Dict{String,<:Any})

Creates a chat room for the specified Amazon Chime Enterprise account.

Arguments

  • name: The room name.
  • account_id: The Amazon Chime account ID.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ClientRequestToken": The idempotency token for the request.
Main.Chime.create_room_membershipMethod
create_room_membership(member_id, account_id, room_id)
create_room_membership(member_id, account_id, room_id, params::Dict{String,<:Any})

Adds a member to a chat room in an Amazon Chime Enterprise account. A member can be either a user or a bot. The member role designates whether the member is a chat room administrator or a general chat room member.

Arguments

  • member_id: The Amazon Chime member ID (user ID or bot ID).
  • account_id: The Amazon Chime account ID.
  • room_id: The room ID.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Role": The role of the member.
Main.Chime.create_sip_media_applicationMethod
create_sip_media_application(aws_region, endpoints, name)
create_sip_media_application(aws_region, endpoints, name, params::Dict{String,<:Any})

Creates a SIP media application.

Arguments

  • aws_region: The AWS Region assigned to the SIP media application.
  • endpoints: List of endpoints (Lambda Amazon Resource Names) specified for the SIP media application. Currently, only one endpoint is supported.
  • name: The SIP media application name.
Main.Chime.create_sip_media_application_callMethod
create_sip_media_application_call(from_phone_number, to_phone_number, sip_media_application_id)
create_sip_media_application_call(from_phone_number, to_phone_number, sip_media_application_id, params::Dict{String,<:Any})

Creates an outbound call to a phone number from the phone number specified in the request, and it invokes the endpoint of the specified sipMediaApplicationId.

Arguments

  • from_phone_number: The phone number that a user calls from. This is a phone number in your Amazon Chime phone number inventory.
  • to_phone_number: The phone number that the service should call.
  • sip_media_application_id: The ID of the SIP media application.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "SipHeaders": The SIP headers added to an outbound call leg.
Main.Chime.create_sip_ruleMethod
create_sip_rule(name, target_applications, trigger_type, trigger_value)
create_sip_rule(name, target_applications, trigger_type, trigger_value, params::Dict{String,<:Any})

Creates a SIP rule which can be used to run a SIP media application as a target for a specific trigger type.

Arguments

  • name: The name of the SIP rule.
  • target_applications: List of SIP media applications with priority and AWS Region. Only one SIP application per AWS Region can be used.
  • trigger_type: The type of trigger assigned to the SIP rule in TriggerValue, currently RequestUriHostname or ToPhoneNumber.
  • trigger_value: If TriggerType is RequestUriHostname, the value can be the outbound host name of an Amazon Chime Voice Connector. If TriggerType is ToPhoneNumber, the value can be a customer-owned phone number in the E164 format. The SipMediaApplication specified in the SipRule is triggered if the request URI in an incoming SIP request matches the RequestUriHostname, or if the To header in the incoming SIP request matches the ToPhoneNumber value.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Disabled": Enables or disables a rule. You must disable rules before you can delete them.
Main.Chime.create_userMethod
create_user(account_id)
create_user(account_id, params::Dict{String,<:Any})

Creates a user under the specified Amazon Chime account.

Arguments

  • account_id: The Amazon Chime account ID.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Email": The user's email address.
  • "UserType": The user type.
  • "Username": The user name.
Main.Chime.create_voice_connectorMethod
create_voice_connector(name, require_encryption)
create_voice_connector(name, require_encryption, params::Dict{String,<:Any})

Creates an Amazon Chime Voice Connector under the administrator's AWS account. You can choose to create an Amazon Chime Voice Connector in a specific AWS Region. Enabling CreateVoiceConnectorRequestRequireEncryption configures your Amazon Chime Voice Connector to use TLS transport for SIP signaling and Secure RTP (SRTP) for media. Inbound calls use TLS transport, and unencrypted outbound calls are blocked.

Arguments

  • name: The name of the Amazon Chime Voice Connector.
  • require_encryption: When enabled, requires encryption for the Amazon Chime Voice Connector.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "AwsRegion": The AWS Region in which the Amazon Chime Voice Connector is created. Default value: us-east-1 .
Main.Chime.create_voice_connector_groupMethod
create_voice_connector_group(name)
create_voice_connector_group(name, params::Dict{String,<:Any})

Creates an Amazon Chime Voice Connector group under the administrator's AWS account. You can associate Amazon Chime Voice Connectors with the Amazon Chime Voice Connector group by including VoiceConnectorItems in the request. You can include Amazon Chime Voice Connectors from different AWS Regions in your group. This creates a fault tolerant mechanism for fallback in case of availability events.

Arguments

  • name: The name of the Amazon Chime Voice Connector group.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "VoiceConnectorItems": The Amazon Chime Voice Connectors to route inbound calls to.
Main.Chime.delete_accountMethod
delete_account(account_id)
delete_account(account_id, params::Dict{String,<:Any})

Deletes the specified Amazon Chime account. You must suspend all users before deleting Team account. You can use the BatchSuspendUser action to dodo. For EnterpriseLWA and EnterpriseAD accounts, you must release the claimed domains for your Amazon Chime account before deletion. As soon as you release the domain, all users under that account are suspended. Deleted accounts appear in your Disabled accounts list for 90 days. To restore deleted account from your Disabled accounts list, you must contact AWS Support. After 90 days, deleted accounts are permanently removed from your Disabled accounts list.

Arguments

  • account_id: The Amazon Chime account ID.
Main.Chime.delete_app_instanceMethod
delete_app_instance(app_instance_arn)
delete_app_instance(app_instance_arn, params::Dict{String,<:Any})

Deletes an AppInstance and all associated data asynchronously.

Arguments

  • app_instance_arn: The ARN of the AppInstance.
Main.Chime.delete_app_instance_adminMethod
delete_app_instance_admin(app_instance_admin_arn, app_instance_arn)
delete_app_instance_admin(app_instance_admin_arn, app_instance_arn, params::Dict{String,<:Any})

Demotes an AppInstanceAdmin to an AppInstanceUser. This action does not delete the user.

Arguments

  • app_instance_admin_arn: The ARN of the AppInstance's administrator.
  • app_instance_arn: The ARN of the AppInstance.
Main.Chime.delete_app_instance_streaming_configurationsMethod
delete_app_instance_streaming_configurations(app_instance_arn)
delete_app_instance_streaming_configurations(app_instance_arn, params::Dict{String,<:Any})

Deletes the streaming configurations of an AppInstance.

Arguments

  • app_instance_arn: The ARN of the streaming configurations being deleted.
Main.Chime.delete_app_instance_userMethod
delete_app_instance_user(app_instance_user_arn)
delete_app_instance_user(app_instance_user_arn, params::Dict{String,<:Any})

Deletes an AppInstanceUser.

Arguments

  • app_instance_user_arn: The ARN of the user request being deleted.
Main.Chime.delete_attendeeMethod
delete_attendee(attendee_id, meeting_id)
delete_attendee(attendee_id, meeting_id, params::Dict{String,<:Any})

Deletes an attendee from the specified Amazon Chime SDK meeting and deletes their JoinToken. Attendees are automatically deleted when a Amazon Chime SDK meeting is deleted. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide.

Arguments

  • attendee_id: The Amazon Chime SDK attendee ID.
  • meeting_id: The Amazon Chime SDK meeting ID.
Main.Chime.delete_channelMethod
delete_channel(channel_arn)
delete_channel(channel_arn, params::Dict{String,<:Any})

Immediately makes a channel and its memberships inaccessible and marks them for deletion. This is an irreversible process. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

Arguments

  • channel_arn: The ARN of the channel being deleted.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "x-amz-chime-bearer": The AppInstanceUserArn of the user that makes the API call.
Main.Chime.delete_channel_banMethod
delete_channel_ban(channel_arn, member_arn)
delete_channel_ban(channel_arn, member_arn, params::Dict{String,<:Any})

Removes a user from a channel's ban list. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

Arguments

  • channel_arn: The ARN of the channel from which the AppInstanceUser was banned.
  • member_arn: The ARN of the AppInstanceUser that you want to reinstate.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "x-amz-chime-bearer": The AppInstanceUserArn of the user that makes the API call.
Main.Chime.delete_channel_membershipMethod
delete_channel_membership(channel_arn, member_arn)
delete_channel_membership(channel_arn, member_arn, params::Dict{String,<:Any})

Removes a member from a channel. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

Arguments

  • channel_arn: The ARN of the channel from which you want to remove the user.
  • member_arn: The ARN of the member that you're removing from the channel.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "x-amz-chime-bearer": The AppInstanceUserArn of the user that makes the API call.
Main.Chime.delete_channel_messageMethod
delete_channel_message(channel_arn, message_id)
delete_channel_message(channel_arn, message_id, params::Dict{String,<:Any})

Deletes a channel message. Only admins can perform this action. Deletion makes messages inaccessible immediately. A background process deletes any revisions created by UpdateChannelMessage. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

Arguments

  • channel_arn: The ARN of the channel.
  • message_id: The ID of the message being deleted.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "x-amz-chime-bearer": The AppInstanceUserArn of the user that makes the API call.
Main.Chime.delete_channel_moderatorMethod
delete_channel_moderator(channel_arn, channel_moderator_arn)
delete_channel_moderator(channel_arn, channel_moderator_arn, params::Dict{String,<:Any})

Deletes a channel moderator. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

Arguments

  • channel_arn: The ARN of the channel.
  • channel_moderator_arn: The ARN of the moderator being deleted.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "x-amz-chime-bearer": The AppInstanceUserArn of the user that makes the API call.
Main.Chime.delete_events_configurationMethod
delete_events_configuration(account_id, bot_id)
delete_events_configuration(account_id, bot_id, params::Dict{String,<:Any})

Deletes the events configuration that allows a bot to receive outgoing events.

Arguments

  • account_id: The Amazon Chime account ID.
  • bot_id: The bot ID.
Main.Chime.delete_media_capture_pipelineMethod
delete_media_capture_pipeline(media_pipeline_id)
delete_media_capture_pipeline(media_pipeline_id, params::Dict{String,<:Any})

Deletes the media capture pipeline.

Arguments

  • media_pipeline_id: The ID of the media capture pipeline being deleted.
Main.Chime.delete_meetingMethod
delete_meeting(meeting_id)
delete_meeting(meeting_id, params::Dict{String,<:Any})

Deletes the specified Amazon Chime SDK meeting. The operation deletes all attendees, disconnects all clients, and prevents new clients from joining the meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide.

Arguments

  • meeting_id: The Amazon Chime SDK meeting ID.
Main.Chime.delete_phone_numberMethod
delete_phone_number(phone_number_id)
delete_phone_number(phone_number_id, params::Dict{String,<:Any})

Moves the specified phone number into the Deletion queue. A phone number must be disassociated from any users or Amazon Chime Voice Connectors before it can be deleted. Deleted phone numbers remain in the Deletion queue for 7 days before they are deleted permanently.

Arguments

  • phone_number_id: The phone number ID.
Main.Chime.delete_proxy_sessionMethod
delete_proxy_session(proxy_session_id, voice_connector_id)
delete_proxy_session(proxy_session_id, voice_connector_id, params::Dict{String,<:Any})

Deletes the specified proxy session from the specified Amazon Chime Voice Connector.

Arguments

  • proxy_session_id: The proxy session ID.
  • voice_connector_id: The Amazon Chime voice connector ID.
Main.Chime.delete_roomMethod
delete_room(account_id, room_id)
delete_room(account_id, room_id, params::Dict{String,<:Any})

Deletes a chat room in an Amazon Chime Enterprise account.

Arguments

  • account_id: The Amazon Chime account ID.
  • room_id: The chat room ID.
Main.Chime.delete_room_membershipMethod
delete_room_membership(account_id, member_id, room_id)
delete_room_membership(account_id, member_id, room_id, params::Dict{String,<:Any})

Removes a member from a chat room in an Amazon Chime Enterprise account.

Arguments

  • account_id: The Amazon Chime account ID.
  • member_id: The member ID (user ID or bot ID).
  • room_id: The room ID.
Main.Chime.delete_sip_media_applicationMethod
delete_sip_media_application(sip_media_application_id)
delete_sip_media_application(sip_media_application_id, params::Dict{String,<:Any})

Deletes a SIP media application.

Arguments

  • sip_media_application_id: The SIP media application ID.
Main.Chime.delete_sip_ruleMethod
delete_sip_rule(sip_rule_id)
delete_sip_rule(sip_rule_id, params::Dict{String,<:Any})

Deletes a SIP rule. You must disable a SIP rule before you can delete it.

Arguments

  • sip_rule_id: The SIP rule ID.
Main.Chime.delete_voice_connectorMethod
delete_voice_connector(voice_connector_id)
delete_voice_connector(voice_connector_id, params::Dict{String,<:Any})

Deletes the specified Amazon Chime Voice Connector. Any phone numbers associated with the Amazon Chime Voice Connector must be disassociated from it before it can be deleted.

Arguments

  • voice_connector_id: The Amazon Chime Voice Connector ID.
Main.Chime.delete_voice_connector_emergency_calling_configurationMethod
delete_voice_connector_emergency_calling_configuration(voice_connector_id)
delete_voice_connector_emergency_calling_configuration(voice_connector_id, params::Dict{String,<:Any})

Deletes the emergency calling configuration details from the specified Amazon Chime Voice Connector.

Arguments

  • voice_connector_id: The Amazon Chime Voice Connector ID.
Main.Chime.delete_voice_connector_groupMethod
delete_voice_connector_group(voice_connector_group_id)
delete_voice_connector_group(voice_connector_group_id, params::Dict{String,<:Any})

Deletes the specified Amazon Chime Voice Connector group. Any VoiceConnectorItems and phone numbers associated with the group must be removed before it can be deleted.

Arguments

  • voice_connector_group_id: The Amazon Chime Voice Connector group ID.
Main.Chime.delete_voice_connector_originationMethod
delete_voice_connector_origination(voice_connector_id)
delete_voice_connector_origination(voice_connector_id, params::Dict{String,<:Any})

Deletes the origination settings for the specified Amazon Chime Voice Connector. If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to deleting the origination settings.

Arguments

  • voice_connector_id: The Amazon Chime Voice Connector ID.
Main.Chime.delete_voice_connector_proxyMethod
delete_voice_connector_proxy(voice_connector_id)
delete_voice_connector_proxy(voice_connector_id, params::Dict{String,<:Any})

Deletes the proxy configuration from the specified Amazon Chime Voice Connector.

Arguments

  • voice_connector_id: The Amazon Chime Voice Connector ID.
Main.Chime.delete_voice_connector_streaming_configurationMethod
delete_voice_connector_streaming_configuration(voice_connector_id)
delete_voice_connector_streaming_configuration(voice_connector_id, params::Dict{String,<:Any})

Deletes the streaming configuration for the specified Amazon Chime Voice Connector.

Arguments

  • voice_connector_id: The Amazon Chime Voice Connector ID.
Main.Chime.delete_voice_connector_terminationMethod
delete_voice_connector_termination(voice_connector_id)
delete_voice_connector_termination(voice_connector_id, params::Dict{String,<:Any})

Deletes the termination settings for the specified Amazon Chime Voice Connector. If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to deleting the termination settings.

Arguments

  • voice_connector_id: The Amazon Chime Voice Connector ID.
Main.Chime.delete_voice_connector_termination_credentialsMethod
delete_voice_connector_termination_credentials(usernames, voice_connector_id)
delete_voice_connector_termination_credentials(usernames, voice_connector_id, params::Dict{String,<:Any})

Deletes the specified SIP credentials used by your equipment to authenticate during call termination.

Arguments

  • usernames: The RFC2617 compliant username associated with the SIP credentials, in US-ASCII format.
  • voice_connector_id: The Amazon Chime Voice Connector ID.
Main.Chime.describe_app_instanceMethod
describe_app_instance(app_instance_arn)
describe_app_instance(app_instance_arn, params::Dict{String,<:Any})

Returns the full details of an AppInstance.

Arguments

  • app_instance_arn: The ARN of the AppInstance.
Main.Chime.describe_app_instance_adminMethod
describe_app_instance_admin(app_instance_admin_arn, app_instance_arn)
describe_app_instance_admin(app_instance_admin_arn, app_instance_arn, params::Dict{String,<:Any})

Returns the full details of an AppInstanceAdmin.

Arguments

  • app_instance_admin_arn: The ARN of the AppInstanceAdmin.
  • app_instance_arn: The ARN of the AppInstance.
Main.Chime.describe_app_instance_userMethod
describe_app_instance_user(app_instance_user_arn)
describe_app_instance_user(app_instance_user_arn, params::Dict{String,<:Any})

Returns the full details of an AppInstanceUser.

Arguments

  • app_instance_user_arn: The ARN of the AppInstanceUser.
Main.Chime.describe_channelMethod
describe_channel(channel_arn)
describe_channel(channel_arn, params::Dict{String,<:Any})

Returns the full details of a channel in an Amazon Chime AppInstance. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

Arguments

  • channel_arn: The ARN of the channel.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "x-amz-chime-bearer": The AppInstanceUserArn of the user that makes the API call.
Main.Chime.describe_channel_banMethod
describe_channel_ban(channel_arn, member_arn)
describe_channel_ban(channel_arn, member_arn, params::Dict{String,<:Any})

Returns the full details of a channel ban. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

Arguments

  • channel_arn: The ARN of the channel from which the user is banned.
  • member_arn: The ARN of the member being banned.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "x-amz-chime-bearer": The AppInstanceUserArn of the user that makes the API call.
Main.Chime.describe_channel_membershipMethod
describe_channel_membership(channel_arn, member_arn)
describe_channel_membership(channel_arn, member_arn, params::Dict{String,<:Any})

Returns the full details of a user's channel membership. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

Arguments

  • channel_arn: The ARN of the channel.
  • member_arn: The ARN of the member.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "x-amz-chime-bearer": The AppInstanceUserArn of the user that makes the API call.
Main.Chime.describe_channel_membership_for_app_instance_userMethod
describe_channel_membership_for_app_instance_user(app-instance-user-arn, channel_arn)
describe_channel_membership_for_app_instance_user(app-instance-user-arn, channel_arn, params::Dict{String,<:Any})

Returns the details of a channel based on the membership of the specified AppInstanceUser. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

Arguments

  • app-instance-user-arn: The ARN of the user in a channel.
  • channel_arn: The ARN of the channel to which the user belongs.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "x-amz-chime-bearer": The AppInstanceUserArn of the user that makes the API call.
Main.Chime.describe_channel_moderated_by_app_instance_userMethod
describe_channel_moderated_by_app_instance_user(app-instance-user-arn, channel_arn)
describe_channel_moderated_by_app_instance_user(app-instance-user-arn, channel_arn, params::Dict{String,<:Any})

Returns the full details of a channel moderated by the specified AppInstanceUser. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

Arguments

  • app-instance-user-arn: The ARN of the AppInstanceUser in the moderated channel.
  • channel_arn: The ARN of the moderated channel.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "x-amz-chime-bearer": The AppInstanceUserArn of the user that makes the API call.
Main.Chime.describe_channel_moderatorMethod
describe_channel_moderator(channel_arn, channel_moderator_arn)
describe_channel_moderator(channel_arn, channel_moderator_arn, params::Dict{String,<:Any})

Returns the full details of a single ChannelModerator. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

Arguments

  • channel_arn: The ARN of the channel.
  • channel_moderator_arn: The ARN of the channel moderator.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "x-amz-chime-bearer": The AppInstanceUserArn of the user that makes the API call.
Main.Chime.disassociate_phone_number_from_userMethod
disassociate_phone_number_from_user(account_id, user_id)
disassociate_phone_number_from_user(account_id, user_id, params::Dict{String,<:Any})

Disassociates the primary provisioned phone number from the specified Amazon Chime user.

Arguments

  • account_id: The Amazon Chime account ID.
  • user_id: The user ID.
Main.Chime.disassociate_phone_numbers_from_voice_connectorMethod
disassociate_phone_numbers_from_voice_connector(e164_phone_numbers, voice_connector_id)
disassociate_phone_numbers_from_voice_connector(e164_phone_numbers, voice_connector_id, params::Dict{String,<:Any})

Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector.

Arguments

  • e164_phone_numbers: List of phone numbers, in E.164 format.
  • voice_connector_id: The Amazon Chime Voice Connector ID.
Main.Chime.disassociate_phone_numbers_from_voice_connector_groupMethod
disassociate_phone_numbers_from_voice_connector_group(e164_phone_numbers, voice_connector_group_id)
disassociate_phone_numbers_from_voice_connector_group(e164_phone_numbers, voice_connector_group_id, params::Dict{String,<:Any})

Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector group.

Arguments

  • e164_phone_numbers: List of phone numbers, in E.164 format.
  • voice_connector_group_id: The Amazon Chime Voice Connector group ID.
Main.Chime.disassociate_signin_delegate_groups_from_accountMethod
disassociate_signin_delegate_groups_from_account(group_names, account_id)
disassociate_signin_delegate_groups_from_account(group_names, account_id, params::Dict{String,<:Any})

Disassociates the specified sign-in delegate groups from the specified Amazon Chime account.

Arguments

  • group_names: The sign-in delegate group names.
  • account_id: The Amazon Chime account ID.
Main.Chime.get_accountMethod
get_account(account_id)
get_account(account_id, params::Dict{String,<:Any})

Retrieves details for the specified Amazon Chime account, such as account type and supported licenses.

Arguments

  • account_id: The Amazon Chime account ID.
Main.Chime.get_account_settingsMethod
get_account_settings(account_id)
get_account_settings(account_id, params::Dict{String,<:Any})

Retrieves account settings for the specified Amazon Chime account ID, such as remote control and dialout settings. For more information about these settings, see Use the Policies Page in the Amazon Chime Administration Guide.

Arguments

  • account_id: The Amazon Chime account ID.
Main.Chime.get_app_instance_retention_settingsMethod
get_app_instance_retention_settings(app_instance_arn)
get_app_instance_retention_settings(app_instance_arn, params::Dict{String,<:Any})

Gets the retention settings for an AppInstance.

Arguments

  • app_instance_arn: The ARN of the AppInstance.
Main.Chime.get_app_instance_streaming_configurationsMethod
get_app_instance_streaming_configurations(app_instance_arn)
get_app_instance_streaming_configurations(app_instance_arn, params::Dict{String,<:Any})

Gets the streaming settings for an AppInstance.

Arguments

  • app_instance_arn: The ARN of the AppInstance.
Main.Chime.get_attendeeMethod
get_attendee(attendee_id, meeting_id)
get_attendee(attendee_id, meeting_id, params::Dict{String,<:Any})

Gets the Amazon Chime SDK attendee details for a specified meeting ID and attendee ID. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide .

Arguments

  • attendee_id: The Amazon Chime SDK attendee ID.
  • meeting_id: The Amazon Chime SDK meeting ID.
Main.Chime.get_botMethod
get_bot(account_id, bot_id)
get_bot(account_id, bot_id, params::Dict{String,<:Any})

Retrieves details for the specified bot, such as bot email address, bot type, status, and display name.

Arguments

  • account_id: The Amazon Chime account ID.
  • bot_id: The bot ID.
Main.Chime.get_channel_messageMethod
get_channel_message(channel_arn, message_id)
get_channel_message(channel_arn, message_id, params::Dict{String,<:Any})

Gets the full details of a channel message. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

Arguments

  • channel_arn: The ARN of the channel.
  • message_id: The ID of the message.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "x-amz-chime-bearer": The AppInstanceUserArn of the user that makes the API call.
Main.Chime.get_events_configurationMethod
get_events_configuration(account_id, bot_id)
get_events_configuration(account_id, bot_id, params::Dict{String,<:Any})

Gets details for an events configuration that allows a bot to receive outgoing events, such as an HTTPS endpoint or Lambda function ARN.

Arguments

  • account_id: The Amazon Chime account ID.
  • bot_id: The bot ID.
Main.Chime.get_global_settingsMethod
get_global_settings()
get_global_settings(params::Dict{String,<:Any})

Retrieves global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.

Main.Chime.get_media_capture_pipelineMethod
get_media_capture_pipeline(media_pipeline_id)
get_media_capture_pipeline(media_pipeline_id, params::Dict{String,<:Any})

Gets an existing media capture pipeline.

Arguments

  • media_pipeline_id: The ID of the pipeline that you want to get.
Main.Chime.get_meetingMethod
get_meeting(meeting_id)
get_meeting(meeting_id, params::Dict{String,<:Any})

Gets the Amazon Chime SDK meeting details for the specified meeting ID. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide .

Arguments

  • meeting_id: The Amazon Chime SDK meeting ID.
Main.Chime.get_phone_numberMethod
get_phone_number(phone_number_id)
get_phone_number(phone_number_id, params::Dict{String,<:Any})

Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.

Arguments

  • phone_number_id: The phone number ID.
Main.Chime.get_phone_number_orderMethod
get_phone_number_order(phone_number_order_id)
get_phone_number_order(phone_number_order_id, params::Dict{String,<:Any})

Retrieves details for the specified phone number order, such as the order creation timestamp, phone numbers in E.164 format, product type, and order status.

Arguments

  • phone_number_order_id: The ID for the phone number order.
Main.Chime.get_phone_number_settingsMethod
get_phone_number_settings()
get_phone_number_settings(params::Dict{String,<:Any})

Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name.

Main.Chime.get_proxy_sessionMethod
get_proxy_session(proxy_session_id, voice_connector_id)
get_proxy_session(proxy_session_id, voice_connector_id, params::Dict{String,<:Any})

Gets the specified proxy session details for the specified Amazon Chime Voice Connector.

Arguments

  • proxy_session_id: The proxy session ID.
  • voice_connector_id: The Amazon Chime voice connector ID.
Main.Chime.get_retention_settingsMethod
get_retention_settings(account_id)
get_retention_settings(account_id, params::Dict{String,<:Any})

Gets the retention settings for the specified Amazon Chime Enterprise account. For more information about retention settings, see Managing Chat Retention Policies in the Amazon Chime Administration Guide.

Arguments

  • account_id: The Amazon Chime account ID.
Main.Chime.get_roomMethod
get_room(account_id, room_id)
get_room(account_id, room_id, params::Dict{String,<:Any})

Retrieves room details, such as the room name, for a room in an Amazon Chime Enterprise account.

Arguments

  • account_id: The Amazon Chime account ID.
  • room_id: The room ID.
Main.Chime.get_sip_media_applicationMethod
get_sip_media_application(sip_media_application_id)
get_sip_media_application(sip_media_application_id, params::Dict{String,<:Any})

Retrieves the information for a SIP media application, including name, AWS Region, and endpoints.

Arguments

  • sip_media_application_id: The SIP media application ID.
Main.Chime.get_sip_media_application_logging_configurationMethod
get_sip_media_application_logging_configuration(sip_media_application_id)
get_sip_media_application_logging_configuration(sip_media_application_id, params::Dict{String,<:Any})

Returns the logging configuration for the specified SIP media application.

Arguments

  • sip_media_application_id: The SIP media application ID.
Main.Chime.get_sip_ruleMethod
get_sip_rule(sip_rule_id)
get_sip_rule(sip_rule_id, params::Dict{String,<:Any})

Retrieves the details of a SIP rule, such as the rule ID, name, triggers, and target endpoints.

Arguments

  • sip_rule_id: The SIP rule ID.
Main.Chime.get_userMethod
get_user(account_id, user_id)
get_user(account_id, user_id, params::Dict{String,<:Any})

Retrieves details for the specified user ID, such as primary email address, license type,and personal meeting PIN. To retrieve user details with an email address instead of a user ID, use the ListUsers action, and then filter by email address.

Arguments

  • account_id: The Amazon Chime account ID.
  • user_id: The user ID.
Main.Chime.get_user_settingsMethod
get_user_settings(account_id, user_id)
get_user_settings(account_id, user_id, params::Dict{String,<:Any})

Retrieves settings for the specified user ID, such as any associated phone number settings.

Arguments

  • account_id: The Amazon Chime account ID.
  • user_id: The user ID.
Main.Chime.get_voice_connectorMethod
get_voice_connector(voice_connector_id)
get_voice_connector(voice_connector_id, params::Dict{String,<:Any})

Retrieves details for the specified Amazon Chime Voice Connector, such as timestamps,name, outbound host, and encryption requirements.

Arguments

  • voice_connector_id: The Amazon Chime Voice Connector ID.
Main.Chime.get_voice_connector_emergency_calling_configurationMethod
get_voice_connector_emergency_calling_configuration(voice_connector_id)
get_voice_connector_emergency_calling_configuration(voice_connector_id, params::Dict{String,<:Any})

Gets the emergency calling configuration details for the specified Amazon Chime Voice Connector.

Arguments

  • voice_connector_id: The Amazon Chime Voice Connector ID.
Main.Chime.get_voice_connector_groupMethod
get_voice_connector_group(voice_connector_group_id)
get_voice_connector_group(voice_connector_group_id, params::Dict{String,<:Any})

Retrieves details for the specified Amazon Chime Voice Connector group, such as timestamps,name, and associated VoiceConnectorItems.

Arguments

  • voice_connector_group_id: The Amazon Chime Voice Connector group ID.
Main.Chime.get_voice_connector_logging_configurationMethod
get_voice_connector_logging_configuration(voice_connector_id)
get_voice_connector_logging_configuration(voice_connector_id, params::Dict{String,<:Any})

Retrieves the logging configuration details for the specified Amazon Chime Voice Connector. Shows whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.

Arguments

  • voice_connector_id: The Amazon Chime Voice Connector ID.
Main.Chime.get_voice_connector_originationMethod
get_voice_connector_origination(voice_connector_id)
get_voice_connector_origination(voice_connector_id, params::Dict{String,<:Any})

Retrieves origination setting details for the specified Amazon Chime Voice Connector.

Arguments

  • voice_connector_id: The Amazon Chime Voice Connector ID.
Main.Chime.get_voice_connector_proxyMethod
get_voice_connector_proxy(voice_connector_id)
get_voice_connector_proxy(voice_connector_id, params::Dict{String,<:Any})

Gets the proxy configuration details for the specified Amazon Chime Voice Connector.

Arguments

  • voice_connector_id: The Amazon Chime voice connector ID.
Main.Chime.get_voice_connector_streaming_configurationMethod
get_voice_connector_streaming_configuration(voice_connector_id)
get_voice_connector_streaming_configuration(voice_connector_id, params::Dict{String,<:Any})

Retrieves the streaming configuration details for the specified Amazon Chime Voice Connector. Shows whether media streaming is enabled for sending to Amazon Kinesis. It also shows the retention period, in hours, for the Amazon Kinesis data.

Arguments

  • voice_connector_id: The Amazon Chime Voice Connector ID.
Main.Chime.get_voice_connector_terminationMethod
get_voice_connector_termination(voice_connector_id)
get_voice_connector_termination(voice_connector_id, params::Dict{String,<:Any})

Retrieves termination setting details for the specified Amazon Chime Voice Connector.

Arguments

  • voice_connector_id: The Amazon Chime Voice Connector ID.
Main.Chime.get_voice_connector_termination_healthMethod
get_voice_connector_termination_health(voice_connector_id)
get_voice_connector_termination_health(voice_connector_id, params::Dict{String,<:Any})

Retrieves information about the last time a SIP OPTIONS ping was received from your SIP infrastructure for the specified Amazon Chime Voice Connector.

Arguments

  • voice_connector_id: The Amazon Chime Voice Connector ID.
Main.Chime.invite_usersMethod
invite_users(user_email_list, account_id)
invite_users(user_email_list, account_id, params::Dict{String,<:Any})

Sends email to a maximum of 50 users, inviting them to the specified Amazon Chime Team account. Only Team account types are currently supported for this action.

Arguments

  • user_email_list: The user email addresses to which to send the email invitation.
  • account_id: The Amazon Chime account ID.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "UserType": The user type.
Main.Chime.list_accountsMethod
list_accounts()
list_accounts(params::Dict{String,<:Any})

Lists the Amazon Chime accounts under the administrator's AWS account. You can filter accounts by account name prefix. To find out which Amazon Chime account a user belongs to, you can filter by the user's email address, which returns one account result.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "max-results": The maximum number of results to return in a single call. Defaults to
  • "name": Amazon Chime account name prefix with which to filter results.
  • "next-token": The token to use to retrieve the next page of results.
  • "user-email": User email address with which to filter results.
Main.Chime.list_app_instance_adminsMethod
list_app_instance_admins(app_instance_arn)
list_app_instance_admins(app_instance_arn, params::Dict{String,<:Any})

Returns a list of the administrators in the AppInstance.

Arguments

  • app_instance_arn: The ARN of the AppInstance.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "max-results": The maximum number of administrators that you want to return.
  • "next-token": The token returned from previous API requests until the number of administrators is reached.
Main.Chime.list_app_instance_usersMethod
list_app_instance_users(app-instance-arn)
list_app_instance_users(app-instance-arn, params::Dict{String,<:Any})

List all AppInstanceUsers created under a single AppInstance.

Arguments

  • app-instance-arn: The ARN of the AppInstance.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "max-results": The maximum number of requests that you want returned.
  • "next-token": The token passed by previous API calls until all requested users are returned.
Main.Chime.list_app_instancesMethod
list_app_instances()
list_app_instances(params::Dict{String,<:Any})

Lists all Amazon Chime AppInstances created under a single AWS account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "max-results": The maximum number of AppInstances that you want to return.
  • "next-token": The token passed by previous API requests until you reach the maximum number of AppInstances.
Main.Chime.list_attendee_tagsMethod
list_attendee_tags(attendee_id, meeting_id)
list_attendee_tags(attendee_id, meeting_id, params::Dict{String,<:Any})

Lists the tags applied to an Amazon Chime SDK attendee resource.

Arguments

  • attendee_id: The Amazon Chime SDK attendee ID.
  • meeting_id: The Amazon Chime SDK meeting ID.
Main.Chime.list_attendeesMethod
list_attendees(meeting_id)
list_attendees(meeting_id, params::Dict{String,<:Any})

Lists the attendees for the specified Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide.

Arguments

  • meeting_id: The Amazon Chime SDK meeting ID.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "max-results": The maximum number of results to return in a single call.
  • "next-token": The token to use to retrieve the next page of results.
Main.Chime.list_botsMethod
list_bots(account_id)
list_bots(account_id, params::Dict{String,<:Any})

Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.

Arguments

  • account_id: The Amazon Chime account ID.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "max-results": The maximum number of results to return in a single call. The default is
  • "next-token": The token to use to retrieve the next page of results.
Main.Chime.list_channel_bansMethod
list_channel_bans(channel_arn)
list_channel_bans(channel_arn, params::Dict{String,<:Any})

Lists all the users banned from a particular channel. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

Arguments

  • channel_arn: The ARN of the channel.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "max-results": The maximum number of bans that you want returned.
  • "next-token": The token passed by previous API calls until all requested bans are returned.
  • "x-amz-chime-bearer": The AppInstanceUserArn of the user that makes the API call.
Main.Chime.list_channel_membershipsMethod
list_channel_memberships(channel_arn)
list_channel_memberships(channel_arn, params::Dict{String,<:Any})

Lists all channel memberships in a channel. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

Arguments

  • channel_arn: The maximum number of channel memberships that you want returned.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "max-results": The maximum number of channel memberships that you want returned.
  • "next-token": The token passed by previous API calls until all requested channel memberships are returned.
  • "type": The membership type of a user, DEFAULT or HIDDEN. Default members are always returned as part of ListChannelMemberships. Hidden members are only returned if the type filter in ListChannelMemberships equals HIDDEN. Otherwise hidden members are not returned.
  • "x-amz-chime-bearer": The AppInstanceUserArn of the user that makes the API call.
Main.Chime.list_channel_memberships_for_app_instance_userMethod
list_channel_memberships_for_app_instance_user()
list_channel_memberships_for_app_instance_user(params::Dict{String,<:Any})

Lists all channels that a particular AppInstanceUser is a part of. Only an AppInstanceAdmin can call the API with a user ARN that is not their own. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "app-instance-user-arn": The ARN of the AppInstanceUsers
  • "max-results": The maximum number of users that you want returned.
  • "next-token": The token returned from previous API requests until the number of channel memberships is reached.
  • "x-amz-chime-bearer": The AppInstanceUserArn of the user that makes the API call.
Main.Chime.list_channel_messagesMethod
list_channel_messages(channel_arn)
list_channel_messages(channel_arn, params::Dict{String,<:Any})

List all the messages in a channel. Returns a paginated list of ChannelMessages. By default, sorted by creation timestamp in descending order. Redacted messages appear in the results as empty, since they are only redacted, not deleted. Deleted messages do not appear in the results. This action always returns the latest version of an edited message. Also, the x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

Arguments

  • channel_arn: The ARN of the channel.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "max-results": The maximum number of messages that you want returned.
  • "next-token": The token passed by previous API calls until all requested messages are returned.
  • "not-after": The final or ending time stamp for your requested messages.
  • "not-before": The initial or starting time stamp for your requested messages.
  • "sort-order": The order in which you want messages sorted. Default is Descending, based on time created.
  • "x-amz-chime-bearer": The AppInstanceUserArn of the user that makes the API call.
Main.Chime.list_channel_moderatorsMethod
list_channel_moderators(channel_arn)
list_channel_moderators(channel_arn, params::Dict{String,<:Any})

Lists all the moderators for a channel. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

Arguments

  • channel_arn: The ARN of the channel.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "max-results": The maximum number of moderators that you want returned.
  • "next-token": The token passed by previous API calls until all requested moderators are returned.
  • "x-amz-chime-bearer": The AppInstanceUserArn of the user that makes the API call.
Main.Chime.list_channelsMethod
list_channels(app-instance-arn)
list_channels(app-instance-arn, params::Dict{String,<:Any})

Lists all Channels created under a single Chime App as a paginated list. You can specify filters to narrow results. Functionality &amp; restrictions Use privacy = PUBLIC to retrieve all public channels in the account. Only an AppInstanceAdmin can set privacy = PRIVATE to list the private channels in an account. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

Arguments

  • app-instance-arn: The ARN of the AppInstance.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "max-results": The maximum number of channels that you want to return.
  • "next-token": The token passed by previous API calls until all requested channels are returned.
  • "privacy": The privacy setting. PUBLIC retrieves all the public channels. PRIVATE retrieves private channels. Only an AppInstanceAdmin can retrieve private channels.
  • "x-amz-chime-bearer": The AppInstanceUserArn of the user that makes the API call.
Main.Chime.list_channels_moderated_by_app_instance_userMethod
list_channels_moderated_by_app_instance_user()
list_channels_moderated_by_app_instance_user(params::Dict{String,<:Any})

A list of the channels moderated by an AppInstanceUser. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "app-instance-user-arn": The ARN of the user in the moderated channel.
  • "max-results": The maximum number of channels in the request.
  • "next-token": The token returned from previous API requests until the number of channels moderated by the user is reached.
  • "x-amz-chime-bearer": The AppInstanceUserArn of the user that makes the API call.
Main.Chime.list_media_capture_pipelinesMethod
list_media_capture_pipelines()
list_media_capture_pipelines(params::Dict{String,<:Any})

Returns a list of media capture pipelines.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "max-results": The maximum number of results to return in a single call. Valid Range: 1
  • "next-token": The token used to retrieve the next page of results.
Main.Chime.list_meeting_tagsMethod
list_meeting_tags(meeting_id)
list_meeting_tags(meeting_id, params::Dict{String,<:Any})

Lists the tags applied to an Amazon Chime SDK meeting resource.

Arguments

  • meeting_id: The Amazon Chime SDK meeting ID.
Main.Chime.list_meetingsMethod
list_meetings()
list_meetings(params::Dict{String,<:Any})

Lists up to 100 active Amazon Chime SDK meetings. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "max-results": The maximum number of results to return in a single call.
  • "next-token": The token to use to retrieve the next page of results.
Main.Chime.list_phone_number_ordersMethod
list_phone_number_orders()
list_phone_number_orders(params::Dict{String,<:Any})

Lists the phone number orders for the administrator's Amazon Chime account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "max-results": The maximum number of results to return in a single call.
  • "next-token": The token to use to retrieve the next page of results.
Main.Chime.list_phone_numbersMethod
list_phone_numbers()
list_phone_numbers(params::Dict{String,<:Any})

Lists the phone numbers for the specified Amazon Chime account, Amazon Chime user, Amazon Chime Voice Connector, or Amazon Chime Voice Connector group.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "filter-name": The filter to use to limit the number of results.
  • "filter-value": The value to use for the filter.
  • "max-results": The maximum number of results to return in a single call.
  • "next-token": The token to use to retrieve the next page of results.
  • "product-type": The phone number product type.
  • "status": The phone number status.
Main.Chime.list_proxy_sessionsMethod
list_proxy_sessions(voice_connector_id)
list_proxy_sessions(voice_connector_id, params::Dict{String,<:Any})

Lists the proxy sessions for the specified Amazon Chime Voice Connector.

Arguments

  • voice_connector_id: The Amazon Chime voice connector ID.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "max-results": The maximum number of results to return in a single call.
  • "next-token": The token to use to retrieve the next page of results.
  • "status": The proxy session status.
Main.Chime.list_room_membershipsMethod
list_room_memberships(account_id, room_id)
list_room_memberships(account_id, room_id, params::Dict{String,<:Any})

Lists the membership details for the specified room in an Amazon Chime Enterprise account, such as the members' IDs, email addresses, and names.

Arguments

  • account_id: The Amazon Chime account ID.
  • room_id: The room ID.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "max-results": The maximum number of results to return in a single call.
  • "next-token": The token to use to retrieve the next page of results.
Main.Chime.list_roomsMethod
list_rooms(account_id)
list_rooms(account_id, params::Dict{String,<:Any})

Lists the room details for the specified Amazon Chime Enterprise account. Optionally, filter the results by a member ID (user ID or bot ID) to see a list of rooms that the member belongs to.

Arguments

  • account_id: The Amazon Chime account ID.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "max-results": The maximum number of results to return in a single call.
  • "member-id": The member ID (user ID or bot ID).
  • "next-token": The token to use to retrieve the next page of results.
Main.Chime.list_sip_media_applicationsMethod
list_sip_media_applications()
list_sip_media_applications(params::Dict{String,<:Any})

Lists the SIP media applications under the administrator's AWS account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "max-results": The maximum number of results to return in a single call. Defaults to
  • "next-token": The token to use to retrieve the next page of results.
Main.Chime.list_sip_rulesMethod
list_sip_rules()
list_sip_rules(params::Dict{String,<:Any})

Lists the SIP rules under the administrator's AWS account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "max-results": The maximum number of results to return in a single call. Defaults to
  • "next-token": The token to use to retrieve the next page of results.
  • "sip-media-application": The SIP media application ID.
Main.Chime.list_supported_phone_number_countriesMethod
list_supported_phone_number_countries(product-type)
list_supported_phone_number_countries(product-type, params::Dict{String,<:Any})

Lists supported phone number countries.

Arguments

  • product-type: The phone number product type.
Main.Chime.list_tags_for_resourceMethod
list_tags_for_resource(arn)
list_tags_for_resource(arn, params::Dict{String,<:Any})

Lists the tags applied to an Amazon Chime SDK meeting resource.

Arguments

  • arn: The resource ARN.
Main.Chime.list_usersMethod
list_users(account_id)
list_users(account_id, params::Dict{String,<:Any})

Lists the users that belong to the specified Amazon Chime account. You can specify an email address to list only the user that the email address belongs to.

Arguments

  • account_id: The Amazon Chime account ID.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "max-results": The maximum number of results to return in a single call. Defaults to
  • "next-token": The token to use to retrieve the next page of results.
  • "user-email": Optional. The user email address used to filter results. Maximum 1.
  • "user-type": The user type.
Main.Chime.list_voice_connector_groupsMethod
list_voice_connector_groups()
list_voice_connector_groups(params::Dict{String,<:Any})

Lists the Amazon Chime Voice Connector groups for the administrator's AWS account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "max-results": The maximum number of results to return in a single call.
  • "next-token": The token to use to retrieve the next page of results.
Main.Chime.list_voice_connector_termination_credentialsMethod
list_voice_connector_termination_credentials(voice_connector_id)
list_voice_connector_termination_credentials(voice_connector_id, params::Dict{String,<:Any})

Lists the SIP credentials for the specified Amazon Chime Voice Connector.

Arguments

  • voice_connector_id: The Amazon Chime Voice Connector ID.
Main.Chime.list_voice_connectorsMethod
list_voice_connectors()
list_voice_connectors(params::Dict{String,<:Any})

Lists the Amazon Chime Voice Connectors for the administrator's AWS account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "max-results": The maximum number of results to return in a single call.
  • "next-token": The token to use to retrieve the next page of results.
Main.Chime.logout_userMethod
logout_user(account_id, user_id)
logout_user(account_id, user_id, params::Dict{String,<:Any})

Logs out the specified user from all of the devices they are currently logged into.

Arguments

  • account_id: The Amazon Chime account ID.
  • user_id: The user ID.
Main.Chime.put_app_instance_retention_settingsMethod
put_app_instance_retention_settings(app_instance_retention_settings, app_instance_arn)
put_app_instance_retention_settings(app_instance_retention_settings, app_instance_arn, params::Dict{String,<:Any})

Sets the amount of time in days that a given AppInstance retains data.

Arguments

  • app_instance_retention_settings: The time in days to retain data. Data type: number.
  • app_instance_arn: The ARN of the AppInstance.
Main.Chime.put_app_instance_streaming_configurationsMethod
put_app_instance_streaming_configurations(app_instance_streaming_configurations, app_instance_arn)
put_app_instance_streaming_configurations(app_instance_streaming_configurations, app_instance_arn, params::Dict{String,<:Any})

The data streaming configurations of an AppInstance.

Arguments

  • app_instance_streaming_configurations: The streaming configurations set for an AppInstance.
  • app_instance_arn: The ARN of the AppInstance.
Main.Chime.put_events_configurationMethod
put_events_configuration(account_id, bot_id)
put_events_configuration(account_id, bot_id, params::Dict{String,<:Any})

Creates an events configuration that allows a bot to receive outgoing events sent by Amazon Chime. Choose either an HTTPS endpoint or a Lambda function ARN. For more information, see Bot.

Arguments

  • account_id: The Amazon Chime account ID.
  • bot_id: The bot ID.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "LambdaFunctionArn": Lambda function ARN that allows the bot to receive outgoing events.
  • "OutboundEventsHTTPSEndpoint": HTTPS endpoint that allows the bot to receive outgoing events.
Main.Chime.put_retention_settingsMethod
put_retention_settings(retention_settings, account_id)
put_retention_settings(retention_settings, account_id, params::Dict{String,<:Any})

Puts retention settings for the specified Amazon Chime Enterprise account. We recommend using AWS CloudTrail to monitor usage of this API for your account. For more information, see Logging Amazon Chime API Calls with AWS CloudTrail in the Amazon Chime Administration Guide. To turn off existing retention settings, remove the number of days from the corresponding RetentionDays field in the RetentionSettings object. For more information about retention settings, see Managing Chat Retention Policies in the Amazon Chime Administration Guide.

Arguments

  • retention_settings: The retention settings.
  • account_id: The Amazon Chime account ID.
Main.Chime.put_sip_media_application_logging_configurationMethod
put_sip_media_application_logging_configuration(sip_media_application_id)
put_sip_media_application_logging_configuration(sip_media_application_id, params::Dict{String,<:Any})

Updates the logging configuration for the specified SIP media application.

Arguments

  • sip_media_application_id: The SIP media application ID.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "SipMediaApplicationLoggingConfiguration": The actual logging configuration.
Main.Chime.put_voice_connector_emergency_calling_configurationMethod
put_voice_connector_emergency_calling_configuration(emergency_calling_configuration, voice_connector_id)
put_voice_connector_emergency_calling_configuration(emergency_calling_configuration, voice_connector_id, params::Dict{String,<:Any})

Puts emergency calling configuration details to the specified Amazon Chime Voice Connector, such as emergency phone numbers and calling countries. Origination and termination settings must be enabled for the Amazon Chime Voice Connector before emergency calling can be configured.

Arguments

  • emergency_calling_configuration: The emergency calling configuration details.
  • voice_connector_id: The Amazon Chime Voice Connector ID.
Main.Chime.put_voice_connector_logging_configurationMethod
put_voice_connector_logging_configuration(logging_configuration, voice_connector_id)
put_voice_connector_logging_configuration(logging_configuration, voice_connector_id, params::Dict{String,<:Any})

Adds a logging configuration for the specified Amazon Chime Voice Connector. The logging configuration specifies whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.

Arguments

  • logging_configuration: The logging configuration details to add.
  • voice_connector_id: The Amazon Chime Voice Connector ID.
Main.Chime.put_voice_connector_originationMethod
put_voice_connector_origination(origination, voice_connector_id)
put_voice_connector_origination(origination, voice_connector_id, params::Dict{String,<:Any})

Adds origination settings for the specified Amazon Chime Voice Connector. If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to turning off origination settings.

Arguments

  • origination: The origination setting details to add.
  • voice_connector_id: The Amazon Chime Voice Connector ID.
Main.Chime.put_voice_connector_proxyMethod
put_voice_connector_proxy(default_session_expiry_minutes, phone_number_pool_countries, voice_connector_id)
put_voice_connector_proxy(default_session_expiry_minutes, phone_number_pool_countries, voice_connector_id, params::Dict{String,<:Any})

Puts the specified proxy configuration to the specified Amazon Chime Voice Connector.

Arguments

  • default_session_expiry_minutes: The default number of minutes allowed for proxy sessions.
  • phone_number_pool_countries: The countries for proxy phone numbers to be selected from.
  • voice_connector_id: The Amazon Chime voice connector ID.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Disabled": When true, stops proxy sessions from being created on the specified Amazon Chime Voice Connector.
  • "FallBackPhoneNumber": The phone number to route calls to after a proxy session expires.
Main.Chime.put_voice_connector_streaming_configurationMethod
put_voice_connector_streaming_configuration(streaming_configuration, voice_connector_id)
put_voice_connector_streaming_configuration(streaming_configuration, voice_connector_id, params::Dict{String,<:Any})

Adds a streaming configuration for the specified Amazon Chime Voice Connector. The streaming configuration specifies whether media streaming is enabled for sending to Kinesis. It also sets the retention period, in hours, for the Amazon Kinesis data.

Arguments

  • streaming_configuration: The streaming configuration details to add.
  • voice_connector_id: The Amazon Chime Voice Connector ID.
Main.Chime.put_voice_connector_terminationMethod
put_voice_connector_termination(termination, voice_connector_id)
put_voice_connector_termination(termination, voice_connector_id, params::Dict{String,<:Any})

Adds termination settings for the specified Amazon Chime Voice Connector. If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to turning off termination settings.

Arguments

  • termination: The termination setting details to add.
  • voice_connector_id: The Amazon Chime Voice Connector ID.
Main.Chime.put_voice_connector_termination_credentialsMethod
put_voice_connector_termination_credentials(voice_connector_id)
put_voice_connector_termination_credentials(voice_connector_id, params::Dict{String,<:Any})

Adds termination SIP credentials for the specified Amazon Chime Voice Connector.

Arguments

  • voice_connector_id: The Amazon Chime Voice Connector ID.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Credentials": The termination SIP credentials.
Main.Chime.redact_channel_messageMethod
redact_channel_message(channel_arn, message_id)
redact_channel_message(channel_arn, message_id, params::Dict{String,<:Any})

Redacts message content, but not metadata. The message exists in the back end, but the action returns null content, and the state shows as redacted. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

Arguments

  • channel_arn: The ARN of the channel containing the messages that you want to redact.
  • message_id: The ID of the message being redacted.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "x-amz-chime-bearer": The AppInstanceUserArn of the user that makes the API call.
Main.Chime.redact_conversation_messageMethod
redact_conversation_message(account_id, conversation_id, message_id)
redact_conversation_message(account_id, conversation_id, message_id, params::Dict{String,<:Any})

Redacts the specified message from the specified Amazon Chime conversation.

Arguments

  • account_id: The Amazon Chime account ID.
  • conversation_id: The conversation ID.
  • message_id: The message ID.
Main.Chime.redact_room_messageMethod
redact_room_message(account_id, message_id, room_id)
redact_room_message(account_id, message_id, room_id, params::Dict{String,<:Any})

Redacts the specified message from the specified Amazon Chime channel.

Arguments

  • account_id: The Amazon Chime account ID.
  • message_id: The message ID.
  • room_id: The room ID.
Main.Chime.regenerate_security_tokenMethod
regenerate_security_token(account_id, bot_id)
regenerate_security_token(account_id, bot_id, params::Dict{String,<:Any})

Regenerates the security token for a bot.

Arguments

  • account_id: The Amazon Chime account ID.
  • bot_id: The bot ID.
Main.Chime.reset_personal_pinMethod
reset_personal_pin(account_id, user_id)
reset_personal_pin(account_id, user_id, params::Dict{String,<:Any})

Resets the personal meeting PIN for the specified user on an Amazon Chime account. Returns the User object with the updated personal meeting PIN.

Arguments

  • account_id: The Amazon Chime account ID.
  • user_id: The user ID.
Main.Chime.restore_phone_numberMethod
restore_phone_number(phone_number_id)
restore_phone_number(phone_number_id, params::Dict{String,<:Any})

Moves a phone number from the Deletion queue back into the phone number Inventory.

Arguments

  • phone_number_id: The phone number.
Main.Chime.search_available_phone_numbersMethod
search_available_phone_numbers()
search_available_phone_numbers(params::Dict{String,<:Any})

Searches for phone numbers that can be ordered. For US numbers, provide at least one of the following search filters: AreaCode, City, State, or TollFreePrefix. If you provide City, you must also provide State. Numbers outside the US only support the PhoneNumberType filter, which you must use.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "area-code": The area code used to filter results. Only applies to the US.
  • "city": The city used to filter results. Only applies to the US.
  • "country": The country used to filter results. Defaults to the US Format: ISO 3166-1 alpha-2.
  • "max-results": The maximum number of results to return in a single call.
  • "next-token": The token used to retrieve the next page of results.
  • "phone-number-type": The phone number type used to filter results. Required for non-US numbers.
  • "state": The state used to filter results. Required only if you provide City. Only applies to the US.
  • "toll-free-prefix": The toll-free prefix that you use to filter results. Only applies to the US.
Main.Chime.send_channel_messageMethod
send_channel_message(client_request_token, content, persistence, type, channel_arn)
send_channel_message(client_request_token, content, persistence, type, channel_arn, params::Dict{String,<:Any})

Sends a message to a particular channel that the member is a part of. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. Also, STANDARD messages can contain 4KB of data and the 1KB of metadata. CONTROL messages can contain 30 bytes of data and no metadata.

Arguments

  • client_request_token: The Idempotency token for each client request.
  • content: The content of the message.
  • persistence: Boolean that controls whether the message is persisted on the back end. Required.
  • type: The type of message, STANDARD or CONTROL.
  • channel_arn: The ARN of the channel.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Metadata": The optional metadata for each message.
  • "x-amz-chime-bearer": The AppInstanceUserArn of the user that makes the API call.
Main.Chime.start_meeting_transcriptionMethod
start_meeting_transcription(transcription_configuration, meeting_id)
start_meeting_transcription(transcription_configuration, meeting_id, params::Dict{String,<:Any})

Starts transcription for the specified meetingId. For more information, refer to Using Amazon Chime SDK live transcription in the Amazon Chime SDK Developer Guide. If you specify an invalid configuration, a TranscriptFailed event will be sent with the contents of the BadRequestException generated by Amazon Transcribe. For more information on each parameter and which combinations are valid, refer to the StartStreamTranscription API in the Amazon Transcribe Developer Guide. Amazon Chime SDK live transcription is powered by Amazon Transcribe. Use of Amazon Transcribe is subject to the AWS Service Terms, including the terms specific to the AWS Machine Learning and Artificial Intelligence Services.

Arguments

  • transcription_configuration: The configuration for the current transcription operation. Must contain EngineTranscribeSettings or EngineTranscribeMedicalSettings.
  • meeting_id: The unique ID of the meeting being transcribed.
Main.Chime.stop_meeting_transcriptionMethod
stop_meeting_transcription(meeting_id)
stop_meeting_transcription(meeting_id, params::Dict{String,<:Any})

Stops transcription for the specified meetingId.

Arguments

  • meeting_id: The unique ID of the meeting for which you stop transcription.
Main.Chime.tag_attendeeMethod
tag_attendee(tags, attendee_id, meeting_id)
tag_attendee(tags, attendee_id, meeting_id, params::Dict{String,<:Any})

Applies the specified tags to the specified Amazon Chime SDK attendee.

Arguments

  • tags: The tag key-value pairs.
  • attendee_id: The Amazon Chime SDK attendee ID.
  • meeting_id: The Amazon Chime SDK meeting ID.
Main.Chime.tag_meetingMethod
tag_meeting(tags, meeting_id)
tag_meeting(tags, meeting_id, params::Dict{String,<:Any})

Applies the specified tags to the specified Amazon Chime SDK meeting.

Arguments

  • tags: The tag key-value pairs.
  • meeting_id: The Amazon Chime SDK meeting ID.
Main.Chime.tag_resourceMethod
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})

Applies the specified tags to the specified Amazon Chime SDK meeting resource.

Arguments

  • resource_arn: The resource ARN.
  • tags: The tag key-value pairs.
Main.Chime.untag_attendeeMethod
untag_attendee(tag_keys, attendee_id, meeting_id)
untag_attendee(tag_keys, attendee_id, meeting_id, params::Dict{String,<:Any})

Untags the specified tags from the specified Amazon Chime SDK attendee.

Arguments

  • tag_keys: The tag keys.
  • attendee_id: The Amazon Chime SDK attendee ID.
  • meeting_id: The Amazon Chime SDK meeting ID.
Main.Chime.untag_meetingMethod
untag_meeting(tag_keys, meeting_id)
untag_meeting(tag_keys, meeting_id, params::Dict{String,<:Any})

Untags the specified tags from the specified Amazon Chime SDK meeting.

Arguments

  • tag_keys: The tag keys.
  • meeting_id: The Amazon Chime SDK meeting ID.
Main.Chime.untag_resourceMethod
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})

Untags the specified tags from the specified Amazon Chime SDK meeting resource.

Arguments

  • resource_arn: The resource ARN.
  • tag_keys: The tag keys.
Main.Chime.update_accountMethod
update_account(account_id)
update_account(account_id, params::Dict{String,<:Any})

Updates account details for the specified Amazon Chime account. Currently, only account name and default license updates are supported for this action.

Arguments

  • account_id: The Amazon Chime account ID.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "DefaultLicense": The default license applied when you add users to an Amazon Chime account.
  • "Name": The new name for the specified Amazon Chime account.
Main.Chime.update_account_settingsMethod
update_account_settings(account_settings, account_id)
update_account_settings(account_settings, account_id, params::Dict{String,<:Any})

Updates the settings for the specified Amazon Chime account. You can update settings for remote control of shared screens, or for the dial-out option. For more information about these settings, see Use the Policies Page in the Amazon Chime Administration Guide.

Arguments

  • account_settings: The Amazon Chime account settings to update.
  • account_id: The Amazon Chime account ID.
Main.Chime.update_app_instanceMethod
update_app_instance(name, app_instance_arn)
update_app_instance(name, app_instance_arn, params::Dict{String,<:Any})

Updates AppInstance metadata.

Arguments

  • name: The name that you want to change.
  • app_instance_arn: The ARN of the AppInstance.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Metadata": The metadata that you want to change.
Main.Chime.update_app_instance_userMethod
update_app_instance_user(name, app_instance_user_arn)
update_app_instance_user(name, app_instance_user_arn, params::Dict{String,<:Any})

Updates the details of an AppInstanceUser. You can update names and metadata.

Arguments

  • name: The name of the AppInstanceUser.
  • app_instance_user_arn: The ARN of the AppInstanceUser.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Metadata": The metadata of the AppInstanceUser.
Main.Chime.update_botMethod
update_bot(account_id, bot_id)
update_bot(account_id, bot_id, params::Dict{String,<:Any})

Updates the status of the specified bot, such as starting or stopping the bot from running in your Amazon Chime Enterprise account.

Arguments

  • account_id: The Amazon Chime account ID.
  • bot_id: The bot ID.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Disabled": When true, stops the specified bot from running in your account.
Main.Chime.update_channelMethod
update_channel(mode, name, channel_arn)
update_channel(mode, name, channel_arn, params::Dict{String,<:Any})

Update a channel's attributes. Restriction: You can't change a channel's privacy. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

Arguments

  • mode: The mode of the update request.
  • name: The name of the channel.
  • channel_arn: The ARN of the channel.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Metadata": The metadata for the update request.
  • "x-amz-chime-bearer": The AppInstanceUserArn of the user that makes the API call.
Main.Chime.update_channel_messageMethod
update_channel_message(channel_arn, message_id)
update_channel_message(channel_arn, message_id, params::Dict{String,<:Any})

Updates the content of a message. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

Arguments

  • channel_arn: The ARN of the channel.
  • message_id: The ID string of the message being updated.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Content": The content of the message being updated.
  • "Metadata": The metadata of the message being updated.
  • "x-amz-chime-bearer": The AppInstanceUserArn of the user that makes the API call.
Main.Chime.update_channel_read_markerMethod
update_channel_read_marker(channel_arn)
update_channel_read_marker(channel_arn, params::Dict{String,<:Any})

The details of the time when a user last read messages in a channel. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

Arguments

  • channel_arn: The ARN of the channel.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "x-amz-chime-bearer": The AppInstanceUserArn of the user that makes the API call.
Main.Chime.update_global_settingsMethod
update_global_settings()
update_global_settings(params::Dict{String,<:Any})

Updates global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "BusinessCalling": The Amazon Chime Business Calling settings.
  • "VoiceConnector": The Amazon Chime Voice Connector settings.
Main.Chime.update_phone_numberMethod
update_phone_number(phone_number_id)
update_phone_number(phone_number_id, params::Dict{String,<:Any})

Updates phone number details, such as product type or calling name, for the specified phone number ID. You can update one phone number detail at a time. For example, you can update either the product type or the calling name in one action. For toll-free numbers, you cannot use the Amazon Chime Business Calling product type. For numbers outside the U.S., you must use the Amazon Chime SIP Media Application Dial-In product type. Updates to outbound calling names can take 72 hours to complete. Pending updates to outbound calling names must be complete before you can request another update.

Arguments

  • phone_number_id: The phone number ID.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "CallingName": The outbound calling name associated with the phone number.
  • "ProductType": The product type.
Main.Chime.update_phone_number_settingsMethod
update_phone_number_settings(calling_name)
update_phone_number_settings(calling_name, params::Dict{String,<:Any})

Updates the phone number settings for the administrator's AWS account, such as the default outbound calling name. You can update the default outbound calling name once every seven days. Outbound calling names can take up to 72 hours to update.

Arguments

  • calling_name: The default outbound calling name for the account.
Main.Chime.update_proxy_sessionMethod
update_proxy_session(capabilities, proxy_session_id, voice_connector_id)
update_proxy_session(capabilities, proxy_session_id, voice_connector_id, params::Dict{String,<:Any})

Updates the specified proxy session details, such as voice or SMS capabilities.

Arguments

  • capabilities: The proxy session capabilities.
  • proxy_session_id: The proxy session ID.
  • voice_connector_id: The Amazon Chime voice connector ID.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ExpiryMinutes": The number of minutes allowed for the proxy session.
Main.Chime.update_roomMethod
update_room(account_id, room_id)
update_room(account_id, room_id, params::Dict{String,<:Any})

Updates room details, such as the room name, for a room in an Amazon Chime Enterprise account.

Arguments

  • account_id: The Amazon Chime account ID.
  • room_id: The room ID.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Name": The room name.
Main.Chime.update_room_membershipMethod
update_room_membership(account_id, member_id, room_id)
update_room_membership(account_id, member_id, room_id, params::Dict{String,<:Any})

Updates room membership details, such as the member role, for a room in an Amazon Chime Enterprise account. The member role designates whether the member is a chat room administrator or a general chat room member. The member role can be updated only for user IDs.

Arguments

  • account_id: The Amazon Chime account ID.
  • member_id: The member ID.
  • room_id: The room ID.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Role": The role of the member.
Main.Chime.update_sip_media_applicationMethod
update_sip_media_application(sip_media_application_id)
update_sip_media_application(sip_media_application_id, params::Dict{String,<:Any})

Updates the details of the specified SIP media application.

Arguments

  • sip_media_application_id: The SIP media application ID.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Endpoints": The new set of endpoints for the specified SIP media application.
  • "Name": The new name for the specified SIP media application.
Main.Chime.update_sip_media_application_callMethod
update_sip_media_application_call(arguments, sip_media_application_id, transaction_id)
update_sip_media_application_call(arguments, sip_media_application_id, transaction_id, params::Dict{String,<:Any})

Invokes the AWS Lambda function associated with the SIP media application and transaction ID in an update request. The Lambda function can then return a new set of actions.

Arguments

  • arguments: Arguments made available to the Lambda function as part of the CALLUPDATEREQUESTED event. Can contain 0-20 key-value pairs.
  • sip_media_application_id: The ID of the SIP media application handling the call.
  • transaction_id: The ID of the call transaction.
Main.Chime.update_sip_ruleMethod
update_sip_rule(name, sip_rule_id)
update_sip_rule(name, sip_rule_id, params::Dict{String,<:Any})

Updates the details of the specified SIP rule.

Arguments

  • name: The new name for the specified SIP rule.
  • sip_rule_id: The SIP rule ID.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Disabled": The new value specified to indicate whether the rule is disabled.
  • "TargetApplications": The new value of the list of target applications.
Main.Chime.update_userMethod
update_user(account_id, user_id)
update_user(account_id, user_id, params::Dict{String,<:Any})

Updates user details for a specified user ID. Currently, only LicenseType updates are supported for this action.

Arguments

  • account_id: The Amazon Chime account ID.
  • user_id: The user ID.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "AlexaForBusinessMetadata": The Alexa for Business metadata.
  • "LicenseType": The user license type to update. This must be a supported license type for the Amazon Chime account that the user belongs to.
  • "UserType": The user type.
Main.Chime.update_user_settingsMethod
update_user_settings(user_settings, account_id, user_id)
update_user_settings(user_settings, account_id, user_id, params::Dict{String,<:Any})

Updates the settings for the specified user, such as phone number settings.

Arguments

  • user_settings: The user settings to update.
  • account_id: The Amazon Chime account ID.
  • user_id: The user ID.
Main.Chime.update_voice_connectorMethod
update_voice_connector(name, require_encryption, voice_connector_id)
update_voice_connector(name, require_encryption, voice_connector_id, params::Dict{String,<:Any})

Updates details for the specified Amazon Chime Voice Connector.

Arguments

  • name: The name of the Amazon Chime Voice Connector.
  • require_encryption: When enabled, requires encryption for the Amazon Chime Voice Connector.
  • voice_connector_id: The Amazon Chime Voice Connector ID.
Main.Chime.update_voice_connector_groupMethod
update_voice_connector_group(name, voice_connector_items, voice_connector_group_id)
update_voice_connector_group(name, voice_connector_items, voice_connector_group_id, params::Dict{String,<:Any})

Updates details of the specified Amazon Chime Voice Connector group, such as the name and Amazon Chime Voice Connector priority ranking.

Arguments

  • name: The name of the Amazon Chime Voice Connector group.
  • voice_connector_items: The VoiceConnectorItems to associate with the group.
  • voice_connector_group_id: The Amazon Chime Voice Connector group ID.
Main.Chime.validate_e911_addressMethod
validate_e911_address(aws_account_id, city, country, postal_code, state, street_info, street_number)
validate_e911_address(aws_account_id, city, country, postal_code, state, street_info, street_number, params::Dict{String,<:Any})

Validates an address to be used for 911 calls made with Amazon Chime Voice Connectors. You can use validated addresses in a Presence Information Data Format Location Object file that you include in SIP requests. That helps ensure that addresses are routed to the appropriate Public Safety Answering Point.

Arguments

  • aws_account_id: The AWS account ID.
  • city: The address city, such as Portland.
  • country: The address country, such as US.
  • postal_code: The address postal code, such as 04352.
  • state: The address state, such as ME.
  • street_info: The address street information, such as 8th Avenue.
  • street_number: The address street number, such as 200 or 2121.