Paws

 view release on metacpan or  search on metacpan

lib/Paws/Chime.pm  view on Meta::CPAN

For C<EnterpriseLWA> and C<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 C<Disabled> accounts list for 90 days.
To restore deleted account from your C<Disabled> accounts list, you
must contact AWS Support.

After 90 days, deleted accounts are permanently removed from your
C<Disabled> accounts list.


=head2 DeleteAppInstance

=over

=item AppInstanceArn => Str


=back

Each argument is described in detail in: L<Paws::Chime::DeleteAppInstance>

Returns: nothing

Deletes an C<AppInstance> and all associated data asynchronously.


=head2 DeleteAppInstanceAdmin

=over

=item AppInstanceAdminArn => Str

=item AppInstanceArn => Str


=back

Each argument is described in detail in: L<Paws::Chime::DeleteAppInstanceAdmin>

Returns: nothing

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


=head2 DeleteAppInstanceStreamingConfigurations

=over

=item AppInstanceArn => Str


=back

Each argument is described in detail in: L<Paws::Chime::DeleteAppInstanceStreamingConfigurations>

Returns: nothing

Deletes the streaming configurations of an C<AppInstance>.


=head2 DeleteAppInstanceUser

=over

=item AppInstanceUserArn => Str


=back

Each argument is described in detail in: L<Paws::Chime::DeleteAppInstanceUser>

Returns: nothing

Deletes an C<AppInstanceUser>.


=head2 DeleteAttendee

=over

=item AttendeeId => Str

=item MeetingId => Str


=back

Each argument is described in detail in: L<Paws::Chime::DeleteAttendee>

Returns: nothing

Deletes an attendee from the specified Amazon Chime SDK meeting and
deletes their C<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
I<Amazon Chime Developer Guide>.


=head2 DeleteChannel

=over

=item ChannelArn => Str

=item [ChimeBearer => Str]


=back

Each argument is described in detail in: L<Paws::Chime::DeleteChannel>

Returns: nothing

Immediately makes a channel and its memberships inaccessible and marks
them for deletion. This is an irreversible process.

The C<x-amz-chime-bearer> request header is mandatory. Use the

lib/Paws/Chime.pm  view on Meta::CPAN

Each argument is described in detail in: L<Paws::Chime::DeleteVoiceConnectorGroup>

Returns: nothing

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


=head2 DeleteVoiceConnectorOrigination

=over

=item VoiceConnectorId => Str


=back

Each argument is described in detail in: L<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.


=head2 DeleteVoiceConnectorProxy

=over

=item VoiceConnectorId => Str


=back

Each argument is described in detail in: L<Paws::Chime::DeleteVoiceConnectorProxy>

Returns: nothing

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


=head2 DeleteVoiceConnectorStreamingConfiguration

=over

=item VoiceConnectorId => Str


=back

Each argument is described in detail in: L<Paws::Chime::DeleteVoiceConnectorStreamingConfiguration>

Returns: nothing

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


=head2 DeleteVoiceConnectorTermination

=over

=item VoiceConnectorId => Str


=back

Each argument is described in detail in: L<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.


=head2 DeleteVoiceConnectorTerminationCredentials

=over

=item Usernames => ArrayRef[Str|Undef]

=item VoiceConnectorId => Str


=back

Each argument is described in detail in: L<Paws::Chime::DeleteVoiceConnectorTerminationCredentials>

Returns: nothing

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


=head2 DescribeAppInstance

=over

=item AppInstanceArn => Str


=back

Each argument is described in detail in: L<Paws::Chime::DescribeAppInstance>

Returns: a L<Paws::Chime::DescribeAppInstanceResponse> instance

Returns the full details of an C<AppInstance>.


=head2 DescribeAppInstanceAdmin

lib/Paws/Chime.pm  view on Meta::CPAN

=back

Each argument is described in detail in: L<Paws::Chime::GetAccount>

Returns: a L<Paws::Chime::GetAccountResponse> instance

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


=head2 GetAccountSettings

=over

=item AccountId => Str


=back

Each argument is described in detail in: L<Paws::Chime::GetAccountSettings>

Returns: a L<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
I<Amazon Chime Administration Guide>.


=head2 GetAppInstanceRetentionSettings

=over

=item AppInstanceArn => Str


=back

Each argument is described in detail in: L<Paws::Chime::GetAppInstanceRetentionSettings>

Returns: a L<Paws::Chime::GetAppInstanceRetentionSettingsResponse> instance

Gets the retention settings for an C<AppInstance>.


=head2 GetAppInstanceStreamingConfigurations

=over

=item AppInstanceArn => Str


=back

Each argument is described in detail in: L<Paws::Chime::GetAppInstanceStreamingConfigurations>

Returns: a L<Paws::Chime::GetAppInstanceStreamingConfigurationsResponse> instance

Gets the streaming settings for an C<AppInstance>.


=head2 GetAttendee

=over

=item AttendeeId => Str

=item MeetingId => Str


=back

Each argument is described in detail in: L<Paws::Chime::GetAttendee>

Returns: a L<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
I<Amazon Chime Developer Guide> .


=head2 GetBot

=over

=item AccountId => Str

=item BotId => Str


=back

Each argument is described in detail in: L<Paws::Chime::GetBot>

Returns: a L<Paws::Chime::GetBotResponse> instance

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


=head2 GetChannelMessage

=over

=item ChannelArn => Str

=item MessageId => Str

=item [ChimeBearer => Str]


=back

Each argument is described in detail in: L<Paws::Chime::GetChannelMessage>

Returns: a L<Paws::Chime::GetChannelMessageResponse> instance

lib/Paws/Chime.pm  view on Meta::CPAN

=back

Each argument is described in detail in: L<Paws::Chime::GetVoiceConnectorLoggingConfiguration>

Returns: a L<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.


=head2 GetVoiceConnectorOrigination

=over

=item VoiceConnectorId => Str


=back

Each argument is described in detail in: L<Paws::Chime::GetVoiceConnectorOrigination>

Returns: a L<Paws::Chime::GetVoiceConnectorOriginationResponse> instance

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


=head2 GetVoiceConnectorProxy

=over

=item VoiceConnectorId => Str


=back

Each argument is described in detail in: L<Paws::Chime::GetVoiceConnectorProxy>

Returns: a L<Paws::Chime::GetVoiceConnectorProxyResponse> instance

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


=head2 GetVoiceConnectorStreamingConfiguration

=over

=item VoiceConnectorId => Str


=back

Each argument is described in detail in: L<Paws::Chime::GetVoiceConnectorStreamingConfiguration>

Returns: a L<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.


=head2 GetVoiceConnectorTermination

=over

=item VoiceConnectorId => Str


=back

Each argument is described in detail in: L<Paws::Chime::GetVoiceConnectorTermination>

Returns: a L<Paws::Chime::GetVoiceConnectorTerminationResponse> instance

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


=head2 GetVoiceConnectorTerminationHealth

=over

=item VoiceConnectorId => Str


=back

Each argument is described in detail in: L<Paws::Chime::GetVoiceConnectorTerminationHealth>

Returns: a L<Paws::Chime::GetVoiceConnectorTerminationHealthResponse> instance

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


=head2 InviteUsers

=over

=item AccountId => Str

=item UserEmailList => ArrayRef[Str|Undef]

=item [UserType => Str]


=back

Each argument is described in detail in: L<Paws::Chime::InviteUsers>

Returns: a L<Paws::Chime::InviteUsersResponse> instance

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

lib/Paws/Chime.pm  view on Meta::CPAN

Returns: a L<Paws::Chime::ListVoiceConnectorTerminationCredentialsResponse> instance

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


=head2 LogoutUser

=over

=item AccountId => Str

=item UserId => Str


=back

Each argument is described in detail in: L<Paws::Chime::LogoutUser>

Returns: a L<Paws::Chime::LogoutUserResponse> instance

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


=head2 PutAppInstanceRetentionSettings

=over

=item AppInstanceArn => Str

=item AppInstanceRetentionSettings => L<Paws::Chime::AppInstanceRetentionSettings>


=back

Each argument is described in detail in: L<Paws::Chime::PutAppInstanceRetentionSettings>

Returns: a L<Paws::Chime::PutAppInstanceRetentionSettingsResponse> instance

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


=head2 PutAppInstanceStreamingConfigurations

=over

=item AppInstanceArn => Str

=item AppInstanceStreamingConfigurations => ArrayRef[L<Paws::Chime::AppInstanceStreamingConfiguration>]


=back

Each argument is described in detail in: L<Paws::Chime::PutAppInstanceStreamingConfigurations>

Returns: a L<Paws::Chime::PutAppInstanceStreamingConfigurationsResponse> instance

The data streaming configurations of an C<AppInstance>.


=head2 PutEventsConfiguration

=over

=item AccountId => Str

=item BotId => Str

=item [LambdaFunctionArn => Str]

=item [OutboundEventsHTTPSEndpoint => Str]


=back

Each argument is described in detail in: L<Paws::Chime::PutEventsConfiguration>

Returns: a L<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.


=head2 PutRetentionSettings

=over

=item AccountId => Str

=item RetentionSettings => L<Paws::Chime::RetentionSettings>


=back

Each argument is described in detail in: L<Paws::Chime::PutRetentionSettings>

Returns: a L<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
I<Amazon Chime Administration Guide>.

To turn off existing retention settings, remove the number of days from
the corresponding B<RetentionDays> field in the B<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 I<Amazon Chime Administration Guide>.


=head2 PutSipMediaApplicationLoggingConfiguration

=over

lib/Paws/Chime.pm  view on Meta::CPAN

=item Origination => L<Paws::Chime::Origination>

=item VoiceConnectorId => Str


=back

Each argument is described in detail in: L<Paws::Chime::PutVoiceConnectorOrigination>

Returns: a L<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.


=head2 PutVoiceConnectorProxy

=over

=item DefaultSessionExpiryMinutes => Int

=item PhoneNumberPoolCountries => ArrayRef[Str|Undef]

=item VoiceConnectorId => Str

=item [Disabled => Bool]

=item [FallBackPhoneNumber => Str]


=back

Each argument is described in detail in: L<Paws::Chime::PutVoiceConnectorProxy>

Returns: a L<Paws::Chime::PutVoiceConnectorProxyResponse> instance

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


=head2 PutVoiceConnectorStreamingConfiguration

=over

=item StreamingConfiguration => L<Paws::Chime::StreamingConfiguration>

=item VoiceConnectorId => Str


=back

Each argument is described in detail in: L<Paws::Chime::PutVoiceConnectorStreamingConfiguration>

Returns: a L<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.


=head2 PutVoiceConnectorTermination

=over

=item Termination => L<Paws::Chime::Termination>

=item VoiceConnectorId => Str


=back

Each argument is described in detail in: L<Paws::Chime::PutVoiceConnectorTermination>

Returns: a L<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.


=head2 PutVoiceConnectorTerminationCredentials

=over

=item VoiceConnectorId => Str

=item [Credentials => ArrayRef[L<Paws::Chime::Credential>]]


=back

Each argument is described in detail in: L<Paws::Chime::PutVoiceConnectorTerminationCredentials>

Returns: nothing

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


=head2 RedactChannelMessage

=over

=item ChannelArn => Str

=item MessageId => Str

=item [ChimeBearer => Str]


=back

Each argument is described in detail in: L<Paws::Chime::RedactChannelMessage>