Guides

CHIME

Suggest Edits
docs.aws.amazon.com
AWS documentation

AssociatePhoneNumberWithUser

valid {
    input.Body.E164PhoneNumber == STRING
    input.ReqMap.accountId == STRING
    input.ReqMap.userId == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

AssociateSigninDelegateGroupsWithAccount

valid {
    input.Body.SigninDelegateGroups[_].GroupName == STRING
    input.ReqMap.accountId == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

BatchCreateRoomMembership

enum_RoomMembershipRole := [ "Administrator", "Member" ]

valid {
    input.Body.MembershipItemList[_].MemberId == STRING
    input.Body.MembershipItemList[_].Role == enum_RoomMembershipRole[_]
    input.ReqMap.accountId == STRING
    input.ReqMap.roomId == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

BatchDeletePhoneNumber

valid {
    input.Body.PhoneNumberIds[_] == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

BatchSuspendUser

valid {
    input.Body.UserIdList[_] == STRING
    input.ReqMap.accountId == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

BatchUnsuspendUser

valid {
    input.Body.UserIdList[_] == STRING
    input.ReqMap.accountId == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

BatchUpdatePhoneNumber

enum_PhoneNumberProductType := [ "BusinessCalling", "VoiceConnector", "SipMediaApplicationDialIn" ]

valid {
    input.Body.UpdatePhoneNumberRequestItems[_].PhoneNumberId == STRING
    input.Body.UpdatePhoneNumberRequestItems[_].ProductType == enum_PhoneNumberProductType[_]
    input.Body.UpdatePhoneNumberRequestItems[_].CallingName == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

BatchUpdateUser

enum_License := [ "Basic", "Plus", "Pro", "ProTrial" ]
enum_UserType := [ "PrivateUser", "SharedDevice" ]

valid {
    input.Body.UpdateUserRequestItems[_].UserId == STRING
    input.Body.UpdateUserRequestItems[_].LicenseType == enum_License[_]
    input.Body.UpdateUserRequestItems[_].UserType == enum_UserType[_]
    input.Body.UpdateUserRequestItems[_].AlexaForBusinessMetadata.IsAlexaForBusinessEnabled == BOOLEAN
    input.Body.UpdateUserRequestItems[_].AlexaForBusinessMetadata.AlexaForBusinessRoomArn == STRING
    input.ReqMap.accountId == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

CreateAccount

valid {
    input.Body.Name == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

CreateBot

valid {
    input.Body.DisplayName == STRING
    input.Body.Domain == STRING
    input.ReqMap.accountId == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

CreateMeetingDialOut

valid {
    input.Body.FromPhoneNumber == STRING
    input.Body.ToPhoneNumber == STRING
    input.Body.JoinToken == STRING
    input.ReqMap.meetingId == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

CreatePhoneNumberOrder

enum_PhoneNumberProductType := [ "BusinessCalling", "VoiceConnector", "SipMediaApplicationDialIn" ]

valid {
    input.Body.ProductType == enum_PhoneNumberProductType[_]
    input.Body.E164PhoneNumbers[_] == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

CreateRoom

valid {
    input.Body.Name == STRING
    input.Body.ClientRequestToken == STRING
    input.ReqMap.accountId == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

CreateRoomMembership

enum_RoomMembershipRole := [ "Administrator", "Member" ]

valid {
    input.Body.MemberId == STRING
    input.Body.Role == enum_RoomMembershipRole[_]
    input.ReqMap.accountId == STRING
    input.ReqMap.roomId == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

CreateUser

enum_UserType := [ "PrivateUser", "SharedDevice" ]

valid {
    input.Body.Username == STRING
    input.Body.Email == STRING
    input.Body.UserType == enum_UserType[_]
    input.ReqMap.accountId == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

DeleteAccount

valid {
    input.ReqMap.accountId == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

DeleteEventsConfiguration

valid {
    input.ReqMap.accountId == STRING
    input.ReqMap.botId == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

DeletePhoneNumber

valid {
    input.ReqMap.phoneNumberId == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

DeleteRoom

valid {
    input.ReqMap.accountId == STRING
    input.ReqMap.roomId == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

DeleteRoomMembership

valid {
    input.ReqMap.accountId == STRING
    input.ReqMap.roomId == STRING
    input.ReqMap.memberId == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

DisassociatePhoneNumberFromUser

valid {
    input.ReqMap.accountId == STRING
    input.ReqMap.userId == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

DisassociateSigninDelegateGroupsFromAccount

valid {
    input.Body.GroupNames[_] == STRING
    input.ReqMap.accountId == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

GetAccount

valid {
    input.ReqMap.accountId == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

GetAccountSettings

valid {
    input.ReqMap.accountId == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

GetBot

valid {
    input.ReqMap.accountId == STRING
    input.ReqMap.botId == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

GetEventsConfiguration

valid {
    input.ReqMap.accountId == STRING
    input.ReqMap.botId == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

GetGlobalSettings

valid {
    input.ReqMap.accountId == STRING
    input.ReqMap.botId == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

GetPhoneNumber

valid {
    input.ReqMap.phoneNumberId == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

GetPhoneNumberOrder

valid {
    input.ReqMap.phoneNumberOrderId == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

GetPhoneNumberSettings

valid {
    input.ReqMap.phoneNumberOrderId == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

GetRetentionSettings

valid {
    input.ReqMap.accountId == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

GetRoom

valid {
    input.ReqMap.accountId == STRING
    input.ReqMap.roomId == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

GetUser

valid {
    input.ReqMap.accountId == STRING
    input.ReqMap.userId == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

GetUserSettings

valid {
    input.ReqMap.accountId == STRING
    input.ReqMap.userId == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

InviteUsers

enum_UserType := [ "PrivateUser", "SharedDevice" ]

valid {
    input.Body.UserEmailList[_] == STRING
    input.Body.UserType == enum_UserType[_]
    input.ReqMap.accountId == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

ListAccounts

valid {
    input.Qs.name == STRING
    input.Qs.user-email == STRING
    input.Qs.next-token == STRING
    input.Qs.max-results == INTEGER
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

ListBots

valid {
    input.ReqMap.accountId == STRING
    input.Qs.max-results == INTEGER
    input.Qs.next-token == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

ListPhoneNumberOrders

valid {
    input.Qs.next-token == STRING
    input.Qs.max-results == INTEGER
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

ListPhoneNumbers

enum_PhoneNumberAssociationName := [ "AccountId", "UserId", "VoiceConnectorId", "VoiceConnectorGroupId", "SipRuleId" ]
enum_PhoneNumberProductType := [ "BusinessCalling", "VoiceConnector", "SipMediaApplicationDialIn" ]
enum_PhoneNumberStatus := [ "AcquireInProgress", "AcquireFailed", "Unassigned", "Assigned", "ReleaseInProgress", "DeleteInProgress", "ReleaseFailed", "DeleteFailed" ]

valid {
    input.Qs.status == enum_PhoneNumberStatus[_]
    input.Qs.product-type == enum_PhoneNumberProductType[_]
    input.Qs.filter-name == enum_PhoneNumberAssociationName[_]
    input.Qs.filter-value == STRING
    input.Qs.max-results == INTEGER
    input.Qs.next-token == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

ListRoomMemberships

valid {
    input.ReqMap.accountId == STRING
    input.ReqMap.roomId == STRING
    input.Qs.max-results == INTEGER
    input.Qs.next-token == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

ListRooms

valid {
    input.ReqMap.accountId == STRING
    input.Qs.member-id == STRING
    input.Qs.max-results == INTEGER
    input.Qs.next-token == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

ListSupportedPhoneNumberCountries

enum_PhoneNumberProductType := [ "BusinessCalling", "VoiceConnector", "SipMediaApplicationDialIn" ]

valid {
    input.Qs.product-type == enum_PhoneNumberProductType[_]
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

ListUsers

enum_UserType := [ "PrivateUser", "SharedDevice" ]

valid {
    input.ReqMap.accountId == STRING
    input.Qs.user-email == STRING
    input.Qs.user-type == enum_UserType[_]
    input.Qs.max-results == INTEGER
    input.Qs.next-token == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

LogoutUser

valid {
    input.ReqMap.accountId == STRING
    input.ReqMap.userId == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

PutEventsConfiguration

valid {
    input.Body.OutboundEventsHTTPSEndpoint == STRING
    input.Body.LambdaFunctionArn == STRING
    input.ReqMap.accountId == STRING
    input.ReqMap.botId == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

PutRetentionSettings

valid {
    input.Body.RetentionSettings.RoomRetentionSettings.RetentionDays == INTEGER
    input.Body.RetentionSettings.ConversationRetentionSettings.RetentionDays == INTEGER
    input.ReqMap.accountId == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

RedactConversationMessage

valid {
    input.ReqMap.accountId == STRING
    input.ReqMap.conversationId == STRING
    input.ReqMap.messageId == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

RedactRoomMessage

valid {
    input.ReqMap.accountId == STRING
    input.ReqMap.roomId == STRING
    input.ReqMap.messageId == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

RegenerateSecurityToken

valid {
    input.ReqMap.accountId == STRING
    input.ReqMap.botId == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

ResetPersonalPIN

valid {
    input.ReqMap.accountId == STRING
    input.ReqMap.userId == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

RestorePhoneNumber

valid {
    input.ReqMap.phoneNumberId == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

SearchAvailablePhoneNumbers

enum_PhoneNumberType := [ "Local", "TollFree" ]

valid {
    input.Qs.area-code == STRING
    input.Qs.city == STRING
    input.Qs.country == STRING
    input.Qs.state == STRING
    input.Qs.toll-free-prefix == STRING
    input.Qs.phone-number-type == enum_PhoneNumberType[_]
    input.Qs.max-results == INTEGER
    input.Qs.next-token == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

UpdateAccount

enum_License := [ "Basic", "Plus", "Pro", "ProTrial" ]

valid {
    input.Body.Name == STRING
    input.Body.DefaultLicense == enum_License[_]
    input.ReqMap.accountId == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

UpdateAccountSettings

valid {
    input.Body.AccountSettings.DisableRemoteControl == BOOLEAN
    input.Body.AccountSettings.EnableDialOut == BOOLEAN
    input.ReqMap.accountId == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

UpdateBot

valid {
    input.Body.Disabled == BOOLEAN
    input.ReqMap.accountId == STRING
    input.ReqMap.botId == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

UpdateGlobalSettings

valid {
    input.Body.BusinessCalling.CdrBucket == STRING
    input.Body.VoiceConnector.CdrBucket == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

UpdatePhoneNumber

enum_PhoneNumberProductType := [ "BusinessCalling", "VoiceConnector", "SipMediaApplicationDialIn" ]

valid {
    input.Body.ProductType == enum_PhoneNumberProductType[_]
    input.Body.CallingName == STRING
    input.ReqMap.phoneNumberId == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

UpdatePhoneNumberSettings

valid {
    input.Body.CallingName == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

UpdateRoom

valid {
    input.Body.Name == STRING
    input.ReqMap.accountId == STRING
    input.ReqMap.roomId == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

UpdateRoomMembership

enum_RoomMembershipRole := [ "Administrator", "Member" ]

valid {
    input.Body.Role == enum_RoomMembershipRole[_]
    input.ReqMap.accountId == STRING
    input.ReqMap.roomId == STRING
    input.ReqMap.memberId == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

UpdateUser

enum_License := [ "Basic", "Plus", "Pro", "ProTrial" ]
enum_UserType := [ "PrivateUser", "SharedDevice" ]

valid {
    input.Body.LicenseType == enum_License[_]
    input.Body.UserType == enum_UserType[_]
    input.Body.AlexaForBusinessMetadata.IsAlexaForBusinessEnabled == BOOLEAN
    input.Body.AlexaForBusinessMetadata.AlexaForBusinessRoomArn == STRING
    input.ReqMap.accountId == STRING
    input.ReqMap.userId == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

UpdateUserSettings

valid {
    input.Body.UserSettings.Telephony.InboundCalling == BOOLEAN
    input.Body.UserSettings.Telephony.OutboundCalling == BOOLEAN
    input.Body.UserSettings.Telephony.SMS == BOOLEAN
    input.ReqMap.accountId == STRING
    input.ReqMap.userId == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

Updated 29 days ago