AlexaForBusiness class
Alexa for Business helps you use Alexa in your organization. Alexa for Business provides you with the tools to manage Alexa devices, enroll your users, and assign skills, at scale. You can build your own context-aware voice skills using the Alexa Skills Kit and the Alexa for Business API operations. You can also make these available as private skills for your organization. Alexa for Business makes it efficient to voice-enable your products and services, thus providing context-aware voice experiences for your customers. Device makers building with the Alexa Voice Service (AVS) can create fully integrated solutions, register their products with Alexa for Business, and manage them as shared devices in their organization.
Constructors
- AlexaForBusiness({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
approveSkill(
{required String skillId}) → Future< void> - Associates a skill with the organization under the customer's AWS account. If a skill is private, the user implicitly accepts access to this skill during enablement.
-
associateContactWithAddressBook(
{required String addressBookArn, required String contactArn}) → Future< void> - Associates a contact with a given address book.
-
associateDeviceWithNetworkProfile(
{required String deviceArn, required String networkProfileArn}) → Future< void> - Associates a device with the specified network profile.
-
associateDeviceWithRoom(
{String? deviceArn, String? roomArn}) → Future< void> - Associates a device with a given room. This applies all the settings from the room profile to the device, and all the skills in any skill groups added to that room. This operation requires the device to be online, or else a manual sync is required.
-
associateSkillGroupWithRoom(
{String? roomArn, String? skillGroupArn}) → Future< void> - Associates a skill group with a given room. This enables all skills in the associated skill group on all devices in the room.
-
associateSkillWithSkillGroup(
{required String skillId, String? skillGroupArn}) → Future< void> - Associates a skill with a skill group.
-
associateSkillWithUsers(
{required String skillId}) → Future< void> - Makes a private skill available for enrolled users to enable on their devices.
-
close(
) → void - Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.
-
createAddressBook(
{required String name, String? clientRequestToken, String? description}) → Future< CreateAddressBookResponse> - Creates an address book with the specified details.
-
createBusinessReportSchedule(
{required BusinessReportContentRange contentRange, required BusinessReportFormat format, String? clientRequestToken, BusinessReportRecurrence? recurrence, String? s3BucketName, String? s3KeyPrefix, String? scheduleName, List< Tag> ? tags}) → Future<CreateBusinessReportScheduleResponse> - Creates a recurring schedule for usage reports to deliver to the specified S3 location with a specified daily or weekly interval.
-
createConferenceProvider(
{required String conferenceProviderName, required ConferenceProviderType conferenceProviderType, required MeetingSetting meetingSetting, String? clientRequestToken, IPDialIn? iPDialIn, PSTNDialIn? pSTNDialIn}) → Future< CreateConferenceProviderResponse> - Adds a new conference provider under the user's AWS account.
-
createContact(
{required String firstName, String? clientRequestToken, String? displayName, String? lastName, String? phoneNumber, List< PhoneNumber> ? phoneNumbers, List<SipAddress> ? sipAddresses}) → Future<CreateContactResponse> - Creates a contact with the specified details.
-
createGatewayGroup(
{required String name, String? clientRequestToken, String? description}) → Future< CreateGatewayGroupResponse> - Creates a gateway group with the specified details.
-
createNetworkProfile(
{required String networkProfileName, required NetworkSecurityType securityType, required String ssid, String? certificateAuthorityArn, String? clientRequestToken, String? currentPassword, String? description, NetworkEapMethod? eapMethod, String? nextPassword, List< String> ? trustAnchors}) → Future<CreateNetworkProfileResponse> - Creates a network profile with the specified details.
-
createProfile(
{required String address, required DistanceUnit distanceUnit, required String profileName, required TemperatureUnit temperatureUnit, required String timezone, required WakeWord wakeWord, String? clientRequestToken, String? locale, int? maxVolumeLimit, CreateMeetingRoomConfiguration? meetingRoomConfiguration, bool? pSTNEnabled, bool? setupModeDisabled, List< Tag> ? tags}) → Future<CreateProfileResponse> - Creates a new room profile with the specified details.
-
createRoom(
{required String roomName, String? clientRequestToken, String? description, String? profileArn, String? providerCalendarId, List< Tag> ? tags}) → Future<CreateRoomResponse> - Creates a room with the specified details.
-
createSkillGroup(
{required String skillGroupName, String? clientRequestToken, String? description, List< Tag> ? tags}) → Future<CreateSkillGroupResponse> - Creates a skill group with a specified name and description.
-
createUser(
{required String userId, String? clientRequestToken, String? email, String? firstName, String? lastName, List< Tag> ? tags}) → Future<CreateUserResponse> - Creates a user.
-
deleteAddressBook(
{required String addressBookArn}) → Future< void> - Deletes an address book by the address book ARN.
-
deleteBusinessReportSchedule(
{required String scheduleArn}) → Future< void> - Deletes the recurring report delivery schedule with the specified schedule ARN.
-
deleteConferenceProvider(
{required String conferenceProviderArn}) → Future< void> - Deletes a conference provider.
-
deleteContact(
{required String contactArn}) → Future< void> - Deletes a contact by the contact ARN.
-
deleteDevice(
{required String deviceArn}) → Future< void> - Removes a device from Alexa For Business.
-
deleteDeviceUsageData(
{required String deviceArn, required DeviceUsageType deviceUsageType}) → Future< void> - When this action is called for a specified shared device, it allows authorized users to delete the device's entire previous history of voice input data and associated response data. This action can be called once every 24 hours for a specific shared device.
-
deleteGatewayGroup(
{required String gatewayGroupArn}) → Future< void> - Deletes a gateway group.
-
deleteNetworkProfile(
{required String networkProfileArn}) → Future< void> - Deletes a network profile by the network profile ARN.
-
deleteProfile(
{String? profileArn}) → Future< void> - Deletes a room profile by the profile ARN.
-
deleteRoom(
{String? roomArn}) → Future< void> - Deletes a room by the room ARN.
-
deleteRoomSkillParameter(
{required String parameterKey, required String skillId, String? roomArn}) → Future< void> - Deletes room skill parameter details by room, skill, and parameter key ID.
-
deleteSkillAuthorization(
{required String skillId, String? roomArn}) → Future< void> - Unlinks a third-party account from a skill.
-
deleteSkillGroup(
{String? skillGroupArn}) → Future< void> - Deletes a skill group by skill group ARN.
-
deleteUser(
{required String enrollmentId, String? userArn}) → Future< void> - Deletes a specified user by user ARN and enrollment ARN.
-
disassociateContactFromAddressBook(
{required String addressBookArn, required String contactArn}) → Future< void> - Disassociates a contact from a given address book.
-
disassociateDeviceFromRoom(
{String? deviceArn}) → Future< void> - Disassociates a device from its current room. The device continues to be connected to the Wi-Fi network and is still registered to the account. The device settings and skills are removed from the room.
-
disassociateSkillFromSkillGroup(
{required String skillId, String? skillGroupArn}) → Future< void> - Disassociates a skill from a skill group.
-
disassociateSkillFromUsers(
{required String skillId}) → Future< void> - Makes a private skill unavailable for enrolled users and prevents them from enabling it on their devices.
-
disassociateSkillGroupFromRoom(
{String? roomArn, String? skillGroupArn}) → Future< void> - Disassociates a skill group from a specified room. This disables all skills in the skill group on all devices in the room.
-
forgetSmartHomeAppliances(
{required String roomArn}) → Future< void> - Forgets smart home appliances associated to a room.
-
getAddressBook(
{required String addressBookArn}) → Future< GetAddressBookResponse> - Gets address the book details by the address book ARN.
-
getConferencePreference(
) → Future< GetConferencePreferenceResponse> - Retrieves the existing conference preferences.
-
getConferenceProvider(
{required String conferenceProviderArn}) → Future< GetConferenceProviderResponse> - Gets details about a specific conference provider.
-
getContact(
{required String contactArn}) → Future< GetContactResponse> - Gets the contact details by the contact ARN.
-
getDevice(
{String? deviceArn}) → Future< GetDeviceResponse> - Gets the details of a device by device ARN.
-
getGateway(
{required String gatewayArn}) → Future< GetGatewayResponse> - Retrieves the details of a gateway.
-
getGatewayGroup(
{required String gatewayGroupArn}) → Future< GetGatewayGroupResponse> - Retrieves the details of a gateway group.
-
getInvitationConfiguration(
) → Future< GetInvitationConfigurationResponse> - Retrieves the configured values for the user enrollment invitation email template.
-
getNetworkProfile(
{required String networkProfileArn}) → Future< GetNetworkProfileResponse> - Gets the network profile details by the network profile ARN.
-
getProfile(
{String? profileArn}) → Future< GetProfileResponse> - Gets the details of a room profile by profile ARN.
-
getRoom(
{String? roomArn}) → Future< GetRoomResponse> - Gets room details by room ARN.
-
getRoomSkillParameter(
{required String parameterKey, required String skillId, String? roomArn}) → Future< GetRoomSkillParameterResponse> - Gets room skill parameter details by room, skill, and parameter key ARN.
-
getSkillGroup(
{String? skillGroupArn}) → Future< GetSkillGroupResponse> - Gets skill group details by skill group ARN.
-
listBusinessReportSchedules(
{int? maxResults, String? nextToken}) → Future< ListBusinessReportSchedulesResponse> - Lists the details of the schedules that a user configured. A download URL of the report associated with each schedule is returned every time this action is called. A new download URL is returned each time, and is valid for 24 hours.
-
listConferenceProviders(
{int? maxResults, String? nextToken}) → Future< ListConferenceProvidersResponse> - Lists conference providers under a specific AWS account.
-
listDeviceEvents(
{required String deviceArn, DeviceEventType? eventType, int? maxResults, String? nextToken}) → Future< ListDeviceEventsResponse> - Lists the device event history, including device connection status, for up to 30 days.
-
listGatewayGroups(
{int? maxResults, String? nextToken}) → Future< ListGatewayGroupsResponse> - Retrieves a list of gateway group summaries. Use GetGatewayGroup to retrieve details of a specific gateway group.
-
listGateways(
{String? gatewayGroupArn, int? maxResults, String? nextToken}) → Future< ListGatewaysResponse> - Retrieves a list of gateway summaries. Use GetGateway to retrieve details of a specific gateway. An optional gateway group ARN can be provided to only retrieve gateway summaries of gateways that are associated with that gateway group ARN.
-
listSkills(
{EnablementTypeFilter? enablementType, int? maxResults, String? nextToken, String? skillGroupArn, SkillTypeFilter? skillType}) → Future< ListSkillsResponse> - Lists all enabled skills in a specific skill group.
-
listSkillsStoreCategories(
{int? maxResults, String? nextToken}) → Future< ListSkillsStoreCategoriesResponse> - Lists all categories in the Alexa skill store.
-
listSkillsStoreSkillsByCategory(
{required int categoryId, int? maxResults, String? nextToken}) → Future< ListSkillsStoreSkillsByCategoryResponse> - Lists all skills in the Alexa skill store by category.
-
listSmartHomeAppliances(
{required String roomArn, int? maxResults, String? nextToken}) → Future< ListSmartHomeAppliancesResponse> - Lists all of the smart home appliances associated with a room.
-
listTags(
{required String arn, int? maxResults, String? nextToken}) → Future< ListTagsResponse> - Lists all tags for the specified resource.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
putConferencePreference(
{required ConferencePreference conferencePreference}) → Future< void> - Sets the conference preferences on a specific conference provider at the account level.
-
putInvitationConfiguration(
{required String organizationName, String? contactEmail, List< String> ? privateSkillIds}) → Future<void> - Configures the email template for the user enrollment invitation with the specified attributes.
-
putRoomSkillParameter(
{required RoomSkillParameter roomSkillParameter, required String skillId, String? roomArn}) → Future< void> - Updates room skill parameter details by room, skill, and parameter key ID. Not all skills have a room skill parameter.
-
putSkillAuthorization(
{required Map< String, String> authorizationResult, required String skillId, String? roomArn}) → Future<void> - Links a user's account to a third-party skill provider. If this API operation is called by an assumed IAM role, the skill being linked must be a private skill. Also, the skill must be owned by the AWS account that assumed the IAM role.
-
registerAVSDevice(
{required String amazonId, required String clientId, required String productId, required String userCode, String? deviceSerialNumber, String? roomArn}) → Future< RegisterAVSDeviceResponse> - Registers an Alexa-enabled device built by an Original Equipment Manufacturer (OEM) using Alexa Voice Service (AVS).
-
rejectSkill(
{required String skillId}) → Future< void> - Disassociates a skill from the organization under a user's AWS account. If the skill is a private skill, it moves to an AcceptStatus of PENDING. Any private or public skill that is rejected can be added later by calling the ApproveSkill API.
-
resolveRoom(
{required String skillId, required String userId}) → Future< ResolveRoomResponse> - Determines the details for the room from which a skill request was invoked. This operation is used by skill developers.
-
revokeInvitation(
{String? enrollmentId, String? userArn}) → Future< void> - Revokes an invitation and invalidates the enrollment URL.
-
searchAddressBooks(
{List< Filter> ? filters, int? maxResults, String? nextToken, List<Sort> ? sortCriteria}) → Future<SearchAddressBooksResponse> - Searches address books and lists the ones that meet a set of filter and sort criteria.
-
searchContacts(
{List< Filter> ? filters, int? maxResults, String? nextToken, List<Sort> ? sortCriteria}) → Future<SearchContactsResponse> - Searches contacts and lists the ones that meet a set of filter and sort criteria.
-
searchDevices(
{List< Filter> ? filters, int? maxResults, String? nextToken, List<Sort> ? sortCriteria}) → Future<SearchDevicesResponse> - Searches devices and lists the ones that meet a set of filter criteria.
-
searchNetworkProfiles(
{List< Filter> ? filters, int? maxResults, String? nextToken, List<Sort> ? sortCriteria}) → Future<SearchNetworkProfilesResponse> - Searches network profiles and lists the ones that meet a set of filter and sort criteria.
-
searchProfiles(
{List< Filter> ? filters, int? maxResults, String? nextToken, List<Sort> ? sortCriteria}) → Future<SearchProfilesResponse> - Searches room profiles and lists the ones that meet a set of filter criteria.
-
searchRooms(
{List< Filter> ? filters, int? maxResults, String? nextToken, List<Sort> ? sortCriteria}) → Future<SearchRoomsResponse> - Searches rooms and lists the ones that meet a set of filter and sort criteria.
-
searchSkillGroups(
{List< Filter> ? filters, int? maxResults, String? nextToken, List<Sort> ? sortCriteria}) → Future<SearchSkillGroupsResponse> - Searches skill groups and lists the ones that meet a set of filter and sort criteria.
-
searchUsers(
{List< Filter> ? filters, int? maxResults, String? nextToken, List<Sort> ? sortCriteria}) → Future<SearchUsersResponse> - Searches users and lists the ones that meet a set of filter and sort criteria.
-
sendAnnouncement(
{required Content content, required List< Filter> roomFilters, String? clientRequestToken, int? timeToLiveInSeconds}) → Future<SendAnnouncementResponse> - Triggers an asynchronous flow to send text, SSML, or audio announcements to rooms that are identified by a search or filter.
-
sendInvitation(
{String? userArn}) → Future< void> - Sends an enrollment invitation email with a URL to a user. The URL is valid for 30 days or until you call this operation again, whichever comes first.
-
startDeviceSync(
{required List< Feature> features, String? deviceArn, String? roomArn}) → Future<void> - Resets a device and its account to the known default settings. This clears all information and settings set by previous users in the following ways:
-
startSmartHomeApplianceDiscovery(
{required String roomArn}) → Future< void> - Initiates the discovery of any smart home appliances associated with the room.
-
tagResource(
{required String arn, required List< Tag> tags}) → Future<void> - Adds metadata tags to a specified resource.
-
toString(
) → String -
A string representation of this object.
inherited
-
untagResource(
{required String arn, required List< String> tagKeys}) → Future<void> - Removes metadata tags from a specified resource.
-
updateAddressBook(
{required String addressBookArn, String? description, String? name}) → Future< void> - Updates address book details by the address book ARN.
-
updateBusinessReportSchedule(
{required String scheduleArn, BusinessReportFormat? format, BusinessReportRecurrence? recurrence, String? s3BucketName, String? s3KeyPrefix, String? scheduleName}) → Future< void> - Updates the configuration of the report delivery schedule with the specified schedule ARN.
-
updateConferenceProvider(
{required String conferenceProviderArn, required ConferenceProviderType conferenceProviderType, required MeetingSetting meetingSetting, IPDialIn? iPDialIn, PSTNDialIn? pSTNDialIn}) → Future< void> - Updates an existing conference provider's settings.
-
updateContact(
{required String contactArn, String? displayName, String? firstName, String? lastName, String? phoneNumber, List< PhoneNumber> ? phoneNumbers, List<SipAddress> ? sipAddresses}) → Future<void> - Updates the contact details by the contact ARN.
-
updateDevice(
{String? deviceArn, String? deviceName}) → Future< void> - Updates the device name by device ARN.
-
updateGateway(
{required String gatewayArn, String? description, String? name, String? softwareVersion}) → Future< void> - Updates the details of a gateway. If any optional field is not provided, the existing corresponding value is left unmodified.
-
updateGatewayGroup(
{required String gatewayGroupArn, String? description, String? name}) → Future< void> - Updates the details of a gateway group. If any optional field is not provided, the existing corresponding value is left unmodified.
-
updateNetworkProfile(
{required String networkProfileArn, String? certificateAuthorityArn, String? currentPassword, String? description, String? networkProfileName, String? nextPassword, List< String> ? trustAnchors}) → Future<void> - Updates a network profile by the network profile ARN.
-
updateProfile(
{String? address, DistanceUnit? distanceUnit, bool? isDefault, String? locale, int? maxVolumeLimit, UpdateMeetingRoomConfiguration? meetingRoomConfiguration, bool? pSTNEnabled, String? profileArn, String? profileName, bool? setupModeDisabled, TemperatureUnit? temperatureUnit, String? timezone, WakeWord? wakeWord}) → Future< void> - Updates an existing room profile by room profile ARN.
-
updateRoom(
{String? description, String? profileArn, String? providerCalendarId, String? roomArn, String? roomName}) → Future< void> - Updates room details by room ARN.
-
updateSkillGroup(
{String? description, String? skillGroupArn, String? skillGroupName}) → Future< void> - Updates skill group details by skill group ARN.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited