libZSservicesZSamazonka-chimeZSamazonka-chime
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Chime.Lens

Contents

Description

 
Synopsis

Operations

DescribeChannelMembership

describeChannelMembership_chimeBearer :: Lens' DescribeChannelMembership (Maybe Text) Source #

The AppInstanceUserArn of the user that makes the API call.

describeChannelMembership_channelArn :: Lens' DescribeChannelMembership Text Source #

The ARN of the channel.

describeChannelMembership_memberArn :: Lens' DescribeChannelMembership Text Source #

The ARN of the member.

describeChannelMembershipResponse_channelMembership :: Lens' DescribeChannelMembershipResponse (Maybe ChannelMembership) Source #

The details of the membership.

describeChannelMembershipResponse_httpStatus :: Lens' DescribeChannelMembershipResponse Int Source #

The response's http status code.

CreateAppInstance

createAppInstance_metadata :: Lens' CreateAppInstance (Maybe Text) Source #

The metadata of the AppInstance. Limited to a 1KB string in UTF-8.

createAppInstance_tags :: Lens' CreateAppInstance (Maybe (NonEmpty Tag)) Source #

Tags assigned to the AppInstanceUser.

createAppInstance_name :: Lens' CreateAppInstance Text Source #

The name of the AppInstance.

createAppInstance_clientRequestToken :: Lens' CreateAppInstance Text Source #

The ClientRequestToken of the AppInstance.

createAppInstanceResponse_appInstanceArn :: Lens' CreateAppInstanceResponse (Maybe Text) Source #

The Amazon Resource Number (ARN) of the AppInstance.

createAppInstanceResponse_httpStatus :: Lens' CreateAppInstanceResponse Int Source #

The response's http status code.

GetVoiceConnectorGroup

getVoiceConnectorGroup_voiceConnectorGroupId :: Lens' GetVoiceConnectorGroup Text Source #

The Amazon Chime Voice Connector group ID.

getVoiceConnectorGroupResponse_voiceConnectorGroup :: Lens' GetVoiceConnectorGroupResponse (Maybe VoiceConnectorGroup) Source #

The Amazon Chime Voice Connector group details.

getVoiceConnectorGroupResponse_httpStatus :: Lens' GetVoiceConnectorGroupResponse Int Source #

The response's http status code.

ListVoiceConnectors

listVoiceConnectors_nextToken :: Lens' ListVoiceConnectors (Maybe Text) Source #

The token to use to retrieve the next page of results.

listVoiceConnectors_maxResults :: Lens' ListVoiceConnectors (Maybe Natural) Source #

The maximum number of results to return in a single call.

listVoiceConnectorsResponse_nextToken :: Lens' ListVoiceConnectorsResponse (Maybe Text) Source #

The token to use to retrieve the next page of results.

listVoiceConnectorsResponse_voiceConnectors :: Lens' ListVoiceConnectorsResponse (Maybe [VoiceConnector]) Source #

The details of the Amazon Chime Voice Connectors.

listVoiceConnectorsResponse_httpStatus :: Lens' ListVoiceConnectorsResponse Int Source #

The response's http status code.

ListRoomMemberships

listRoomMemberships_nextToken :: Lens' ListRoomMemberships (Maybe Text) Source #

The token to use to retrieve the next page of results.

listRoomMemberships_maxResults :: Lens' ListRoomMemberships (Maybe Natural) Source #

The maximum number of results to return in a single call.

listRoomMemberships_accountId :: Lens' ListRoomMemberships Text Source #

The Amazon Chime account ID.

listRoomMemberships_roomId :: Lens' ListRoomMemberships Text Source #

The room ID.

listRoomMembershipsResponse_nextToken :: Lens' ListRoomMembershipsResponse (Maybe Text) Source #

The token to use to retrieve the next page of results.

listRoomMembershipsResponse_roomMemberships :: Lens' ListRoomMembershipsResponse (Maybe [RoomMembership]) Source #

The room membership details.

listRoomMembershipsResponse_httpStatus :: Lens' ListRoomMembershipsResponse Int Source #

The response's http status code.

GetPhoneNumberSettings

getPhoneNumberSettingsResponse_callingNameUpdatedTimestamp :: Lens' GetPhoneNumberSettingsResponse (Maybe UTCTime) Source #

The updated outbound calling name timestamp, in ISO 8601 format.

getPhoneNumberSettingsResponse_callingName :: Lens' GetPhoneNumberSettingsResponse (Maybe Text) Source #

The default outbound calling name for the account.

getPhoneNumberSettingsResponse_httpStatus :: Lens' GetPhoneNumberSettingsResponse Int Source #

The response's http status code.

UpdateGlobalSettings

updateGlobalSettings_businessCalling :: Lens' UpdateGlobalSettings (Maybe BusinessCallingSettings) Source #

The Amazon Chime Business Calling settings.

updateGlobalSettings_voiceConnector :: Lens' UpdateGlobalSettings (Maybe VoiceConnectorSettings) Source #

The Amazon Chime Voice Connector settings.

ListAttendees

listAttendees_nextToken :: Lens' ListAttendees (Maybe Text) Source #

The token to use to retrieve the next page of results.

listAttendees_maxResults :: Lens' ListAttendees (Maybe Natural) Source #

The maximum number of results to return in a single call.

listAttendees_meetingId :: Lens' ListAttendees Text Source #

The Amazon Chime SDK meeting ID.

listAttendeesResponse_attendees :: Lens' ListAttendeesResponse (Maybe [Attendee]) Source #

The Amazon Chime SDK attendee information.

listAttendeesResponse_nextToken :: Lens' ListAttendeesResponse (Maybe Text) Source #

The token to use to retrieve the next page of results.

listAttendeesResponse_httpStatus :: Lens' ListAttendeesResponse Int Source #

The response's http status code.

PutVoiceConnectorLoggingConfiguration

putVoiceConnectorLoggingConfiguration_voiceConnectorId :: Lens' PutVoiceConnectorLoggingConfiguration Text Source #

The Amazon Chime Voice Connector ID.

putVoiceConnectorLoggingConfiguration_loggingConfiguration :: Lens' PutVoiceConnectorLoggingConfiguration LoggingConfiguration Source #

The logging configuration details to add.

putVoiceConnectorLoggingConfigurationResponse_loggingConfiguration :: Lens' PutVoiceConnectorLoggingConfigurationResponse (Maybe LoggingConfiguration) Source #

The updated logging configuration details.

putVoiceConnectorLoggingConfigurationResponse_httpStatus :: Lens' PutVoiceConnectorLoggingConfigurationResponse Int Source #

The response's http status code.

GetVoiceConnectorTermination

getVoiceConnectorTermination_voiceConnectorId :: Lens' GetVoiceConnectorTermination Text Source #

The Amazon Chime Voice Connector ID.

getVoiceConnectorTerminationResponse_termination :: Lens' GetVoiceConnectorTerminationResponse (Maybe Termination) Source #

The termination setting details.

getVoiceConnectorTerminationResponse_httpStatus :: Lens' GetVoiceConnectorTerminationResponse Int Source #

The response's http status code.

DeleteAttendee

deleteAttendee_meetingId :: Lens' DeleteAttendee Text Source #

The Amazon Chime SDK meeting ID.

deleteAttendee_attendeeId :: Lens' DeleteAttendee Text Source #

The Amazon Chime SDK attendee ID.

GetVoiceConnectorProxy

getVoiceConnectorProxy_voiceConnectorId :: Lens' GetVoiceConnectorProxy Text Source #

The Amazon Chime voice connector ID.

getVoiceConnectorProxyResponse_proxy :: Lens' GetVoiceConnectorProxyResponse (Maybe Proxy) Source #

The proxy configuration details.

getVoiceConnectorProxyResponse_httpStatus :: Lens' GetVoiceConnectorProxyResponse Int Source #

The response's http status code.

DeleteVoiceConnectorEmergencyCallingConfiguration

deleteVoiceConnectorEmergencyCallingConfiguration_voiceConnectorId :: Lens' DeleteVoiceConnectorEmergencyCallingConfiguration Text Source #

The Amazon Chime Voice Connector ID.

GetVoiceConnectorStreamingConfiguration

getVoiceConnectorStreamingConfiguration_voiceConnectorId :: Lens' GetVoiceConnectorStreamingConfiguration Text Source #

The Amazon Chime Voice Connector ID.

getVoiceConnectorStreamingConfigurationResponse_streamingConfiguration :: Lens' GetVoiceConnectorStreamingConfigurationResponse (Maybe StreamingConfiguration) Source #

The streaming configuration details.

getVoiceConnectorStreamingConfigurationResponse_httpStatus :: Lens' GetVoiceConnectorStreamingConfigurationResponse Int Source #

The response's http status code.

UpdateSipMediaApplicationCall

updateSipMediaApplicationCall_sipMediaApplicationId :: Lens' UpdateSipMediaApplicationCall Text Source #

The ID of the SIP media application handling the call.

updateSipMediaApplicationCall_transactionId :: Lens' UpdateSipMediaApplicationCall Text Source #

The ID of the call transaction.

updateSipMediaApplicationCall_arguments :: Lens' UpdateSipMediaApplicationCall (HashMap Text Text) Source #

Arguments made available to the Lambda function as part of the CALL_UPDATE_REQUESTED event. Can contain 0-20 key-value pairs.

updateSipMediaApplicationCallResponse_sipMediaApplicationCall :: Lens' UpdateSipMediaApplicationCallResponse (Maybe SipMediaApplicationCall) Source #

Undocumented member.

updateSipMediaApplicationCallResponse_httpStatus :: Lens' UpdateSipMediaApplicationCallResponse Int Source #

The response's http status code.

StopMeetingTranscription

stopMeetingTranscription_meetingId :: Lens' StopMeetingTranscription Text Source #

The unique ID of the meeting for which you stop transcription.

stopMeetingTranscriptionResponse_httpStatus :: Lens' StopMeetingTranscriptionResponse Int Source #

The response's http status code.

GetAppInstanceRetentionSettings

getAppInstanceRetentionSettings_appInstanceArn :: Lens' GetAppInstanceRetentionSettings Text Source #

The ARN of the AppInstance.

getAppInstanceRetentionSettingsResponse_appInstanceRetentionSettings :: Lens' GetAppInstanceRetentionSettingsResponse (Maybe AppInstanceRetentionSettings) Source #

The retention settings for the AppInstance.

getAppInstanceRetentionSettingsResponse_initiateDeletionTimestamp :: Lens' GetAppInstanceRetentionSettingsResponse (Maybe UTCTime) Source #

The timestamp representing the time at which the specified items are retained, in Epoch Seconds.

getAppInstanceRetentionSettingsResponse_httpStatus :: Lens' GetAppInstanceRetentionSettingsResponse Int Source #

The response's http status code.

PutVoiceConnectorEmergencyCallingConfiguration

putVoiceConnectorEmergencyCallingConfiguration_voiceConnectorId :: Lens' PutVoiceConnectorEmergencyCallingConfiguration Text Source #

The Amazon Chime Voice Connector ID.

putVoiceConnectorEmergencyCallingConfiguration_emergencyCallingConfiguration :: Lens' PutVoiceConnectorEmergencyCallingConfiguration EmergencyCallingConfiguration Source #

The emergency calling configuration details.

putVoiceConnectorEmergencyCallingConfigurationResponse_emergencyCallingConfiguration :: Lens' PutVoiceConnectorEmergencyCallingConfigurationResponse (Maybe EmergencyCallingConfiguration) Source #

The emergency calling configuration details.

putVoiceConnectorEmergencyCallingConfigurationResponse_httpStatus :: Lens' PutVoiceConnectorEmergencyCallingConfigurationResponse Int Source #

The response's http status code.

CreateMeetingWithAttendees

createMeetingWithAttendees_mediaRegion :: Lens' CreateMeetingWithAttendees (Maybe Text) Source #

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 .

createMeetingWithAttendees_meetingHostId :: Lens' CreateMeetingWithAttendees (Maybe Text) Source #

Reserved.

createMeetingWithAttendees_attendees :: Lens' CreateMeetingWithAttendees (Maybe (NonEmpty CreateAttendeeRequestItem)) Source #

The request containing the attendees to create.

createMeetingWithAttendees_notificationsConfiguration :: Lens' CreateMeetingWithAttendees (Maybe MeetingNotificationConfiguration) Source #

Undocumented member.

createMeetingWithAttendees_externalMeetingId :: Lens' CreateMeetingWithAttendees (Maybe Text) Source #

The external meeting ID.

createMeetingWithAttendees_tags :: Lens' CreateMeetingWithAttendees (Maybe (NonEmpty Tag)) Source #

The tag key-value pairs.

createMeetingWithAttendees_clientRequestToken :: Lens' CreateMeetingWithAttendees Text Source #

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

createMeetingWithAttendeesResponse_attendees :: Lens' CreateMeetingWithAttendeesResponse (Maybe [Attendee]) Source #

The attendee information, including attendees IDs and join tokens.

createMeetingWithAttendeesResponse_meeting :: Lens' CreateMeetingWithAttendeesResponse (Maybe Meeting) Source #

Undocumented member.

createMeetingWithAttendeesResponse_errors :: Lens' CreateMeetingWithAttendeesResponse (Maybe [CreateAttendeeError]) Source #

If the action fails for one or more of the attendees in the request, a list of the attendees is returned, along with error codes and error messages.

createMeetingWithAttendeesResponse_httpStatus :: Lens' CreateMeetingWithAttendeesResponse Int Source #

The response's http status code.

ListChannels

listChannels_privacy :: Lens' ListChannels (Maybe ChannelPrivacy) Source #

The privacy setting. PUBLIC retrieves all the public channels. PRIVATE retrieves private channels. Only an AppInstanceAdmin can retrieve private channels.

listChannels_chimeBearer :: Lens' ListChannels (Maybe Text) Source #

The AppInstanceUserArn of the user that makes the API call.

listChannels_nextToken :: Lens' ListChannels (Maybe Text) Source #

The token passed by previous API calls until all requested channels are returned.

listChannels_maxResults :: Lens' ListChannels (Maybe Natural) Source #

The maximum number of channels that you want to return.

listChannels_appInstanceArn :: Lens' ListChannels Text Source #

The ARN of the AppInstance.

listChannelsResponse_channels :: Lens' ListChannelsResponse (Maybe [ChannelSummary]) Source #

The information about each channel.

listChannelsResponse_nextToken :: Lens' ListChannelsResponse (Maybe Text) Source #

The token returned from previous API requests until the number of channels is reached.

listChannelsResponse_httpStatus :: Lens' ListChannelsResponse Int Source #

The response's http status code.

DisassociatePhoneNumberFromUser

disassociatePhoneNumberFromUser_accountId :: Lens' DisassociatePhoneNumberFromUser Text Source #

The Amazon Chime account ID.

disassociatePhoneNumberFromUser_userId :: Lens' DisassociatePhoneNumberFromUser Text Source #

The user ID.

disassociatePhoneNumberFromUserResponse_httpStatus :: Lens' DisassociatePhoneNumberFromUserResponse Int Source #

The response's http status code.

DisassociateSigninDelegateGroupsFromAccount

disassociateSigninDelegateGroupsFromAccount_accountId :: Lens' DisassociateSigninDelegateGroupsFromAccount Text Source #

The Amazon Chime account ID.

disassociateSigninDelegateGroupsFromAccount_groupNames :: Lens' DisassociateSigninDelegateGroupsFromAccount (NonEmpty Text) Source #

The sign-in delegate group names.

disassociateSigninDelegateGroupsFromAccountResponse_httpStatus :: Lens' DisassociateSigninDelegateGroupsFromAccountResponse Int Source #

The response's http status code.

ResetPersonalPIN

resetPersonalPIN_accountId :: Lens' ResetPersonalPIN Text Source #

The Amazon Chime account ID.

resetPersonalPIN_userId :: Lens' ResetPersonalPIN Text Source #

The user ID.

resetPersonalPINResponse_user :: Lens' ResetPersonalPINResponse (Maybe User) Source #

The user details and new personal meeting PIN.

resetPersonalPINResponse_httpStatus :: Lens' ResetPersonalPINResponse Int Source #

The response's http status code.

ListTagsForResource

listTagsForResource_resourceARN :: Lens' ListTagsForResource Text Source #

The resource ARN.

listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (NonEmpty Tag)) Source #

A list of tag-key value pairs.

listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int Source #

The response's http status code.

DeleteChannel

deleteChannel_chimeBearer :: Lens' DeleteChannel (Maybe Text) Source #

The AppInstanceUserArn of the user that makes the API call.

deleteChannel_channelArn :: Lens' DeleteChannel Text Source #

The ARN of the channel being deleted.

UpdateChannel

updateChannel_chimeBearer :: Lens' UpdateChannel (Maybe Text) Source #

The AppInstanceUserArn of the user that makes the API call.

updateChannel_metadata :: Lens' UpdateChannel (Maybe Text) Source #

The metadata for the update request.

updateChannel_channelArn :: Lens' UpdateChannel Text Source #

The ARN of the channel.

updateChannel_name :: Lens' UpdateChannel Text Source #

The name of the channel.

updateChannel_mode :: Lens' UpdateChannel ChannelMode Source #

The mode of the update request.

updateChannelResponse_channelArn :: Lens' UpdateChannelResponse (Maybe Text) Source #

The ARN of the channel.

updateChannelResponse_httpStatus :: Lens' UpdateChannelResponse Int Source #

The response's http status code.

DescribeAppInstanceAdmin

describeAppInstanceAdmin_appInstanceAdminArn :: Lens' DescribeAppInstanceAdmin Text Source #

The ARN of the AppInstanceAdmin.

describeAppInstanceAdmin_appInstanceArn :: Lens' DescribeAppInstanceAdmin Text Source #

The ARN of the AppInstance.

describeAppInstanceAdminResponse_appInstanceAdmin :: Lens' DescribeAppInstanceAdminResponse (Maybe AppInstanceAdmin) Source #

The ARN and name of the AppInstanceUser, the ARN of the AppInstance, and the created and last-updated timestamps. All timestamps use epoch milliseconds.

describeAppInstanceAdminResponse_httpStatus :: Lens' DescribeAppInstanceAdminResponse Int Source #

The response's http status code.

CreateAttendee

createAttendee_tags :: Lens' CreateAttendee (Maybe (NonEmpty Tag)) Source #

The tag key-value pairs.

createAttendee_meetingId :: Lens' CreateAttendee Text Source #

The Amazon Chime SDK meeting ID.

createAttendee_externalUserId :: Lens' CreateAttendee Text Source #

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

createAttendeeResponse_attendee :: Lens' CreateAttendeeResponse (Maybe Attendee) Source #

The attendee information, including attendee ID and join token.

createAttendeeResponse_httpStatus :: Lens' CreateAttendeeResponse Int Source #

The response's http status code.

ListSupportedPhoneNumberCountries

listSupportedPhoneNumberCountries_productType :: Lens' ListSupportedPhoneNumberCountries PhoneNumberProductType Source #

The phone number product type.

listSupportedPhoneNumberCountriesResponse_phoneNumberCountries :: Lens' ListSupportedPhoneNumberCountriesResponse (Maybe [PhoneNumberCountry]) Source #

The supported phone number countries.

listSupportedPhoneNumberCountriesResponse_httpStatus :: Lens' ListSupportedPhoneNumberCountriesResponse Int Source #

The response's http status code.

DeleteSipRule

deleteSipRule_sipRuleId :: Lens' DeleteSipRule Text Source #

The SIP rule ID.

UpdateSipRule

updateSipRule_disabled :: Lens' UpdateSipRule (Maybe Bool) Source #

The new value specified to indicate whether the rule is disabled.

updateSipRule_targetApplications :: Lens' UpdateSipRule (Maybe (NonEmpty SipRuleTargetApplication)) Source #

The new value of the list of target applications.

updateSipRule_sipRuleId :: Lens' UpdateSipRule Text Source #

The SIP rule ID.

updateSipRule_name :: Lens' UpdateSipRule Text Source #

The new name for the specified SIP rule.

updateSipRuleResponse_sipRule :: Lens' UpdateSipRuleResponse (Maybe SipRule) Source #

Updated SIP rule details.

updateSipRuleResponse_httpStatus :: Lens' UpdateSipRuleResponse Int Source #

The response's http status code.

UpdateAccountSettings

updateAccountSettings_accountId :: Lens' UpdateAccountSettings Text Source #

The Amazon Chime account ID.

updateAccountSettings_accountSettings :: Lens' UpdateAccountSettings AccountSettings Source #

The Amazon Chime account settings to update.

updateAccountSettingsResponse_httpStatus :: Lens' UpdateAccountSettingsResponse Int Source #

The response's http status code.

DeleteVoiceConnectorOrigination

deleteVoiceConnectorOrigination_voiceConnectorId :: Lens' DeleteVoiceConnectorOrigination Text Source #

The Amazon Chime Voice Connector ID.

DeleteSipMediaApplication

deleteSipMediaApplication_sipMediaApplicationId :: Lens' DeleteSipMediaApplication Text Source #

The SIP media application ID.

UpdateSipMediaApplication

updateSipMediaApplication_name :: Lens' UpdateSipMediaApplication (Maybe Text) Source #

The new name for the specified SIP media application.

updateSipMediaApplication_endpoints :: Lens' UpdateSipMediaApplication (Maybe (NonEmpty SipMediaApplicationEndpoint)) Source #

The new set of endpoints for the specified SIP media application.

updateSipMediaApplication_sipMediaApplicationId :: Lens' UpdateSipMediaApplication Text Source #

The SIP media application ID.

updateSipMediaApplicationResponse_sipMediaApplication :: Lens' UpdateSipMediaApplicationResponse (Maybe SipMediaApplication) Source #

The updated SIP media application details.

updateSipMediaApplicationResponse_httpStatus :: Lens' UpdateSipMediaApplicationResponse Int Source #

The response's http status code.

DisassociatePhoneNumbersFromVoiceConnector

disassociatePhoneNumbersFromVoiceConnector_voiceConnectorId :: Lens' DisassociatePhoneNumbersFromVoiceConnector Text Source #

The Amazon Chime Voice Connector ID.

disassociatePhoneNumbersFromVoiceConnector_e164PhoneNumbers :: Lens' DisassociatePhoneNumbersFromVoiceConnector [Text] Source #

List of phone numbers, in E.164 format.

disassociatePhoneNumbersFromVoiceConnectorResponse_phoneNumberErrors :: Lens' DisassociatePhoneNumbersFromVoiceConnectorResponse (Maybe [PhoneNumberError]) Source #

If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.

disassociatePhoneNumbersFromVoiceConnectorResponse_httpStatus :: Lens' DisassociatePhoneNumbersFromVoiceConnectorResponse Int Source #

The response's http status code.

GetMessagingSessionEndpoint

getMessagingSessionEndpointResponse_endpoint :: Lens' GetMessagingSessionEndpointResponse (Maybe MessagingSessionEndpoint) Source #

The endpoint returned in the response.

getMessagingSessionEndpointResponse_httpStatus :: Lens' GetMessagingSessionEndpointResponse Int Source #

The response's http status code.

PutVoiceConnectorOrigination

putVoiceConnectorOrigination_voiceConnectorId :: Lens' PutVoiceConnectorOrigination Text Source #

The Amazon Chime Voice Connector ID.

putVoiceConnectorOrigination_origination :: Lens' PutVoiceConnectorOrigination Origination Source #

The origination setting details to add.

putVoiceConnectorOriginationResponse_origination :: Lens' PutVoiceConnectorOriginationResponse (Maybe Origination) Source #

The updated origination setting details.

putVoiceConnectorOriginationResponse_httpStatus :: Lens' PutVoiceConnectorOriginationResponse Int Source #

The response's http status code.

CreateAppInstanceUser

createAppInstanceUser_metadata :: Lens' CreateAppInstanceUser (Maybe Text) Source #

The request's metadata. Limited to a 1KB string in UTF-8.

createAppInstanceUser_tags :: Lens' CreateAppInstanceUser (Maybe (NonEmpty Tag)) Source #

Tags assigned to the AppInstanceUser.

createAppInstanceUser_appInstanceArn :: Lens' CreateAppInstanceUser Text Source #

The ARN of the AppInstance request.

createAppInstanceUser_appInstanceUserId :: Lens' CreateAppInstanceUser Text Source #

The user ID of the AppInstance.

createAppInstanceUser_name :: Lens' CreateAppInstanceUser Text Source #

The user's name.

createAppInstanceUser_clientRequestToken :: Lens' CreateAppInstanceUser Text Source #

The token assigned to the user requesting an AppInstance.

createAppInstanceUserResponse_appInstanceUserArn :: Lens' CreateAppInstanceUserResponse (Maybe Text) Source #

The user's ARN.

createAppInstanceUserResponse_httpStatus :: Lens' CreateAppInstanceUserResponse Int Source #

The response's http status code.

ListAttendeeTags

listAttendeeTags_meetingId :: Lens' ListAttendeeTags Text Source #

The Amazon Chime SDK meeting ID.

listAttendeeTags_attendeeId :: Lens' ListAttendeeTags Text Source #

The Amazon Chime SDK attendee ID.

listAttendeeTagsResponse_tags :: Lens' ListAttendeeTagsResponse (Maybe (NonEmpty Tag)) Source #

A list of tag key-value pairs.

listAttendeeTagsResponse_httpStatus :: Lens' ListAttendeeTagsResponse Int Source #

The response's http status code.

ListChannelsModeratedByAppInstanceUser

listChannelsModeratedByAppInstanceUser_appInstanceUserArn :: Lens' ListChannelsModeratedByAppInstanceUser (Maybe Text) Source #

The ARN of the user in the moderated channel.

listChannelsModeratedByAppInstanceUser_chimeBearer :: Lens' ListChannelsModeratedByAppInstanceUser (Maybe Text) Source #

The AppInstanceUserArn of the user that makes the API call.

listChannelsModeratedByAppInstanceUser_nextToken :: Lens' ListChannelsModeratedByAppInstanceUser (Maybe Text) Source #

The token returned from previous API requests until the number of channels moderated by the user is reached.

listChannelsModeratedByAppInstanceUser_maxResults :: Lens' ListChannelsModeratedByAppInstanceUser (Maybe Natural) Source #

The maximum number of channels in the request.

listChannelsModeratedByAppInstanceUserResponse_channels :: Lens' ListChannelsModeratedByAppInstanceUserResponse (Maybe [ChannelModeratedByAppInstanceUserSummary]) Source #

The moderated channels in the request.

listChannelsModeratedByAppInstanceUserResponse_nextToken :: Lens' ListChannelsModeratedByAppInstanceUserResponse (Maybe Text) Source #

The token returned from previous API requests until the number of channels moderated by the user is reached.

listChannelsModeratedByAppInstanceUserResponse_httpStatus :: Lens' ListChannelsModeratedByAppInstanceUserResponse Int Source #

The response's http status code.

RedactChannelMessage

redactChannelMessage_chimeBearer :: Lens' RedactChannelMessage (Maybe Text) Source #

The AppInstanceUserArn of the user that makes the API call.

redactChannelMessage_channelArn :: Lens' RedactChannelMessage Text Source #

The ARN of the channel containing the messages that you want to redact.

redactChannelMessage_messageId :: Lens' RedactChannelMessage Text Source #

The ID of the message being redacted.

redactChannelMessageResponse_channelArn :: Lens' RedactChannelMessageResponse (Maybe Text) Source #

The ARN of the channel containing the messages that you want to redact.

redactChannelMessageResponse_messageId :: Lens' RedactChannelMessageResponse (Maybe Text) Source #

The ID of the message being redacted.

redactChannelMessageResponse_httpStatus :: Lens' RedactChannelMessageResponse Int Source #

The response's http status code.

PutRetentionSettings

putRetentionSettings_accountId :: Lens' PutRetentionSettings Text Source #

The Amazon Chime account ID.

putRetentionSettings_retentionSettings :: Lens' PutRetentionSettings RetentionSettings Source #

The retention settings.

putRetentionSettingsResponse_retentionSettings :: Lens' PutRetentionSettingsResponse (Maybe RetentionSettings) Source #

The retention settings.

putRetentionSettingsResponse_initiateDeletionTimestamp :: Lens' PutRetentionSettingsResponse (Maybe UTCTime) Source #

The timestamp representing the time at which the specified items are permanently deleted, in ISO 8601 format.

putRetentionSettingsResponse_httpStatus :: Lens' PutRetentionSettingsResponse Int Source #

The response's http status code.

ListUsers

listUsers_nextToken :: Lens' ListUsers (Maybe Text) Source #

The token to use to retrieve the next page of results.

listUsers_userEmail :: Lens' ListUsers (Maybe Text) Source #

Optional. The user email address used to filter results. Maximum 1.

listUsers_maxResults :: Lens' ListUsers (Maybe Natural) Source #

The maximum number of results to return in a single call. Defaults to 100.

listUsers_userType :: Lens' ListUsers (Maybe UserType) Source #

The user type.

listUsers_accountId :: Lens' ListUsers Text Source #

The Amazon Chime account ID.

listUsersResponse_users :: Lens' ListUsersResponse (Maybe [User]) Source #

List of users and user details.

listUsersResponse_nextToken :: Lens' ListUsersResponse (Maybe Text) Source #

The token to use to retrieve the next page of results.

listUsersResponse_httpStatus :: Lens' ListUsersResponse Int Source #

The response's http status code.

DeleteVoiceConnectorStreamingConfiguration

deleteVoiceConnectorStreamingConfiguration_voiceConnectorId :: Lens' DeleteVoiceConnectorStreamingConfiguration Text Source #

The Amazon Chime Voice Connector ID.

AssociatePhoneNumbersWithVoiceConnectorGroup

associatePhoneNumbersWithVoiceConnectorGroup_forceAssociate :: Lens' AssociatePhoneNumbersWithVoiceConnectorGroup (Maybe Bool) Source #

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.

associatePhoneNumbersWithVoiceConnectorGroup_voiceConnectorGroupId :: Lens' AssociatePhoneNumbersWithVoiceConnectorGroup Text Source #

The Amazon Chime Voice Connector group ID.

associatePhoneNumbersWithVoiceConnectorGroup_e164PhoneNumbers :: Lens' AssociatePhoneNumbersWithVoiceConnectorGroup [Text] Source #

List of phone numbers, in E.164 format.

associatePhoneNumbersWithVoiceConnectorGroupResponse_phoneNumberErrors :: Lens' AssociatePhoneNumbersWithVoiceConnectorGroupResponse (Maybe [PhoneNumberError]) Source #

If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.

associatePhoneNumbersWithVoiceConnectorGroupResponse_httpStatus :: Lens' AssociatePhoneNumbersWithVoiceConnectorGroupResponse Int Source #

The response's http status code.

PutAppInstanceRetentionSettings

putAppInstanceRetentionSettings_appInstanceArn :: Lens' PutAppInstanceRetentionSettings Text Source #

The ARN of the AppInstance.

putAppInstanceRetentionSettings_appInstanceRetentionSettings :: Lens' PutAppInstanceRetentionSettings AppInstanceRetentionSettings Source #

The time in days to retain data. Data type: number.

putAppInstanceRetentionSettingsResponse_appInstanceRetentionSettings :: Lens' PutAppInstanceRetentionSettingsResponse (Maybe AppInstanceRetentionSettings) Source #

The time in days to retain data. Data type: number.

putAppInstanceRetentionSettingsResponse_initiateDeletionTimestamp :: Lens' PutAppInstanceRetentionSettingsResponse (Maybe UTCTime) Source #

The time at which the API deletes data.

putAppInstanceRetentionSettingsResponse_httpStatus :: Lens' PutAppInstanceRetentionSettingsResponse Int Source #

The response's http status code.

GetVoiceConnectorLoggingConfiguration

getVoiceConnectorLoggingConfiguration_voiceConnectorId :: Lens' GetVoiceConnectorLoggingConfiguration Text Source #

The Amazon Chime Voice Connector ID.

getVoiceConnectorLoggingConfigurationResponse_loggingConfiguration :: Lens' GetVoiceConnectorLoggingConfigurationResponse (Maybe LoggingConfiguration) Source #

The logging configuration details.

getVoiceConnectorLoggingConfigurationResponse_httpStatus :: Lens' GetVoiceConnectorLoggingConfigurationResponse Int Source #

The response's http status code.

ListBots

listBots_nextToken :: Lens' ListBots (Maybe Text) Source #

The token to use to retrieve the next page of results.

listBots_maxResults :: Lens' ListBots (Maybe Natural) Source #

The maximum number of results to return in a single call. The default is 10.

listBots_accountId :: Lens' ListBots Text Source #

The Amazon Chime account ID.

listBotsResponse_bots :: Lens' ListBotsResponse (Maybe [Bot]) Source #

List of bots and bot details.

listBotsResponse_nextToken :: Lens' ListBotsResponse (Maybe Text) Source #

The token to use to retrieve the next page of results.

listBotsResponse_httpStatus :: Lens' ListBotsResponse Int Source #

The response's http status code.

DeleteChannelMembership

deleteChannelMembership_chimeBearer :: Lens' DeleteChannelMembership (Maybe Text) Source #

The AppInstanceUserArn of the user that makes the API call.

deleteChannelMembership_channelArn :: Lens' DeleteChannelMembership Text Source #

The ARN of the channel from which you want to remove the user.

deleteChannelMembership_memberArn :: Lens' DeleteChannelMembership Text Source #

The ARN of the member that you're removing from the channel.

PutVoiceConnectorStreamingConfiguration

putVoiceConnectorStreamingConfiguration_voiceConnectorId :: Lens' PutVoiceConnectorStreamingConfiguration Text Source #

The Amazon Chime Voice Connector ID.

putVoiceConnectorStreamingConfiguration_streamingConfiguration :: Lens' PutVoiceConnectorStreamingConfiguration StreamingConfiguration Source #

The streaming configuration details to add.

putVoiceConnectorStreamingConfigurationResponse_streamingConfiguration :: Lens' PutVoiceConnectorStreamingConfigurationResponse (Maybe StreamingConfiguration) Source #

The updated streaming configuration details.

putVoiceConnectorStreamingConfigurationResponse_httpStatus :: Lens' PutVoiceConnectorStreamingConfigurationResponse Int Source #

The response's http status code.

ListChannelMemberships

listChannelMemberships_chimeBearer :: Lens' ListChannelMemberships (Maybe Text) Source #

The AppInstanceUserArn of the user that makes the API call.

listChannelMemberships_nextToken :: Lens' ListChannelMemberships (Maybe Text) Source #

The token passed by previous API calls until all requested channel memberships are returned.

listChannelMemberships_type :: Lens' ListChannelMemberships (Maybe ChannelMembershipType) Source #

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.

listChannelMemberships_maxResults :: Lens' ListChannelMemberships (Maybe Natural) Source #

The maximum number of channel memberships that you want returned.

listChannelMemberships_channelArn :: Lens' ListChannelMemberships Text Source #

The maximum number of channel memberships that you want returned.

listChannelMembershipsResponse_channelMemberships :: Lens' ListChannelMembershipsResponse (Maybe [ChannelMembershipSummary]) Source #

The information for the requested channel memberships.

listChannelMembershipsResponse_channelArn :: Lens' ListChannelMembershipsResponse (Maybe Text) Source #

The ARN of the channel.

listChannelMembershipsResponse_nextToken :: Lens' ListChannelMembershipsResponse (Maybe Text) Source #

The token passed by previous API calls until all requested channel memberships are returned.

listChannelMembershipsResponse_httpStatus :: Lens' ListChannelMembershipsResponse Int Source #

The response's http status code.

GetGlobalSettings

getGlobalSettingsResponse_businessCalling :: Lens' GetGlobalSettingsResponse (Maybe BusinessCallingSettings) Source #

The Amazon Chime Business Calling settings.

getGlobalSettingsResponse_voiceConnector :: Lens' GetGlobalSettingsResponse (Maybe VoiceConnectorSettings) Source #

The Amazon Chime Voice Connector settings.

getGlobalSettingsResponse_httpStatus :: Lens' GetGlobalSettingsResponse Int Source #

The response's http status code.

DeleteMeeting

deleteMeeting_meetingId :: Lens' DeleteMeeting Text Source #

The Amazon Chime SDK meeting ID.

ListMeetings

listMeetings_nextToken :: Lens' ListMeetings (Maybe Text) Source #

The token to use to retrieve the next page of results.

listMeetings_maxResults :: Lens' ListMeetings (Maybe Natural) Source #

The maximum number of results to return in a single call.

listMeetingsResponse_meetings :: Lens' ListMeetingsResponse (Maybe [Meeting]) Source #

The Amazon Chime SDK meeting information.

listMeetingsResponse_nextToken :: Lens' ListMeetingsResponse (Maybe Text) Source #

The token to use to retrieve the next page of results.

listMeetingsResponse_httpStatus :: Lens' ListMeetingsResponse Int Source #

The response's http status code.

GetAttendee

getAttendee_meetingId :: Lens' GetAttendee Text Source #

The Amazon Chime SDK meeting ID.

getAttendee_attendeeId :: Lens' GetAttendee Text Source #

The Amazon Chime SDK attendee ID.

getAttendeeResponse_attendee :: Lens' GetAttendeeResponse (Maybe Attendee) Source #

The Amazon Chime SDK attendee information.

getAttendeeResponse_httpStatus :: Lens' GetAttendeeResponse Int Source #

The response's http status code.

DeleteAccount

deleteAccount_accountId :: Lens' DeleteAccount Text Source #

The Amazon Chime account ID.

deleteAccountResponse_httpStatus :: Lens' DeleteAccountResponse Int Source #

The response's http status code.

UpdateAccount

updateAccount_defaultLicense :: Lens' UpdateAccount (Maybe License) Source #

The default license applied when you add users to an Amazon Chime account.

updateAccount_name :: Lens' UpdateAccount (Maybe Text) Source #

The new name for the specified Amazon Chime account.

updateAccount_accountId :: Lens' UpdateAccount Text Source #

The Amazon Chime account ID.

updateAccountResponse_account :: Lens' UpdateAccountResponse (Maybe Account) Source #

The updated Amazon Chime account details.

updateAccountResponse_httpStatus :: Lens' UpdateAccountResponse Int Source #

The response's http status code.

ListAccounts

listAccounts_nextToken :: Lens' ListAccounts (Maybe Text) Source #

The token to use to retrieve the next page of results.

listAccounts_name :: Lens' ListAccounts (Maybe Text) Source #

Amazon Chime account name prefix with which to filter results.

listAccounts_userEmail :: Lens' ListAccounts (Maybe Text) Source #

User email address with which to filter results.

listAccounts_maxResults :: Lens' ListAccounts (Maybe Natural) Source #

The maximum number of results to return in a single call. Defaults to 100.

listAccountsResponse_accounts :: Lens' ListAccountsResponse (Maybe [Account]) Source #

List of Amazon Chime accounts and account details.

listAccountsResponse_nextToken :: Lens' ListAccountsResponse (Maybe Text) Source #

The token to use to retrieve the next page of results.

listAccountsResponse_httpStatus :: Lens' ListAccountsResponse Int Source #

The response's http status code.

UpdateBot

updateBot_disabled :: Lens' UpdateBot (Maybe Bool) Source #

When true, stops the specified bot from running in your account.

updateBot_accountId :: Lens' UpdateBot Text Source #

The Amazon Chime account ID.

updateBot_botId :: Lens' UpdateBot Text Source #

The bot ID.

updateBotResponse_bot :: Lens' UpdateBotResponse (Maybe Bot) Source #

The updated bot details.

updateBotResponse_httpStatus :: Lens' UpdateBotResponse Int Source #

The response's http status code.

ListPhoneNumberOrders

listPhoneNumberOrders_nextToken :: Lens' ListPhoneNumberOrders (Maybe Text) Source #

The token to use to retrieve the next page of results.

listPhoneNumberOrders_maxResults :: Lens' ListPhoneNumberOrders (Maybe Natural) Source #

The maximum number of results to return in a single call.

listPhoneNumberOrdersResponse_phoneNumberOrders :: Lens' ListPhoneNumberOrdersResponse (Maybe [PhoneNumberOrder]) Source #

The phone number order details.

listPhoneNumberOrdersResponse_nextToken :: Lens' ListPhoneNumberOrdersResponse (Maybe Text) Source #

The token to use to retrieve the next page of results.

listPhoneNumberOrdersResponse_httpStatus :: Lens' ListPhoneNumberOrdersResponse Int Source #

The response's http status code.

SearchAvailablePhoneNumbers

searchAvailablePhoneNumbers_phoneNumberType :: Lens' SearchAvailablePhoneNumbers (Maybe PhoneNumberType) Source #

The phone number type used to filter results. Required for non-US numbers.

searchAvailablePhoneNumbers_state :: Lens' SearchAvailablePhoneNumbers (Maybe Text) Source #

The state used to filter results. Required only if you provide City. Only applies to the US.

searchAvailablePhoneNumbers_tollFreePrefix :: Lens' SearchAvailablePhoneNumbers (Maybe Text) Source #

The toll-free prefix that you use to filter results. Only applies to the US.

searchAvailablePhoneNumbers_country :: Lens' SearchAvailablePhoneNumbers (Maybe Text) Source #

The country used to filter results. Defaults to the US Format: ISO 3166-1 alpha-2.

searchAvailablePhoneNumbers_nextToken :: Lens' SearchAvailablePhoneNumbers (Maybe Text) Source #

The token used to retrieve the next page of results.

searchAvailablePhoneNumbers_city :: Lens' SearchAvailablePhoneNumbers (Maybe Text) Source #

The city used to filter results. Only applies to the US.

searchAvailablePhoneNumbers_areaCode :: Lens' SearchAvailablePhoneNumbers (Maybe Text) Source #

The area code used to filter results. Only applies to the US.

searchAvailablePhoneNumbers_maxResults :: Lens' SearchAvailablePhoneNumbers (Maybe Natural) Source #

The maximum number of results to return in a single call.

searchAvailablePhoneNumbersResponse_e164PhoneNumbers :: Lens' SearchAvailablePhoneNumbersResponse (Maybe [Text]) Source #

List of phone numbers, in E.164 format.

searchAvailablePhoneNumbersResponse_nextToken :: Lens' SearchAvailablePhoneNumbersResponse (Maybe Text) Source #

The token used to retrieve the next page of search results.

searchAvailablePhoneNumbersResponse_httpStatus :: Lens' SearchAvailablePhoneNumbersResponse Int Source #

The response's http status code.

CreateAppInstanceAdmin

createAppInstanceAdmin_appInstanceAdminArn :: Lens' CreateAppInstanceAdmin Text Source #

The ARN of the administrator of the current AppInstance.

createAppInstanceAdmin_appInstanceArn :: Lens' CreateAppInstanceAdmin Text Source #

The ARN of the AppInstance.

createAppInstanceAdminResponse_appInstanceAdmin :: Lens' CreateAppInstanceAdminResponse (Maybe Identity) Source #

The name and ARN of the admin for the AppInstance.

createAppInstanceAdminResponse_appInstanceArn :: Lens' CreateAppInstanceAdminResponse (Maybe Text) Source #

The ARN of the of the admin for the AppInstance.

createAppInstanceAdminResponse_httpStatus :: Lens' CreateAppInstanceAdminResponse Int Source #

The response's http status code.

TagMeeting

tagMeeting_meetingId :: Lens' TagMeeting Text Source #

The Amazon Chime SDK meeting ID.

tagMeeting_tags :: Lens' TagMeeting (NonEmpty Tag) Source #

The tag key-value pairs.

ListVoiceConnectorGroups

listVoiceConnectorGroups_nextToken :: Lens' ListVoiceConnectorGroups (Maybe Text) Source #

The token to use to retrieve the next page of results.

listVoiceConnectorGroups_maxResults :: Lens' ListVoiceConnectorGroups (Maybe Natural) Source #

The maximum number of results to return in a single call.

listVoiceConnectorGroupsResponse_voiceConnectorGroups :: Lens' ListVoiceConnectorGroupsResponse (Maybe [VoiceConnectorGroup]) Source #

The details of the Amazon Chime Voice Connector groups.

listVoiceConnectorGroupsResponse_nextToken :: Lens' ListVoiceConnectorGroupsResponse (Maybe Text) Source #

The token to use to retrieve the next page of results.

listVoiceConnectorGroupsResponse_httpStatus :: Lens' ListVoiceConnectorGroupsResponse Int Source #

The response's http status code.

LogoutUser

logoutUser_accountId :: Lens' LogoutUser Text Source #

The Amazon Chime account ID.

logoutUser_userId :: Lens' LogoutUser Text Source #

The user ID.

logoutUserResponse_httpStatus :: Lens' LogoutUserResponse Int Source #

The response's http status code.

ListVoiceConnectorTerminationCredentials

listVoiceConnectorTerminationCredentials_voiceConnectorId :: Lens' ListVoiceConnectorTerminationCredentials Text Source #

The Amazon Chime Voice Connector ID.

listVoiceConnectorTerminationCredentialsResponse_usernames :: Lens' ListVoiceConnectorTerminationCredentialsResponse (Maybe [Text]) Source #

A list of user names.

listVoiceConnectorTerminationCredentialsResponse_httpStatus :: Lens' ListVoiceConnectorTerminationCredentialsResponse Int Source #

The response's http status code.

CreateMediaCapturePipeline

createMediaCapturePipeline_chimeSdkMeetingConfiguration :: Lens' CreateMediaCapturePipeline (Maybe ChimeSdkMeetingConfiguration) Source #

The configuration for a specified media capture pipeline. SourceType must be ChimeSdkMeeting.

createMediaCapturePipeline_clientRequestToken :: Lens' CreateMediaCapturePipeline (Maybe Text) Source #

The token assigned to the client making the pipeline request.

createMediaCapturePipeline_sourceType :: Lens' CreateMediaCapturePipeline MediaPipelineSourceType Source #

Source type from which the media artifacts will be captured. A Chime SDK Meeting is the only supported source.

createMediaCapturePipeline_sourceArn :: Lens' CreateMediaCapturePipeline Text Source #

ARN of the source from which the media artifacts are captured.

createMediaCapturePipeline_sinkType :: Lens' CreateMediaCapturePipeline MediaPipelineSinkType Source #

Destination type to which the media artifacts are saved. You must use an S3 bucket.

createMediaCapturePipeline_sinkArn :: Lens' CreateMediaCapturePipeline Text Source #

The ARN of the sink type.

createMediaCapturePipelineResponse_mediaCapturePipeline :: Lens' CreateMediaCapturePipelineResponse (Maybe MediaCapturePipeline) Source #

A media capture pipeline object, the ID, source type, source ARN, sink type, and sink ARN of a media capture pipeline object.

createMediaCapturePipelineResponse_httpStatus :: Lens' CreateMediaCapturePipelineResponse Int Source #

The response's http status code.

CreateProxySession

createProxySession_numberSelectionBehavior :: Lens' CreateProxySession (Maybe NumberSelectionBehavior) Source #

The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.

createProxySession_geoMatchParams :: Lens' CreateProxySession (Maybe GeoMatchParams) Source #

The country and area code for the proxy phone number.

createProxySession_expiryMinutes :: Lens' CreateProxySession (Maybe Natural) Source #

The number of minutes allowed for the proxy session.

createProxySession_name :: Lens' CreateProxySession (Maybe Text) Source #

The name of the proxy session.

createProxySession_geoMatchLevel :: Lens' CreateProxySession (Maybe GeoMatchLevel) Source #

The preference for matching the country or area code of the proxy phone number with that of the first participant.

createProxySession_participantPhoneNumbers :: Lens' CreateProxySession (NonEmpty Text) Source #

The participant phone numbers.

createProxySession_capabilities :: Lens' CreateProxySession [Capability] Source #

The proxy session capabilities.

createProxySession_voiceConnectorId :: Lens' CreateProxySession Text Source #

The Amazon Chime voice connector ID.

createProxySessionResponse_proxySession :: Lens' CreateProxySessionResponse (Maybe ProxySession) Source #

The proxy session details.

createProxySessionResponse_httpStatus :: Lens' CreateProxySessionResponse Int Source #

The response's http status code.

DeleteEventsConfiguration

deleteEventsConfiguration_accountId :: Lens' DeleteEventsConfiguration Text Source #

The Amazon Chime account ID.

deleteEventsConfiguration_botId :: Lens' DeleteEventsConfiguration Text Source #

The bot ID.

PutEventsConfiguration

putEventsConfiguration_lambdaFunctionArn :: Lens' PutEventsConfiguration (Maybe Text) Source #

Lambda function ARN that allows the bot to receive outgoing events.

putEventsConfiguration_outboundEventsHTTPSEndpoint :: Lens' PutEventsConfiguration (Maybe Text) Source #

HTTPS endpoint that allows the bot to receive outgoing events.

putEventsConfiguration_accountId :: Lens' PutEventsConfiguration Text Source #

The Amazon Chime account ID.

putEventsConfiguration_botId :: Lens' PutEventsConfiguration Text Source #

The bot ID.

putEventsConfigurationResponse_eventsConfiguration :: Lens' PutEventsConfigurationResponse (Maybe EventsConfiguration) Source #

Undocumented member.

putEventsConfigurationResponse_httpStatus :: Lens' PutEventsConfigurationResponse Int Source #

The response's http status code.

GetChannelMessage

getChannelMessage_chimeBearer :: Lens' GetChannelMessage (Maybe Text) Source #

The AppInstanceUserArn of the user that makes the API call.

getChannelMessage_channelArn :: Lens' GetChannelMessage Text Source #

The ARN of the channel.

getChannelMessage_messageId :: Lens' GetChannelMessage Text Source #

The ID of the message.

getChannelMessageResponse_channelMessage :: Lens' GetChannelMessageResponse (Maybe ChannelMessage) Source #

The details of and content in the message.

getChannelMessageResponse_httpStatus :: Lens' GetChannelMessageResponse Int Source #

The response's http status code.

UpdateRoom

updateRoom_name :: Lens' UpdateRoom (Maybe Text) Source #

The room name.

updateRoom_accountId :: Lens' UpdateRoom Text Source #

The Amazon Chime account ID.

updateRoom_roomId :: Lens' UpdateRoom Text Source #

The room ID.

updateRoomResponse_room :: Lens' UpdateRoomResponse (Maybe Room) Source #

The room details.

updateRoomResponse_httpStatus :: Lens' UpdateRoomResponse Int Source #

The response's http status code.

DeleteRoom

deleteRoom_accountId :: Lens' DeleteRoom Text Source #

The Amazon Chime account ID.

deleteRoom_roomId :: Lens' DeleteRoom Text Source #

The chat room ID.

PutSipMediaApplicationLoggingConfiguration

putSipMediaApplicationLoggingConfiguration_sipMediaApplicationLoggingConfiguration :: Lens' PutSipMediaApplicationLoggingConfiguration (Maybe SipMediaApplicationLoggingConfiguration) Source #

The actual logging configuration.

putSipMediaApplicationLoggingConfiguration_sipMediaApplicationId :: Lens' PutSipMediaApplicationLoggingConfiguration Text Source #

The SIP media application ID.

putSipMediaApplicationLoggingConfigurationResponse_sipMediaApplicationLoggingConfiguration :: Lens' PutSipMediaApplicationLoggingConfigurationResponse (Maybe SipMediaApplicationLoggingConfiguration) Source #

Undocumented member.

putSipMediaApplicationLoggingConfigurationResponse_httpStatus :: Lens' PutSipMediaApplicationLoggingConfigurationResponse Int Source #

The response's http status code.

DescribeChannelMembershipForAppInstanceUser

describeChannelMembershipForAppInstanceUser_chimeBearer :: Lens' DescribeChannelMembershipForAppInstanceUser (Maybe Text) Source #

The AppInstanceUserArn of the user that makes the API call.

describeChannelMembershipForAppInstanceUser_channelArn :: Lens' DescribeChannelMembershipForAppInstanceUser Text Source #

The ARN of the channel to which the user belongs.

describeChannelMembershipForAppInstanceUser_appInstanceUserArn :: Lens' DescribeChannelMembershipForAppInstanceUser Text Source #

The ARN of the user in a channel.

describeChannelMembershipForAppInstanceUserResponse_channelMembership :: Lens' DescribeChannelMembershipForAppInstanceUserResponse (Maybe ChannelMembershipForAppInstanceUserSummary) Source #

The channel to which a user belongs.

describeChannelMembershipForAppInstanceUserResponse_httpStatus :: Lens' DescribeChannelMembershipForAppInstanceUserResponse Int Source #

The response's http status code.

ListAppInstanceAdmins

listAppInstanceAdmins_nextToken :: Lens' ListAppInstanceAdmins (Maybe Text) Source #

The token returned from previous API requests until the number of administrators is reached.

listAppInstanceAdmins_maxResults :: Lens' ListAppInstanceAdmins (Maybe Natural) Source #

The maximum number of administrators that you want to return.

listAppInstanceAdmins_appInstanceArn :: Lens' ListAppInstanceAdmins Text Source #

The ARN of the AppInstance.

listAppInstanceAdminsResponse_nextToken :: Lens' ListAppInstanceAdminsResponse (Maybe Text) Source #

The token returned from previous API requests until the number of administrators is reached.

listAppInstanceAdminsResponse_appInstanceAdmins :: Lens' ListAppInstanceAdminsResponse (Maybe [AppInstanceAdminSummary]) Source #

The information for each administrator.

listAppInstanceAdminsResponse_appInstanceArn :: Lens' ListAppInstanceAdminsResponse (Maybe Text) Source #

The ARN of the AppInstance.

listAppInstanceAdminsResponse_httpStatus :: Lens' ListAppInstanceAdminsResponse Int Source #

The response's http status code.

DeletePhoneNumber

deletePhoneNumber_phoneNumberId :: Lens' DeletePhoneNumber Text Source #

The phone number ID.

UpdatePhoneNumber

updatePhoneNumber_productType :: Lens' UpdatePhoneNumber (Maybe PhoneNumberProductType) Source #

The product type.

updatePhoneNumber_callingName :: Lens' UpdatePhoneNumber (Maybe Text) Source #

The outbound calling name associated with the phone number.

updatePhoneNumber_phoneNumberId :: Lens' UpdatePhoneNumber Text Source #

The phone number ID.

updatePhoneNumberResponse_phoneNumber :: Lens' UpdatePhoneNumberResponse (Maybe PhoneNumber) Source #

The updated phone number details.

updatePhoneNumberResponse_httpStatus :: Lens' UpdatePhoneNumberResponse Int Source #

The response's http status code.

ListPhoneNumbers

listPhoneNumbers_status :: Lens' ListPhoneNumbers (Maybe PhoneNumberStatus) Source #

The phone number status.

listPhoneNumbers_filterName :: Lens' ListPhoneNumbers (Maybe PhoneNumberAssociationName) Source #

The filter to use to limit the number of results.

listPhoneNumbers_productType :: Lens' ListPhoneNumbers (Maybe PhoneNumberProductType) Source #

The phone number product type.

listPhoneNumbers_nextToken :: Lens' ListPhoneNumbers (Maybe Text) Source #

The token to use to retrieve the next page of results.

listPhoneNumbers_filterValue :: Lens' ListPhoneNumbers (Maybe Text) Source #

The value to use for the filter.

listPhoneNumbers_maxResults :: Lens' ListPhoneNumbers (Maybe Natural) Source #

The maximum number of results to return in a single call.

listPhoneNumbersResponse_nextToken :: Lens' ListPhoneNumbersResponse (Maybe Text) Source #

The token to use to retrieve the next page of results.

listPhoneNumbersResponse_phoneNumbers :: Lens' ListPhoneNumbersResponse (Maybe [PhoneNumber]) Source #

The phone number details.

listPhoneNumbersResponse_httpStatus :: Lens' ListPhoneNumbersResponse Int Source #

The response's http status code.

CreateChannelModerator

createChannelModerator_chimeBearer :: Lens' CreateChannelModerator (Maybe Text) Source #

The AppInstanceUserArn of the user that makes the API call.

createChannelModerator_channelArn :: Lens' CreateChannelModerator Text Source #

The ARN of the channel.

createChannelModerator_channelModeratorArn :: Lens' CreateChannelModerator Text Source #

The ARN of the moderator.

createChannelModeratorResponse_channelModerator :: Lens' CreateChannelModeratorResponse (Maybe Identity) Source #

The ARNs of the channel and the moderator.

createChannelModeratorResponse_channelArn :: Lens' CreateChannelModeratorResponse (Maybe Text) Source #

The ARN of the channel.

createChannelModeratorResponse_httpStatus :: Lens' CreateChannelModeratorResponse Int Source #

The response's http status code.

GetAppInstanceStreamingConfigurations

getAppInstanceStreamingConfigurations_appInstanceArn :: Lens' GetAppInstanceStreamingConfigurations Text Source #

The ARN of the AppInstance.

getAppInstanceStreamingConfigurationsResponse_appInstanceStreamingConfigurations :: Lens' GetAppInstanceStreamingConfigurationsResponse (Maybe (NonEmpty AppInstanceStreamingConfiguration)) Source #

The streaming settings.

getAppInstanceStreamingConfigurationsResponse_httpStatus :: Lens' GetAppInstanceStreamingConfigurationsResponse Int Source #

The response's http status code.

ListAppInstances

listAppInstances_nextToken :: Lens' ListAppInstances (Maybe Text) Source #

The token passed by previous API requests until you reach the maximum number of AppInstances.

listAppInstances_maxResults :: Lens' ListAppInstances (Maybe Natural) Source #

The maximum number of AppInstances that you want to return.

listAppInstancesResponse_appInstances :: Lens' ListAppInstancesResponse (Maybe [AppInstanceSummary]) Source #

The information for each AppInstance.

listAppInstancesResponse_nextToken :: Lens' ListAppInstancesResponse (Maybe Text) Source #

The token passed by previous API requests until the maximum number of AppInstances is reached.

listAppInstancesResponse_httpStatus :: Lens' ListAppInstancesResponse Int Source #

The response's http status code.

DescribeChannelModeratedByAppInstanceUser

describeChannelModeratedByAppInstanceUser_chimeBearer :: Lens' DescribeChannelModeratedByAppInstanceUser (Maybe Text) Source #

The AppInstanceUserArn of the user that makes the API call.

describeChannelModeratedByAppInstanceUser_channelArn :: Lens' DescribeChannelModeratedByAppInstanceUser Text Source #

The ARN of the moderated channel.

describeChannelModeratedByAppInstanceUser_appInstanceUserArn :: Lens' DescribeChannelModeratedByAppInstanceUser Text Source #

The ARN of the AppInstanceUser in the moderated channel.

describeChannelModeratedByAppInstanceUserResponse_channel :: Lens' DescribeChannelModeratedByAppInstanceUserResponse (Maybe ChannelModeratedByAppInstanceUserSummary) Source #

The moderated channel.

describeChannelModeratedByAppInstanceUserResponse_httpStatus :: Lens' DescribeChannelModeratedByAppInstanceUserResponse Int Source #

The response's http status code.

GetPhoneNumber

getPhoneNumber_phoneNumberId :: Lens' GetPhoneNumber Text Source #

The phone number ID.

getPhoneNumberResponse_phoneNumber :: Lens' GetPhoneNumberResponse (Maybe PhoneNumber) Source #

The phone number details.

getPhoneNumberResponse_httpStatus :: Lens' GetPhoneNumberResponse Int Source #

The response's http status code.

GetEventsConfiguration

getEventsConfiguration_accountId :: Lens' GetEventsConfiguration Text Source #

The Amazon Chime account ID.

getEventsConfiguration_botId :: Lens' GetEventsConfiguration Text Source #

The bot ID.

getEventsConfigurationResponse_eventsConfiguration :: Lens' GetEventsConfigurationResponse (Maybe EventsConfiguration) Source #

The events configuration details.

getEventsConfigurationResponse_httpStatus :: Lens' GetEventsConfigurationResponse Int Source #

The response's http status code.

GetSipMediaApplicationLoggingConfiguration

getSipMediaApplicationLoggingConfiguration_sipMediaApplicationId :: Lens' GetSipMediaApplicationLoggingConfiguration Text Source #

The SIP media application ID.

getSipMediaApplicationLoggingConfigurationResponse_sipMediaApplicationLoggingConfiguration :: Lens' GetSipMediaApplicationLoggingConfigurationResponse (Maybe SipMediaApplicationLoggingConfiguration) Source #

The actual logging configuration.

getSipMediaApplicationLoggingConfigurationResponse_httpStatus :: Lens' GetSipMediaApplicationLoggingConfigurationResponse Int Source #

The response's http status code.

BatchUpdateUser

batchUpdateUser_accountId :: Lens' BatchUpdateUser Text Source #

The Amazon Chime account ID.

batchUpdateUser_updateUserRequestItems :: Lens' BatchUpdateUser [UpdateUserRequestItem] Source #

The request containing the user IDs and details to update.

batchUpdateUserResponse_userErrors :: Lens' BatchUpdateUserResponse (Maybe [UserError]) Source #

If the BatchUpdateUser action fails for one or more of the user IDs in the request, a list of the user IDs is returned, along with error codes and error messages.

batchUpdateUserResponse_httpStatus :: Lens' BatchUpdateUserResponse Int Source #

The response's http status code.

SendChannelMessage

sendChannelMessage_chimeBearer :: Lens' SendChannelMessage (Maybe Text) Source #

The AppInstanceUserArn of the user that makes the API call.

sendChannelMessage_metadata :: Lens' SendChannelMessage (Maybe Text) Source #

The optional metadata for each message.

sendChannelMessage_channelArn :: Lens' SendChannelMessage Text Source #

The ARN of the channel.

sendChannelMessage_content :: Lens' SendChannelMessage Text Source #

The content of the message.

sendChannelMessage_type :: Lens' SendChannelMessage ChannelMessageType Source #

The type of message, STANDARD or CONTROL.

sendChannelMessage_persistence :: Lens' SendChannelMessage ChannelMessagePersistenceType Source #

Boolean that controls whether the message is persisted on the back end. Required.

sendChannelMessage_clientRequestToken :: Lens' SendChannelMessage Text Source #

The Idempotency token for each client request.

sendChannelMessageResponse_channelArn :: Lens' SendChannelMessageResponse (Maybe Text) Source #

The ARN of the channel.

sendChannelMessageResponse_messageId :: Lens' SendChannelMessageResponse (Maybe Text) Source #

The ID string assigned to each message.

sendChannelMessageResponse_httpStatus :: Lens' SendChannelMessageResponse Int Source #

The response's http status code.

TagAttendee

tagAttendee_meetingId :: Lens' TagAttendee Text Source #

The Amazon Chime SDK meeting ID.

tagAttendee_attendeeId :: Lens' TagAttendee Text Source #

The Amazon Chime SDK attendee ID.

tagAttendee_tags :: Lens' TagAttendee (NonEmpty Tag) Source #

The tag key-value pairs.

UpdateVoiceConnector

updateVoiceConnector_voiceConnectorId :: Lens' UpdateVoiceConnector Text Source #

The Amazon Chime Voice Connector ID.

updateVoiceConnector_name :: Lens' UpdateVoiceConnector Text Source #

The name of the Amazon Chime Voice Connector.

updateVoiceConnector_requireEncryption :: Lens' UpdateVoiceConnector Bool Source #

When enabled, requires encryption for the Amazon Chime Voice Connector.

updateVoiceConnectorResponse_voiceConnector :: Lens' UpdateVoiceConnectorResponse (Maybe VoiceConnector) Source #

The updated Amazon Chime Voice Connector details.

updateVoiceConnectorResponse_httpStatus :: Lens' UpdateVoiceConnectorResponse Int Source #

The response's http status code.

DeleteVoiceConnector

deleteVoiceConnector_voiceConnectorId :: Lens' DeleteVoiceConnector Text Source #

The Amazon Chime Voice Connector ID.

GetMediaCapturePipeline

getMediaCapturePipeline_mediaPipelineId :: Lens' GetMediaCapturePipeline Text Source #

The ID of the pipeline that you want to get.

getMediaCapturePipelineResponse_mediaCapturePipeline :: Lens' GetMediaCapturePipelineResponse (Maybe MediaCapturePipeline) Source #

The media capture pipeline object.

getMediaCapturePipelineResponse_httpStatus :: Lens' GetMediaCapturePipelineResponse Int Source #

The response's http status code.

UpdateRoomMembership

updateRoomMembership_role :: Lens' UpdateRoomMembership (Maybe RoomMembershipRole) Source #

The role of the member.

updateRoomMembership_accountId :: Lens' UpdateRoomMembership Text Source #

The Amazon Chime account ID.

updateRoomMembership_roomId :: Lens' UpdateRoomMembership Text Source #

The room ID.

updateRoomMembership_memberId :: Lens' UpdateRoomMembership Text Source #

The member ID.

updateRoomMembershipResponse_roomMembership :: Lens' UpdateRoomMembershipResponse (Maybe RoomMembership) Source #

The room membership details.

updateRoomMembershipResponse_httpStatus :: Lens' UpdateRoomMembershipResponse Int Source #

The response's http status code.

GetProxySession

getProxySession_voiceConnectorId :: Lens' GetProxySession Text Source #

The Amazon Chime voice connector ID.

getProxySession_proxySessionId :: Lens' GetProxySession Text Source #

The proxy session ID.

getProxySessionResponse_proxySession :: Lens' GetProxySessionResponse (Maybe ProxySession) Source #

The proxy session details.

getProxySessionResponse_httpStatus :: Lens' GetProxySessionResponse Int Source #

The response's http status code.

DeleteRoomMembership

deleteRoomMembership_accountId :: Lens' DeleteRoomMembership Text Source #

The Amazon Chime account ID.

deleteRoomMembership_roomId :: Lens' DeleteRoomMembership Text Source #

The room ID.

deleteRoomMembership_memberId :: Lens' DeleteRoomMembership Text Source #

The member ID (user ID or bot ID).

DescribeAppInstanceUser

describeAppInstanceUser_appInstanceUserArn :: Lens' DescribeAppInstanceUser Text Source #

The ARN of the AppInstanceUser.

describeAppInstanceUserResponse_appInstanceUser :: Lens' DescribeAppInstanceUserResponse (Maybe AppInstanceUser) Source #

The name of the AppInstanceUser.

describeAppInstanceUserResponse_httpStatus :: Lens' DescribeAppInstanceUserResponse Int Source #

The response's http status code.

BatchUnsuspendUser

batchUnsuspendUser_accountId :: Lens' BatchUnsuspendUser Text Source #

The Amazon Chime account ID.

batchUnsuspendUser_userIdList :: Lens' BatchUnsuspendUser [Text] Source #

The request containing the user IDs to unsuspend.

batchUnsuspendUserResponse_userErrors :: Lens' BatchUnsuspendUserResponse (Maybe [UserError]) Source #

If the BatchUnsuspendUser action fails for one or more of the user IDs in the request, a list of the user IDs is returned, along with error codes and error messages.

batchUnsuspendUserResponse_httpStatus :: Lens' BatchUnsuspendUserResponse Int Source #

The response's http status code.

DeleteChannelBan

deleteChannelBan_chimeBearer :: Lens' DeleteChannelBan (Maybe Text) Source #

The AppInstanceUserArn of the user that makes the API call.

deleteChannelBan_channelArn :: Lens' DeleteChannelBan Text Source #

The ARN of the channel from which the AppInstanceUser was banned.

deleteChannelBan_memberArn :: Lens' DeleteChannelBan Text Source #

The ARN of the AppInstanceUser that you want to reinstate.

GetMeeting

getMeeting_meetingId :: Lens' GetMeeting Text Source #

The Amazon Chime SDK meeting ID.

getMeetingResponse_meeting :: Lens' GetMeetingResponse (Maybe Meeting) Source #

The Amazon Chime SDK meeting information.

getMeetingResponse_httpStatus :: Lens' GetMeetingResponse Int Source #

The response's http status code.

RestorePhoneNumber

restorePhoneNumber_phoneNumberId :: Lens' RestorePhoneNumber Text Source #

The phone number.

restorePhoneNumberResponse_phoneNumber :: Lens' RestorePhoneNumberResponse (Maybe PhoneNumber) Source #

The phone number details.

restorePhoneNumberResponse_httpStatus :: Lens' RestorePhoneNumberResponse Int Source #

The response's http status code.

GetRetentionSettings

getRetentionSettings_accountId :: Lens' GetRetentionSettings Text Source #

The Amazon Chime account ID.

getRetentionSettingsResponse_retentionSettings :: Lens' GetRetentionSettingsResponse (Maybe RetentionSettings) Source #

The retention settings.

getRetentionSettingsResponse_initiateDeletionTimestamp :: Lens' GetRetentionSettingsResponse (Maybe UTCTime) Source #

The timestamp representing the time at which the specified items are permanently deleted, in ISO 8601 format.

getRetentionSettingsResponse_httpStatus :: Lens' GetRetentionSettingsResponse Int Source #

The response's http status code.

GetBot

getBot_accountId :: Lens' GetBot Text Source #

The Amazon Chime account ID.

getBot_botId :: Lens' GetBot Text Source #

The bot ID.

getBotResponse_bot :: Lens' GetBotResponse (Maybe Bot) Source #

The chat bot details.

getBotResponse_httpStatus :: Lens' GetBotResponse Int Source #

The response's http status code.

GetUser

getUser_accountId :: Lens' GetUser Text Source #

The Amazon Chime account ID.

getUser_userId :: Lens' GetUser Text Source #

The user ID.

getUserResponse_user :: Lens' GetUserResponse (Maybe User) Source #

The user details.

getUserResponse_httpStatus :: Lens' GetUserResponse Int Source #

The response's http status code.

UntagAttendee

untagAttendee_meetingId :: Lens' UntagAttendee Text Source #

The Amazon Chime SDK meeting ID.

untagAttendee_tagKeys :: Lens' UntagAttendee (NonEmpty Text) Source #

The tag keys.

untagAttendee_attendeeId :: Lens' UntagAttendee Text Source #

The Amazon Chime SDK attendee ID.

StartMeetingTranscription

startMeetingTranscription_meetingId :: Lens' StartMeetingTranscription Text Source #

The unique ID of the meeting being transcribed.

startMeetingTranscription_transcriptionConfiguration :: Lens' StartMeetingTranscription TranscriptionConfiguration Source #

The configuration for the current transcription operation. Must contain EngineTranscribeSettings or EngineTranscribeMedicalSettings.

startMeetingTranscriptionResponse_httpStatus :: Lens' StartMeetingTranscriptionResponse Int Source #

The response's http status code.

ListChannelBans

listChannelBans_chimeBearer :: Lens' ListChannelBans (Maybe Text) Source #

The AppInstanceUserArn of the user that makes the API call.

listChannelBans_nextToken :: Lens' ListChannelBans (Maybe Text) Source #

The token passed by previous API calls until all requested bans are returned.

listChannelBans_maxResults :: Lens' ListChannelBans (Maybe Natural) Source #

The maximum number of bans that you want returned.

listChannelBans_channelArn :: Lens' ListChannelBans Text Source #

The ARN of the channel.

listChannelBansResponse_channelArn :: Lens' ListChannelBansResponse (Maybe Text) Source #

The ARN of the channel.

listChannelBansResponse_nextToken :: Lens' ListChannelBansResponse (Maybe Text) Source #

The token passed by previous API calls until all requested bans are returned.

listChannelBansResponse_channelBans :: Lens' ListChannelBansResponse (Maybe [ChannelBanSummary]) Source #

The information for each requested ban.

listChannelBansResponse_httpStatus :: Lens' ListChannelBansResponse Int Source #

The response's http status code.

CreateChannel

createChannel_mode :: Lens' CreateChannel (Maybe ChannelMode) Source #

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.

createChannel_privacy :: Lens' CreateChannel (Maybe ChannelPrivacy) Source #

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.

createChannel_chimeBearer :: Lens' CreateChannel (Maybe Text) Source #

The AppInstanceUserArn of the user that makes the API call.

createChannel_metadata :: Lens' CreateChannel (Maybe Text) Source #

The metadata of the creation request. Limited to 1KB and UTF-8.

createChannel_tags :: Lens' CreateChannel (Maybe (NonEmpty Tag)) Source #

The tags for the creation request.

createChannel_appInstanceArn :: Lens' CreateChannel Text Source #

The ARN of the channel request.

createChannel_name :: Lens' CreateChannel Text Source #

The name of the channel.

createChannel_clientRequestToken :: Lens' CreateChannel Text Source #

The client token for the request. An Idempotency token.

createChannelResponse_channelArn :: Lens' CreateChannelResponse (Maybe Text) Source #

The ARN of the channel.

createChannelResponse_httpStatus :: Lens' CreateChannelResponse Int Source #

The response's http status code.

BatchSuspendUser

batchSuspendUser_accountId :: Lens' BatchSuspendUser Text Source #

The Amazon Chime account ID.

batchSuspendUser_userIdList :: Lens' BatchSuspendUser [Text] Source #

The request containing the user IDs to suspend.

batchSuspendUserResponse_userErrors :: Lens' BatchSuspendUserResponse (Maybe [UserError]) Source #

If the BatchSuspendUser action fails for one or more of the user IDs in the request, a list of the user IDs is returned, along with error codes and error messages.

batchSuspendUserResponse_httpStatus :: Lens' BatchSuspendUserResponse Int Source #

The response's http status code.

GetAccount

getAccount_accountId :: Lens' GetAccount Text Source #

The Amazon Chime account ID.

getAccountResponse_account :: Lens' GetAccountResponse (Maybe Account) Source #

The Amazon Chime account details.

getAccountResponse_httpStatus :: Lens' GetAccountResponse Int Source #

The response's http status code.

DescribeChannelModerator

describeChannelModerator_chimeBearer :: Lens' DescribeChannelModerator (Maybe Text) Source #

The AppInstanceUserArn of the user that makes the API call.

describeChannelModerator_channelArn :: Lens' DescribeChannelModerator Text Source #

The ARN of the channel.

describeChannelModerator_channelModeratorArn :: Lens' DescribeChannelModerator Text Source #

The ARN of the channel moderator.

describeChannelModeratorResponse_channelModerator :: Lens' DescribeChannelModeratorResponse (Maybe ChannelModerator) Source #

The details of the channel moderator.

describeChannelModeratorResponse_httpStatus :: Lens' DescribeChannelModeratorResponse Int Source #

The response's http status code.

AssociatePhoneNumbersWithVoiceConnector

associatePhoneNumbersWithVoiceConnector_forceAssociate :: Lens' AssociatePhoneNumbersWithVoiceConnector (Maybe Bool) Source #

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.

associatePhoneNumbersWithVoiceConnector_voiceConnectorId :: Lens' AssociatePhoneNumbersWithVoiceConnector Text Source #

The Amazon Chime Voice Connector ID.

associatePhoneNumbersWithVoiceConnector_e164PhoneNumbers :: Lens' AssociatePhoneNumbersWithVoiceConnector [Text] Source #

List of phone numbers, in E.164 format.

associatePhoneNumbersWithVoiceConnectorResponse_phoneNumberErrors :: Lens' AssociatePhoneNumbersWithVoiceConnectorResponse (Maybe [PhoneNumberError]) Source #

If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.

associatePhoneNumbersWithVoiceConnectorResponse_httpStatus :: Lens' AssociatePhoneNumbersWithVoiceConnectorResponse Int Source #

The response's http status code.

GetPhoneNumberOrder

getPhoneNumberOrder_phoneNumberOrderId :: Lens' GetPhoneNumberOrder Text Source #

The ID for the phone number order.

getPhoneNumberOrderResponse_phoneNumberOrder :: Lens' GetPhoneNumberOrderResponse (Maybe PhoneNumberOrder) Source #

The phone number order details.

getPhoneNumberOrderResponse_httpStatus :: Lens' GetPhoneNumberOrderResponse Int Source #

The response's http status code.

GetSipRule

getSipRule_sipRuleId :: Lens' GetSipRule Text Source #

The SIP rule ID.

getSipRuleResponse_sipRule :: Lens' GetSipRuleResponse (Maybe SipRule) Source #

The SIP rule details.

getSipRuleResponse_httpStatus :: Lens' GetSipRuleResponse Int Source #

The response's http status code.

GetUserSettings

getUserSettings_accountId :: Lens' GetUserSettings Text Source #

The Amazon Chime account ID.

getUserSettings_userId :: Lens' GetUserSettings Text Source #

The user ID.

getUserSettingsResponse_userSettings :: Lens' GetUserSettingsResponse (Maybe UserSettings) Source #

The user settings.

getUserSettingsResponse_httpStatus :: Lens' GetUserSettingsResponse Int Source #

The response's http status code.

GetSipMediaApplication

getSipMediaApplication_sipMediaApplicationId :: Lens' GetSipMediaApplication Text Source #

The SIP media application ID.

getSipMediaApplicationResponse_sipMediaApplication :: Lens' GetSipMediaApplicationResponse (Maybe SipMediaApplication) Source #

The SIP media application details.

getSipMediaApplicationResponse_httpStatus :: Lens' GetSipMediaApplicationResponse Int Source #

The response's http status code.

GetAccountSettings

getAccountSettings_accountId :: Lens' GetAccountSettings Text Source #

The Amazon Chime account ID.

getAccountSettingsResponse_accountSettings :: Lens' GetAccountSettingsResponse (Maybe AccountSettings) Source #

The Amazon Chime account settings.

getAccountSettingsResponse_httpStatus :: Lens' GetAccountSettingsResponse Int Source #

The response's http status code.

CreateChannelBan

createChannelBan_chimeBearer :: Lens' CreateChannelBan (Maybe Text) Source #

The AppInstanceUserArn of the user that makes the API call.

createChannelBan_channelArn :: Lens' CreateChannelBan Text Source #

The ARN of the ban request.

createChannelBan_memberArn :: Lens' CreateChannelBan Text Source #

The ARN of the member being banned.

createChannelBanResponse_channelArn :: Lens' CreateChannelBanResponse (Maybe Text) Source #

The ARN of the response to the ban request.

createChannelBanResponse_member :: Lens' CreateChannelBanResponse (Maybe Identity) Source #

The ChannelArn and BannedIdentity of the member in the ban response.

createChannelBanResponse_httpStatus :: Lens' CreateChannelBanResponse Int Source #

The response's http status code.

ListMeetingTags

listMeetingTags_meetingId :: Lens' ListMeetingTags Text Source #

The Amazon Chime SDK meeting ID.

listMeetingTagsResponse_tags :: Lens' ListMeetingTagsResponse (Maybe (NonEmpty Tag)) Source #

A list of tag key-value pairs.

listMeetingTagsResponse_httpStatus :: Lens' ListMeetingTagsResponse Int Source #

The response's http status code.

ListChannelMembershipsForAppInstanceUser

listChannelMembershipsForAppInstanceUser_appInstanceUserArn :: Lens' ListChannelMembershipsForAppInstanceUser (Maybe Text) Source #

The ARN of the AppInstanceUsers

listChannelMembershipsForAppInstanceUser_chimeBearer :: Lens' ListChannelMembershipsForAppInstanceUser (Maybe Text) Source #

The AppInstanceUserArn of the user that makes the API call.

listChannelMembershipsForAppInstanceUser_nextToken :: Lens' ListChannelMembershipsForAppInstanceUser (Maybe Text) Source #

The token returned from previous API requests until the number of channel memberships is reached.

listChannelMembershipsForAppInstanceUser_maxResults :: Lens' ListChannelMembershipsForAppInstanceUser (Maybe Natural) Source #

The maximum number of users that you want returned.

listChannelMembershipsForAppInstanceUserResponse_channelMemberships :: Lens' ListChannelMembershipsForAppInstanceUserResponse (Maybe [ChannelMembershipForAppInstanceUserSummary]) Source #

The token passed by previous API calls until all requested users are returned.

listChannelMembershipsForAppInstanceUserResponse_nextToken :: Lens' ListChannelMembershipsForAppInstanceUserResponse (Maybe Text) Source #

The token passed by previous API calls until all requested users are returned.

listChannelMembershipsForAppInstanceUserResponse_httpStatus :: Lens' ListChannelMembershipsForAppInstanceUserResponse Int Source #

The response's http status code.

GetVoiceConnectorOrigination

getVoiceConnectorOrigination_voiceConnectorId :: Lens' GetVoiceConnectorOrigination Text Source #

The Amazon Chime Voice Connector ID.

getVoiceConnectorOriginationResponse_origination :: Lens' GetVoiceConnectorOriginationResponse (Maybe Origination) Source #

The origination setting details.

getVoiceConnectorOriginationResponse_httpStatus :: Lens' GetVoiceConnectorOriginationResponse Int Source #

The response's http status code.

BatchUpdatePhoneNumber

batchUpdatePhoneNumber_updatePhoneNumberRequestItems :: Lens' BatchUpdatePhoneNumber [UpdatePhoneNumberRequestItem] Source #

The request containing the phone number IDs and product types or calling names to update.

batchUpdatePhoneNumberResponse_phoneNumberErrors :: Lens' BatchUpdatePhoneNumberResponse (Maybe [PhoneNumberError]) Source #

If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.

batchUpdatePhoneNumberResponse_httpStatus :: Lens' BatchUpdatePhoneNumberResponse Int Source #

The response's http status code.

DisassociatePhoneNumbersFromVoiceConnectorGroup

disassociatePhoneNumbersFromVoiceConnectorGroup_voiceConnectorGroupId :: Lens' DisassociatePhoneNumbersFromVoiceConnectorGroup Text Source #

The Amazon Chime Voice Connector group ID.

disassociatePhoneNumbersFromVoiceConnectorGroup_e164PhoneNumbers :: Lens' DisassociatePhoneNumbersFromVoiceConnectorGroup [Text] Source #

List of phone numbers, in E.164 format.

disassociatePhoneNumbersFromVoiceConnectorGroupResponse_phoneNumberErrors :: Lens' DisassociatePhoneNumbersFromVoiceConnectorGroupResponse (Maybe [PhoneNumberError]) Source #

If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.

disassociatePhoneNumbersFromVoiceConnectorGroupResponse_httpStatus :: Lens' DisassociatePhoneNumbersFromVoiceConnectorGroupResponse Int Source #

The response's http status code.

UpdateChannelReadMarker

updateChannelReadMarker_chimeBearer :: Lens' UpdateChannelReadMarker (Maybe Text) Source #

The AppInstanceUserArn of the user that makes the API call.

updateChannelReadMarker_channelArn :: Lens' UpdateChannelReadMarker Text Source #

The ARN of the channel.

updateChannelReadMarkerResponse_channelArn :: Lens' UpdateChannelReadMarkerResponse (Maybe Text) Source #

The ARN of the channel.

updateChannelReadMarkerResponse_httpStatus :: Lens' UpdateChannelReadMarkerResponse Int Source #

The response's http status code.

CreateSipMediaApplicationCall

createSipMediaApplicationCall_sipHeaders :: Lens' CreateSipMediaApplicationCall (Maybe (HashMap Text Text)) Source #

The SIP headers added to an outbound call leg.

createSipMediaApplicationCall_fromPhoneNumber :: Lens' CreateSipMediaApplicationCall Text Source #

The phone number that a user calls from. This is a phone number in your Amazon Chime phone number inventory.

createSipMediaApplicationCall_toPhoneNumber :: Lens' CreateSipMediaApplicationCall Text Source #

The phone number that the service should call.

createSipMediaApplicationCall_sipMediaApplicationId :: Lens' CreateSipMediaApplicationCall Text Source #

The ID of the SIP media application.

createSipMediaApplicationCallResponse_sipMediaApplicationCall :: Lens' CreateSipMediaApplicationCallResponse (Maybe SipMediaApplicationCall) Source #

The actual call.

createSipMediaApplicationCallResponse_httpStatus :: Lens' CreateSipMediaApplicationCallResponse Int Source #

The response's http status code.

BatchDeletePhoneNumber

batchDeletePhoneNumber_phoneNumberIds :: Lens' BatchDeletePhoneNumber (NonEmpty Text) Source #

List of phone number IDs.

batchDeletePhoneNumberResponse_phoneNumberErrors :: Lens' BatchDeletePhoneNumberResponse (Maybe [PhoneNumberError]) Source #

If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.

batchDeletePhoneNumberResponse_httpStatus :: Lens' BatchDeletePhoneNumberResponse Int Source #

The response's http status code.

ListSipMediaApplications

listSipMediaApplications_nextToken :: Lens' ListSipMediaApplications (Maybe Text) Source #

The token to use to retrieve the next page of results.

listSipMediaApplications_maxResults :: Lens' ListSipMediaApplications (Maybe Natural) Source #

The maximum number of results to return in a single call. Defaults to 100.

listSipMediaApplicationsResponse_nextToken :: Lens' ListSipMediaApplicationsResponse (Maybe Text) Source #

The token to use to retrieve the next page of results.

listSipMediaApplicationsResponse_sipMediaApplications :: Lens' ListSipMediaApplicationsResponse (Maybe [SipMediaApplication]) Source #

List of SIP media applications and application details.

listSipMediaApplicationsResponse_httpStatus :: Lens' ListSipMediaApplicationsResponse Int Source #

The response's http status code.

CreateMeeting

createMeeting_mediaRegion :: Lens' CreateMeeting (Maybe Text) Source #

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 .

createMeeting_meetingHostId :: Lens' CreateMeeting (Maybe Text) Source #

Reserved.

createMeeting_notificationsConfiguration :: Lens' CreateMeeting (Maybe MeetingNotificationConfiguration) Source #

The configuration for resource targets to receive notifications when meeting and attendee events occur.

createMeeting_externalMeetingId :: Lens' CreateMeeting (Maybe Text) Source #

The external meeting ID.

createMeeting_tags :: Lens' CreateMeeting (Maybe (NonEmpty Tag)) Source #

The tag key-value pairs.

createMeeting_clientRequestToken :: Lens' CreateMeeting Text Source #

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

createMeetingResponse_meeting :: Lens' CreateMeetingResponse (Maybe Meeting) Source #

The meeting information, including the meeting ID and MediaPlacement .

createMeetingResponse_httpStatus :: Lens' CreateMeetingResponse Int Source #

The response's http status code.

CreatePhoneNumberOrder

createPhoneNumberOrder_productType :: Lens' CreatePhoneNumberOrder PhoneNumberProductType Source #

The phone number product type.

createPhoneNumberOrder_e164PhoneNumbers :: Lens' CreatePhoneNumberOrder [Text] Source #

List of phone numbers, in E.164 format.

createPhoneNumberOrderResponse_phoneNumberOrder :: Lens' CreatePhoneNumberOrderResponse (Maybe PhoneNumberOrder) Source #

The phone number order details.

createPhoneNumberOrderResponse_httpStatus :: Lens' CreatePhoneNumberOrderResponse Int Source #

The response's http status code.

ListSipRules

listSipRules_nextToken :: Lens' ListSipRules (Maybe Text) Source #

The token to use to retrieve the next page of results.

listSipRules_maxResults :: Lens' ListSipRules (Maybe Natural) Source #

The maximum number of results to return in a single call. Defaults to 100.

listSipRules_sipMediaApplicationId :: Lens' ListSipRules (Maybe Text) Source #

The SIP media application ID.

listSipRulesResponse_nextToken :: Lens' ListSipRulesResponse (Maybe Text) Source #

The token to use to retrieve the next page of results.

listSipRulesResponse_sipRules :: Lens' ListSipRulesResponse (Maybe [SipRule]) Source #

List of SIP rules and rule details.

listSipRulesResponse_httpStatus :: Lens' ListSipRulesResponse Int Source #

The response's http status code.

CreateBot

createBot_domain :: Lens' CreateBot (Maybe Text) Source #

The domain of the Amazon Chime Enterprise account.

createBot_displayName :: Lens' CreateBot Text Source #

The bot display name.

createBot_accountId :: Lens' CreateBot Text Source #

The Amazon Chime account ID.

createBotResponse_bot :: Lens' CreateBotResponse (Maybe Bot) Source #

The bot details.

createBotResponse_httpStatus :: Lens' CreateBotResponse Int Source #

The response's http status code.

UpdateUserSettings

updateUserSettings_accountId :: Lens' UpdateUserSettings Text Source #

The Amazon Chime account ID.

updateUserSettings_userId :: Lens' UpdateUserSettings Text Source #

The user ID.

updateUserSettings_userSettings :: Lens' UpdateUserSettings UserSettings Source #

The user settings to update.

CreateUser

createUser_email :: Lens' CreateUser (Maybe Text) Source #

The user's email address.

createUser_username :: Lens' CreateUser (Maybe Text) Source #

The user name.

createUser_userType :: Lens' CreateUser (Maybe UserType) Source #

The user type.

createUser_accountId :: Lens' CreateUser Text Source #

The Amazon Chime account ID.

createUserResponse_user :: Lens' CreateUserResponse (Maybe User) Source #

Undocumented member.

createUserResponse_httpStatus :: Lens' CreateUserResponse Int Source #

The response's http status code.

BatchCreateRoomMembership

batchCreateRoomMembership_accountId :: Lens' BatchCreateRoomMembership Text Source #

The Amazon Chime account ID.

batchCreateRoomMembership_roomId :: Lens' BatchCreateRoomMembership Text Source #

The room ID.

batchCreateRoomMembership_membershipItemList :: Lens' BatchCreateRoomMembership [MembershipItem] Source #

The list of membership items.

batchCreateRoomMembershipResponse_errors :: Lens' BatchCreateRoomMembershipResponse (Maybe [MemberError]) Source #

If the action fails for one or more of the member IDs in the request, a list of the member IDs is returned, along with error codes and error messages.

batchCreateRoomMembershipResponse_httpStatus :: Lens' BatchCreateRoomMembershipResponse Int Source #

The response's http status code.

DescribeAppInstance

describeAppInstance_appInstanceArn :: Lens' DescribeAppInstance Text Source #

The ARN of the AppInstance.

describeAppInstanceResponse_appInstance :: Lens' DescribeAppInstanceResponse (Maybe AppInstance) Source #

The ARN, metadata, created and last-updated timestamps, and the name of the AppInstance. All timestamps use epoch milliseconds.

describeAppInstanceResponse_httpStatus :: Lens' DescribeAppInstanceResponse Int Source #

The response's http status code.

CreateAccount

createAccount_name :: Lens' CreateAccount Text Source #

The name of the Amazon Chime account.

createAccountResponse_account :: Lens' CreateAccountResponse (Maybe Account) Source #

The Amazon Chime account details.

createAccountResponse_httpStatus :: Lens' CreateAccountResponse Int Source #

The response's http status code.

CreateChannelMembership

createChannelMembership_chimeBearer :: Lens' CreateChannelMembership (Maybe Text) Source #

The AppInstanceUserArn of the user that makes the API call.

createChannelMembership_channelArn :: Lens' CreateChannelMembership Text Source #

The ARN of the channel to which you're adding users.

createChannelMembership_memberArn :: Lens' CreateChannelMembership Text Source #

The ARN of the member you want to add to the channel.

createChannelMembership_type :: Lens' CreateChannelMembership ChannelMembershipType Source #

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.

createChannelMembershipResponse_channelArn :: Lens' CreateChannelMembershipResponse (Maybe Text) Source #

The ARN of the channel.

createChannelMembershipResponse_member :: Lens' CreateChannelMembershipResponse (Maybe Identity) Source #

The ARN and metadata of the member being added.

createChannelMembershipResponse_httpStatus :: Lens' CreateChannelMembershipResponse Int Source #

The response's http status code.

DeleteVoiceConnectorTermination

deleteVoiceConnectorTermination_voiceConnectorId :: Lens' DeleteVoiceConnectorTermination Text Source #

The Amazon Chime Voice Connector ID.

AssociatePhoneNumberWithUser

associatePhoneNumberWithUser_accountId :: Lens' AssociatePhoneNumberWithUser Text Source #

The Amazon Chime account ID.

associatePhoneNumberWithUser_userId :: Lens' AssociatePhoneNumberWithUser Text Source #

The user ID.

associatePhoneNumberWithUser_e164PhoneNumber :: Lens' AssociatePhoneNumberWithUser Text Source #

The phone number, in E.164 format.

associatePhoneNumberWithUserResponse_httpStatus :: Lens' AssociatePhoneNumberWithUserResponse Int Source #

The response's http status code.

DeleteVoiceConnectorProxy

deleteVoiceConnectorProxy_voiceConnectorId :: Lens' DeleteVoiceConnectorProxy Text Source #

The Amazon Chime Voice Connector ID.

CreateSipMediaApplication

createSipMediaApplication_awsRegion :: Lens' CreateSipMediaApplication Text Source #

The AWS Region assigned to the SIP media application.

createSipMediaApplication_name :: Lens' CreateSipMediaApplication Text Source #

The SIP media application name.

createSipMediaApplication_endpoints :: Lens' CreateSipMediaApplication (NonEmpty SipMediaApplicationEndpoint) Source #

List of endpoints (Lambda Amazon Resource Names) specified for the SIP media application. Currently, only one endpoint is supported.

createSipMediaApplicationResponse_sipMediaApplication :: Lens' CreateSipMediaApplicationResponse (Maybe SipMediaApplication) Source #

The SIP media application details.

createSipMediaApplicationResponse_httpStatus :: Lens' CreateSipMediaApplicationResponse Int Source #

The response's http status code.

PutVoiceConnectorProxy

putVoiceConnectorProxy_disabled :: Lens' PutVoiceConnectorProxy (Maybe Bool) Source #

When true, stops proxy sessions from being created on the specified Amazon Chime Voice Connector.

putVoiceConnectorProxy_fallBackPhoneNumber :: Lens' PutVoiceConnectorProxy (Maybe Text) Source #

The phone number to route calls to after a proxy session expires.

putVoiceConnectorProxy_defaultSessionExpiryMinutes :: Lens' PutVoiceConnectorProxy Int Source #

The default number of minutes allowed for proxy sessions.

putVoiceConnectorProxy_phoneNumberPoolCountries :: Lens' PutVoiceConnectorProxy (NonEmpty Text) Source #

The countries for proxy phone numbers to be selected from.

putVoiceConnectorProxy_voiceConnectorId :: Lens' PutVoiceConnectorProxy Text Source #

The Amazon Chime voice connector ID.

putVoiceConnectorProxyResponse_proxy :: Lens' PutVoiceConnectorProxyResponse (Maybe Proxy) Source #

The proxy configuration details.

putVoiceConnectorProxyResponse_httpStatus :: Lens' PutVoiceConnectorProxyResponse Int Source #

The response's http status code.

UpdateUser

updateUser_licenseType :: Lens' UpdateUser (Maybe License) Source #

The user license type to update. This must be a supported license type for the Amazon Chime account that the user belongs to.

updateUser_userType :: Lens' UpdateUser (Maybe UserType) Source #

The user type.

updateUser_alexaForBusinessMetadata :: Lens' UpdateUser (Maybe AlexaForBusinessMetadata) Source #

The Alexa for Business metadata.

updateUser_accountId :: Lens' UpdateUser Text Source #

The Amazon Chime account ID.

updateUser_userId :: Lens' UpdateUser Text Source #

The user ID.

updateUserResponse_user :: Lens' UpdateUserResponse (Maybe User) Source #

The updated user details.

updateUserResponse_httpStatus :: Lens' UpdateUserResponse Int Source #

The response's http status code.

PutVoiceConnectorTermination

putVoiceConnectorTermination_voiceConnectorId :: Lens' PutVoiceConnectorTermination Text Source #

The Amazon Chime Voice Connector ID.

putVoiceConnectorTermination_termination :: Lens' PutVoiceConnectorTermination Termination Source #

The termination setting details to add.

putVoiceConnectorTerminationResponse_termination :: Lens' PutVoiceConnectorTerminationResponse (Maybe Termination) Source #

The updated termination setting details.

putVoiceConnectorTerminationResponse_httpStatus :: Lens' PutVoiceConnectorTerminationResponse Int Source #

The response's http status code.

GetVoiceConnectorEmergencyCallingConfiguration

getVoiceConnectorEmergencyCallingConfiguration_voiceConnectorId :: Lens' GetVoiceConnectorEmergencyCallingConfiguration Text Source #

The Amazon Chime Voice Connector ID.

getVoiceConnectorEmergencyCallingConfigurationResponse_emergencyCallingConfiguration :: Lens' GetVoiceConnectorEmergencyCallingConfigurationResponse (Maybe EmergencyCallingConfiguration) Source #

The emergency calling configuration details.

getVoiceConnectorEmergencyCallingConfigurationResponse_httpStatus :: Lens' GetVoiceConnectorEmergencyCallingConfigurationResponse Int Source #

The response's http status code.

PutVoiceConnectorTerminationCredentials

putVoiceConnectorTerminationCredentials_credentials :: Lens' PutVoiceConnectorTerminationCredentials (Maybe [Credential]) Source #

The termination SIP credentials.

putVoiceConnectorTerminationCredentials_voiceConnectorId :: Lens' PutVoiceConnectorTerminationCredentials Text Source #

The Amazon Chime Voice Connector ID.

ListAppInstanceUsers

listAppInstanceUsers_nextToken :: Lens' ListAppInstanceUsers (Maybe Text) Source #

The token passed by previous API calls until all requested users are returned.

listAppInstanceUsers_maxResults :: Lens' ListAppInstanceUsers (Maybe Natural) Source #

The maximum number of requests that you want returned.

listAppInstanceUsers_appInstanceArn :: Lens' ListAppInstanceUsers Text Source #

The ARN of the AppInstance.

listAppInstanceUsersResponse_nextToken :: Lens' ListAppInstanceUsersResponse (Maybe Text) Source #

The token passed by previous API calls until all requested users are returned.

listAppInstanceUsersResponse_appInstanceUsers :: Lens' ListAppInstanceUsersResponse (Maybe [AppInstanceUserSummary]) Source #

The information for each requested AppInstanceUser.

listAppInstanceUsersResponse_appInstanceArn :: Lens' ListAppInstanceUsersResponse (Maybe Text) Source #

The ARN of the AppInstance.

listAppInstanceUsersResponse_httpStatus :: Lens' ListAppInstanceUsersResponse Int Source #

The response's http status code.

AssociateSigninDelegateGroupsWithAccount

associateSigninDelegateGroupsWithAccount_accountId :: Lens' AssociateSigninDelegateGroupsWithAccount Text Source #

The Amazon Chime account ID.

associateSigninDelegateGroupsWithAccount_signinDelegateGroups :: Lens' AssociateSigninDelegateGroupsWithAccount [SigninDelegateGroup] Source #

The sign-in delegate groups.

associateSigninDelegateGroupsWithAccountResponse_httpStatus :: Lens' AssociateSigninDelegateGroupsWithAccountResponse Int Source #

The response's http status code.

CreateSipRule

createSipRule_disabled :: Lens' CreateSipRule (Maybe Bool) Source #

Enables or disables a rule. You must disable rules before you can delete them.

createSipRule_name :: Lens' CreateSipRule Text Source #

The name of the SIP rule.

createSipRule_triggerType :: Lens' CreateSipRule SipRuleTriggerType Source #

The type of trigger assigned to the SIP rule in TriggerValue, currently RequestUriHostname or ToPhoneNumber.

createSipRule_triggerValue :: Lens' CreateSipRule Text Source #

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.

createSipRule_targetApplications :: Lens' CreateSipRule (NonEmpty SipRuleTargetApplication) Source #

List of SIP media applications with priority and AWS Region. Only one SIP application per AWS Region can be used.

createSipRuleResponse_sipRule :: Lens' CreateSipRuleResponse (Maybe SipRule) Source #

Returns the SIP rule information, including the rule ID, triggers, and target applications.

createSipRuleResponse_httpStatus :: Lens' CreateSipRuleResponse Int Source #

The response's http status code.

DeleteVoiceConnectorTerminationCredentials

deleteVoiceConnectorTerminationCredentials_usernames :: Lens' DeleteVoiceConnectorTerminationCredentials [Text] Source #

The RFC2617 compliant username associated with the SIP credentials, in US-ASCII format.

deleteVoiceConnectorTerminationCredentials_voiceConnectorId :: Lens' DeleteVoiceConnectorTerminationCredentials Text Source #

The Amazon Chime Voice Connector ID.

TagResource

tagResource_resourceARN :: Lens' TagResource Text Source #

The resource ARN.

tagResource_tags :: Lens' TagResource (NonEmpty Tag) Source #

The tag key-value pairs.

DeleteAppInstanceUser

deleteAppInstanceUser_appInstanceUserArn :: Lens' DeleteAppInstanceUser Text Source #

The ARN of the user request being deleted.

UpdateAppInstanceUser

updateAppInstanceUser_metadata :: Lens' UpdateAppInstanceUser (Maybe Text) Source #

The metadata of the AppInstanceUser.

updateAppInstanceUser_appInstanceUserArn :: Lens' UpdateAppInstanceUser Text Source #

The ARN of the AppInstanceUser.

updateAppInstanceUser_name :: Lens' UpdateAppInstanceUser Text Source #

The name of the AppInstanceUser.

updateAppInstanceUserResponse_appInstanceUserArn :: Lens' UpdateAppInstanceUserResponse (Maybe Text) Source #

The ARN of the AppInstanceUser.

updateAppInstanceUserResponse_httpStatus :: Lens' UpdateAppInstanceUserResponse Int Source #

The response's http status code.

UntagMeeting

untagMeeting_meetingId :: Lens' UntagMeeting Text Source #

The Amazon Chime SDK meeting ID.

untagMeeting_tagKeys :: Lens' UntagMeeting (NonEmpty Text) Source #

The tag keys.

UpdateVoiceConnectorGroup

updateVoiceConnectorGroup_voiceConnectorGroupId :: Lens' UpdateVoiceConnectorGroup Text Source #

The Amazon Chime Voice Connector group ID.

updateVoiceConnectorGroup_name :: Lens' UpdateVoiceConnectorGroup Text Source #

The name of the Amazon Chime Voice Connector group.

updateVoiceConnectorGroup_voiceConnectorItems :: Lens' UpdateVoiceConnectorGroup [VoiceConnectorItem] Source #

The VoiceConnectorItems to associate with the group.

updateVoiceConnectorGroupResponse_voiceConnectorGroup :: Lens' UpdateVoiceConnectorGroupResponse (Maybe VoiceConnectorGroup) Source #

The updated Amazon Chime Voice Connector group details.

updateVoiceConnectorGroupResponse_httpStatus :: Lens' UpdateVoiceConnectorGroupResponse Int Source #

The response's http status code.

RedactConversationMessage

redactConversationMessage_accountId :: Lens' RedactConversationMessage Text Source #

The Amazon Chime account ID.

redactConversationMessage_conversationId :: Lens' RedactConversationMessage Text Source #

The conversation ID.

redactConversationMessage_messageId :: Lens' RedactConversationMessage Text Source #

The message ID.

redactConversationMessageResponse_httpStatus :: Lens' RedactConversationMessageResponse Int Source #

The response's http status code.

DeleteChannelModerator

deleteChannelModerator_chimeBearer :: Lens' DeleteChannelModerator (Maybe Text) Source #

The AppInstanceUserArn of the user that makes the API call.

deleteChannelModerator_channelArn :: Lens' DeleteChannelModerator Text Source #

The ARN of the channel.

deleteChannelModerator_channelModeratorArn :: Lens' DeleteChannelModerator Text Source #

The ARN of the moderator being deleted.

DeleteVoiceConnectorGroup

deleteVoiceConnectorGroup_voiceConnectorGroupId :: Lens' DeleteVoiceConnectorGroup Text Source #

The Amazon Chime Voice Connector group ID.

DescribeChannelBan

describeChannelBan_chimeBearer :: Lens' DescribeChannelBan (Maybe Text) Source #

The AppInstanceUserArn of the user that makes the API call.

describeChannelBan_channelArn :: Lens' DescribeChannelBan Text Source #

The ARN of the channel from which the user is banned.

describeChannelBan_memberArn :: Lens' DescribeChannelBan Text Source #

The ARN of the member being banned.

describeChannelBanResponse_channelBan :: Lens' DescribeChannelBanResponse (Maybe ChannelBan) Source #

The details of the ban.

describeChannelBanResponse_httpStatus :: Lens' DescribeChannelBanResponse Int Source #

The response's http status code.

DeleteMediaCapturePipeline

deleteMediaCapturePipeline_mediaPipelineId :: Lens' DeleteMediaCapturePipeline Text Source #

The ID of the media capture pipeline being deleted.

UpdateProxySession

updateProxySession_expiryMinutes :: Lens' UpdateProxySession (Maybe Natural) Source #

The number of minutes allowed for the proxy session.

updateProxySession_capabilities :: Lens' UpdateProxySession [Capability] Source #

The proxy session capabilities.

updateProxySession_voiceConnectorId :: Lens' UpdateProxySession Text Source #

The Amazon Chime voice connector ID.

updateProxySession_proxySessionId :: Lens' UpdateProxySession Text Source #

The proxy session ID.

updateProxySessionResponse_proxySession :: Lens' UpdateProxySessionResponse (Maybe ProxySession) Source #

The proxy session details.

updateProxySessionResponse_httpStatus :: Lens' UpdateProxySessionResponse Int Source #

The response's http status code.

DeleteProxySession

deleteProxySession_voiceConnectorId :: Lens' DeleteProxySession Text Source #

The Amazon Chime voice connector ID.

deleteProxySession_proxySessionId :: Lens' DeleteProxySession Text Source #

The proxy session ID.

GetVoiceConnectorTerminationHealth

getVoiceConnectorTerminationHealth_voiceConnectorId :: Lens' GetVoiceConnectorTerminationHealth Text Source #

The Amazon Chime Voice Connector ID.

getVoiceConnectorTerminationHealthResponse_terminationHealth :: Lens' GetVoiceConnectorTerminationHealthResponse (Maybe TerminationHealth) Source #

The termination health details.

getVoiceConnectorTerminationHealthResponse_httpStatus :: Lens' GetVoiceConnectorTerminationHealthResponse Int Source #

The response's http status code.

CreateMeetingDialOut

createMeetingDialOut_meetingId :: Lens' CreateMeetingDialOut Text Source #

The Amazon Chime SDK meeting ID.

createMeetingDialOut_fromPhoneNumber :: Lens' CreateMeetingDialOut Text Source #

Phone number used as the caller ID when the remote party receives a call.

createMeetingDialOut_toPhoneNumber :: Lens' CreateMeetingDialOut Text Source #

Phone number called when inviting someone to a meeting.

createMeetingDialOut_joinToken :: Lens' CreateMeetingDialOut Text Source #

Token used by the Amazon Chime SDK attendee. Call the CreateAttendee action to get a join token.

createMeetingDialOutResponse_transactionId :: Lens' CreateMeetingDialOutResponse (Maybe Text) Source #

Unique ID that tracks API calls.

createMeetingDialOutResponse_httpStatus :: Lens' CreateMeetingDialOutResponse Int Source #

The response's http status code.

UntagResource

untagResource_resourceARN :: Lens' UntagResource Text Source #

The resource ARN.

untagResource_tagKeys :: Lens' UntagResource (NonEmpty Text) Source #

The tag keys.

ListProxySessions

listProxySessions_status :: Lens' ListProxySessions (Maybe ProxySessionStatus) Source #

The proxy session status.

listProxySessions_nextToken :: Lens' ListProxySessions (Maybe Text) Source #

The token to use to retrieve the next page of results.

listProxySessions_maxResults :: Lens' ListProxySessions (Maybe Natural) Source #

The maximum number of results to return in a single call.

listProxySessions_voiceConnectorId :: Lens' ListProxySessions Text Source #

The Amazon Chime voice connector ID.

listProxySessionsResponse_nextToken :: Lens' ListProxySessionsResponse (Maybe Text) Source #

The token to use to retrieve the next page of results.

listProxySessionsResponse_proxySessions :: Lens' ListProxySessionsResponse (Maybe [ProxySession]) Source #

The proxy session details.

listProxySessionsResponse_httpStatus :: Lens' ListProxySessionsResponse Int Source #

The response's http status code.

ListMediaCapturePipelines

listMediaCapturePipelines_nextToken :: Lens' ListMediaCapturePipelines (Maybe Text) Source #

The token used to retrieve the next page of results.

listMediaCapturePipelines_maxResults :: Lens' ListMediaCapturePipelines (Maybe Natural) Source #

The maximum number of results to return in a single call. Valid Range: 1 - 99.

listMediaCapturePipelinesResponse_nextToken :: Lens' ListMediaCapturePipelinesResponse (Maybe Text) Source #

The token used to retrieve the next page of results.

listMediaCapturePipelinesResponse_mediaCapturePipelines :: Lens' ListMediaCapturePipelinesResponse (Maybe [MediaCapturePipeline]) Source #

The media capture pipeline objects in the list.

listMediaCapturePipelinesResponse_httpStatus :: Lens' ListMediaCapturePipelinesResponse Int Source #

The response's http status code.

UpdatePhoneNumberSettings

updatePhoneNumberSettings_callingName :: Lens' UpdatePhoneNumberSettings Text Source #

The default outbound calling name for the account.

InviteUsers

inviteUsers_userType :: Lens' InviteUsers (Maybe UserType) Source #

The user type.

inviteUsers_accountId :: Lens' InviteUsers Text Source #

The Amazon Chime account ID.

inviteUsers_userEmailList :: Lens' InviteUsers [Text] Source #

The user email addresses to which to send the email invitation.

inviteUsersResponse_invites :: Lens' InviteUsersResponse (Maybe [Invite]) Source #

The email invitation details.

inviteUsersResponse_httpStatus :: Lens' InviteUsersResponse Int Source #

The response's http status code.

CreateRoom

createRoom_clientRequestToken :: Lens' CreateRoom (Maybe Text) Source #

The idempotency token for the request.

createRoom_accountId :: Lens' CreateRoom Text Source #

The Amazon Chime account ID.

createRoom_name :: Lens' CreateRoom Text Source #

The room name.

createRoomResponse_room :: Lens' CreateRoomResponse (Maybe Room) Source #

The room details.

createRoomResponse_httpStatus :: Lens' CreateRoomResponse Int Source #

The response's http status code.

ListChannelModerators

listChannelModerators_chimeBearer :: Lens' ListChannelModerators (Maybe Text) Source #

The AppInstanceUserArn of the user that makes the API call.

listChannelModerators_nextToken :: Lens' ListChannelModerators (Maybe Text) Source #

The token passed by previous API calls until all requested moderators are returned.

listChannelModerators_maxResults :: Lens' ListChannelModerators (Maybe Natural) Source #

The maximum number of moderators that you want returned.

listChannelModerators_channelArn :: Lens' ListChannelModerators Text Source #

The ARN of the channel.

listChannelModeratorsResponse_channelArn :: Lens' ListChannelModeratorsResponse (Maybe Text) Source #

The ARN of the channel.

listChannelModeratorsResponse_nextToken :: Lens' ListChannelModeratorsResponse (Maybe Text) Source #

The token passed by previous API calls until all requested moderators are returned.

listChannelModeratorsResponse_channelModerators :: Lens' ListChannelModeratorsResponse (Maybe [ChannelModeratorSummary]) Source #

The information about and names of each moderator.

listChannelModeratorsResponse_httpStatus :: Lens' ListChannelModeratorsResponse Int Source #

The response's http status code.

GetVoiceConnector

getVoiceConnector_voiceConnectorId :: Lens' GetVoiceConnector Text Source #

The Amazon Chime Voice Connector ID.

getVoiceConnectorResponse_voiceConnector :: Lens' GetVoiceConnectorResponse (Maybe VoiceConnector) Source #

The Amazon Chime Voice Connector details.

getVoiceConnectorResponse_httpStatus :: Lens' GetVoiceConnectorResponse Int Source #

The response's http status code.

DescribeChannel

describeChannel_chimeBearer :: Lens' DescribeChannel (Maybe Text) Source #

The AppInstanceUserArn of the user that makes the API call.

describeChannel_channelArn :: Lens' DescribeChannel Text Source #

The ARN of the channel.

describeChannelResponse_channel :: Lens' DescribeChannelResponse (Maybe Channel) Source #

The channel details.

describeChannelResponse_httpStatus :: Lens' DescribeChannelResponse Int Source #

The response's http status code.

CreateVoiceConnectorGroup

createVoiceConnectorGroup_voiceConnectorItems :: Lens' CreateVoiceConnectorGroup (Maybe [VoiceConnectorItem]) Source #

The Amazon Chime Voice Connectors to route inbound calls to.

createVoiceConnectorGroup_name :: Lens' CreateVoiceConnectorGroup Text Source #

The name of the Amazon Chime Voice Connector group.

createVoiceConnectorGroupResponse_voiceConnectorGroup :: Lens' CreateVoiceConnectorGroupResponse (Maybe VoiceConnectorGroup) Source #

The Amazon Chime Voice Connector group details.

createVoiceConnectorGroupResponse_httpStatus :: Lens' CreateVoiceConnectorGroupResponse Int Source #

The response's http status code.

DeleteAppInstanceStreamingConfigurations

deleteAppInstanceStreamingConfigurations_appInstanceArn :: Lens' DeleteAppInstanceStreamingConfigurations Text Source #

The ARN of the streaming configurations being deleted.

ListRooms

listRooms_memberId :: Lens' ListRooms (Maybe Text) Source #

The member ID (user ID or bot ID).

listRooms_nextToken :: Lens' ListRooms (Maybe Text) Source #

The token to use to retrieve the next page of results.

listRooms_maxResults :: Lens' ListRooms (Maybe Natural) Source #

The maximum number of results to return in a single call.

listRooms_accountId :: Lens' ListRooms Text Source #

The Amazon Chime account ID.

listRoomsResponse_rooms :: Lens' ListRoomsResponse (Maybe [Room]) Source #

The room details.

listRoomsResponse_nextToken :: Lens' ListRoomsResponse (Maybe Text) Source #

The token to use to retrieve the next page of results.

listRoomsResponse_httpStatus :: Lens' ListRoomsResponse Int Source #

The response's http status code.

BatchCreateAttendee

batchCreateAttendee_meetingId :: Lens' BatchCreateAttendee Text Source #

The Amazon Chime SDK meeting ID.

batchCreateAttendee_attendees :: Lens' BatchCreateAttendee [CreateAttendeeRequestItem] Source #

The request containing the attendees to create.

batchCreateAttendeeResponse_attendees :: Lens' BatchCreateAttendeeResponse (Maybe [Attendee]) Source #

The attendee information, including attendees IDs and join tokens.

batchCreateAttendeeResponse_errors :: Lens' BatchCreateAttendeeResponse (Maybe [CreateAttendeeError]) Source #

If the action fails for one or more of the attendees in the request, a list of the attendees is returned, along with error codes and error messages.

batchCreateAttendeeResponse_httpStatus :: Lens' BatchCreateAttendeeResponse Int Source #

The response's http status code.

DeleteAppInstanceAdmin

deleteAppInstanceAdmin_appInstanceAdminArn :: Lens' DeleteAppInstanceAdmin Text Source #

The ARN of the AppInstance's administrator.

deleteAppInstanceAdmin_appInstanceArn :: Lens' DeleteAppInstanceAdmin Text Source #

The ARN of the AppInstance.

PutAppInstanceStreamingConfigurations

putAppInstanceStreamingConfigurations_appInstanceArn :: Lens' PutAppInstanceStreamingConfigurations Text Source #

The ARN of the AppInstance.

putAppInstanceStreamingConfigurations_appInstanceStreamingConfigurations :: Lens' PutAppInstanceStreamingConfigurations (NonEmpty AppInstanceStreamingConfiguration) Source #

The streaming configurations set for an AppInstance.

putAppInstanceStreamingConfigurationsResponse_appInstanceStreamingConfigurations :: Lens' PutAppInstanceStreamingConfigurationsResponse (Maybe (NonEmpty AppInstanceStreamingConfiguration)) Source #

The streaming configurations of an AppInstance.

putAppInstanceStreamingConfigurationsResponse_httpStatus :: Lens' PutAppInstanceStreamingConfigurationsResponse Int Source #

The response's http status code.

RegenerateSecurityToken

regenerateSecurityToken_accountId :: Lens' RegenerateSecurityToken Text Source #

The Amazon Chime account ID.

regenerateSecurityToken_botId :: Lens' RegenerateSecurityToken Text Source #

The bot ID.

regenerateSecurityTokenResponse_bot :: Lens' RegenerateSecurityTokenResponse (Maybe Bot) Source #

Undocumented member.

regenerateSecurityTokenResponse_httpStatus :: Lens' RegenerateSecurityTokenResponse Int Source #

The response's http status code.

DeleteChannelMessage

deleteChannelMessage_chimeBearer :: Lens' DeleteChannelMessage (Maybe Text) Source #

The AppInstanceUserArn of the user that makes the API call.

deleteChannelMessage_channelArn :: Lens' DeleteChannelMessage Text Source #

The ARN of the channel.

deleteChannelMessage_messageId :: Lens' DeleteChannelMessage Text Source #

The ID of the message being deleted.

UpdateChannelMessage

updateChannelMessage_chimeBearer :: Lens' UpdateChannelMessage (Maybe Text) Source #

The AppInstanceUserArn of the user that makes the API call.

updateChannelMessage_content :: Lens' UpdateChannelMessage (Maybe Text) Source #

The content of the message being updated.

updateChannelMessage_metadata :: Lens' UpdateChannelMessage (Maybe Text) Source #

The metadata of the message being updated.

updateChannelMessage_channelArn :: Lens' UpdateChannelMessage Text Source #

The ARN of the channel.

updateChannelMessage_messageId :: Lens' UpdateChannelMessage Text Source #

The ID string of the message being updated.

updateChannelMessageResponse_channelArn :: Lens' UpdateChannelMessageResponse (Maybe Text) Source #

The ARN of the channel.

updateChannelMessageResponse_messageId :: Lens' UpdateChannelMessageResponse (Maybe Text) Source #

The ID string of the message being updated.

updateChannelMessageResponse_httpStatus :: Lens' UpdateChannelMessageResponse Int Source #

The response's http status code.

DeleteAppInstance

deleteAppInstance_appInstanceArn :: Lens' DeleteAppInstance Text Source #

The ARN of the AppInstance.

UpdateAppInstance

updateAppInstance_metadata :: Lens' UpdateAppInstance (Maybe Text) Source #

The metadata that you want to change.

updateAppInstance_appInstanceArn :: Lens' UpdateAppInstance Text Source #

The ARN of the AppInstance.

updateAppInstance_name :: Lens' UpdateAppInstance Text Source #

The name that you want to change.

updateAppInstanceResponse_appInstanceArn :: Lens' UpdateAppInstanceResponse (Maybe Text) Source #

The ARN of the AppInstance.

updateAppInstanceResponse_httpStatus :: Lens' UpdateAppInstanceResponse Int Source #

The response's http status code.

CreateVoiceConnector

createVoiceConnector_awsRegion :: Lens' CreateVoiceConnector (Maybe VoiceConnectorAwsRegion) Source #

The AWS Region in which the Amazon Chime Voice Connector is created. Default value: us-east-1 .

createVoiceConnector_name :: Lens' CreateVoiceConnector Text Source #

The name of the Amazon Chime Voice Connector.

createVoiceConnector_requireEncryption :: Lens' CreateVoiceConnector Bool Source #

When enabled, requires encryption for the Amazon Chime Voice Connector.

createVoiceConnectorResponse_voiceConnector :: Lens' CreateVoiceConnectorResponse (Maybe VoiceConnector) Source #

The Amazon Chime Voice Connector details.

createVoiceConnectorResponse_httpStatus :: Lens' CreateVoiceConnectorResponse Int Source #

The response's http status code.

ListChannelMessages

listChannelMessages_chimeBearer :: Lens' ListChannelMessages (Maybe Text) Source #

The AppInstanceUserArn of the user that makes the API call.

listChannelMessages_nextToken :: Lens' ListChannelMessages (Maybe Text) Source #

The token passed by previous API calls until all requested messages are returned.

listChannelMessages_notBefore :: Lens' ListChannelMessages (Maybe UTCTime) Source #

The initial or starting time stamp for your requested messages.

listChannelMessages_sortOrder :: Lens' ListChannelMessages (Maybe SortOrder) Source #

The order in which you want messages sorted. Default is Descending, based on time created.

listChannelMessages_maxResults :: Lens' ListChannelMessages (Maybe Natural) Source #

The maximum number of messages that you want returned.

listChannelMessages_notAfter :: Lens' ListChannelMessages (Maybe UTCTime) Source #

The final or ending time stamp for your requested messages.

listChannelMessages_channelArn :: Lens' ListChannelMessages Text Source #

The ARN of the channel.

listChannelMessagesResponse_channelArn :: Lens' ListChannelMessagesResponse (Maybe Text) Source #

The ARN of the channel containing the requested messages.

listChannelMessagesResponse_nextToken :: Lens' ListChannelMessagesResponse (Maybe Text) Source #

The token passed by previous API calls until all requested messages are returned.

listChannelMessagesResponse_channelMessages :: Lens' ListChannelMessagesResponse (Maybe [ChannelMessageSummary]) Source #

The information about, and content of, each requested message.

listChannelMessagesResponse_httpStatus :: Lens' ListChannelMessagesResponse Int Source #

The response's http status code.

RedactRoomMessage

redactRoomMessage_accountId :: Lens' RedactRoomMessage Text Source #

The Amazon Chime account ID.

redactRoomMessage_roomId :: Lens' RedactRoomMessage Text Source #

The room ID.

redactRoomMessage_messageId :: Lens' RedactRoomMessage Text Source #

The message ID.

redactRoomMessageResponse_httpStatus :: Lens' RedactRoomMessageResponse Int Source #

The response's http status code.

GetRoom

getRoom_accountId :: Lens' GetRoom Text Source #

The Amazon Chime account ID.

getRoom_roomId :: Lens' GetRoom Text Source #

The room ID.

getRoomResponse_room :: Lens' GetRoomResponse (Maybe Room) Source #

The room details.

getRoomResponse_httpStatus :: Lens' GetRoomResponse Int Source #

The response's http status code.

CreateRoomMembership

createRoomMembership_role :: Lens' CreateRoomMembership (Maybe RoomMembershipRole) Source #

The role of the member.

createRoomMembership_accountId :: Lens' CreateRoomMembership Text Source #

The Amazon Chime account ID.

createRoomMembership_roomId :: Lens' CreateRoomMembership Text Source #

The room ID.

createRoomMembership_memberId :: Lens' CreateRoomMembership Text Source #

The Amazon Chime member ID (user ID or bot ID).

createRoomMembershipResponse_roomMembership :: Lens' CreateRoomMembershipResponse (Maybe RoomMembership) Source #

The room membership details.

createRoomMembershipResponse_httpStatus :: Lens' CreateRoomMembershipResponse Int Source #

The response's http status code.

BatchCreateChannelMembership

batchCreateChannelMembership_chimeBearer :: Lens' BatchCreateChannelMembership (Maybe Text) Source #

The AppInstanceUserArn of the user that makes the API call.

batchCreateChannelMembership_type :: Lens' BatchCreateChannelMembership (Maybe ChannelMembershipType) Source #

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.

batchCreateChannelMembership_channelArn :: Lens' BatchCreateChannelMembership Text Source #

The ARN of the channel to which you're adding users.

batchCreateChannelMembership_memberArns :: Lens' BatchCreateChannelMembership (NonEmpty Text) Source #

The ARNs of the members you want to add to the channel.

batchCreateChannelMembershipResponse_errors :: Lens' BatchCreateChannelMembershipResponse (Maybe [BatchCreateChannelMembershipError]) Source #

If the action fails for one or more of the memberships in the request, a list of the memberships is returned, along with error codes and error messages.

batchCreateChannelMembershipResponse_batchChannelMemberships :: Lens' BatchCreateChannelMembershipResponse (Maybe BatchChannelMemberships) Source #

The list of channel memberships in the response.

batchCreateChannelMembershipResponse_httpStatus :: Lens' BatchCreateChannelMembershipResponse Int Source #

The response's http status code.

Types

Account

account_signinDelegateGroups :: Lens' Account (Maybe [SigninDelegateGroup]) Source #

The sign-in delegate groups associated with the account.

account_accountStatus :: Lens' Account (Maybe AccountStatus) Source #

The status of the account.

account_defaultLicense :: Lens' Account (Maybe License) Source #

The default license for the Amazon Chime account.

account_supportedLicenses :: Lens' Account (Maybe [License]) Source #

Supported licenses for the Amazon Chime account.

account_createdTimestamp :: Lens' Account (Maybe UTCTime) Source #

The Amazon Chime account creation timestamp, in ISO 8601 format.

account_accountType :: Lens' Account (Maybe AccountType) Source #

The Amazon Chime account type. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.

account_awsAccountId :: Lens' Account Text Source #

The AWS account ID.

account_accountId :: Lens' Account Text Source #

The Amazon Chime account ID.

account_name :: Lens' Account Text Source #

The Amazon Chime account name.

AccountSettings

accountSettings_enableDialOut :: Lens' AccountSettings (Maybe Bool) Source #

Setting that allows meeting participants to choose the __Call me at a phone number__ option. For more information, see Join a Meeting without the Amazon Chime App.

accountSettings_disableRemoteControl :: Lens' AccountSettings (Maybe Bool) Source #

Setting that stops or starts remote control of shared screens during meetings.

AlexaForBusinessMetadata

alexaForBusinessMetadata_alexaForBusinessRoomArn :: Lens' AlexaForBusinessMetadata (Maybe Text) Source #

The ARN of the room resource.

alexaForBusinessMetadata_isAlexaForBusinessEnabled :: Lens' AlexaForBusinessMetadata (Maybe Bool) Source #

Starts or stops Alexa for Business.

AppInstance

appInstance_name :: Lens' AppInstance (Maybe Text) Source #

The name of an AppInstance.

appInstance_metadata :: Lens' AppInstance (Maybe Text) Source #

The metadata of an AppInstance.

appInstance_appInstanceArn :: Lens' AppInstance (Maybe Text) Source #

The ARN of the messaging instance.

appInstance_createdTimestamp :: Lens' AppInstance (Maybe UTCTime) Source #

The time at which an AppInstance was created. In epoch milliseconds.

appInstance_lastUpdatedTimestamp :: Lens' AppInstance (Maybe UTCTime) Source #

The time an AppInstance was last updated. In epoch milliseconds.

AppInstanceAdmin

appInstanceAdmin_admin :: Lens' AppInstanceAdmin (Maybe Identity) Source #

The AppInstanceAdmin data.

appInstanceAdmin_appInstanceArn :: Lens' AppInstanceAdmin (Maybe Text) Source #

The ARN of the AppInstance for which the user is an administrator.

appInstanceAdmin_createdTimestamp :: Lens' AppInstanceAdmin (Maybe UTCTime) Source #

The time at which an administrator was created.

AppInstanceAdminSummary

appInstanceAdminSummary_admin :: Lens' AppInstanceAdminSummary (Maybe Identity) Source #

The details of the AppInstanceAdmin.

AppInstanceRetentionSettings

appInstanceRetentionSettings_channelRetentionSettings :: Lens' AppInstanceRetentionSettings (Maybe ChannelRetentionSettings) Source #

The length of time in days to retain the messages in a channel.

AppInstanceStreamingConfiguration

appInstanceStreamingConfiguration_appInstanceDataType :: Lens' AppInstanceStreamingConfiguration AppInstanceDataType Source #

The type of data to be streamed.

appInstanceStreamingConfiguration_resourceArn :: Lens' AppInstanceStreamingConfiguration Text Source #

The resource ARN.

AppInstanceSummary

appInstanceSummary_name :: Lens' AppInstanceSummary (Maybe Text) Source #

The name of the AppInstance.

appInstanceSummary_metadata :: Lens' AppInstanceSummary (Maybe Text) Source #

The metadata of the AppInstance.

appInstanceSummary_appInstanceArn :: Lens' AppInstanceSummary (Maybe Text) Source #

The AppInstance ARN.

AppInstanceUser

appInstanceUser_appInstanceUserArn :: Lens' AppInstanceUser (Maybe Text) Source #

The ARN of the AppInstanceUser.

appInstanceUser_name :: Lens' AppInstanceUser (Maybe Text) Source #

The name of the AppInstanceUser.

appInstanceUser_metadata :: Lens' AppInstanceUser (Maybe Text) Source #

The metadata of the AppInstanceUser.

appInstanceUser_createdTimestamp :: Lens' AppInstanceUser (Maybe UTCTime) Source #

The time at which the AppInstanceUser was created.

appInstanceUser_lastUpdatedTimestamp :: Lens' AppInstanceUser (Maybe UTCTime) Source #

The time at which the AppInstanceUser was last updated.

AppInstanceUserMembershipSummary

appInstanceUserMembershipSummary_readMarkerTimestamp :: Lens' AppInstanceUserMembershipSummary (Maybe UTCTime) Source #

The time at which a message was last read.

appInstanceUserMembershipSummary_type :: Lens' AppInstanceUserMembershipSummary (Maybe ChannelMembershipType) Source #

The type of ChannelMembership.

AppInstanceUserSummary

appInstanceUserSummary_appInstanceUserArn :: Lens' AppInstanceUserSummary (Maybe Text) Source #

The ARN of the AppInstanceUser.

appInstanceUserSummary_name :: Lens' AppInstanceUserSummary (Maybe Text) Source #

The name of an AppInstanceUser.

appInstanceUserSummary_metadata :: Lens' AppInstanceUserSummary (Maybe Text) Source #

The metadata of the AppInstanceUser.

ArtifactsConfiguration

artifactsConfiguration_audio :: Lens' ArtifactsConfiguration AudioArtifactsConfiguration Source #

The configuration for the audio artifacts.

artifactsConfiguration_video :: Lens' ArtifactsConfiguration VideoArtifactsConfiguration Source #

The configuration for the video artifacts.

artifactsConfiguration_content :: Lens' ArtifactsConfiguration ContentArtifactsConfiguration Source #

The configuration for the content artifacts.

Attendee

attendee_attendeeId :: Lens' Attendee (Maybe Text) Source #

The Amazon Chime SDK attendee ID.

attendee_joinToken :: Lens' Attendee (Maybe Text) Source #

The join token used by the Amazon Chime SDK attendee.

attendee_externalUserId :: Lens' Attendee (Maybe Text) Source #

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

AudioArtifactsConfiguration

audioArtifactsConfiguration_muxType :: Lens' AudioArtifactsConfiguration AudioMuxType Source #

The MUX type of the audio artifact configuration object.

BatchChannelMemberships

batchChannelMemberships_members :: Lens' BatchChannelMemberships (Maybe [Identity]) Source #

The users successfully added to the request.

batchChannelMemberships_channelArn :: Lens' BatchChannelMemberships (Maybe Text) Source #

The ARN of the channel to which you're adding users.

batchChannelMemberships_type :: Lens' BatchChannelMemberships (Maybe ChannelMembershipType) Source #

The membership types set for the channel users.

batchChannelMemberships_invitedBy :: Lens' BatchChannelMemberships (Maybe Identity) Source #

The identifier of the member who invited another member.

BatchCreateChannelMembershipError

batchCreateChannelMembershipError_errorCode :: Lens' BatchCreateChannelMembershipError (Maybe ErrorCode) Source #

The error code.

batchCreateChannelMembershipError_memberArn :: Lens' BatchCreateChannelMembershipError (Maybe Text) Source #

The ARN of the member that the service couldn't add.

batchCreateChannelMembershipError_errorMessage :: Lens' BatchCreateChannelMembershipError (Maybe Text) Source #

The error message.

Bot

bot_securityToken :: Lens' Bot (Maybe Text) Source #

The security token used to authenticate Amazon Chime with the outgoing event endpoint.

bot_disabled :: Lens' Bot (Maybe Bool) Source #

When true, the bot is stopped from running in your account.

bot_updatedTimestamp :: Lens' Bot (Maybe UTCTime) Source #

The updated bot timestamp, in ISO 8601 format.

bot_userId :: Lens' Bot (Maybe Text) Source #

The unique ID for the bot user.

bot_botId :: Lens' Bot (Maybe Text) Source #

The bot ID.

bot_displayName :: Lens' Bot (Maybe Text) Source #

The bot display name.

bot_botEmail :: Lens' Bot (Maybe Text) Source #

The bot email address.

bot_createdTimestamp :: Lens' Bot (Maybe UTCTime) Source #

The bot creation timestamp, in ISO 8601 format.

bot_botType :: Lens' Bot (Maybe BotType) Source #

The bot type.

BusinessCallingSettings

businessCallingSettings_cdrBucket :: Lens' BusinessCallingSettings (Maybe Text) Source #

The Amazon S3 bucket designated for call detail record storage.

Channel

channel_mode :: Lens' Channel (Maybe ChannelMode) Source #

The mode of the channel.

channel_createdBy :: Lens' Channel (Maybe Identity) Source #

The AppInstanceUser who created the channel.

channel_channelArn :: Lens' Channel (Maybe Text) Source #

The ARN of the channel.

channel_privacy :: Lens' Channel (Maybe ChannelPrivacy) Source #

The channel's privacy setting.

channel_lastMessageTimestamp :: Lens' Channel (Maybe UTCTime) Source #

The time at which a member sent the last message in the channel.

channel_name :: Lens' Channel (Maybe Text) Source #

The name of the channel.

channel_metadata :: Lens' Channel (Maybe Text) Source #

The channel's metadata.

channel_createdTimestamp :: Lens' Channel (Maybe UTCTime) Source #

The time at which the AppInstanceUser created the channel.

channel_lastUpdatedTimestamp :: Lens' Channel (Maybe UTCTime) Source #

The time at which a channel was last updated.

ChannelBan

channelBan_createdBy :: Lens' ChannelBan (Maybe Identity) Source #

The AppInstanceUser who created the ban.

channelBan_channelArn :: Lens' ChannelBan (Maybe Text) Source #

The ARN of the channel from which a member is being banned.

channelBan_member :: Lens' ChannelBan (Maybe Identity) Source #

The member being banned from the channel.

channelBan_createdTimestamp :: Lens' ChannelBan (Maybe UTCTime) Source #

The time at which the ban was created.

ChannelBanSummary

channelBanSummary_member :: Lens' ChannelBanSummary (Maybe Identity) Source #

The member being banned from a channel.

ChannelMembership

channelMembership_channelArn :: Lens' ChannelMembership (Maybe Text) Source #

The ARN of the member's channel.

channelMembership_member :: Lens' ChannelMembership (Maybe Identity) Source #

The data of the channel member.

channelMembership_type :: Lens' ChannelMembership (Maybe ChannelMembershipType) Source #

The membership type set for the channel member.

channelMembership_invitedBy :: Lens' ChannelMembership (Maybe Identity) Source #

The identifier of the member who invited another member.

channelMembership_createdTimestamp :: Lens' ChannelMembership (Maybe UTCTime) Source #

The time at which the channel membership was created.

channelMembership_lastUpdatedTimestamp :: Lens' ChannelMembership (Maybe UTCTime) Source #

The time at which a channel membership was last updated.

ChannelMembershipForAppInstanceUserSummary

channelMembershipForAppInstanceUserSummary_appInstanceUserMembershipSummary :: Lens' ChannelMembershipForAppInstanceUserSummary (Maybe AppInstanceUserMembershipSummary) Source #

Undocumented member.

channelMembershipForAppInstanceUserSummary_channelSummary :: Lens' ChannelMembershipForAppInstanceUserSummary (Maybe ChannelSummary) Source #

Undocumented member.

ChannelMembershipSummary

channelMembershipSummary_member :: Lens' ChannelMembershipSummary (Maybe Identity) Source #

A member's summary data.

ChannelMessage

channelMessage_sender :: Lens' ChannelMessage (Maybe Identity) Source #

The message sender.

channelMessage_channelArn :: Lens' ChannelMessage (Maybe Text) Source #

The ARN of the channel.

channelMessage_content :: Lens' ChannelMessage (Maybe Text) Source #

The message content.

channelMessage_redacted :: Lens' ChannelMessage (Maybe Bool) Source #

Hides the content of a message.

channelMessage_persistence :: Lens' ChannelMessage (Maybe ChannelMessagePersistenceType) Source #

The persistence setting for a channel message.

channelMessage_metadata :: Lens' ChannelMessage (Maybe Text) Source #

The message metadata.

channelMessage_type :: Lens' ChannelMessage (Maybe ChannelMessageType) Source #

The message type.

channelMessage_createdTimestamp :: Lens' ChannelMessage (Maybe UTCTime) Source #

The time at which the message was created.

channelMessage_messageId :: Lens' ChannelMessage (Maybe Text) Source #

The ID of a message.

channelMessage_lastUpdatedTimestamp :: Lens' ChannelMessage (Maybe UTCTime) Source #

The time at which a message was updated.

channelMessage_lastEditedTimestamp :: Lens' ChannelMessage (Maybe UTCTime) Source #

The time at which a message was edited.

ChannelMessageSummary

channelMessageSummary_sender :: Lens' ChannelMessageSummary (Maybe Identity) Source #

The message sender.

channelMessageSummary_content :: Lens' ChannelMessageSummary (Maybe Text) Source #

The content of the message.

channelMessageSummary_redacted :: Lens' ChannelMessageSummary (Maybe Bool) Source #

Indicates whether a message was redacted.

channelMessageSummary_metadata :: Lens' ChannelMessageSummary (Maybe Text) Source #

The metadata of the message.

channelMessageSummary_type :: Lens' ChannelMessageSummary (Maybe ChannelMessageType) Source #

The type of message.

channelMessageSummary_createdTimestamp :: Lens' ChannelMessageSummary (Maybe UTCTime) Source #

The time at which the message summary was created.

channelMessageSummary_messageId :: Lens' ChannelMessageSummary (Maybe Text) Source #

The ID of the message.

channelMessageSummary_lastUpdatedTimestamp :: Lens' ChannelMessageSummary (Maybe UTCTime) Source #

The time at which a message was last updated.

channelMessageSummary_lastEditedTimestamp :: Lens' ChannelMessageSummary (Maybe UTCTime) Source #

The time at which a message was last edited.

ChannelModeratedByAppInstanceUserSummary

channelModeratedByAppInstanceUserSummary_channelSummary :: Lens' ChannelModeratedByAppInstanceUserSummary (Maybe ChannelSummary) Source #

Summary of the details of a Channel.

ChannelModerator

channelModerator_createdBy :: Lens' ChannelModerator (Maybe Identity) Source #

The AppInstanceUser who created the moderator.

channelModerator_channelArn :: Lens' ChannelModerator (Maybe Text) Source #

The ARN of the moderator's channel.

channelModerator_createdTimestamp :: Lens' ChannelModerator (Maybe UTCTime) Source #

The time at which the moderator was created.

channelModerator_moderator :: Lens' ChannelModerator (Maybe Identity) Source #

The moderator's data.

ChannelModeratorSummary

channelModeratorSummary_moderator :: Lens' ChannelModeratorSummary (Maybe Identity) Source #

The data for a moderator.

ChannelRetentionSettings

channelRetentionSettings_retentionDays :: Lens' ChannelRetentionSettings (Maybe Natural) Source #

The time in days to retain the messages in a channel.

ChannelSummary

channelSummary_mode :: Lens' ChannelSummary (Maybe ChannelMode) Source #

The mode of the channel.

channelSummary_channelArn :: Lens' ChannelSummary (Maybe Text) Source #

The ARN of the channel.

channelSummary_privacy :: Lens' ChannelSummary (Maybe ChannelPrivacy) Source #

The privacy setting of the channel.

channelSummary_lastMessageTimestamp :: Lens' ChannelSummary (Maybe UTCTime) Source #

The time at which the last message in a channel was sent.

channelSummary_name :: Lens' ChannelSummary (Maybe Text) Source #

The name of the channel.

channelSummary_metadata :: Lens' ChannelSummary (Maybe Text) Source #

The metadata of the channel.

ChimeSdkMeetingConfiguration

chimeSdkMeetingConfiguration_artifactsConfiguration :: Lens' ChimeSdkMeetingConfiguration (Maybe ArtifactsConfiguration) Source #

The configuration for the artifacts in an Amazon Chime SDK meeting.

chimeSdkMeetingConfiguration_sourceConfiguration :: Lens' ChimeSdkMeetingConfiguration (Maybe SourceConfiguration) Source #

The source configuration for a specified media capture pipline.

ContentArtifactsConfiguration

contentArtifactsConfiguration_muxType :: Lens' ContentArtifactsConfiguration (Maybe ContentMuxType) Source #

The MUX type of the artifact configuration.

contentArtifactsConfiguration_state :: Lens' ContentArtifactsConfiguration ArtifactsState Source #

Indicates whether the content artifact is enabled or disabled.

ConversationRetentionSettings

conversationRetentionSettings_retentionDays :: Lens' ConversationRetentionSettings (Maybe Natural) Source #

The number of days for which to retain conversation messages.

CreateAttendeeError

createAttendeeError_errorCode :: Lens' CreateAttendeeError (Maybe Text) Source #

The error code.

createAttendeeError_errorMessage :: Lens' CreateAttendeeError (Maybe Text) Source #

The error message.

createAttendeeError_externalUserId :: Lens' CreateAttendeeError (Maybe Text) Source #

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

CreateAttendeeRequestItem

createAttendeeRequestItem_tags :: Lens' CreateAttendeeRequestItem (Maybe (NonEmpty Tag)) Source #

The tag key-value pairs.

createAttendeeRequestItem_externalUserId :: Lens' CreateAttendeeRequestItem Text Source #

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

Credential

credential_username :: Lens' Credential (Maybe Text) Source #

The RFC2617 compliant user name associated with the SIP credentials, in US-ASCII format.

credential_password :: Lens' Credential (Maybe Text) Source #

The RFC2617 compliant password associated with the SIP credentials, in US-ASCII format.

DNISEmergencyCallingConfiguration

dNISEmergencyCallingConfiguration_testPhoneNumber :: Lens' DNISEmergencyCallingConfiguration (Maybe Text) Source #

The DNIS phone number to route test emergency calls to, in E.164 format.

dNISEmergencyCallingConfiguration_emergencyPhoneNumber :: Lens' DNISEmergencyCallingConfiguration Text Source #

The DNIS phone number to route emergency calls to, in E.164 format.

dNISEmergencyCallingConfiguration_callingCountry :: Lens' DNISEmergencyCallingConfiguration Text Source #

The country from which emergency calls are allowed, in ISO 3166-1 alpha-2 format.

EmergencyCallingConfiguration

emergencyCallingConfiguration_dnis :: Lens' EmergencyCallingConfiguration (Maybe [DNISEmergencyCallingConfiguration]) Source #

The Dialed Number Identification Service (DNIS) emergency calling configuration details.

EngineTranscribeMedicalSettings

engineTranscribeMedicalSettings_vocabularyName :: Lens' EngineTranscribeMedicalSettings (Maybe Text) Source #

The name of the vocabulary passed to Amazon Transcribe Medical.

engineTranscribeMedicalSettings_region :: Lens' EngineTranscribeMedicalSettings (Maybe TranscribeMedicalRegion) Source #

The AWS Region passed to Amazon Transcribe Medical. If you don't specify a Region, Amazon Chime uses the meeting's Region.

engineTranscribeMedicalSettings_languageCode :: Lens' EngineTranscribeMedicalSettings TranscribeMedicalLanguageCode Source #

The language code specified for the Amazon Transcribe Medical engine.

engineTranscribeMedicalSettings_specialty :: Lens' EngineTranscribeMedicalSettings TranscribeMedicalSpecialty Source #

The specialty specified for the Amazon Transcribe Medical engine.

engineTranscribeMedicalSettings_type :: Lens' EngineTranscribeMedicalSettings TranscribeMedicalType Source #

The type of transcription.

EngineTranscribeSettings

engineTranscribeSettings_vocabularyName :: Lens' EngineTranscribeSettings (Maybe Text) Source #

The name of the vocabulary passed to Amazon Transcribe.

engineTranscribeSettings_vocabularyFilterName :: Lens' EngineTranscribeSettings (Maybe Text) Source #

The name of the vocabulary filter passed to Amazon Transcribe.

engineTranscribeSettings_vocabularyFilterMethod :: Lens' EngineTranscribeSettings (Maybe TranscribeVocabularyFilterMethod) Source #

The filtering method passed to Amazon Transcribe.

engineTranscribeSettings_region :: Lens' EngineTranscribeSettings (Maybe TranscribeRegion) Source #

The AWS Region passed to Amazon Transcribe. If you don't specify a Region, Amazon Chime uses the meeting's Region.

engineTranscribeSettings_languageCode :: Lens' EngineTranscribeSettings TranscribeLanguageCode Source #

The language code specified for the Amazon Transcribe engine.

EventsConfiguration

eventsConfiguration_lambdaFunctionArn :: Lens' EventsConfiguration (Maybe Text) Source #

Lambda function ARN that allows a bot to receive outgoing events.

eventsConfiguration_botId :: Lens' EventsConfiguration (Maybe Text) Source #

The bot ID.

eventsConfiguration_outboundEventsHTTPSEndpoint :: Lens' EventsConfiguration (Maybe Text) Source #

HTTPS endpoint that allows a bot to receive outgoing events.

GeoMatchParams

geoMatchParams_country :: Lens' GeoMatchParams Text Source #

The country.

geoMatchParams_areaCode :: Lens' GeoMatchParams Text Source #

The area code.

Identity

identity_arn :: Lens' Identity (Maybe Text) Source #

The ARN in an Identity.

identity_name :: Lens' Identity (Maybe Text) Source #

The name in an Identity.

Invite

invite_status :: Lens' Invite (Maybe InviteStatus) Source #

The status of the invite.

invite_emailStatus :: Lens' Invite (Maybe EmailStatus) Source #

The status of the invite email.

invite_inviteId :: Lens' Invite (Maybe Text) Source #

The invite ID.

invite_emailAddress :: Lens' Invite (Maybe Text) Source #

The email address to which the invite is sent.

LoggingConfiguration

loggingConfiguration_enableSIPLogs :: Lens' LoggingConfiguration (Maybe Bool) Source #

When true, enables SIP message logs for sending to Amazon CloudWatch Logs.

MediaCapturePipeline

mediaCapturePipeline_status :: Lens' MediaCapturePipeline (Maybe MediaPipelineStatus) Source #

The status of the media capture pipeline.

mediaCapturePipeline_sourceType :: Lens' MediaCapturePipeline (Maybe MediaPipelineSourceType) Source #

Source type from which media artifacts are saved. You must use ChimeMeeting.

mediaCapturePipeline_sourceArn :: Lens' MediaCapturePipeline (Maybe Text) Source #

ARN of the source from which the media artifacts will be saved.

mediaCapturePipeline_updatedTimestamp :: Lens' MediaCapturePipeline (Maybe UTCTime) Source #

The time at which the capture pipeline was updated, in ISO 8601 format.

mediaCapturePipeline_sinkType :: Lens' MediaCapturePipeline (Maybe MediaPipelineSinkType) Source #

Destination type to which the media artifacts are saved. You must use an S3 Bucket.

mediaCapturePipeline_chimeSdkMeetingConfiguration :: Lens' MediaCapturePipeline (Maybe ChimeSdkMeetingConfiguration) Source #

The configuration for a specified media capture pipeline. SourceType must be ChimeSdkMeeting.

mediaCapturePipeline_sinkArn :: Lens' MediaCapturePipeline (Maybe Text) Source #

ARN of the destination to which the media artifacts are saved.

mediaCapturePipeline_mediaPipelineId :: Lens' MediaCapturePipeline (Maybe Text) Source #

The ID of a media capture pipeline.

mediaCapturePipeline_createdTimestamp :: Lens' MediaCapturePipeline (Maybe UTCTime) Source #

The time at which the capture pipeline was created, in ISO 8601 format.

MediaPlacement

mediaPlacement_screenDataUrl :: Lens' MediaPlacement (Maybe Text) Source #

The screen data URL.

mediaPlacement_eventIngestionUrl :: Lens' MediaPlacement (Maybe Text) Source #

The event ingestion URL.

mediaPlacement_signalingUrl :: Lens' MediaPlacement (Maybe Text) Source #

The signaling URL.

mediaPlacement_screenSharingUrl :: Lens' MediaPlacement (Maybe Text) Source #

The screen sharing URL.

mediaPlacement_screenViewingUrl :: Lens' MediaPlacement (Maybe Text) Source #

The screen viewing URL.

mediaPlacement_audioHostUrl :: Lens' MediaPlacement (Maybe Text) Source #

The audio host URL.

mediaPlacement_audioFallbackUrl :: Lens' MediaPlacement (Maybe Text) Source #

The audio fallback URL.

mediaPlacement_turnControlUrl :: Lens' MediaPlacement (Maybe Text) Source #

The turn control URL.

Meeting

meeting_mediaRegion :: Lens' Meeting (Maybe Text) Source #

The Region in which you create the meeting. 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.

meeting_mediaPlacement :: Lens' Meeting (Maybe MediaPlacement) Source #

The media placement for the meeting.

meeting_externalMeetingId :: Lens' Meeting (Maybe Text) Source #

The external meeting ID.

meeting_meetingId :: Lens' Meeting (Maybe Text) Source #

The Amazon Chime SDK meeting ID.

MeetingNotificationConfiguration

meetingNotificationConfiguration_snsTopicArn :: Lens' MeetingNotificationConfiguration (Maybe Text) Source #

The SNS topic ARN.

meetingNotificationConfiguration_sqsQueueArn :: Lens' MeetingNotificationConfiguration (Maybe Text) Source #

The SQS queue ARN.

Member

member_fullName :: Lens' Member (Maybe Text) Source #

The member name.

member_email :: Lens' Member (Maybe Text) Source #

The member email address.

member_memberId :: Lens' Member (Maybe Text) Source #

The member ID (user ID or bot ID).

member_memberType :: Lens' Member (Maybe MemberType) Source #

The member type.

member_accountId :: Lens' Member (Maybe Text) Source #

The Amazon Chime account ID.

MemberError

memberError_memberId :: Lens' MemberError (Maybe Text) Source #

The member ID.

memberError_errorCode :: Lens' MemberError (Maybe ErrorCode) Source #

The error code.

memberError_errorMessage :: Lens' MemberError (Maybe Text) Source #

The error message.

MembershipItem

membershipItem_memberId :: Lens' MembershipItem (Maybe Text) Source #

The member ID.

membershipItem_role :: Lens' MembershipItem (Maybe RoomMembershipRole) Source #

The member role.

MessagingSessionEndpoint

messagingSessionEndpoint_url :: Lens' MessagingSessionEndpoint (Maybe Text) Source #

The endpoint to which you establish a websocket connection.

OrderedPhoneNumber

orderedPhoneNumber_status :: Lens' OrderedPhoneNumber (Maybe OrderedPhoneNumberStatus) Source #

The phone number status.

orderedPhoneNumber_e164PhoneNumber :: Lens' OrderedPhoneNumber (Maybe Text) Source #

The phone number, in E.164 format.

Origination

origination_routes :: Lens' Origination (Maybe [OriginationRoute]) Source #

The call distribution properties defined for your SIP hosts. Valid range: Minimum value of 1. Maximum value of 20. This parameter is not required, but you must specify this parameter or Disabled.

origination_disabled :: Lens' Origination (Maybe Bool) Source #

When origination settings are disabled, inbound calls are not enabled for your Amazon Chime Voice Connector. This parameter is not required, but you must specify this parameter or Routes.

OriginationRoute

originationRoute_priority :: Lens' OriginationRoute (Maybe Natural) Source #

The priority associated with the host, with 1 being the highest priority. Higher priority hosts are attempted first.

originationRoute_weight :: Lens' OriginationRoute (Maybe Natural) Source #

The weight associated with the host. If hosts are equal in priority, calls are redistributed among them based on their relative weight.

originationRoute_protocol :: Lens' OriginationRoute (Maybe OriginationRouteProtocol) Source #

The protocol to use for the origination route. Encryption-enabled Amazon Chime Voice Connectors use TCP protocol by default.

originationRoute_host :: Lens' OriginationRoute (Maybe Text) Source #

The FQDN or IP address to contact for origination traffic.

originationRoute_port :: Lens' OriginationRoute (Maybe Natural) Source #

The designated origination route port. Defaults to 5060.

Participant

participant_phoneNumber :: Lens' Participant (Maybe Text) Source #

The participant's phone number.

participant_proxyPhoneNumber :: Lens' Participant (Maybe Text) Source #

The participant's proxy phone number.

PhoneNumber

phoneNumber_status :: Lens' PhoneNumber (Maybe PhoneNumberStatus) Source #

The phone number status.

phoneNumber_deletionTimestamp :: Lens' PhoneNumber (Maybe UTCTime) Source #

The deleted phone number timestamp, in ISO 8601 format.

phoneNumber_phoneNumberId :: Lens' PhoneNumber (Maybe Text) Source #

The phone number ID.

phoneNumber_country :: Lens' PhoneNumber (Maybe Text) Source #

The phone number country. Format: ISO 3166-1 alpha-2.

phoneNumber_updatedTimestamp :: Lens' PhoneNumber (Maybe UTCTime) Source #

The updated phone number timestamp, in ISO 8601 format.

phoneNumber_productType :: Lens' PhoneNumber (Maybe PhoneNumberProductType) Source #

The phone number product type.

phoneNumber_e164PhoneNumber :: Lens' PhoneNumber (Maybe Text) Source #

The phone number, in E.164 format.

phoneNumber_associations :: Lens' PhoneNumber (Maybe [PhoneNumberAssociation]) Source #

The phone number associations.

phoneNumber_callingName :: Lens' PhoneNumber (Maybe Text) Source #

The outbound calling name associated with the phone number.

phoneNumber_type :: Lens' PhoneNumber (Maybe PhoneNumberType) Source #

The phone number type.

phoneNumber_createdTimestamp :: Lens' PhoneNumber (Maybe UTCTime) Source #

The phone number creation timestamp, in ISO 8601 format.

phoneNumber_capabilities :: Lens' PhoneNumber (Maybe PhoneNumberCapabilities) Source #

The phone number capabilities.

phoneNumber_callingNameStatus :: Lens' PhoneNumber (Maybe CallingNameStatus) Source #

The outbound calling name status.

PhoneNumberAssociation

phoneNumberAssociation_value :: Lens' PhoneNumberAssociation (Maybe Text) Source #

Contains the ID for the entity specified in Name.

phoneNumberAssociation_associatedTimestamp :: Lens' PhoneNumberAssociation (Maybe UTCTime) Source #

The timestamp of the phone number association, in ISO 8601 format.

phoneNumberAssociation_name :: Lens' PhoneNumberAssociation (Maybe PhoneNumberAssociationName) Source #

Defines the association with an Amazon Chime account ID, user ID, Amazon Chime Voice Connector ID, or Amazon Chime Voice Connector group ID.

PhoneNumberCapabilities

phoneNumberCapabilities_outboundMMS :: Lens' PhoneNumberCapabilities (Maybe Bool) Source #

Allows or denies outbound MMS messaging for the specified phone number.

phoneNumberCapabilities_inboundCall :: Lens' PhoneNumberCapabilities (Maybe Bool) Source #

Allows or denies inbound calling for the specified phone number.

phoneNumberCapabilities_inboundSMS :: Lens' PhoneNumberCapabilities (Maybe Bool) Source #

Allows or denies inbound SMS messaging for the specified phone number.

phoneNumberCapabilities_inboundMMS :: Lens' PhoneNumberCapabilities (Maybe Bool) Source #

Allows or denies inbound MMS messaging for the specified phone number.

phoneNumberCapabilities_outboundCall :: Lens' PhoneNumberCapabilities (Maybe Bool) Source #

Allows or denies outbound calling for the specified phone number.

phoneNumberCapabilities_outboundSMS :: Lens' PhoneNumberCapabilities (Maybe Bool) Source #

Allows or denies outbound SMS messaging for the specified phone number.

PhoneNumberCountry

phoneNumberCountry_supportedPhoneNumberTypes :: Lens' PhoneNumberCountry (Maybe [PhoneNumberType]) Source #

The supported phone number types.

phoneNumberCountry_countryCode :: Lens' PhoneNumberCountry (Maybe Text) Source #

The phone number country code. Format: ISO 3166-1 alpha-2.

PhoneNumberError

phoneNumberError_phoneNumberId :: Lens' PhoneNumberError (Maybe Text) Source #

The phone number ID for which the action failed.

phoneNumberError_errorCode :: Lens' PhoneNumberError (Maybe ErrorCode) Source #

The error code.

phoneNumberError_errorMessage :: Lens' PhoneNumberError (Maybe Text) Source #

The error message.

PhoneNumberOrder

phoneNumberOrder_status :: Lens' PhoneNumberOrder (Maybe PhoneNumberOrderStatus) Source #

The status of the phone number order.

phoneNumberOrder_orderedPhoneNumbers :: Lens' PhoneNumberOrder (Maybe [OrderedPhoneNumber]) Source #

The ordered phone number details, such as the phone number in E.164 format and the phone number status.

phoneNumberOrder_updatedTimestamp :: Lens' PhoneNumberOrder (Maybe UTCTime) Source #

The updated phone number order time stamp, in ISO 8601 format.

phoneNumberOrder_productType :: Lens' PhoneNumberOrder (Maybe PhoneNumberProductType) Source #

The phone number order product type.

phoneNumberOrder_phoneNumberOrderId :: Lens' PhoneNumberOrder (Maybe Text) Source #

The phone number order ID.

phoneNumberOrder_createdTimestamp :: Lens' PhoneNumberOrder (Maybe UTCTime) Source #

The phone number order creation time stamp, in ISO 8601 format.

Proxy

proxy_defaultSessionExpiryMinutes :: Lens' Proxy (Maybe Int) Source #

The default number of minutes allowed for proxy sessions.

proxy_disabled :: Lens' Proxy (Maybe Bool) Source #

When true, stops proxy sessions from being created on the specified Amazon Chime Voice Connector.

proxy_fallBackPhoneNumber :: Lens' Proxy (Maybe Text) Source #

The phone number to route calls to after a proxy session expires.

proxy_phoneNumberCountries :: Lens' Proxy (Maybe [Text]) Source #

The countries for proxy phone numbers to be selected from.

ProxySession

proxySession_status :: Lens' ProxySession (Maybe ProxySessionStatus) Source #

The status of the proxy session.

proxySession_numberSelectionBehavior :: Lens' ProxySession (Maybe NumberSelectionBehavior) Source #

The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.

proxySession_geoMatchParams :: Lens' ProxySession (Maybe GeoMatchParams) Source #

The country and area code for the proxy phone number.

proxySession_expiryMinutes :: Lens' ProxySession (Maybe Natural) Source #

The number of minutes allowed for the proxy session.

proxySession_endedTimestamp :: Lens' ProxySession (Maybe UTCTime) Source #

The ended time stamp, in ISO 8601 format.

proxySession_updatedTimestamp :: Lens' ProxySession (Maybe UTCTime) Source #

The updated time stamp, in ISO 8601 format.

proxySession_participants :: Lens' ProxySession (Maybe [Participant]) Source #

The proxy session participants.

proxySession_name :: Lens' ProxySession (Maybe Text) Source #

The name of the proxy session.

proxySession_proxySessionId :: Lens' ProxySession (Maybe Text) Source #

The proxy session ID.

proxySession_geoMatchLevel :: Lens' ProxySession (Maybe GeoMatchLevel) Source #

The preference for matching the country or area code of the proxy phone number with that of the first participant.

proxySession_voiceConnectorId :: Lens' ProxySession (Maybe Text) Source #

The Amazon Chime voice connector ID.

proxySession_createdTimestamp :: Lens' ProxySession (Maybe UTCTime) Source #

The created time stamp, in ISO 8601 format.

proxySession_capabilities :: Lens' ProxySession (Maybe [Capability]) Source #

The proxy session capabilities.

RetentionSettings

retentionSettings_roomRetentionSettings :: Lens' RetentionSettings (Maybe RoomRetentionSettings) Source #

The chat room retention settings.

retentionSettings_conversationRetentionSettings :: Lens' RetentionSettings (Maybe ConversationRetentionSettings) Source #

The chat conversation retention settings.

Room

room_updatedTimestamp :: Lens' Room (Maybe UTCTime) Source #

The room update timestamp, in ISO 8601 format.

room_createdBy :: Lens' Room (Maybe Text) Source #

The identifier of the room creator.

room_accountId :: Lens' Room (Maybe Text) Source #

The Amazon Chime account ID.

room_name :: Lens' Room (Maybe Text) Source #

The room name.

room_roomId :: Lens' Room (Maybe Text) Source #

The room ID.

room_createdTimestamp :: Lens' Room (Maybe UTCTime) Source #

The room creation timestamp, in ISO 8601 format.

RoomMembership

roomMembership_updatedTimestamp :: Lens' RoomMembership (Maybe UTCTime) Source #

The room membership update timestamp, in ISO 8601 format.

roomMembership_role :: Lens' RoomMembership (Maybe RoomMembershipRole) Source #

The membership role.

roomMembership_roomId :: Lens' RoomMembership (Maybe Text) Source #

The room ID.

roomMembership_member :: Lens' RoomMembership (Maybe Member) Source #

Undocumented member.

roomMembership_invitedBy :: Lens' RoomMembership (Maybe Text) Source #

The identifier of the user that invited the room member.

RoomRetentionSettings

roomRetentionSettings_retentionDays :: Lens' RoomRetentionSettings (Maybe Natural) Source #

The number of days for which to retain chat-room messages.

SelectedVideoStreams

selectedVideoStreams_attendeeIds :: Lens' SelectedVideoStreams (Maybe (NonEmpty Text)) Source #

The attendee IDs of the streams selected for a media capture pipeline.

selectedVideoStreams_externalUserIds :: Lens' SelectedVideoStreams (Maybe (NonEmpty Text)) Source #

The external user IDs of the streams selected for a media capture pipeline.

SigninDelegateGroup

signinDelegateGroup_groupName :: Lens' SigninDelegateGroup (Maybe Text) Source #

The group name.

SipMediaApplication

sipMediaApplication_updatedTimestamp :: Lens' SipMediaApplication (Maybe UTCTime) Source #

The SIP media application updated timestamp, in ISO 8601 format.

sipMediaApplication_name :: Lens' SipMediaApplication (Maybe Text) Source #

The name of the SIP media application.

sipMediaApplication_awsRegion :: Lens' SipMediaApplication (Maybe Text) Source #

The AWS Region in which the SIP media application is created.

sipMediaApplication_endpoints :: Lens' SipMediaApplication (Maybe (NonEmpty SipMediaApplicationEndpoint)) Source #

List of endpoints for SIP media application. Currently, only one endpoint per SIP media application is permitted.

sipMediaApplication_createdTimestamp :: Lens' SipMediaApplication (Maybe UTCTime) Source #

The SIP media application creation timestamp, in ISO 8601 format.

sipMediaApplication_sipMediaApplicationId :: Lens' SipMediaApplication (Maybe Text) Source #

The SIP media application ID.

SipMediaApplicationCall

sipMediaApplicationCall_transactionId :: Lens' SipMediaApplicationCall (Maybe Text) Source #

The transaction ID of a call.

SipMediaApplicationEndpoint

sipMediaApplicationEndpoint_lambdaArn :: Lens' SipMediaApplicationEndpoint (Maybe Text) Source #

Valid Amazon Resource Name (ARN) of the Lambda function. The function must be created in the same AWS Region as the SIP media application.

SipMediaApplicationLoggingConfiguration

sipMediaApplicationLoggingConfiguration_enableSipMediaApplicationMessageLogs :: Lens' SipMediaApplicationLoggingConfiguration (Maybe Bool) Source #

Enables application message logs for the SIP media application.

SipRule

sipRule_disabled :: Lens' SipRule (Maybe Bool) Source #

Indicates whether the SIP rule is enabled or disabled. You must disable a rule before you can delete it.

sipRule_targetApplications :: Lens' SipRule (Maybe (NonEmpty SipRuleTargetApplication)) Source #

Target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.

sipRule_triggerType :: Lens' SipRule (Maybe SipRuleTriggerType) Source #

The type of trigger assigned to the SIP rule in TriggerValue, currently RequestUriHostname or ToPhoneNumber.

sipRule_updatedTimestamp :: Lens' SipRule (Maybe UTCTime) Source #

The time at which the SIP rule was last updated, in ISO 8601 format.

sipRule_name :: Lens' SipRule (Maybe Text) Source #

The name of the SIP rule.

sipRule_triggerValue :: Lens' SipRule (Maybe Text) Source #

If TriggerType is RequestUriHostname, then the value can be the outbound host name of the Amazon Chime Voice Connector. If TriggerType is ToPhoneNumber, then the value can be a customer-owned phone number in E164 format. SipRule is triggered when a SIP rule requests host name or ToPhoneNumber matches in the incoming SIP request.

sipRule_createdTimestamp :: Lens' SipRule (Maybe UTCTime) Source #

The time at which the SIP rule was created, in ISO 8601 format.

sipRule_sipRuleId :: Lens' SipRule (Maybe Text) Source #

The SIP rule ID.

SipRuleTargetApplication

sipRuleTargetApplication_priority :: Lens' SipRuleTargetApplication (Maybe Natural) Source #

Priority of the SIP media application in the target list.

sipRuleTargetApplication_awsRegion :: Lens' SipRuleTargetApplication (Maybe Text) Source #

The AWS Region of the target application.

sipRuleTargetApplication_sipMediaApplicationId :: Lens' SipRuleTargetApplication (Maybe Text) Source #

The SIP media application ID.

SourceConfiguration

sourceConfiguration_selectedVideoStreams :: Lens' SourceConfiguration (Maybe SelectedVideoStreams) Source #

The selected video streams to capture for a specified media capture pipeline. The number of video streams can't exceed 25.

StreamingConfiguration

streamingConfiguration_disabled :: Lens' StreamingConfiguration (Maybe Bool) Source #

When true, media streaming to Amazon Kinesis is turned off.

streamingConfiguration_streamingNotificationTargets :: Lens' StreamingConfiguration (Maybe (NonEmpty StreamingNotificationTarget)) Source #

The streaming notification targets.

streamingConfiguration_dataRetentionInHours :: Lens' StreamingConfiguration Natural Source #

The retention period, in hours, for the Amazon Kinesis data.

StreamingNotificationTarget

streamingNotificationTarget_notificationTarget :: Lens' StreamingNotificationTarget NotificationTarget Source #

The streaming notification target.

Tag

tag_key :: Lens' Tag Text Source #

The key of the tag.

tag_value :: Lens' Tag Text Source #

The value of the tag.

TelephonySettings

telephonySettings_inboundCalling :: Lens' TelephonySettings Bool Source #

Allows or denies inbound calling.

telephonySettings_outboundCalling :: Lens' TelephonySettings Bool Source #

Allows or denies outbound calling.

telephonySettings_sms :: Lens' TelephonySettings Bool Source #

Allows or denies SMS messaging.

Termination

termination_defaultPhoneNumber :: Lens' Termination (Maybe Text) Source #

The default caller ID phone number.

termination_disabled :: Lens' Termination (Maybe Bool) Source #

When termination settings are disabled, outbound calls can not be made.

termination_callingRegions :: Lens' Termination (Maybe [Text]) Source #

The countries to which calls are allowed, in ISO 3166-1 alpha-2 format. Required.

termination_cpsLimit :: Lens' Termination (Maybe Natural) Source #

The limit on calls per second. Max value based on account service quota. Default value of 1.

termination_cidrAllowedList :: Lens' Termination (Maybe [Text]) Source #

The IP addresses allowed to make calls, in CIDR format. Required.

TerminationHealth

terminationHealth_source :: Lens' TerminationHealth (Maybe Text) Source #

The source IP address.

terminationHealth_timestamp :: Lens' TerminationHealth (Maybe UTCTime) Source #

The timestamp, in ISO 8601 format.

TranscriptionConfiguration

transcriptionConfiguration_engineTranscribeMedicalSettings :: Lens' TranscriptionConfiguration (Maybe EngineTranscribeMedicalSettings) Source #

The transcription configuration settings passed to Amazon Transcribe Medical.

transcriptionConfiguration_engineTranscribeSettings :: Lens' TranscriptionConfiguration (Maybe EngineTranscribeSettings) Source #

The transcription configuration settings passed to Amazon Transcribe.

UpdatePhoneNumberRequestItem

updatePhoneNumberRequestItem_productType :: Lens' UpdatePhoneNumberRequestItem (Maybe PhoneNumberProductType) Source #

The product type to update.

updatePhoneNumberRequestItem_callingName :: Lens' UpdatePhoneNumberRequestItem (Maybe Text) Source #

The outbound calling name to update.

updatePhoneNumberRequestItem_phoneNumberId :: Lens' UpdatePhoneNumberRequestItem Text Source #

The phone number ID to update.

UpdateUserRequestItem

updateUserRequestItem_licenseType :: Lens' UpdateUserRequestItem (Maybe License) Source #

The user license type.

updateUserRequestItem_userType :: Lens' UpdateUserRequestItem (Maybe UserType) Source #

The user type.

updateUserRequestItem_alexaForBusinessMetadata :: Lens' UpdateUserRequestItem (Maybe AlexaForBusinessMetadata) Source #

The Alexa for Business metadata.

updateUserRequestItem_userId :: Lens' UpdateUserRequestItem Text Source #

The user ID.

User

user_userInvitationStatus :: Lens' User (Maybe InviteStatus) Source #

The user invite status.

user_personalPIN :: Lens' User (Maybe Text) Source #

The user's personal meeting PIN.

user_primaryProvisionedNumber :: Lens' User (Maybe Text) Source #

The primary phone number associated with the user.

user_licenseType :: Lens' User (Maybe License) Source #

The license type for the user.

user_registeredOn :: Lens' User (Maybe UTCTime) Source #

Date and time when the user is registered, in ISO 8601 format.

user_accountId :: Lens' User (Maybe Text) Source #

The Amazon Chime account ID.

user_userRegistrationStatus :: Lens' User (Maybe RegistrationStatus) Source #

The user registration status.

user_invitedOn :: Lens' User (Maybe UTCTime) Source #

Date and time when the user is invited to the Amazon Chime account, in ISO 8601 format.

user_displayName :: Lens' User (Maybe Text) Source #

The display name of the user.

user_primaryEmail :: Lens' User (Maybe Text) Source #

The primary email address of the user.

user_userType :: Lens' User (Maybe UserType) Source #

The user type.

user_alexaForBusinessMetadata :: Lens' User (Maybe AlexaForBusinessMetadata) Source #

The Alexa for Business metadata.

user_userId :: Lens' User Text Source #

The user ID.

UserError

userError_userId :: Lens' UserError (Maybe Text) Source #

The user ID for which the action failed.

userError_errorCode :: Lens' UserError (Maybe ErrorCode) Source #

The error code.

userError_errorMessage :: Lens' UserError (Maybe Text) Source #

The error message.

UserSettings

userSettings_telephony :: Lens' UserSettings TelephonySettings Source #

The telephony settings associated with the user.

VideoArtifactsConfiguration

videoArtifactsConfiguration_muxType :: Lens' VideoArtifactsConfiguration (Maybe VideoMuxType) Source #

The MUX type of the video artifact configuration object.

videoArtifactsConfiguration_state :: Lens' VideoArtifactsConfiguration ArtifactsState Source #

Indicates whether the video artifact is enabled or disabled.

VoiceConnector

voiceConnector_updatedTimestamp :: Lens' VoiceConnector (Maybe UTCTime) Source #

The updated Amazon Chime Voice Connector timestamp, in ISO 8601 format.

voiceConnector_outboundHostName :: Lens' VoiceConnector (Maybe Text) Source #

The outbound host name for the Amazon Chime Voice Connector.

voiceConnector_name :: Lens' VoiceConnector (Maybe Text) Source #

The name of the Amazon Chime Voice Connector.

voiceConnector_requireEncryption :: Lens' VoiceConnector (Maybe Bool) Source #

Designates whether encryption is required for the Amazon Chime Voice Connector.

voiceConnector_awsRegion :: Lens' VoiceConnector (Maybe VoiceConnectorAwsRegion) Source #

The AWS Region in which the Amazon Chime Voice Connector is created. Default: us-east-1.

voiceConnector_voiceConnectorId :: Lens' VoiceConnector (Maybe Text) Source #

The Amazon Chime Voice Connector ID.

voiceConnector_voiceConnectorArn :: Lens' VoiceConnector (Maybe Text) Source #

The ARN of the specified Amazon Chime Voice Connector.

voiceConnector_createdTimestamp :: Lens' VoiceConnector (Maybe UTCTime) Source #

The Amazon Chime Voice Connector creation timestamp, in ISO 8601 format.

VoiceConnectorGroup

voiceConnectorGroup_voiceConnectorGroupId :: Lens' VoiceConnectorGroup (Maybe Text) Source #

The Amazon Chime Voice Connector group ID.

voiceConnectorGroup_updatedTimestamp :: Lens' VoiceConnectorGroup (Maybe UTCTime) Source #

The updated Amazon Chime Voice Connector group time stamp, in ISO 8601 format.

voiceConnectorGroup_voiceConnectorItems :: Lens' VoiceConnectorGroup (Maybe [VoiceConnectorItem]) Source #

The Amazon Chime Voice Connectors to which to route inbound calls.

voiceConnectorGroup_voiceConnectorGroupArn :: Lens' VoiceConnectorGroup (Maybe Text) Source #

The ARN of the specified Amazon Chime Voice Connector group.

voiceConnectorGroup_name :: Lens' VoiceConnectorGroup (Maybe Text) Source #

The name of the Amazon Chime Voice Connector group.

voiceConnectorGroup_createdTimestamp :: Lens' VoiceConnectorGroup (Maybe UTCTime) Source #

The Amazon Chime Voice Connector group creation time stamp, in ISO 8601 format.

VoiceConnectorItem

voiceConnectorItem_voiceConnectorId :: Lens' VoiceConnectorItem Text Source #

The Amazon Chime Voice Connector ID.

voiceConnectorItem_priority :: Lens' VoiceConnectorItem Natural Source #

The priority associated with the Amazon Chime Voice Connector, with 1 being the highest priority. Higher priority Amazon Chime Voice Connectors are attempted first.

VoiceConnectorSettings

voiceConnectorSettings_cdrBucket :: Lens' VoiceConnectorSettings (Maybe Text) Source #

The Amazon S3 bucket designated for call detail record storage.