AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Classes

NameDescription
Class AddressBook

An address book with attributes.

Class AddressBookData

Information related to an address book.

Class AlreadyExistsException

AlexaForBusiness exception

Class AssociateContactWithAddressBookRequest

Container for the parameters to the AssociateContactWithAddressBook operation. Associates a contact with a given address book.

Class AssociateContactWithAddressBookResponse

This is the response object from the AssociateContactWithAddressBook operation.

Class AssociateDeviceWithRoomRequest

Container for the parameters to the AssociateDeviceWithRoom operation. 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.

Class AssociateDeviceWithRoomResponse

This is the response object from the AssociateDeviceWithRoom operation.

Class AssociateSkillGroupWithRoomRequest

Container for the parameters to the AssociateSkillGroupWithRoom operation. Associates a skill group with a given room. This enables all skills in the associated skill group on all devices in the room.

Class AssociateSkillGroupWithRoomResponse

This is the response object from the AssociateSkillGroupWithRoom operation.

Class Contact

A contact with attributes.

Class ContactData

Information related to a contact.

Class CreateAddressBookRequest

Container for the parameters to the CreateAddressBook operation. Creates an address book with the specified details.

Class CreateAddressBookResponse

This is the response object from the CreateAddressBook operation.

Class CreateContactRequest

Container for the parameters to the CreateContact operation. Creates a contact with the specified details.

Class CreateContactResponse

This is the response object from the CreateContact operation.

Class CreateProfileRequest

Container for the parameters to the CreateProfile operation. Creates a new room profile with the specified details.

Class CreateProfileResponse

This is the response object from the CreateProfile operation.

Class CreateRoomRequest

Container for the parameters to the CreateRoom operation. Creates a room with the specified details.

Class CreateRoomResponse

This is the response object from the CreateRoom operation.

Class CreateSkillGroupRequest

Container for the parameters to the CreateSkillGroup operation. Creates a skill group with a specified name and description.

Class CreateSkillGroupResponse

This is the response object from the CreateSkillGroup operation.

Class CreateUserRequest

Container for the parameters to the CreateUser operation. Creates a user.

Class CreateUserResponse

This is the response object from the CreateUser operation.

Class DeleteAddressBookRequest

Container for the parameters to the DeleteAddressBook operation. Deletes an address book by the address book ARN.

Class DeleteAddressBookResponse

This is the response object from the DeleteAddressBook operation.

Class DeleteContactRequest

Container for the parameters to the DeleteContact operation. Deletes a contact by the contact ARN.

Class DeleteContactResponse

This is the response object from the DeleteContact operation.

Class DeleteProfileRequest

Container for the parameters to the DeleteProfile operation. Deletes a room profile by the profile ARN.

Class DeleteProfileResponse

This is the response object from the DeleteProfile operation.

Class DeleteRoomRequest

Container for the parameters to the DeleteRoom operation. Deletes a room by the room ARN.

Class DeleteRoomResponse

This is the response object from the DeleteRoom operation.

Class DeleteRoomSkillParameterRequest

Container for the parameters to the DeleteRoomSkillParameter operation. Deletes room skill parameter details by room, skill, and parameter key ID.

Class DeleteRoomSkillParameterResponse

This is the response object from the DeleteRoomSkillParameter operation.

Class DeleteSkillGroupRequest

Container for the parameters to the DeleteSkillGroup operation. Deletes a skill group by skill group ARN.

Class DeleteSkillGroupResponse

This is the response object from the DeleteSkillGroup operation.

Class DeleteUserRequest

Container for the parameters to the DeleteUser operation. Deletes a specified user by user ARN and enrollment ARN.

Class DeleteUserResponse

This is the response object from the DeleteUser operation.

Class Device

A device with attributes.

Class DeviceData

Device attributes.

Class DeviceEvent

The list of device events.

Class DeviceNotRegisteredException

AlexaForBusiness exception

Class DeviceStatusDetail

Details of a device’s status.

Class DeviceStatusInfo

Detailed information about a device's status.

Class DisassociateContactFromAddressBookRequest

Container for the parameters to the DisassociateContactFromAddressBook operation. Disassociates a contact from a given address book.

Class DisassociateContactFromAddressBookResponse

This is the response object from the DisassociateContactFromAddressBook operation.

Class DisassociateDeviceFromRoomRequest

Container for the parameters to the DisassociateDeviceFromRoom operation. 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.

Class DisassociateDeviceFromRoomResponse

This is the response object from the DisassociateDeviceFromRoom operation.

Class DisassociateSkillGroupFromRoomRequest

Container for the parameters to the DisassociateSkillGroupFromRoom operation. Disassociates a skill group from a specified room. This disables all skills in the skill group on all devices in the room.

Class DisassociateSkillGroupFromRoomResponse

This is the response object from the DisassociateSkillGroupFromRoom operation.

Class Filter

A filter name and value pair that is used to return a more specific list of results. Filters can be used to match a set of resources by various criteria.

Class GetAddressBookRequest

Container for the parameters to the GetAddressBook operation. Gets address the book details by the address book ARN.

Class GetAddressBookResponse

This is the response object from the GetAddressBook operation.

Class GetContactRequest

Container for the parameters to the GetContact operation. Gets the contact details by the contact ARN.

Class GetContactResponse

This is the response object from the GetContact operation.

Class GetDeviceRequest

Container for the parameters to the GetDevice operation. Gets the details of a device by device ARN.

Class GetDeviceResponse

This is the response object from the GetDevice operation.

Class GetProfileRequest

Container for the parameters to the GetProfile operation. Gets the details of a room profile by profile ARN.

Class GetProfileResponse

This is the response object from the GetProfile operation.

Class GetRoomRequest

Container for the parameters to the GetRoom operation. Gets room details by room ARN.

Class GetRoomResponse

This is the response object from the GetRoom operation.

Class GetRoomSkillParameterRequest

Container for the parameters to the GetRoomSkillParameter operation. Gets room skill parameter details by room, skill, and parameter key ARN.

Class GetRoomSkillParameterResponse

This is the response object from the GetRoomSkillParameter operation.

Class GetSkillGroupRequest

Container for the parameters to the GetSkillGroup operation. Gets skill group details by skill group ARN.

Class GetSkillGroupResponse

This is the response object from the GetSkillGroup operation.

Class InvalidUserStatusException

AlexaForBusiness exception

Class LimitExceededException

AlexaForBusiness exception

Class ListDeviceEventsRequest

Container for the parameters to the ListDeviceEvents operation. Lists the device event history, including device connection status, for up to 30 days.

Class ListDeviceEventsResponse

This is the response object from the ListDeviceEvents operation.

Class ListSkillsRequest

Container for the parameters to the ListSkills operation. Lists all enabled skills in a specific skill group.

Class ListSkillsResponse

This is the response object from the ListSkills operation.

Class ListTagsRequest

Container for the parameters to the ListTags operation. Lists all tags for the specified resource.

Class ListTagsResponse

This is the response object from the ListTags operation.

Class NameInUseException

AlexaForBusiness exception

Class NotFoundException

AlexaForBusiness exception

Class Profile

A room profile with attributes.

Class ProfileData

The data of a room profile.

Class PutRoomSkillParameterRequest

Container for the parameters to the PutRoomSkillParameter operation. Updates room skill parameter details by room, skill, and parameter key ID. Not all skills have a room skill parameter.

Class PutRoomSkillParameterResponse

This is the response object from the PutRoomSkillParameter operation.

Class ResolveRoomRequest

Container for the parameters to the ResolveRoom operation. Determines the details for the room from which a skill request was invoked. This operation is used by skill developers.

Class ResolveRoomResponse

This is the response object from the ResolveRoom operation.

Class ResourceInUseException

AlexaForBusiness exception

Class RevokeInvitationRequest

Container for the parameters to the RevokeInvitation operation. Revokes an invitation and invalidates the enrollment URL.

Class RevokeInvitationResponse

This is the response object from the RevokeInvitation operation.

Class Room

A room with attributes.

Class RoomData

The data of a room.

Class RoomSkillParameter

A skill parameter associated with a room.

Class SearchAddressBooksRequest

Container for the parameters to the SearchAddressBooks operation. Searches address books and lists the ones that meet a set of filter and sort criteria.

Class SearchAddressBooksResponse

This is the response object from the SearchAddressBooks operation.

Class SearchContactsRequest

Container for the parameters to the SearchContacts operation. Searches contacts and lists the ones that meet a set of filter and sort criteria.

Class SearchContactsResponse

This is the response object from the SearchContacts operation.

Class SearchDevicesRequest

Container for the parameters to the SearchDevices operation. Searches devices and lists the ones that meet a set of filter criteria.

Class SearchDevicesResponse

This is the response object from the SearchDevices operation.

Class SearchProfilesRequest

Container for the parameters to the SearchProfiles operation. Searches room profiles and lists the ones that meet a set of filter criteria.

Class SearchProfilesResponse

This is the response object from the SearchProfiles operation.

Class SearchRoomsRequest

Container for the parameters to the SearchRooms operation. Searches rooms and lists the ones that meet a set of filter and sort criteria.

Class SearchRoomsResponse

This is the response object from the SearchRooms operation.

Class SearchSkillGroupsRequest

Container for the parameters to the SearchSkillGroups operation. Searches skill groups and lists the ones that meet a set of filter and sort criteria.

Class SearchSkillGroupsResponse

This is the response object from the SearchSkillGroups operation.

Class SearchUsersRequest

Container for the parameters to the SearchUsers operation. Searches users and lists the ones that meet a set of filter and sort criteria.

Class SearchUsersResponse

This is the response object from the SearchUsers operation.

Class SendInvitationRequest

Container for the parameters to the SendInvitation operation. Sends an enrollment invitation email with a URL to a user. The URL is valid for 72 hours or until you call this operation again, whichever comes first.

Class SendInvitationResponse

This is the response object from the SendInvitation operation.

Class SkillGroup

A skill group with attributes.

Class SkillGroupData

The attributes of a skill group.

Class SkillSummary

The summary of skills.

Class Sort

An object representing a sort criteria.

Class StartDeviceSyncRequest

Container for the parameters to the StartDeviceSync operation. Resets a device and its account to the known default settings, by clearing all information and settings set by previous users.

Class StartDeviceSyncResponse

This is the response object from the StartDeviceSync operation.

Class Tag

A key-value pair that can be associated with a resource.

Class TagResourceRequest

Container for the parameters to the TagResource operation. Adds metadata tags to a specified resource.

Class TagResourceResponse

This is the response object from the TagResource operation.

Class UntagResourceRequest

Container for the parameters to the UntagResource operation. Removes metadata tags from a specified resource.

Class UntagResourceResponse

This is the response object from the UntagResource operation.

Class UpdateAddressBookRequest

Container for the parameters to the UpdateAddressBook operation. Updates address book details by the address book ARN.

Class UpdateAddressBookResponse

This is the response object from the UpdateAddressBook operation.

Class UpdateContactRequest

Container for the parameters to the UpdateContact operation. Updates the contact details by the contact ARN.

Class UpdateContactResponse

This is the response object from the UpdateContact operation.

Class UpdateDeviceRequest

Container for the parameters to the UpdateDevice operation. Updates the device name by device ARN.

Class UpdateDeviceResponse

This is the response object from the UpdateDevice operation.

Class UpdateProfileRequest

Container for the parameters to the UpdateProfile operation. Updates an existing room profile by room profile ARN.

Class UpdateProfileResponse

This is the response object from the UpdateProfile operation.

Class UpdateRoomRequest

Container for the parameters to the UpdateRoom operation. Updates room details by room ARN.

Class UpdateRoomResponse

This is the response object from the UpdateRoom operation.

Class UpdateSkillGroupRequest

Container for the parameters to the UpdateSkillGroup operation. Updates skill group details by skill group ARN.

Class UpdateSkillGroupResponse

This is the response object from the UpdateSkillGroup operation.

Class UserData

Information related to a user.