NAME
Paws::Chime - Perl Interface to AWS Amazon Chime
SYNOPSIS
use Paws;
my $obj = Paws->service('Chime');
my $res = $obj->Method(
Arg1 => $val1,
Arg2 => [ 'V1', 'V2' ],
# if Arg3 is an object, the HashRef will be used as arguments to the constructor
# of the arguments type
Arg3 => { Att1 => 'Val1' },
# if Arg4 is an array of objects, the HashRefs will be passed as arguments to
# the constructor of the arguments type
Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ],
);DESCRIPTION
The Amazon Chime API (application programming interface) is designed for developers to perform key tasks, such as creating and managing Amazon Chime accounts, users, and Voice Connectors. This guide provides detailed information about the Amazon Chime API, including operations, types, inputs and outputs, and error codes. It also includes some server-side API actions to use with the Amazon Chime SDK. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) in the Amazon Chime Developer Guide.
You can use an AWS SDK, the AWS Command Line Interface (AWS CLI), or the REST API to make API calls. We recommend using an AWS SDK or the AWS CLI. Each API operation includes links to information about using it with a language-specific AWS SDK or the AWS CLI.
- Using an AWS SDK
-
You don't need to write code to calculate a signature for request authentication. The SDK clients authenticate your requests by using access keys that you provide. For more information about AWS SDKs, see the AWS Developer Center (http://aws.amazon.com/developer/).
- Using the AWS CLI
-
Use your access keys with the AWS CLI to make API calls. For information about setting up the AWS CLI, see Installing the AWS Command Line Interface (https://docs.aws.amazon.com/cli/latest/userguide/installing.html) in the AWS Command Line Interface User Guide. For a list of available Amazon Chime commands, see the Amazon Chime commands (https://docs.aws.amazon.com/cli/latest/reference/chime/index.html) in the AWS CLI Command Reference.
- Using REST APIs
-
If you use REST to make API calls, you must authenticate your request by providing a signature. Amazon Chime supports signature version 4. For more information, see Signature Version 4 Signing Process (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) in the Amazon Web Services General Reference.
When making REST API calls, use the service name
chimeand REST endpointhttps://service.chime.aws.amazon.com.
Administrative permissions are controlled using AWS Identity and Access Management (IAM). For more information, see Identity and Access Management for Amazon Chime (https://docs.aws.amazon.com/chime/latest/ag/security-iam.html) in the Amazon Chime Administration Guide.
For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01
METHODS
AssociatePhoneNumbersWithVoiceConnector
Each argument is described in detail in: Paws::Chime::AssociatePhoneNumbersWithVoiceConnector
Returns: a Paws::Chime::AssociatePhoneNumbersWithVoiceConnectorResponse instance
Associates phone numbers with the specified Amazon Chime Voice Connector.
AssociatePhoneNumbersWithVoiceConnectorGroup
Each argument is described in detail in: Paws::Chime::AssociatePhoneNumbersWithVoiceConnectorGroup
Returns: a Paws::Chime::AssociatePhoneNumbersWithVoiceConnectorGroupResponse instance
Associates phone numbers with the specified Amazon Chime Voice Connector group.
AssociatePhoneNumberWithUser
Each argument is described in detail in: Paws::Chime::AssociatePhoneNumberWithUser
Returns: a Paws::Chime::AssociatePhoneNumberWithUserResponse instance
Associates a phone number with the specified Amazon Chime user.
AssociateSigninDelegateGroupsWithAccount
- AccountId => Str
- SigninDelegateGroups => ArrayRef[Paws::Chime::SigninDelegateGroup]
Each argument is described in detail in: Paws::Chime::AssociateSigninDelegateGroupsWithAccount
Returns: a Paws::Chime::AssociateSigninDelegateGroupsWithAccountResponse instance
Associates the specified sign-in delegate groups with the specified Amazon Chime account.
BatchCreateAttendee
- Attendees => ArrayRef[Paws::Chime::CreateAttendeeRequestItem]
- MeetingId => Str
Each argument is described in detail in: Paws::Chime::BatchCreateAttendee
Returns: a Paws::Chime::BatchCreateAttendeeResponse instance
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 (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) in the Amazon Chime Developer Guide.
BatchCreateChannelMembership
Each argument is described in detail in: Paws::Chime::BatchCreateChannelMembership
Returns: a Paws::Chime::BatchCreateChannelMembershipResponse instance
Adds a specified number of users to a channel.
BatchCreateRoomMembership
- AccountId => Str
- MembershipItemList => ArrayRef[Paws::Chime::MembershipItem]
- RoomId => Str
Each argument is described in detail in: Paws::Chime::BatchCreateRoomMembership
Returns: a Paws::Chime::BatchCreateRoomMembershipResponse instance
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.
BatchDeletePhoneNumber
Each argument is described in detail in: Paws::Chime::BatchDeletePhoneNumber
Returns: a Paws::Chime::BatchDeletePhoneNumberResponse instance
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.
BatchSuspendUser
Each argument is described in detail in: Paws::Chime::BatchSuspendUser
Returns: a Paws::Chime::BatchSuspendUserResponse instance
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 (https://docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html) 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.
BatchUnsuspendUser
Each argument is described in detail in: Paws::Chime::BatchUnsuspendUser
Returns: a Paws::Chime::BatchUnsuspendUserResponse instance
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 (https://docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html) 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.
BatchUpdatePhoneNumber
- UpdatePhoneNumberRequestItems => ArrayRef[Paws::Chime::UpdatePhoneNumberRequestItem]
Each argument is described in detail in: Paws::Chime::BatchUpdatePhoneNumber
Returns: a Paws::Chime::BatchUpdatePhoneNumberResponse instance
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.
BatchUpdateUser
- AccountId => Str
- UpdateUserRequestItems => ArrayRef[Paws::Chime::UpdateUserRequestItem]
Each argument is described in detail in: Paws::Chime::BatchUpdateUser
Returns: a Paws::Chime::BatchUpdateUserResponse instance
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.
CreateAccount
Each argument is described in detail in: Paws::Chime::CreateAccount
Returns: a Paws::Chime::CreateAccountResponse instance
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 (https://docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html) in the Amazon Chime Administration Guide.
CreateAppInstance
- ClientRequestToken => Str
- Name => Str
- [Metadata => Str]
- [Tags => ArrayRef[Paws::Chime::Tag]]
Each argument is described in detail in: Paws::Chime::CreateAppInstance
Returns: a Paws::Chime::CreateAppInstanceResponse instance
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.
CreateAppInstanceAdmin
Each argument is described in detail in: Paws::Chime::CreateAppInstanceAdmin
Returns: a Paws::Chime::CreateAppInstanceAdminResponse instance
Promotes an AppInstanceUser to an AppInstanceAdmin. The promoted user can perform the following actions.
ChannelModeratoractions across all channels in theAppInstance.DeleteChannelMessageactions.
Only an AppInstanceUser can be promoted to an AppInstanceAdmin role.
CreateAppInstanceUser
- AppInstanceArn => Str
- AppInstanceUserId => Str
- ClientRequestToken => Str
- Name => Str
- [Metadata => Str]
- [Tags => ArrayRef[Paws::Chime::Tag]]
Each argument is described in detail in: Paws::Chime::CreateAppInstanceUser
Returns: a Paws::Chime::CreateAppInstanceUserResponse instance
Creates a user under an Amazon Chime AppInstance. The request consists of a unique appInstanceUserId and Name for that user.
CreateAttendee
- ExternalUserId => Str
- MeetingId => Str
- [Tags => ArrayRef[Paws::Chime::Tag]]
Each argument is described in detail in: Paws::Chime::CreateAttendee
Returns: a Paws::Chime::CreateAttendeeResponse instance
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 (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) in the Amazon Chime Developer Guide.
CreateBot
Each argument is described in detail in: Paws::Chime::CreateBot
Returns: a Paws::Chime::CreateBotResponse instance
Creates a bot for an Amazon Chime Enterprise account.
CreateChannel
- AppInstanceArn => Str
- ClientRequestToken => Str
- Name => Str
- [ChimeBearer => Str]
- [Metadata => Str]
- [Mode => Str]
- [Privacy => Str]
- [Tags => ArrayRef[Paws::Chime::Tag]]
Each argument is described in detail in: Paws::Chime::CreateChannel
Returns: a Paws::Chime::CreateChannelResponse instance
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.
CreateChannelBan
Each argument is described in detail in: Paws::Chime::CreateChannelBan
Returns: a Paws::Chime::CreateChannelBanResponse instance
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.
CreateChannelMembership
Each argument is described in detail in: Paws::Chime::CreateChannelMembership
Returns: a Paws::Chime::CreateChannelMembershipResponse instance
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.
CreateChannelModerator
Each argument is described in detail in: Paws::Chime::CreateChannelModerator
Returns: a Paws::Chime::CreateChannelModeratorResponse instance
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.
CreateMeeting
- ClientRequestToken => Str
- [ExternalMeetingId => Str]
- [MediaRegion => Str]
- [MeetingHostId => Str]
- [NotificationsConfiguration => Paws::Chime::MeetingNotificationConfiguration]
- [Tags => ArrayRef[Paws::Chime::Tag]]
Each argument is described in detail in: Paws::Chime::CreateMeeting
Returns: a Paws::Chime::CreateMeetingResponse instance
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 (https://docs.aws.amazon.com/chime/latest/dg/chime-sdk-meetings-regions.html) in the Amazon Chime Developer Guide . For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) in the Amazon Chime Developer Guide .
CreateMeetingDialOut
Each argument is described in detail in: Paws::Chime::CreateMeetingDialOut
Returns: a Paws::Chime::CreateMeetingDialOutResponse instance
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.
CreateMeetingWithAttendees
- ClientRequestToken => Str
- [Attendees => ArrayRef[Paws::Chime::CreateAttendeeRequestItem]]
- [ExternalMeetingId => Str]
- [MediaRegion => Str]
- [MeetingHostId => Str]
- [NotificationsConfiguration => Paws::Chime::MeetingNotificationConfiguration]
- [Tags => ArrayRef[Paws::Chime::Tag]]
Each argument is described in detail in: Paws::Chime::CreateMeetingWithAttendees
Returns: a Paws::Chime::CreateMeetingWithAttendeesResponse instance
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 (https://docs.aws.amazon.com/chime/latest/dg/chime-sdk-meetings-regions.html) in the Amazon Chime Developer Guide . For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) in the Amazon Chime Developer Guide .
CreatePhoneNumberOrder
Each argument is described in detail in: Paws::Chime::CreatePhoneNumberOrder
Returns: a Paws::Chime::CreatePhoneNumberOrderResponse instance
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.
CreateProxySession
- Capabilities => ArrayRef[Str|Undef]
- ParticipantPhoneNumbers => ArrayRef[Str|Undef]
- VoiceConnectorId => Str
- [ExpiryMinutes => Int]
- [GeoMatchLevel => Str]
- [GeoMatchParams => Paws::Chime::GeoMatchParams]
- [Name => Str]
- [NumberSelectionBehavior => Str]
Each argument is described in detail in: Paws::Chime::CreateProxySession
Returns: a Paws::Chime::CreateProxySessionResponse instance
Creates a proxy session on the specified Amazon Chime Voice Connector for the specified participant phone numbers.
CreateRoom
Each argument is described in detail in: Paws::Chime::CreateRoom
Returns: a Paws::Chime::CreateRoomResponse instance
Creates a chat room for the specified Amazon Chime Enterprise account.
CreateRoomMembership
Each argument is described in detail in: Paws::Chime::CreateRoomMembership
Returns: a Paws::Chime::CreateRoomMembershipResponse instance
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.
CreateSipMediaApplication
- AwsRegion => Str
- Endpoints => ArrayRef[Paws::Chime::SipMediaApplicationEndpoint]
- Name => Str
Each argument is described in detail in: Paws::Chime::CreateSipMediaApplication
Returns: a Paws::Chime::CreateSipMediaApplicationResponse instance
Creates a SIP media application.
CreateSipMediaApplicationCall
Each argument is described in detail in: Paws::Chime::CreateSipMediaApplicationCall
Returns: a Paws::Chime::CreateSipMediaApplicationCallResponse instance
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.
CreateSipRule
- Name => Str
- TargetApplications => ArrayRef[Paws::Chime::SipRuleTargetApplication]
- TriggerType => Str
- TriggerValue => Str
- [Disabled => Bool]
Each argument is described in detail in: Paws::Chime::CreateSipRule
Returns: a Paws::Chime::CreateSipRuleResponse instance
Creates a SIP rule which can be used to run a SIP media application as a target for a specific trigger type.
CreateUser
Each argument is described in detail in: Paws::Chime::CreateUser
Returns: a Paws::Chime::CreateUserResponse instance
Creates a user under the specified Amazon Chime account.
CreateVoiceConnector
Each argument is described in detail in: Paws::Chime::CreateVoiceConnector
Returns: a Paws::Chime::CreateVoiceConnectorResponse instance
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 CreateVoiceConnectorRequest$RequireEncryption 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.
CreateVoiceConnectorGroup
- Name => Str
- [VoiceConnectorItems => ArrayRef[Paws::Chime::VoiceConnectorItem]]
Each argument is described in detail in: Paws::Chime::CreateVoiceConnectorGroup
Returns: a Paws::Chime::CreateVoiceConnectorGroupResponse instance
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.
DeleteAccount
Each argument is described in detail in: Paws::Chime::DeleteAccount
Returns: a Paws::Chime::DeleteAccountResponse instance
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.
DeleteAppInstance
Each argument is described in detail in: Paws::Chime::DeleteAppInstance
Returns: nothing
Deletes an AppInstance and all associated data asynchronously.
DeleteAppInstanceAdmin
Each argument is described in detail in: Paws::Chime::DeleteAppInstanceAdmin
Returns: nothing
Demotes an AppInstanceAdmin to an AppInstanceUser. This action does not delete the user.
DeleteAppInstanceStreamingConfigurations
Each argument is described in detail in: Paws::Chime::DeleteAppInstanceStreamingConfigurations
Returns: nothing
Deletes the streaming configurations of an AppInstance.
DeleteAppInstanceUser
Each argument is described in detail in: Paws::Chime::DeleteAppInstanceUser
Returns: nothing
Deletes an AppInstanceUser.
DeleteAttendee
Each argument is described in detail in: Paws::Chime::DeleteAttendee
Returns: nothing
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 (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) in the Amazon Chime Developer Guide.
DeleteChannel
Each argument is described in detail in: Paws::Chime::DeleteChannel
Returns: nothing
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.
DeleteChannelBan
Each argument is described in detail in: Paws::Chime::DeleteChannelBan
Returns: nothing
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.
DeleteChannelMembership
Each argument is described in detail in: Paws::Chime::DeleteChannelMembership
Returns: nothing
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.
DeleteChannelMessage
Each argument is described in detail in: Paws::Chime::DeleteChannelMessage
Returns: nothing
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.
DeleteChannelModerator
Each argument is described in detail in: Paws::Chime::DeleteChannelModerator
Returns: nothing
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.
DeleteEventsConfiguration
Each argument is described in detail in: Paws::Chime::DeleteEventsConfiguration
Returns: nothing
Deletes the events configuration that allows a bot to receive outgoing events.
DeleteMeeting
Each argument is described in detail in: Paws::Chime::DeleteMeeting
Returns: nothing
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 (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) in the Amazon Chime Developer Guide.
DeletePhoneNumber
Each argument is described in detail in: Paws::Chime::DeletePhoneNumber
Returns: nothing
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.
DeleteProxySession
Each argument is described in detail in: Paws::Chime::DeleteProxySession
Returns: nothing
Deletes the specified proxy session from the specified Amazon Chime Voice Connector.
DeleteRoom
Each argument is described in detail in: Paws::Chime::DeleteRoom
Returns: nothing
Deletes a chat room in an Amazon Chime Enterprise account.
DeleteRoomMembership
Each argument is described in detail in: Paws::Chime::DeleteRoomMembership
Returns: nothing
Removes a member from a chat room in an Amazon Chime Enterprise account.
DeleteSipMediaApplication
Each argument is described in detail in: Paws::Chime::DeleteSipMediaApplication
Returns: nothing
Deletes a SIP media application.
DeleteSipRule
Each argument is described in detail in: Paws::Chime::DeleteSipRule
Returns: nothing
Deletes a SIP rule. You must disable a SIP rule before you can delete it.
DeleteVoiceConnector
Each argument is described in detail in: Paws::Chime::DeleteVoiceConnector
Returns: nothing
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.
DeleteVoiceConnectorEmergencyCallingConfiguration
Each argument is described in detail in: Paws::Chime::DeleteVoiceConnectorEmergencyCallingConfiguration
Returns: nothing
Deletes the emergency calling configuration details from the specified Amazon Chime Voice Connector.
DeleteVoiceConnectorGroup
Each argument is described in detail in: Paws::Chime::DeleteVoiceConnectorGroup
Returns: nothing
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.
DeleteVoiceConnectorOrigination
Each argument is described in detail in: Paws::Chime::DeleteVoiceConnectorOrigination
Returns: nothing
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.
DeleteVoiceConnectorProxy
Each argument is described in detail in: Paws::Chime::DeleteVoiceConnectorProxy
Returns: nothing
Deletes the proxy configuration from the specified Amazon Chime Voice Connector.
DeleteVoiceConnectorStreamingConfiguration
Each argument is described in detail in: Paws::Chime::DeleteVoiceConnectorStreamingConfiguration
Returns: nothing
Deletes the streaming configuration for the specified Amazon Chime Voice Connector.
DeleteVoiceConnectorTermination
Each argument is described in detail in: Paws::Chime::DeleteVoiceConnectorTermination
Returns: nothing
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.
DeleteVoiceConnectorTerminationCredentials
Each argument is described in detail in: Paws::Chime::DeleteVoiceConnectorTerminationCredentials
Returns: nothing
Deletes the specified SIP credentials used by your equipment to authenticate during call termination.
DescribeAppInstance
Each argument is described in detail in: Paws::Chime::DescribeAppInstance
Returns: a Paws::Chime::DescribeAppInstanceResponse instance
Returns the full details of an AppInstance.
DescribeAppInstanceAdmin
Each argument is described in detail in: Paws::Chime::DescribeAppInstanceAdmin
Returns: a Paws::Chime::DescribeAppInstanceAdminResponse instance
Returns the full details of an AppInstanceAdmin.
DescribeAppInstanceUser
Each argument is described in detail in: Paws::Chime::DescribeAppInstanceUser
Returns: a Paws::Chime::DescribeAppInstanceUserResponse instance
Returns the full details of an AppInstanceUser .
DescribeChannel
Each argument is described in detail in: Paws::Chime::DescribeChannel
Returns: a Paws::Chime::DescribeChannelResponse instance
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.
DescribeChannelBan
Each argument is described in detail in: Paws::Chime::DescribeChannelBan
Returns: a Paws::Chime::DescribeChannelBanResponse instance
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.
DescribeChannelMembership
Each argument is described in detail in: Paws::Chime::DescribeChannelMembership
Returns: a Paws::Chime::DescribeChannelMembershipResponse instance
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.
DescribeChannelMembershipForAppInstanceUser
Each argument is described in detail in: Paws::Chime::DescribeChannelMembershipForAppInstanceUser
Returns: a Paws::Chime::DescribeChannelMembershipForAppInstanceUserResponse instance
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.
DescribeChannelModeratedByAppInstanceUser
Each argument is described in detail in: Paws::Chime::DescribeChannelModeratedByAppInstanceUser
Returns: a Paws::Chime::DescribeChannelModeratedByAppInstanceUserResponse instance
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.
DescribeChannelModerator
Each argument is described in detail in: Paws::Chime::DescribeChannelModerator
Returns: a Paws::Chime::DescribeChannelModeratorResponse instance
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.
DisassociatePhoneNumberFromUser
Each argument is described in detail in: Paws::Chime::DisassociatePhoneNumberFromUser
Returns: a Paws::Chime::DisassociatePhoneNumberFromUserResponse instance
Disassociates the primary provisioned phone number from the specified Amazon Chime user.
DisassociatePhoneNumbersFromVoiceConnector
Each argument is described in detail in: Paws::Chime::DisassociatePhoneNumbersFromVoiceConnector
Returns: a Paws::Chime::DisassociatePhoneNumbersFromVoiceConnectorResponse instance
Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector.
DisassociatePhoneNumbersFromVoiceConnectorGroup
Each argument is described in detail in: Paws::Chime::DisassociatePhoneNumbersFromVoiceConnectorGroup
Returns: a Paws::Chime::DisassociatePhoneNumbersFromVoiceConnectorGroupResponse instance
Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector group.
DisassociateSigninDelegateGroupsFromAccount
Each argument is described in detail in: Paws::Chime::DisassociateSigninDelegateGroupsFromAccount
Returns: a Paws::Chime::DisassociateSigninDelegateGroupsFromAccountResponse instance
Disassociates the specified sign-in delegate groups from the specified Amazon Chime account.
GetAccount
Each argument is described in detail in: Paws::Chime::GetAccount
Returns: a Paws::Chime::GetAccountResponse instance
Retrieves details for the specified Amazon Chime account, such as account type and supported licenses.
GetAccountSettings
Each argument is described in detail in: Paws::Chime::GetAccountSettings
Returns: a Paws::Chime::GetAccountSettingsResponse instance
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 (https://docs.aws.amazon.com/chime/latest/ag/policies.html) in the Amazon Chime Administration Guide.
GetAppInstanceRetentionSettings
Each argument is described in detail in: Paws::Chime::GetAppInstanceRetentionSettings
Returns: a Paws::Chime::GetAppInstanceRetentionSettingsResponse instance
Gets the retention settings for an AppInstance.
GetAppInstanceStreamingConfigurations
Each argument is described in detail in: Paws::Chime::GetAppInstanceStreamingConfigurations
Returns: a Paws::Chime::GetAppInstanceStreamingConfigurationsResponse instance
Gets the streaming settings for an AppInstance.
GetAttendee
Each argument is described in detail in: Paws::Chime::GetAttendee
Returns: a Paws::Chime::GetAttendeeResponse instance
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 (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) in the Amazon Chime Developer Guide .
GetBot
Each argument is described in detail in: Paws::Chime::GetBot
Returns: a Paws::Chime::GetBotResponse instance
Retrieves details for the specified bot, such as bot email address, bot type, status, and display name.
GetChannelMessage
Each argument is described in detail in: Paws::Chime::GetChannelMessage
Returns: a Paws::Chime::GetChannelMessageResponse instance
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.
GetEventsConfiguration
Each argument is described in detail in: Paws::Chime::GetEventsConfiguration
Returns: a Paws::Chime::GetEventsConfigurationResponse instance
Gets details for an events configuration that allows a bot to receive outgoing events, such as an HTTPS endpoint or Lambda function ARN.
GetGlobalSettings
Each argument is described in detail in: Paws::Chime::GetGlobalSettings
Returns: a Paws::Chime::GetGlobalSettingsResponse instance
Retrieves global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.
GetMeeting
Each argument is described in detail in: Paws::Chime::GetMeeting
Returns: a Paws::Chime::GetMeetingResponse instance
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 (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) in the Amazon Chime Developer Guide .
GetMessagingSessionEndpoint
Each argument is described in detail in: Paws::Chime::GetMessagingSessionEndpoint
Returns: a Paws::Chime::GetMessagingSessionEndpointResponse instance
The details of the endpoint for the messaging session.
GetPhoneNumber
Each argument is described in detail in: Paws::Chime::GetPhoneNumber
Returns: a Paws::Chime::GetPhoneNumberResponse instance
Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.
GetPhoneNumberOrder
Each argument is described in detail in: Paws::Chime::GetPhoneNumberOrder
Returns: a Paws::Chime::GetPhoneNumberOrderResponse instance
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.
GetPhoneNumberSettings
Each argument is described in detail in: Paws::Chime::GetPhoneNumberSettings
Returns: a Paws::Chime::GetPhoneNumberSettingsResponse instance
Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name.
GetProxySession
Each argument is described in detail in: Paws::Chime::GetProxySession
Returns: a Paws::Chime::GetProxySessionResponse instance
Gets the specified proxy session details for the specified Amazon Chime Voice Connector.
GetRetentionSettings
Each argument is described in detail in: Paws::Chime::GetRetentionSettings
Returns: a Paws::Chime::GetRetentionSettingsResponse instance
Gets the retention settings for the specified Amazon Chime Enterprise account. For more information about retention settings, see Managing Chat Retention Policies (https://docs.aws.amazon.com/chime/latest/ag/chat-retention.html) in the Amazon Chime Administration Guide.
GetRoom
Each argument is described in detail in: Paws::Chime::GetRoom
Returns: a Paws::Chime::GetRoomResponse instance
Retrieves room details, such as the room name, for a room in an Amazon Chime Enterprise account.
GetSipMediaApplication
Each argument is described in detail in: Paws::Chime::GetSipMediaApplication
Returns: a Paws::Chime::GetSipMediaApplicationResponse instance
Retrieves the information for a SIP media application, including name, AWS Region, and endpoints.
GetSipMediaApplicationLoggingConfiguration
Each argument is described in detail in: Paws::Chime::GetSipMediaApplicationLoggingConfiguration
Returns: a Paws::Chime::GetSipMediaApplicationLoggingConfigurationResponse instance
Returns the logging configuration for the specified SIP media application.
GetSipRule
Each argument is described in detail in: Paws::Chime::GetSipRule
Returns: a Paws::Chime::GetSipRuleResponse instance
Retrieves the details of a SIP rule, such as the rule ID, name, triggers, and target endpoints.
GetUser
Each argument is described in detail in: Paws::Chime::GetUser
Returns: a Paws::Chime::GetUserResponse instance
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.
GetUserSettings
Each argument is described in detail in: Paws::Chime::GetUserSettings
Returns: a Paws::Chime::GetUserSettingsResponse instance
Retrieves settings for the specified user ID, such as any associated phone number settings.
GetVoiceConnector
Each argument is described in detail in: Paws::Chime::GetVoiceConnector
Returns: a Paws::Chime::GetVoiceConnectorResponse instance
Retrieves details for the specified Amazon Chime Voice Connector, such as timestamps,name, outbound host, and encryption requirements.
GetVoiceConnectorEmergencyCallingConfiguration
Each argument is described in detail in: Paws::Chime::GetVoiceConnectorEmergencyCallingConfiguration
Returns: a Paws::Chime::GetVoiceConnectorEmergencyCallingConfigurationResponse instance
Gets the emergency calling configuration details for the specified Amazon Chime Voice Connector.
GetVoiceConnectorGroup
Each argument is described in detail in: Paws::Chime::GetVoiceConnectorGroup
Returns: a Paws::Chime::GetVoiceConnectorGroupResponse instance
Retrieves details for the specified Amazon Chime Voice Connector group, such as timestamps,name, and associated VoiceConnectorItems.
GetVoiceConnectorLoggingConfiguration
Each argument is described in detail in: Paws::Chime::GetVoiceConnectorLoggingConfiguration
Returns: a Paws::Chime::GetVoiceConnectorLoggingConfigurationResponse instance
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.
GetVoiceConnectorOrigination
Each argument is described in detail in: Paws::Chime::GetVoiceConnectorOrigination
Returns: a Paws::Chime::GetVoiceConnectorOriginationResponse instance
Retrieves origination setting details for the specified Amazon Chime Voice Connector.
GetVoiceConnectorProxy
Each argument is described in detail in: Paws::Chime::GetVoiceConnectorProxy
Returns: a Paws::Chime::GetVoiceConnectorProxyResponse instance
Gets the proxy configuration details for the specified Amazon Chime Voice Connector.
GetVoiceConnectorStreamingConfiguration
Each argument is described in detail in: Paws::Chime::GetVoiceConnectorStreamingConfiguration
Returns: a Paws::Chime::GetVoiceConnectorStreamingConfigurationResponse instance
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.
GetVoiceConnectorTermination
Each argument is described in detail in: Paws::Chime::GetVoiceConnectorTermination
Returns: a Paws::Chime::GetVoiceConnectorTerminationResponse instance
Retrieves termination setting details for the specified Amazon Chime Voice Connector.
GetVoiceConnectorTerminationHealth
Each argument is described in detail in: Paws::Chime::GetVoiceConnectorTerminationHealth
Returns: a Paws::Chime::GetVoiceConnectorTerminationHealthResponse instance
Retrieves information about the last time a SIP OPTIONS ping was received from your SIP infrastructure for the specified Amazon Chime Voice Connector.
InviteUsers
Each argument is described in detail in: Paws::Chime::InviteUsers
Returns: a Paws::Chime::InviteUsersResponse instance
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.
ListAccounts
Each argument is described in detail in: Paws::Chime::ListAccounts
Returns: a Paws::Chime::ListAccountsResponse instance
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.
ListAppInstanceAdmins
Each argument is described in detail in: Paws::Chime::ListAppInstanceAdmins
Returns: a Paws::Chime::ListAppInstanceAdminsResponse instance
Returns a list of the administrators in the AppInstance.
ListAppInstances
Each argument is described in detail in: Paws::Chime::ListAppInstances
Returns: a Paws::Chime::ListAppInstancesResponse instance
Lists all Amazon Chime AppInstances created under a single AWS account.
ListAppInstanceUsers
Each argument is described in detail in: Paws::Chime::ListAppInstanceUsers
Returns: a Paws::Chime::ListAppInstanceUsersResponse instance
List all AppInstanceUsers created under a single AppInstance.
ListAttendees
Each argument is described in detail in: Paws::Chime::ListAttendees
Returns: a Paws::Chime::ListAttendeesResponse instance
Lists the attendees for the specified Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) in the Amazon Chime Developer Guide.
ListAttendeeTags
Each argument is described in detail in: Paws::Chime::ListAttendeeTags
Returns: a Paws::Chime::ListAttendeeTagsResponse instance
Lists the tags applied to an Amazon Chime SDK attendee resource.
ListBots
Each argument is described in detail in: Paws::Chime::ListBots
Returns: a Paws::Chime::ListBotsResponse instance
Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.
ListChannelBans
Each argument is described in detail in: Paws::Chime::ListChannelBans
Returns: a Paws::Chime::ListChannelBansResponse instance
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.
ListChannelMemberships
Each argument is described in detail in: Paws::Chime::ListChannelMemberships
Returns: a Paws::Chime::ListChannelMembershipsResponse instance
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.
ListChannelMembershipsForAppInstanceUser
Each argument is described in detail in: Paws::Chime::ListChannelMembershipsForAppInstanceUser
Returns: a Paws::Chime::ListChannelMembershipsForAppInstanceUserResponse instance
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.
ListChannelMessages
- ChannelArn => Str
- [ChimeBearer => Str]
- [MaxResults => Int]
- [NextToken => Str]
- [NotAfter => Str]
- [NotBefore => Str]
- [SortOrder => Str]
Each argument is described in detail in: Paws::Chime::ListChannelMessages
Returns: a Paws::Chime::ListChannelMessagesResponse instance
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.
ListChannelModerators
Each argument is described in detail in: Paws::Chime::ListChannelModerators
Returns: a Paws::Chime::ListChannelModeratorsResponse instance
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.
ListChannels
Each argument is described in detail in: Paws::Chime::ListChannels
Returns: a Paws::Chime::ListChannelsResponse instance
Lists all Channels created under a single Chime App as a paginated list. You can specify filters to narrow results.
Functionality & restrictions
Use privacy =
PUBLICto retrieve all public channels in the account.Only an
AppInstanceAdmincan set privacy =PRIVATEto 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.
ListChannelsModeratedByAppInstanceUser
Each argument is described in detail in: Paws::Chime::ListChannelsModeratedByAppInstanceUser
Returns: a Paws::Chime::ListChannelsModeratedByAppInstanceUserResponse instance
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.
ListMeetings
Each argument is described in detail in: Paws::Chime::ListMeetings
Returns: a Paws::Chime::ListMeetingsResponse instance
Lists up to 100 active Amazon Chime SDK meetings. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) in the Amazon Chime Developer Guide.
ListMeetingTags
Each argument is described in detail in: Paws::Chime::ListMeetingTags
Returns: a Paws::Chime::ListMeetingTagsResponse instance
Lists the tags applied to an Amazon Chime SDK meeting resource.
ListPhoneNumberOrders
Each argument is described in detail in: Paws::Chime::ListPhoneNumberOrders
Returns: a Paws::Chime::ListPhoneNumberOrdersResponse instance
Lists the phone number orders for the administrator's Amazon Chime account.
ListPhoneNumbers
- [FilterName => Str]
- [FilterValue => Str]
- [MaxResults => Int]
- [NextToken => Str]
- [ProductType => Str]
- [Status => Str]
Each argument is described in detail in: Paws::Chime::ListPhoneNumbers
Returns: a Paws::Chime::ListPhoneNumbersResponse instance
Lists the phone numbers for the specified Amazon Chime account, Amazon Chime user, Amazon Chime Voice Connector, or Amazon Chime Voice Connector group.
ListProxySessions
Each argument is described in detail in: Paws::Chime::ListProxySessions
Returns: a Paws::Chime::ListProxySessionsResponse instance
Lists the proxy sessions for the specified Amazon Chime Voice Connector.
ListRoomMemberships
Each argument is described in detail in: Paws::Chime::ListRoomMemberships
Returns: a Paws::Chime::ListRoomMembershipsResponse instance
Lists the membership details for the specified room in an Amazon Chime Enterprise account, such as the members' IDs, email addresses, and names.
ListRooms
Each argument is described in detail in: Paws::Chime::ListRooms
Returns: a Paws::Chime::ListRoomsResponse instance
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.
ListSipMediaApplications
Each argument is described in detail in: Paws::Chime::ListSipMediaApplications
Returns: a Paws::Chime::ListSipMediaApplicationsResponse instance
Lists the SIP media applications under the administrator's AWS account.
ListSipRules
Each argument is described in detail in: Paws::Chime::ListSipRules
Returns: a Paws::Chime::ListSipRulesResponse instance
Lists the SIP rules under the administrator's AWS account.
ListSupportedPhoneNumberCountries
Each argument is described in detail in: Paws::Chime::ListSupportedPhoneNumberCountries
Returns: a Paws::Chime::ListSupportedPhoneNumberCountriesResponse instance
Lists supported phone number countries.
ListTagsForResource
Each argument is described in detail in: Paws::Chime::ListTagsForResource
Returns: a Paws::Chime::ListTagsForResourceResponse instance
Lists the tags applied to an Amazon Chime SDK meeting resource.
ListUsers
Each argument is described in detail in: Paws::Chime::ListUsers
Returns: a Paws::Chime::ListUsersResponse instance
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.
ListVoiceConnectorGroups
Each argument is described in detail in: Paws::Chime::ListVoiceConnectorGroups
Returns: a Paws::Chime::ListVoiceConnectorGroupsResponse instance
Lists the Amazon Chime Voice Connector groups for the administrator's AWS account.
ListVoiceConnectors
Each argument is described in detail in: Paws::Chime::ListVoiceConnectors
Returns: a Paws::Chime::ListVoiceConnectorsResponse instance
Lists the Amazon Chime Voice Connectors for the administrator's AWS account.
ListVoiceConnectorTerminationCredentials
Each argument is described in detail in: Paws::Chime::ListVoiceConnectorTerminationCredentials
Returns: a Paws::Chime::ListVoiceConnectorTerminationCredentialsResponse instance
Lists the SIP credentials for the specified Amazon Chime Voice Connector.
LogoutUser
Each argument is described in detail in: Paws::Chime::LogoutUser
Returns: a Paws::Chime::LogoutUserResponse instance
Logs out the specified user from all of the devices they are currently logged into.
PutAppInstanceRetentionSettings
- AppInstanceArn => Str
- AppInstanceRetentionSettings => Paws::Chime::AppInstanceRetentionSettings
Each argument is described in detail in: Paws::Chime::PutAppInstanceRetentionSettings
Returns: a Paws::Chime::PutAppInstanceRetentionSettingsResponse instance
Sets the amount of time in days that a given AppInstance retains data.
PutAppInstanceStreamingConfigurations
- AppInstanceArn => Str
- AppInstanceStreamingConfigurations => ArrayRef[Paws::Chime::AppInstanceStreamingConfiguration]
Each argument is described in detail in: Paws::Chime::PutAppInstanceStreamingConfigurations
Returns: a Paws::Chime::PutAppInstanceStreamingConfigurationsResponse instance
The data streaming configurations of an AppInstance.
PutEventsConfiguration
Each argument is described in detail in: Paws::Chime::PutEventsConfiguration
Returns: a Paws::Chime::PutEventsConfigurationResponse instance
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.
PutRetentionSettings
- AccountId => Str
- RetentionSettings => Paws::Chime::RetentionSettings
Each argument is described in detail in: Paws::Chime::PutRetentionSettings
Returns: a Paws::Chime::PutRetentionSettingsResponse instance
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 (https://docs.aws.amazon.com/chime/latest/ag/cloudtrail.html) 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 (https://docs.aws.amazon.com/chime/latest/ag/chat-retention.html) in the Amazon Chime Administration Guide.
PutSipMediaApplicationLoggingConfiguration
- SipMediaApplicationId => Str
- [SipMediaApplicationLoggingConfiguration => Paws::Chime::SipMediaApplicationLoggingConfiguration]
Each argument is described in detail in: Paws::Chime::PutSipMediaApplicationLoggingConfiguration
Returns: a Paws::Chime::PutSipMediaApplicationLoggingConfigurationResponse instance
Updates the logging configuration for the specified SIP media application.
PutVoiceConnectorEmergencyCallingConfiguration
- EmergencyCallingConfiguration => Paws::Chime::EmergencyCallingConfiguration
- VoiceConnectorId => Str
Each argument is described in detail in: Paws::Chime::PutVoiceConnectorEmergencyCallingConfiguration
Returns: a Paws::Chime::PutVoiceConnectorEmergencyCallingConfigurationResponse instance
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.
PutVoiceConnectorLoggingConfiguration
- LoggingConfiguration => Paws::Chime::LoggingConfiguration
- VoiceConnectorId => Str
Each argument is described in detail in: Paws::Chime::PutVoiceConnectorLoggingConfiguration
Returns: a Paws::Chime::PutVoiceConnectorLoggingConfigurationResponse instance
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.
PutVoiceConnectorOrigination
- Origination => Paws::Chime::Origination
- VoiceConnectorId => Str
Each argument is described in detail in: Paws::Chime::PutVoiceConnectorOrigination
Returns: a Paws::Chime::PutVoiceConnectorOriginationResponse instance
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.
PutVoiceConnectorProxy
- DefaultSessionExpiryMinutes => Int
- PhoneNumberPoolCountries => ArrayRef[Str|Undef]
- VoiceConnectorId => Str
- [Disabled => Bool]
- [FallBackPhoneNumber => Str]
Each argument is described in detail in: Paws::Chime::PutVoiceConnectorProxy
Returns: a Paws::Chime::PutVoiceConnectorProxyResponse instance
Puts the specified proxy configuration to the specified Amazon Chime Voice Connector.
PutVoiceConnectorStreamingConfiguration
- StreamingConfiguration => Paws::Chime::StreamingConfiguration
- VoiceConnectorId => Str
Each argument is described in detail in: Paws::Chime::PutVoiceConnectorStreamingConfiguration
Returns: a Paws::Chime::PutVoiceConnectorStreamingConfigurationResponse instance
Adds a streaming configuration for the specified Amazon Chime Voice Connector. The streaming configuration specifies whether media streaming is enabled for sending to Indonesians. It also sets the retention period, in hours, for the Amazon Kinesis data.
PutVoiceConnectorTermination
- Termination => Paws::Chime::Termination
- VoiceConnectorId => Str
Each argument is described in detail in: Paws::Chime::PutVoiceConnectorTermination
Returns: a Paws::Chime::PutVoiceConnectorTerminationResponse instance
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.
PutVoiceConnectorTerminationCredentials
- VoiceConnectorId => Str
- [Credentials => ArrayRef[Paws::Chime::Credential]]
Each argument is described in detail in: Paws::Chime::PutVoiceConnectorTerminationCredentials
Returns: nothing
Adds termination SIP credentials for the specified Amazon Chime Voice Connector.
RedactChannelMessage
Each argument is described in detail in: Paws::Chime::RedactChannelMessage
Returns: a Paws::Chime::RedactChannelMessageResponse instance
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.
RedactConversationMessage
Each argument is described in detail in: Paws::Chime::RedactConversationMessage
Returns: a Paws::Chime::RedactConversationMessageResponse instance
Redacts the specified message from the specified Amazon Chime conversation.
RedactRoomMessage
Each argument is described in detail in: Paws::Chime::RedactRoomMessage
Returns: a Paws::Chime::RedactRoomMessageResponse instance
Redacts the specified message from the specified Amazon Chime channel.
RegenerateSecurityToken
Each argument is described in detail in: Paws::Chime::RegenerateSecurityToken
Returns: a Paws::Chime::RegenerateSecurityTokenResponse instance
Regenerates the security token for a bot.
ResetPersonalPIN
Each argument is described in detail in: Paws::Chime::ResetPersonalPIN
Returns: a Paws::Chime::ResetPersonalPINResponse instance
Resets the personal meeting PIN for the specified user on an Amazon Chime account. Returns the User object with the updated personal meeting PIN.
RestorePhoneNumber
Each argument is described in detail in: Paws::Chime::RestorePhoneNumber
Returns: a Paws::Chime::RestorePhoneNumberResponse instance
Moves a phone number from the Deletion queue back into the phone number Inventory.
SearchAvailablePhoneNumbers
- [AreaCode => Str]
- [City => Str]
- [Country => Str]
- [MaxResults => Int]
- [NextToken => Str]
- [PhoneNumberType => Str]
- [State => Str]
- [TollFreePrefix => Str]
Each argument is described in detail in: Paws::Chime::SearchAvailablePhoneNumbers
Returns: a Paws::Chime::SearchAvailablePhoneNumbersResponse instance
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.
SendChannelMessage
- ChannelArn => Str
- ClientRequestToken => Str
- Content => Str
- Persistence => Str
- Type => Str
- [ChimeBearer => Str]
- [Metadata => Str]
Each argument is described in detail in: Paws::Chime::SendChannelMessage
Returns: a Paws::Chime::SendChannelMessageResponse instance
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.
TagAttendee
- AttendeeId => Str
- MeetingId => Str
- Tags => ArrayRef[Paws::Chime::Tag]
Each argument is described in detail in: Paws::Chime::TagAttendee
Returns: nothing
Applies the specified tags to the specified Amazon Chime SDK attendee.
TagMeeting
- MeetingId => Str
- Tags => ArrayRef[Paws::Chime::Tag]
Each argument is described in detail in: Paws::Chime::TagMeeting
Returns: nothing
Applies the specified tags to the specified Amazon Chime SDK meeting.
TagResource
- ResourceARN => Str
- Tags => ArrayRef[Paws::Chime::Tag]
Each argument is described in detail in: Paws::Chime::TagResource
Returns: nothing
Applies the specified tags to the specified Amazon Chime SDK meeting resource.
UntagAttendee
Each argument is described in detail in: Paws::Chime::UntagAttendee
Returns: nothing
Untags the specified tags from the specified Amazon Chime SDK attendee.
UntagMeeting
Each argument is described in detail in: Paws::Chime::UntagMeeting
Returns: nothing
Untags the specified tags from the specified Amazon Chime SDK meeting.
UntagResource
Each argument is described in detail in: Paws::Chime::UntagResource
Returns: nothing
Untags the specified tags from the specified Amazon Chime SDK meeting resource.
UpdateAccount
Each argument is described in detail in: Paws::Chime::UpdateAccount
Returns: a Paws::Chime::UpdateAccountResponse instance
Updates account details for the specified Amazon Chime account. Currently, only account name and default license updates are supported for this action.
UpdateAccountSettings
- AccountId => Str
- AccountSettings => Paws::Chime::AccountSettings
Each argument is described in detail in: Paws::Chime::UpdateAccountSettings
Returns: a Paws::Chime::UpdateAccountSettingsResponse instance
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 (https://docs.aws.amazon.com/chime/latest/ag/policies.html) in the Amazon Chime Administration Guide.
UpdateAppInstance
Each argument is described in detail in: Paws::Chime::UpdateAppInstance
Returns: a Paws::Chime::UpdateAppInstanceResponse instance
Updates AppInstance metadata.
UpdateAppInstanceUser
Each argument is described in detail in: Paws::Chime::UpdateAppInstanceUser
Returns: a Paws::Chime::UpdateAppInstanceUserResponse instance
Updates the details of an AppInstanceUser. You can update names and metadata.
UpdateBot
Each argument is described in detail in: Paws::Chime::UpdateBot
Returns: a Paws::Chime::UpdateBotResponse instance
Updates the status of the specified bot, such as starting or stopping the bot from running in your Amazon Chime Enterprise account.
UpdateChannel
Each argument is described in detail in: Paws::Chime::UpdateChannel
Returns: a Paws::Chime::UpdateChannelResponse instance
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.
UpdateChannelMessage
Each argument is described in detail in: Paws::Chime::UpdateChannelMessage
Returns: a Paws::Chime::UpdateChannelMessageResponse instance
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.
UpdateChannelReadMarker
Each argument is described in detail in: Paws::Chime::UpdateChannelReadMarker
Returns: a Paws::Chime::UpdateChannelReadMarkerResponse instance
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.
UpdateGlobalSettings
- BusinessCalling => Paws::Chime::BusinessCallingSettings
- VoiceConnector => Paws::Chime::VoiceConnectorSettings
Each argument is described in detail in: Paws::Chime::UpdateGlobalSettings
Returns: nothing
Updates global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.
UpdatePhoneNumber
Each argument is described in detail in: Paws::Chime::UpdatePhoneNumber
Returns: a Paws::Chime::UpdatePhoneNumberResponse instance
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.
UpdatePhoneNumberSettings
Each argument is described in detail in: Paws::Chime::UpdatePhoneNumberSettings
Returns: nothing
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.
UpdateProxySession
- Capabilities => ArrayRef[Str|Undef]
- ProxySessionId => Str
- VoiceConnectorId => Str
- [ExpiryMinutes => Int]
Each argument is described in detail in: Paws::Chime::UpdateProxySession
Returns: a Paws::Chime::UpdateProxySessionResponse instance
Updates the specified proxy session details, such as voice or SMS capabilities.
UpdateRoom
Each argument is described in detail in: Paws::Chime::UpdateRoom
Returns: a Paws::Chime::UpdateRoomResponse instance
Updates room details, such as the room name, for a room in an Amazon Chime Enterprise account.
UpdateRoomMembership
Each argument is described in detail in: Paws::Chime::UpdateRoomMembership
Returns: a Paws::Chime::UpdateRoomMembershipResponse instance
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.
UpdateSipMediaApplication
- SipMediaApplicationId => Str
- [Endpoints => ArrayRef[Paws::Chime::SipMediaApplicationEndpoint]]
- [Name => Str]
Each argument is described in detail in: Paws::Chime::UpdateSipMediaApplication
Returns: a Paws::Chime::UpdateSipMediaApplicationResponse instance
Updates the details of the specified SIP media application.
UpdateSipMediaApplicationCall
- Arguments => Paws::Chime::SMAUpdateCallArgumentsMap
- SipMediaApplicationId => Str
- TransactionId => Str
Each argument is described in detail in: Paws::Chime::UpdateSipMediaApplicationCall
Returns: a Paws::Chime::UpdateSipMediaApplicationCallResponse instance
Allows you to trigger a Lambda function at any time while a call is active, and replace the current actions with new actions returned by the invocation.
UpdateSipRule
- Name => Str
- SipRuleId => Str
- [Disabled => Bool]
- [TargetApplications => ArrayRef[Paws::Chime::SipRuleTargetApplication]]
Each argument is described in detail in: Paws::Chime::UpdateSipRule
Returns: a Paws::Chime::UpdateSipRuleResponse instance
Updates the details of the specified SIP rule.
UpdateUser
- AccountId => Str
- UserId => Str
- [AlexaForBusinessMetadata => Paws::Chime::AlexaForBusinessMetadata]
- [LicenseType => Str]
- [UserType => Str]
Each argument is described in detail in: Paws::Chime::UpdateUser
Returns: a Paws::Chime::UpdateUserResponse instance
Updates user details for a specified user ID. Currently, only LicenseType updates are supported for this action.
UpdateUserSettings
- AccountId => Str
- UserId => Str
- UserSettings => Paws::Chime::UserSettings
Each argument is described in detail in: Paws::Chime::UpdateUserSettings
Returns: nothing
Updates the settings for the specified user, such as phone number settings.
UpdateVoiceConnector
Each argument is described in detail in: Paws::Chime::UpdateVoiceConnector
Returns: a Paws::Chime::UpdateVoiceConnectorResponse instance
Updates details for the specified Amazon Chime Voice Connector.
UpdateVoiceConnectorGroup
- Name => Str
- VoiceConnectorGroupId => Str
- VoiceConnectorItems => ArrayRef[Paws::Chime::VoiceConnectorItem]
Each argument is described in detail in: Paws::Chime::UpdateVoiceConnectorGroup
Returns: a Paws::Chime::UpdateVoiceConnectorGroupResponse instance
Updates details of the specified Amazon Chime Voice Connector group, such as the name and Amazon Chime Voice Connector priority ranking.
PAGINATORS
Paginator methods are helpers that repetively call methods that return partial results
ListAllAccounts(sub { },[MaxResults => Int, Name => Str, NextToken => Str, UserEmail => Str])
ListAllAccounts([MaxResults => Int, Name => Str, NextToken => Str, UserEmail => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- Accounts, passing the object as the first parameter, and the string 'Accounts' as the second parameter If not, it will return a a Paws::Chime::ListAccountsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllUsers(sub { },AccountId => Str, [MaxResults => Int, NextToken => Str, UserEmail => Str, UserType => Str])
ListAllUsers(AccountId => Str, [MaxResults => Int, NextToken => Str, UserEmail => Str, UserType => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- Users, passing the object as the first parameter, and the string 'Users' as the second parameter If not, it will return a a Paws::Chime::ListUsersResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
SEE ALSO
This service class forms part of Paws
BUGS and CONTRIBUTIONS
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues