Actions Permission-only actions Resource types Condition keys

Actions, resources, and condition keys for Alexa for Business

Alexa for Business (service prefix: a4b) provides the following service-specific operations, resources, actions, and condition keys for use in IAM permission policies.

References:

Learn how to configure this service.
View a list of the API operations available for this service.
Learn how to secure this service and its resources by using IAM permission policies.
View the programmatic service authorization reference for this service.

Topics

Actions defined by Alexa for Business
Permission-only actions for Alexa for Business
Resource types defined by Alexa for Business
Condition keys for Alexa for Business

Actions defined by Alexa for Business

You can specify the following actions in the Action element of an IAM policy statement. Use policies to grant permissions to perform an operation in AWS. When you use an action in a policy, you usually allow or deny access to the API operation or CLI command with the same name. However, in some cases, a single action controls access to more than one operation. Alternatively, some operations require several different actions.

Actions	Description	Resource types (*required)	Condition keys	Access level
ApproveSkill	Grants permission to associate a skill with the organization under the customer's AWS account			Write
AssociateContactWithAddressBook	Grants permission to associate a contact with a given address book	addressbook*		Write
AssociateContactWithAddressBook		contact*		Write
AssociateDeviceWithNetworkProfile	Grants permission to associate a device with the specified network profile	device*	aws:ResourceTag/${TagKey}	Write
AssociateDeviceWithNetworkProfile		networkprofile*		Write
AssociateDeviceWithRoom	Grants permission to associate device with given room	device*	aws:ResourceTag/${TagKey}	Write
AssociateDeviceWithRoom	Grants permission to associate device with given room	room*	aws:ResourceTag/${TagKey}	Write
AssociateSkillGroupWithRoom	Grants permission to associate the skill group with given room	room*	aws:ResourceTag/${TagKey}	Write
AssociateSkillGroupWithRoom		skillgroup*		Write
AssociateSkillWithSkillGroup	Grants permission to associate a skill with a skill group	skillgroup*		Write
AssociateSkillWithUsers	Grants permission to make a private skill available for enrolled users to enable on their devices			Write
CreateAddressBook	Grants permission to create an address book with the specified details		aws:RequestTag/${TagKey} aws:TagKeys	Write
CreateBusinessReportSchedule	Grants permission to create a recurring schedule for usage reports to deliver to the specified S3 location with a specified daily or weekly interval		aws:RequestTag/${TagKey} aws:TagKeys	Write
CreateConferenceProvider	Grants permission to add a new conference provider under the user's AWS account		aws:RequestTag/${TagKey} aws:TagKeys	Write
CreateContact	Grants permission to create a contact with the specified details		aws:RequestTag/${TagKey} aws:TagKeys	Write
CreateGatewayGroup	Grants permission to create a gateway group with the specified details		aws:RequestTag/${TagKey} aws:TagKeys	Write
CreateNetworkProfile	Grants permission to create a network profile with the specified details		aws:RequestTag/${TagKey} aws:TagKeys	Write
CreateProfile	Grants permission to create a new profile		aws:RequestTag/${TagKey} aws:TagKeys	Write
CreateRoom	Grants permission to create room with the specified details	profile*	aws:RequestTag/${TagKey} aws:TagKeys	Write
CreateSkillGroup	Grants permission to create a skill group with given name and description		aws:RequestTag/${TagKey} aws:TagKeys	Write
CreateUser	Grants permission to create a user	user*	aws:RequestTag/${TagKey} aws:ResourceTag/${TagKey} aws:TagKeys	Write
DeleteAddressBook	Grants permission to delete an address book by the address book ARN	addressbook*		Write
DeleteBusinessReportSchedule	Grants permission to delete the recurring report delivery schedule with the specified schedule ARN	schedule*		Write
DeleteConferenceProvider	Grants permission to delete a conference provider	conferenceprovider*		Write
DeleteContact	Grants permission to delete a contact by the contact ARN	contact*		Write
DeleteDevice	Grants permission to remove a device from Alexa For Business	device*	aws:ResourceTag/${TagKey}	Write
DeleteDeviceUsageData	Grants permission to delete the device's entire previous history of voice input data and associated response data	device*	aws:ResourceTag/${TagKey}	Write
DeleteGatewayGroup	Grants permission to delete a gateway group	gatewaygroup*		Write
DeleteNetworkProfile	Grants permission to delete a network profile by the network profile ARN	networkprofile*		Write
DeleteProfile	Grants permission to delete profile by profile ARN	profile*		Write
DeleteRoom	Grants permission to delete room	room*	aws:ResourceTag/${TagKey}	Write
DeleteRoomSkillParameter	Grants permission to delete a parameter from a skill and room	room*	aws:ResourceTag/${TagKey}	Write
DeleteSkillAuthorization	Grants permission to unlink a third-party account from a skill	room*	aws:ResourceTag/${TagKey}	Write
DeleteSkillGroup	Grants permission to delete skill group with skill group ARN	skillgroup*		Write
DeleteUser	Grants permission to delete a user	user*	aws:ResourceTag/${TagKey}	Write
DisassociateContactFromAddressBook	Grants permission to disassociate a contact from a given address book	addressbook*		Write
DisassociateContactFromAddressBook		contact*		Write
DisassociateDeviceFromRoom	Grants permission to disassociate device from its current room	device*	aws:ResourceTag/${TagKey}	Write
DisassociateSkillFromSkillGroup	Grants permission to disassociate a skill from a skill group	skillgroup*		Write
DisassociateSkillFromUsers	Grants permission to make a private skill unavailable for enrolled users and prevent them from enabling it on their devices	user*	aws:ResourceTag/${TagKey}	Write
DisassociateSkillGroupFromRoom	Grants permission to disassociate the skill group from given room	room*	aws:ResourceTag/${TagKey}	Write
DisassociateSkillGroupFromRoom		skillgroup*		Write
ForgetSmartHomeAppliances	Grants permission to forget smart home appliances associated to a room	room*	aws:ResourceTag/${TagKey}	Write
GetAddressBook	Grants permission to get the address book details by the address book ARN	addressbook*		Read
GetConferencePreference	Grants permission to retrieve the existing conference preferences			Read
GetConferenceProvider	Grants permission to get details about a specific conference provider	conferenceprovider*		Read
GetContact	Grants permission to get the contact details by the contact ARN	contact*		Read
GetDevice	Grants permission to get device details	device*	aws:ResourceTag/${TagKey}	Read
GetGateway	Grants permission to retrieve the details of a gateway	gateway*		Read
GetGatewayGroup	Grants permission to retrieve the details of a gateway group	gatewaygroup*		Read
GetInvitationConfiguration	Grants permission to retrieve the configured values for the user enrollment invitation email template			Read
GetNetworkProfile	Grants permission to get the network profile details by the network profile ARN	networkprofile*		Read
GetProfile	Grants permission to get profile when provided with Profile ARN	profile*		Read
GetRoom	Grants permission to get room details	room*	aws:ResourceTag/${TagKey}	Read
GetRoomSkillParameter	Grants permission to get an existing parameter that has been set for a skill and room	room*	aws:ResourceTag/${TagKey}	Read
GetSkillGroup	Grants permission to get skill group details with skill group ARN	skillgroup*		Read
ListBusinessReportSchedules	Grants permission to list the details of the schedules that a user configured			List
ListConferenceProviders	Grants permission to list conference providers under a specific AWS account			List
ListDeviceEvents	Grants permission to list the device event history, including device connection status, for up to 30 days	device*	aws:ResourceTag/${TagKey}	List
ListGatewayGroups	Grants permission to list gateway group summaries			List
ListGateways	Grants permission to list gateway summaries	gatewaygroup*		List
ListSkills	Grants permission to list skills			List
ListSkillsStoreCategories	Grants permission to list all categories in the Alexa skill store			List
ListSkillsStoreSkillsByCategory	Grants permission to list all skills in the Alexa skill store by category			List
ListSmartHomeAppliances	Grants permission to list all of the smart home appliances associated with a room	room*	aws:ResourceTag/${TagKey}	List
ListTags	Grants permission to list all tags on a resource	device	aws:ResourceTag/${TagKey}	Read
		room	aws:ResourceTag/${TagKey}
		user	aws:ResourceTag/${TagKey}
PutConferencePreference	Grants permission to set the conference preferences on a specific conference provider at the account level			Write
PutInvitationConfiguration	Grants permission to configure the email template for the user enrollment invitation with the specified attributes			Write
PutRoomSkillParameter	Grants permission to put a room specific parameter for a skill	room*	aws:ResourceTag/${TagKey}	Write
PutSkillAuthorization	Grants permission to link a user's account to a third-party skill provider	room*	aws:ResourceTag/${TagKey}	Write
RegisterAVSDevice	Grants permission to register an Alexa-enabled device built by an Original Equipment Manufacturer (OEM) using Alexa Voice Service (AVS)		aws:RequestTag/${TagKey} aws:TagKeys	Write
RejectSkill	Grants permission to disassociate a skill from the organization under a user's AWS account			Write
ResolveRoom	Grants permission to resolve room information			Read
RevokeInvitation	Grants permission to revoke an invitation	user*	aws:ResourceTag/${TagKey}	Write
SearchAddressBooks	Grants permission to search address books and list the ones that meet a set of filter and sort criteria			List
SearchContacts	Grants permission to search contacts and list the ones that meet a set of filter and sort criteria			List
SearchDevices	Grants permission to search for devices			List
SearchNetworkProfiles	Grants permission to search network profiles and list the ones that meet a set of filter and sort criteria			List
SearchProfiles	Grants permission to search for profiles			List
SearchRooms	Grants permission to search for rooms			List
SearchSkillGroups	Grants permission to search for skill groups			List
SearchUsers	Grants permission to search for users			List
SendAnnouncement	Grants permission to trigger an asynchronous flow to send text, SSML, or audio announcements to rooms that are identified by a search or filter			Write
SendInvitation	Grants permission to send an invitation to a user	user*	aws:ResourceTag/${TagKey}	Write
StartDeviceSync	Grants permission to restore the device and its account to its known, default settings by clearing all information and settings set by its previous users			Write
StartSmartHomeApplianceDiscovery	Grants permission to initiate the discovery of any smart home appliances associated with the room	room*	aws:ResourceTag/${TagKey}	Read
TagResource	Grants permission to add metadata tags to a resource	device	aws:RequestTag/${TagKey} aws:ResourceTag/${TagKey} aws:TagKeys	Tagging, Write
		room	aws:RequestTag/${TagKey} aws:ResourceTag/${TagKey} aws:TagKeys
		user	aws:RequestTag/${TagKey} aws:ResourceTag/${TagKey} aws:TagKeys
UntagResource	Grants permission to remove metadata tags from a resource	device	aws:ResourceTag/${TagKey}	Tagging, Write
		room	aws:ResourceTag/${TagKey}
		user	aws:ResourceTag/${TagKey}
UpdateAddressBook	Grants permission to update address book details by the address book ARN	addressbook*		Write
UpdateBusinessReportSchedule	Grants permission to update the configuration of the report delivery schedule with the specified schedule ARN	schedule*		Write
UpdateConferenceProvider	Grants permission to update an existing conference provider's settings	conferenceprovider*		Write
UpdateContact	Grants permission to update the contact details by the contact ARN	contact*		Write
UpdateDevice	Grants permission to update device name	device*	aws:ResourceTag/${TagKey}	Write
UpdateGateway	Grants permission to update the details of a gateway	gateway*		Write
UpdateGatewayGroup	Grants permission to update the details of a gateway group	gatewaygroup*		Write
UpdateNetworkProfile	Grants permission to update a network profile by the network profile ARN	networkprofile*		Write
UpdateProfile	Grants permission to update an existing profile	profile*		Write
UpdateRoom	Grants permission to update room details	room*	aws:ResourceTag/${TagKey}	Write
UpdateSkillGroup	Grants permission to update skill group details with skill group ARN	skillgroup*		Write

Permission-only actions for Alexa for Business

The following actions are defined by Alexa for Business but are not directly invocable through any API operation. They can only be used in IAM policy statements to grant or deny permissions.

Actions	Description	Access level
CompleteRegistration	Grants permission to complete the operation of registering an Alexa device	Write
PutDeviceSetupEvents	Grants permission to publish Alexa device setup events	Write
RegisterDevice	Grants permission to register an Alexa device	Write

Resource types defined by Alexa for Business

The following resource types are defined by this service and can be used in the Resource element of IAM permission policy statements.

Resource types	ARN	Condition keys
addressbook	arn:${Partition}:a4b:${Region}:${Account}:address-book/${ResourceId}
conferenceprovider	arn:${Partition}:a4b:${Region}:${Account}:conference-provider/${ResourceId}
contact	arn:${Partition}:a4b:${Region}:${Account}:contact/${ResourceId}
device	arn:${Partition}:a4b:${Region}:${Account}:device/${ResourceId}	aws:ResourceTag/${TagKey}
gateway	arn:${Partition}:a4b:${Region}:${Account}:gateway/${ResourceId}
gatewaygroup	arn:${Partition}:a4b:${Region}:${Account}:gateway-group/${ResourceId}
networkprofile	arn:${Partition}:a4b:${Region}:${Account}:network-profile/${ResourceId}
profile	arn:${Partition}:a4b:${Region}:${Account}:profile/${ResourceId}
room	arn:${Partition}:a4b:${Region}:${Account}:room/${ResourceId}	aws:ResourceTag/${TagKey}
schedule	arn:${Partition}:a4b:${Region}:${Account}:schedule/${ResourceId}
skillgroup	arn:${Partition}:a4b:${Region}:${Account}:skill-group/${ResourceId}
user	arn:${Partition}:a4b:${Region}:${Account}:user/${ResourceId}	aws:ResourceTag/${TagKey}

Condition keys for Alexa for Business

Alexa for Business defines the following condition keys that can be used in the Condition element of an IAM policy.

Condition keys	Description	Type
a4b:amazonId	Filters actions based on the Amazon Id in the request	String
a4b:filters_deviceType	Filters actions based on the device type in the request	ArrayOfString
aws:RequestTag/${TagKey}	Filters actions based on the allowed set of values for each of the tags	String
aws:ResourceTag/${TagKey}	Filters actions based on tag-value assoicated with the resource	String
aws:TagKeys	Filters actions based on the presence of mandatory tags in the request	ArrayOfString

Warning Javascript is disabled or is unavailable in your browser.

To use the Amazon Web Services Documentation, Javascript must be enabled. Please refer to your browser's Help pages for instructions.

Document Conventions

AWS Support Plans (supportplans)

Amazon AI Operations (aiops)