Class: AWS.AlexaForBusiness

Inherits:
AWS.Service show all
Identifier:
alexaforbusiness
API Version:
2017-11-09
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

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.

Sending a Request Using AlexaForBusiness

var alexaforbusiness = new AWS.AlexaForBusiness();
alexaforbusiness.forgetSmartHomeAppliances(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the AlexaForBusiness object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var alexaforbusiness = new AWS.AlexaForBusiness({apiVersion: '2017-11-09'});

You can also set the API version globally in AWS.config.apiVersions using the alexaforbusiness service identifier:

AWS.config.apiVersions = {
  alexaforbusiness: '2017-11-09',
  // other service API versions
};

var alexaforbusiness = new AWS.AlexaForBusiness();

Version:

  • 2017-11-09

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.AlexaForBusiness(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a AlexaForBusiness object

var alexaforbusiness = new AWS.AlexaForBusiness({apiVersion: '2017-11-09'});

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com'.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.AlexaForBusiness.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.AlexaForBusiness.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.AlexaForBusiness.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and returns the amount of time to delay in milliseconds. The base option will be ignored if this option is supplied.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean)

    whether to enable endpoint discovery for operations that allow optionally using an endpoint returned by the service. Defaults to 'false'

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

Property Details

endpointAWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

approveSkill(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the approveSkill operation

var params = {
  SkillId: 'STRING_VALUE' /* required */
};
alexaforbusiness.approveSkill(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • SkillId — (String)

      The unique identifier of the skill.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

associateContactWithAddressBook(params = {}, callback) ⇒ AWS.Request

Associates a contact with a given address book.

Service Reference:

Examples:

Calling the associateContactWithAddressBook operation

var params = {
  AddressBookArn: 'STRING_VALUE', /* required */
  ContactArn: 'STRING_VALUE' /* required */
};
alexaforbusiness.associateContactWithAddressBook(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ContactArn — (String)

      The ARN of the contact to associate with an address book.

    • AddressBookArn — (String)

      The ARN of the address book with which to associate the contact.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

associateDeviceWithRoom(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the associateDeviceWithRoom operation

var params = {
  DeviceArn: 'STRING_VALUE',
  RoomArn: 'STRING_VALUE'
};
alexaforbusiness.associateDeviceWithRoom(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DeviceArn — (String)

      The ARN of the device to associate to a room. Required.

    • RoomArn — (String)

      The ARN of the room with which to associate the device. Required.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

associateSkillGroupWithRoom(params = {}, callback) ⇒ AWS.Request

Associates a skill group with a given room. This enables all skills in the associated skill group on all devices in the room.

Service Reference:

Examples:

Calling the associateSkillGroupWithRoom operation

var params = {
  RoomArn: 'STRING_VALUE',
  SkillGroupArn: 'STRING_VALUE'
};
alexaforbusiness.associateSkillGroupWithRoom(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • SkillGroupArn — (String)

      The ARN of the skill group to associate with a room. Required.

    • RoomArn — (String)

      The ARN of the room with which to associate the skill group. Required.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

associateSkillWithSkillGroup(params = {}, callback) ⇒ AWS.Request

Associates a skill with a skill group.

Service Reference:

Examples:

Calling the associateSkillWithSkillGroup operation

var params = {
  SkillId: 'STRING_VALUE', /* required */
  SkillGroupArn: 'STRING_VALUE'
};
alexaforbusiness.associateSkillWithSkillGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • SkillGroupArn — (String)

      The ARN of the skill group to associate the skill to. Required.

    • SkillId — (String)

      The unique identifier of the skill.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

associateSkillWithUsers(params = {}, callback) ⇒ AWS.Request

Makes a private skill available for enrolled users to enable on their devices.

Service Reference:

Examples:

Calling the associateSkillWithUsers operation

var params = {
  SkillId: 'STRING_VALUE' /* required */
};
alexaforbusiness.associateSkillWithUsers(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • SkillId — (String)

      The private skill ID you want to make available to enrolled users.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createAddressBook(params = {}, callback) ⇒ AWS.Request

Creates an address book with the specified details.

Service Reference:

Examples:

Calling the createAddressBook operation

var params = {
  Name: 'STRING_VALUE', /* required */
  ClientRequestToken: 'STRING_VALUE',
  Description: 'STRING_VALUE'
};
alexaforbusiness.createAddressBook(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Name — (String)

      The name of the address book.

    • Description — (String)

      The description of the address book.

    • ClientRequestToken — (String)

      A unique, user-specified identifier for the request that ensures idempotency.

      If a token is not provided, the SDK will use a version 4 UUID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AddressBookArn — (String)

        The ARN of the newly created address book.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createBusinessReportSchedule(params = {}, callback) ⇒ AWS.Request

Creates a recurring schedule for usage reports to deliver to the specified S3 location with a specified daily or weekly interval.

Service Reference:

Examples:

Calling the createBusinessReportSchedule operation

var params = {
  ContentRange: { /* required */
    Interval: ONE_DAY | ONE_WEEK
  },
  Format: CSV | CSV_ZIP, /* required */
  ClientRequestToken: 'STRING_VALUE',
  Recurrence: {
    StartDate: 'STRING_VALUE'
  },
  S3BucketName: 'STRING_VALUE',
  S3KeyPrefix: 'STRING_VALUE',
  ScheduleName: 'STRING_VALUE'
};
alexaforbusiness.createBusinessReportSchedule(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ScheduleName — (String)

      The name identifier of the schedule.

    • S3BucketName — (String)

      The S3 bucket name of the output reports. If this isn't specified, the report can be retrieved from a download link by calling ListBusinessReportSchedule.

    • S3KeyPrefix — (String)

      The S3 key where the report is delivered.

    • Format — (String)

      The format of the generated report (individual CSV files or zipped files of individual files).

      Possible values include:
      • "CSV"
      • "CSV_ZIP"
    • ContentRange — (map)

      The content range of the reports.

      • Interval — (String)

        The interval of the content range.

        Possible values include:
        • "ONE_DAY"
        • "ONE_WEEK"
    • Recurrence — (map)

      The recurrence of the reports. If this isn't specified, the report will only be delivered one time when the API is called.

      • StartDate — (String)

        The start date.

    • ClientRequestToken — (String)

      The client request token.

      If a token is not provided, the SDK will use a version 4 UUID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ScheduleArn — (String)

        The ARN of the business report schedule.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createConferenceProvider(params = {}, callback) ⇒ AWS.Request

Adds a new conference provider under the user's AWS account.

Service Reference:

Examples:

Calling the createConferenceProvider operation

var params = {
  ConferenceProviderName: 'STRING_VALUE', /* required */
  ConferenceProviderType: CHIME | BLUEJEANS | FUZE | GOOGLE_HANGOUTS | POLYCOM | RINGCENTRAL | SKYPE_FOR_BUSINESS | WEBEX | ZOOM | CUSTOM, /* required */
  MeetingSetting: { /* required */
    RequirePin: YES | NO | OPTIONAL /* required */
  },
  ClientRequestToken: 'STRING_VALUE',
  IPDialIn: {
    CommsProtocol: SIP | SIPS | H323, /* required */
    Endpoint: 'STRING_VALUE' /* required */
  },
  PSTNDialIn: {
    CountryCode: 'STRING_VALUE', /* required */
    OneClickIdDelay: 'STRING_VALUE', /* required */
    OneClickPinDelay: 'STRING_VALUE', /* required */
    PhoneNumber: 'STRING_VALUE' /* required */
  }
};
alexaforbusiness.createConferenceProvider(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ConferenceProviderName — (String)

      The name of the conference provider.

    • ConferenceProviderType — (String)

      Represents a type within a list of predefined types.

      Possible values include:
      • "CHIME"
      • "BLUEJEANS"
      • "FUZE"
      • "GOOGLE_HANGOUTS"
      • "POLYCOM"
      • "RINGCENTRAL"
      • "SKYPE_FOR_BUSINESS"
      • "WEBEX"
      • "ZOOM"
      • "CUSTOM"
    • IPDialIn — (map)

      The IP endpoint and protocol for calling.

      • Endpointrequired — (String)

        The IP address.

      • CommsProtocolrequired — (String)

        The protocol, including SIP, SIPS, and H323.

        Possible values include:
        • "SIP"
        • "SIPS"
        • "H323"
    • PSTNDialIn — (map)

      The information for PSTN conferencing.

      • CountryCoderequired — (String)

        The zip code.

      • PhoneNumberrequired — (String)

        The phone number to call to join the conference.

      • OneClickIdDelayrequired — (String)

        The delay duration before Alexa enters the conference ID with dual-tone multi-frequency (DTMF). Each number on the dial pad corresponds to a DTMF tone, which is how we send data over the telephone network.

      • OneClickPinDelayrequired — (String)

        The delay duration before Alexa enters the conference pin with dual-tone multi-frequency (DTMF). Each number on the dial pad corresponds to a DTMF tone, which is how we send data over the telephone network.

    • MeetingSetting — (map)

      The meeting settings for the conference provider.

      • RequirePinrequired — (String)

        The values that indicate whether the pin is always required.

        Possible values include:
        • "YES"
        • "NO"
        • "OPTIONAL"
    • ClientRequestToken — (String)

      The request token of the client.

      If a token is not provided, the SDK will use a version 4 UUID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ConferenceProviderArn — (String)

        The ARN of the newly-created conference provider.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createContact(params = {}, callback) ⇒ AWS.Request

Creates a contact with the specified details.

Service Reference:

Examples:

Calling the createContact operation

var params = {
  FirstName: 'STRING_VALUE', /* required */
  ClientRequestToken: 'STRING_VALUE',
  DisplayName: 'STRING_VALUE',
  LastName: 'STRING_VALUE',
  PhoneNumber: 'STRING_VALUE'
};
alexaforbusiness.createContact(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DisplayName — (String)

      The name of the contact to display on the console.

    • FirstName — (String)

      The first name of the contact that is used to call the contact on the device.

    • LastName — (String)

      The last name of the contact that is used to call the contact on the device.

    • PhoneNumber — (String)

      The phone number of the contact in E.164 format.

    • ClientRequestToken — (String)

      A unique, user-specified identifier for this request that ensures idempotency.

      If a token is not provided, the SDK will use a version 4 UUID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ContactArn — (String)

        The ARN of the newly created address book.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createProfile(params = {}, callback) ⇒ AWS.Request

Creates a new room profile with the specified details.

Service Reference:

Examples:

Calling the createProfile operation

var params = {
  Address: 'STRING_VALUE', /* required */
  DistanceUnit: METRIC | IMPERIAL, /* required */
  ProfileName: 'STRING_VALUE', /* required */
  TemperatureUnit: FAHRENHEIT | CELSIUS, /* required */
  Timezone: 'STRING_VALUE', /* required */
  WakeWord: ALEXA | AMAZON | ECHO | COMPUTER, /* required */
  ClientRequestToken: 'STRING_VALUE',
  MaxVolumeLimit: 'NUMBER_VALUE',
  PSTNEnabled: true || false,
  SetupModeDisabled: true || false
};
alexaforbusiness.createProfile(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ProfileName — (String)

      The name of a room profile.

    • Timezone — (String)

      The time zone used by a room profile.

    • Address — (String)

      The valid address for the room.

    • DistanceUnit — (String)

      The distance unit to be used by devices in the profile.

      Possible values include:
      • "METRIC"
      • "IMPERIAL"
    • TemperatureUnit — (String)

      The temperature unit to be used by devices in the profile.

      Possible values include:
      • "FAHRENHEIT"
      • "CELSIUS"
    • WakeWord — (String)

      A wake word for Alexa, Echo, Amazon, or a computer.

      Possible values include:
      • "ALEXA"
      • "AMAZON"
      • "ECHO"
      • "COMPUTER"
    • ClientRequestToken — (String)

      The user-specified token that is used during the creation of a profile.

      If a token is not provided, the SDK will use a version 4 UUID.
    • SetupModeDisabled — (Boolean)

      Whether room profile setup is enabled.

    • MaxVolumeLimit — (Integer)

      The maximum volume limit for a room profile.

    • PSTNEnabled — (Boolean)

      Whether PSTN calling is enabled.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ProfileArn — (String)

        The ARN of the newly created room profile in the response.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createRoom(params = {}, callback) ⇒ AWS.Request

Creates a room with the specified details.

Service Reference:

Examples:

Calling the createRoom operation

var params = {
  RoomName: 'STRING_VALUE', /* required */
  ClientRequestToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  ProfileArn: 'STRING_VALUE',
  ProviderCalendarId: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
alexaforbusiness.createRoom(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • RoomName — (String)

      The name for the room.

    • Description — (String)

      The description for the room.

    • ProfileArn — (String)

      The profile ARN for the room.

    • ProviderCalendarId — (String)

      The calendar ARN for the room.

    • ClientRequestToken — (String)

      A unique, user-specified identifier for this request that ensures idempotency.

      If a token is not provided, the SDK will use a version 4 UUID.
    • Tags — (Array<map>)

      The tags for the room.

      • Keyrequired — (String)

        The key of a tag. Tag keys are case-sensitive.

      • Valuerequired — (String)

        The value of a tag. Tag values are case-sensitive and can be null.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • RoomArn — (String)

        The ARN of the newly created room in the response.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createSkillGroup(params = {}, callback) ⇒ AWS.Request

Creates a skill group with a specified name and description.

Service Reference:

Examples:

Calling the createSkillGroup operation

var params = {
  SkillGroupName: 'STRING_VALUE', /* required */
  ClientRequestToken: 'STRING_VALUE',
  Description: 'STRING_VALUE'
};
alexaforbusiness.createSkillGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • SkillGroupName — (String)

      The name for the skill group.

    • Description — (String)

      The description for the skill group.

    • ClientRequestToken — (String)

      A unique, user-specified identifier for this request that ensures idempotency.

      If a token is not provided, the SDK will use a version 4 UUID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SkillGroupArn — (String)

        The ARN of the newly created skill group in the response.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createUser(params = {}, callback) ⇒ AWS.Request

Creates a user.

Service Reference:

Examples:

Calling the createUser operation

var params = {
  UserId: 'STRING_VALUE', /* required */
  ClientRequestToken: 'STRING_VALUE',
  Email: 'STRING_VALUE',
  FirstName: 'STRING_VALUE',
  LastName: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
alexaforbusiness.createUser(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • UserId — (String)

      The ARN for the user.

    • FirstName — (String)

      The first name for the user.

    • LastName — (String)

      The last name for the user.

    • Email — (String)

      The email address for the user.

    • ClientRequestToken — (String)

      A unique, user-specified identifier for this request that ensures idempotency.

      If a token is not provided, the SDK will use a version 4 UUID.
    • Tags — (Array<map>)

      The tags for the user.

      • Keyrequired — (String)

        The key of a tag. Tag keys are case-sensitive.

      • Valuerequired — (String)

        The value of a tag. Tag values are case-sensitive and can be null.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • UserArn — (String)

        The ARN of the newly created user in the response.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteAddressBook(params = {}, callback) ⇒ AWS.Request

Deletes an address book by the address book ARN.

Service Reference:

Examples:

Calling the deleteAddressBook operation

var params = {
  AddressBookArn: 'STRING_VALUE' /* required */
};
alexaforbusiness.deleteAddressBook(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AddressBookArn — (String)

      The ARN of the address book to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteBusinessReportSchedule(params = {}, callback) ⇒ AWS.Request

Deletes the recurring report delivery schedule with the specified schedule ARN.

Service Reference:

Examples:

Calling the deleteBusinessReportSchedule operation

var params = {
  ScheduleArn: 'STRING_VALUE' /* required */
};
alexaforbusiness.deleteBusinessReportSchedule(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ScheduleArn — (String)

      The ARN of the business report schedule.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteConferenceProvider(params = {}, callback) ⇒ AWS.Request

Deletes a conference provider.

Service Reference:

Examples:

Calling the deleteConferenceProvider operation

var params = {
  ConferenceProviderArn: 'STRING_VALUE' /* required */
};
alexaforbusiness.deleteConferenceProvider(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ConferenceProviderArn — (String)

      The ARN of the conference provider.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteContact(params = {}, callback) ⇒ AWS.Request

Deletes a contact by the contact ARN.

Service Reference:

Examples:

Calling the deleteContact operation

var params = {
  ContactArn: 'STRING_VALUE' /* required */
};
alexaforbusiness.deleteContact(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ContactArn — (String)

      The ARN of the contact to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteDevice(params = {}, callback) ⇒ AWS.Request

Removes a device from Alexa For Business.

Service Reference:

Examples:

Calling the deleteDevice operation

var params = {
  DeviceArn: 'STRING_VALUE' /* required */
};
alexaforbusiness.deleteDevice(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DeviceArn — (String)

      The ARN of the device for which to request details.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteProfile(params = {}, callback) ⇒ AWS.Request

Deletes a room profile by the profile ARN.

Service Reference:

Examples:

Calling the deleteProfile operation

var params = {
  ProfileArn: 'STRING_VALUE'
};
alexaforbusiness.deleteProfile(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ProfileArn — (String)

      The ARN of the room profile to delete. Required.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteRoom(params = {}, callback) ⇒ AWS.Request

Deletes a room by the room ARN.

Service Reference:

Examples:

Calling the deleteRoom operation

var params = {
  RoomArn: 'STRING_VALUE'
};
alexaforbusiness.deleteRoom(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • RoomArn — (String)

      The ARN of the room to delete. Required.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteRoomSkillParameter(params = {}, callback) ⇒ AWS.Request

Deletes room skill parameter details by room, skill, and parameter key ID.

Service Reference:

Examples:

Calling the deleteRoomSkillParameter operation

var params = {
  ParameterKey: 'STRING_VALUE', /* required */
  SkillId: 'STRING_VALUE', /* required */
  RoomArn: 'STRING_VALUE'
};
alexaforbusiness.deleteRoomSkillParameter(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • RoomArn — (String)

      The ARN of the room from which to remove the room skill parameter details.

    • SkillId — (String)

      The ID of the skill from which to remove the room skill parameter details.

    • ParameterKey — (String)

      The room skill parameter key for which to remove details.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteSkillAuthorization(params = {}, callback) ⇒ AWS.Request

Unlinks a third-party account from a skill.

Service Reference:

Examples:

Calling the deleteSkillAuthorization operation

var params = {
  SkillId: 'STRING_VALUE', /* required */
  RoomArn: 'STRING_VALUE'
};
alexaforbusiness.deleteSkillAuthorization(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • SkillId — (String)

      The unique identifier of a skill.

    • RoomArn — (String)

      The room that the skill is authorized for.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteSkillGroup(params = {}, callback) ⇒ AWS.Request

Deletes a skill group by skill group ARN.

Service Reference:

Examples:

Calling the deleteSkillGroup operation

var params = {
  SkillGroupArn: 'STRING_VALUE'
};
alexaforbusiness.deleteSkillGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • SkillGroupArn — (String)

      The ARN of the skill group to delete. Required.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteUser(params = {}, callback) ⇒ AWS.Request

Deletes a specified user by user ARN and enrollment ARN.

Service Reference:

Examples:

Calling the deleteUser operation

var params = {
  EnrollmentId: 'STRING_VALUE', /* required */
  UserArn: 'STRING_VALUE'
};
alexaforbusiness.deleteUser(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • UserArn — (String)

      The ARN of the user to delete in the organization. Required.

    • EnrollmentId — (String)

      The ARN of the user's enrollment in the organization. Required.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

disassociateContactFromAddressBook(params = {}, callback) ⇒ AWS.Request

Disassociates a contact from a given address book.

Examples:

Calling the disassociateContactFromAddressBook operation

var params = {
  AddressBookArn: 'STRING_VALUE', /* required */
  ContactArn: 'STRING_VALUE' /* required */
};
alexaforbusiness.disassociateContactFromAddressBook(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ContactArn — (String)

      The ARN of the contact to disassociate from an address book.

    • AddressBookArn — (String)

      The ARN of the address from which to disassociate the contact.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

disassociateDeviceFromRoom(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the disassociateDeviceFromRoom operation

var params = {
  DeviceArn: 'STRING_VALUE'
};
alexaforbusiness.disassociateDeviceFromRoom(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DeviceArn — (String)

      The ARN of the device to disassociate from a room. Required.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

disassociateSkillFromSkillGroup(params = {}, callback) ⇒ AWS.Request

Disassociates a skill from a skill group.

Service Reference:

Examples:

Calling the disassociateSkillFromSkillGroup operation

var params = {
  SkillId: 'STRING_VALUE', /* required */
  SkillGroupArn: 'STRING_VALUE'
};
alexaforbusiness.disassociateSkillFromSkillGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • SkillGroupArn — (String)

      The unique identifier of a skill. Required.

    • SkillId — (String)

      The ARN of a skill group to associate to a skill.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

disassociateSkillFromUsers(params = {}, callback) ⇒ AWS.Request

Makes a private skill unavailable for enrolled users and prevents them from enabling it on their devices.

Service Reference:

Examples:

Calling the disassociateSkillFromUsers operation

var params = {
  SkillId: 'STRING_VALUE' /* required */
};
alexaforbusiness.disassociateSkillFromUsers(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • SkillId — (String)

      The private skill ID you want to make unavailable for enrolled users.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

disassociateSkillGroupFromRoom(params = {}, callback) ⇒ AWS.Request

Disassociates a skill group from a specified room. This disables all skills in the skill group on all devices in the room.

Service Reference:

Examples:

Calling the disassociateSkillGroupFromRoom operation

var params = {
  RoomArn: 'STRING_VALUE',
  SkillGroupArn: 'STRING_VALUE'
};
alexaforbusiness.disassociateSkillGroupFromRoom(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • SkillGroupArn — (String)

      The ARN of the skill group to disassociate from a room. Required.

    • RoomArn — (String)

      The ARN of the room from which the skill group is to be disassociated. Required.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

forgetSmartHomeAppliances(params = {}, callback) ⇒ AWS.Request

Forgets smart home appliances associated to a room.

Service Reference:

Examples:

Calling the forgetSmartHomeAppliances operation

var params = {
  RoomArn: 'STRING_VALUE' /* required */
};
alexaforbusiness.forgetSmartHomeAppliances(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • RoomArn — (String)

      The room that the appliances are associated with.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getAddressBook(params = {}, callback) ⇒ AWS.Request

Gets address the book details by the address book ARN.

Service Reference:

Examples:

Calling the getAddressBook operation

var params = {
  AddressBookArn: 'STRING_VALUE' /* required */
};
alexaforbusiness.getAddressBook(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AddressBookArn — (String)

      The ARN of the address book for which to request details.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AddressBook — (map)

        The details of the requested address book.

        • AddressBookArn — (String)

          The ARN of the address book.

        • Name — (String)

          The name of the address book.

        • Description — (String)

          The description of the address book.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getConferencePreference(params = {}, callback) ⇒ AWS.Request

Retrieves the existing conference preferences.

Service Reference:

Examples:

Calling the getConferencePreference operation

var params = {
};
alexaforbusiness.getConferencePreference(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Preference — (map)

        The conference preference.

        • DefaultConferenceProviderArn — (String)

          The ARN of the default conference provider.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getConferenceProvider(params = {}, callback) ⇒ AWS.Request

Gets details about a specific conference provider.

Service Reference:

Examples:

Calling the getConferenceProvider operation

var params = {
  ConferenceProviderArn: 'STRING_VALUE' /* required */
};
alexaforbusiness.getConferenceProvider(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ConferenceProviderArn — (String)

      The ARN of the newly created conference provider.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ConferenceProvider — (map)

        The conference provider.

        • Arn — (String)

          The ARN of the newly created conference provider.

        • Name — (String)

          The name of the conference provider.

        • Type — (String)

          The type of conference providers.

          Possible values include:
          • "CHIME"
          • "BLUEJEANS"
          • "FUZE"
          • "GOOGLE_HANGOUTS"
          • "POLYCOM"
          • "RINGCENTRAL"
          • "SKYPE_FOR_BUSINESS"
          • "WEBEX"
          • "ZOOM"
          • "CUSTOM"
        • IPDialIn — (map)

          The IP endpoint and protocol for calling.

          • Endpointrequired — (String)

            The IP address.

          • CommsProtocolrequired — (String)

            The protocol, including SIP, SIPS, and H323.

            Possible values include:
            • "SIP"
            • "SIPS"
            • "H323"
        • PSTNDialIn — (map)

          The information for PSTN conferencing.

          • CountryCoderequired — (String)

            The zip code.

          • PhoneNumberrequired — (String)

            The phone number to call to join the conference.

          • OneClickIdDelayrequired — (String)

            The delay duration before Alexa enters the conference ID with dual-tone multi-frequency (DTMF). Each number on the dial pad corresponds to a DTMF tone, which is how we send data over the telephone network.

          • OneClickPinDelayrequired — (String)

            The delay duration before Alexa enters the conference pin with dual-tone multi-frequency (DTMF). Each number on the dial pad corresponds to a DTMF tone, which is how we send data over the telephone network.

        • MeetingSetting — (map)

          The meeting settings for the conference provider.

          • RequirePinrequired — (String)

            The values that indicate whether the pin is always required.

            Possible values include:
            • "YES"
            • "NO"
            • "OPTIONAL"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getContact(params = {}, callback) ⇒ AWS.Request

Gets the contact details by the contact ARN.

Service Reference:

Examples:

Calling the getContact operation

var params = {
  ContactArn: 'STRING_VALUE' /* required */
};
alexaforbusiness.getContact(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ContactArn — (String)

      The ARN of the contact for which to request details.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Contact — (map)

        The details of the requested contact.

        • ContactArn — (String)

          The ARN of the contact.

        • DisplayName — (String)

          The name of the contact to display on the console.

        • FirstName — (String)

          The first name of the contact, used to call the contact on the device.

        • LastName — (String)

          The last name of the contact, used to call the contact on the device.

        • PhoneNumber — (String)

          The phone number of the contact.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getDevice(params = {}, callback) ⇒ AWS.Request

Gets the details of a device by device ARN.

Service Reference:

Examples:

Calling the getDevice operation

var params = {
  DeviceArn: 'STRING_VALUE'
};
alexaforbusiness.getDevice(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DeviceArn — (String)

      The ARN of the device for which to request details. Required.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Device — (map)

        The details of the device requested. Required.

        • DeviceArn — (String)

          The ARN of a device.

        • DeviceSerialNumber — (String)

          The serial number of a device.

        • DeviceType — (String)

          The type of a device.

        • DeviceName — (String)

          The name of a device.

        • SoftwareVersion — (String)

          The software version of a device.

        • MacAddress — (String)

          The MAC address of a device.

        • RoomArn — (String)

          The room ARN of a device.

        • DeviceStatus — (String)

          The status of a device. If the status is not READY, check the DeviceStatusInfo value for details.

          Possible values include:
          • "READY"
          • "PENDING"
          • "WAS_OFFLINE"
          • "DEREGISTERED"
        • DeviceStatusInfo — (map)

          Detailed information about a device's status.

          • DeviceStatusDetails — (Array<map>)

            One or more device status detail descriptions.

            • Code — (String)

              The device status detail code.

              Possible values include:
              • "DEVICE_SOFTWARE_UPDATE_NEEDED"
              • "DEVICE_WAS_OFFLINE"
          • ConnectionStatus — (String)

            The latest available information about the connection status of a device.

            Possible values include:
            • "ONLINE"
            • "OFFLINE"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getInvitationConfiguration(params = {}, callback) ⇒ AWS.Request

Retrieves the configured values for the user enrollment invitation email template.

Service Reference:

Examples:

Calling the getInvitationConfiguration operation

var params = {
};
alexaforbusiness.getInvitationConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • OrganizationName — (String)

        The name of the organization sending the enrollment invite to a user.

      • ContactEmail — (String)

        The email ID of the organization or individual contact that the enrolled user can use.

      • PrivateSkillIds — (Array<String>)

        The list of private skill IDs that you want to recommend to the user to enable in the invitation.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getProfile(params = {}, callback) ⇒ AWS.Request

Gets the details of a room profile by profile ARN.

Service Reference:

Examples:

Calling the getProfile operation

var params = {
  ProfileArn: 'STRING_VALUE'
};
alexaforbusiness.getProfile(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ProfileArn — (String)

      The ARN of the room profile for which to request details. Required.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Profile — (map)

        The details of the room profile requested. Required.

        • ProfileArn — (String)

          The ARN of a room profile.

        • ProfileName — (String)

          The name of a room profile.

        • IsDefault — (Boolean)

          Retrieves if the profile is default or not.

        • Address — (String)

          The address of a room profile.

        • Timezone — (String)

          The time zone of a room profile.

        • DistanceUnit — (String)

          The distance unit of a room profile.

          Possible values include:
          • "METRIC"
          • "IMPERIAL"
        • TemperatureUnit — (String)

          The temperature unit of a room profile.

          Possible values include:
          • "FAHRENHEIT"
          • "CELSIUS"
        • WakeWord — (String)

          The wake word of a room profile.

          Possible values include:
          • "ALEXA"
          • "AMAZON"
          • "ECHO"
          • "COMPUTER"
        • SetupModeDisabled — (Boolean)

          The setup mode of a room profile.

        • MaxVolumeLimit — (Integer)

          The max volume limit of a room profile.

        • PSTNEnabled — (Boolean)

          The PSTN setting of a room profile.

        • AddressBookArn — (String)

          The ARN of the address book.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getRoom(params = {}, callback) ⇒ AWS.Request

Gets room details by room ARN.

Service Reference:

Examples:

Calling the getRoom operation

var params = {
  RoomArn: 'STRING_VALUE'
};
alexaforbusiness.getRoom(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • RoomArn — (String)

      The ARN of the room for which to request details. Required.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Room — (map)

        The details of the room requested.

        • RoomArn — (String)

          The ARN of a room.

        • RoomName — (String)

          The name of a room.

        • Description — (String)

          The description of a room.

        • ProviderCalendarId — (String)

          The provider calendar ARN of a room.

        • ProfileArn — (String)

          The profile ARN of a room.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getRoomSkillParameter(params = {}, callback) ⇒ AWS.Request

Gets room skill parameter details by room, skill, and parameter key ARN.

Service Reference:

Examples:

Calling the getRoomSkillParameter operation

var params = {
  ParameterKey: 'STRING_VALUE', /* required */
  SkillId: 'STRING_VALUE', /* required */
  RoomArn: 'STRING_VALUE'
};
alexaforbusiness.getRoomSkillParameter(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • RoomArn — (String)

      The ARN of the room from which to get the room skill parameter details.

    • SkillId — (String)

      The ARN of the skill from which to get the room skill parameter details. Required.

    • ParameterKey — (String)

      The room skill parameter key for which to get details. Required.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • RoomSkillParameter — (map)

        The details of the room skill parameter requested. Required.

        • ParameterKeyrequired — (String)

          The parameter key of a room skill parameter. ParameterKey is an enumerated type that only takes “DEFAULT” or “SCOPE” as valid values.

        • ParameterValuerequired — (String)

          The parameter value of a room skill parameter.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getSkillGroup(params = {}, callback) ⇒ AWS.Request

Gets skill group details by skill group ARN.

Service Reference:

Examples:

Calling the getSkillGroup operation

var params = {
  SkillGroupArn: 'STRING_VALUE'
};
alexaforbusiness.getSkillGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • SkillGroupArn — (String)

      The ARN of the skill group for which to get details. Required.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SkillGroup — (map)

        The details of the skill group requested. Required.

        • SkillGroupArn — (String)

          The ARN of a skill group.

        • SkillGroupName — (String)

          The name of a skill group.

        • Description — (String)

          The description of a skill group.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listBusinessReportSchedules(params = {}, callback) ⇒ AWS.Request

Lists the details of the schedules that a user configured.

Service Reference:

Examples:

Calling the listBusinessReportSchedules operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
alexaforbusiness.listBusinessReportSchedules(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • NextToken — (String)

      The token used to list the remaining schedules from the previous API call.

    • MaxResults — (Integer)

      The maximum number of schedules listed in the call.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • BusinessReportSchedules — (Array<map>)

        The schedule of the reports.

        • ScheduleArn — (String)

          The ARN of the business report schedule.

        • ScheduleName — (String)

          The name identifier of the schedule.

        • S3BucketName — (String)

          The S3 bucket name of the output reports.

        • S3KeyPrefix — (String)

          The S3 key where the report is delivered.

        • Format — (String)

          The format of the generated report (individual CSV files or zipped files of individual files).

          Possible values include:
          • "CSV"
          • "CSV_ZIP"
        • ContentRange — (map)

          The content range of the reports.

          • Interval — (String)

            The interval of the content range.

            Possible values include:
            • "ONE_DAY"
            • "ONE_WEEK"
        • Recurrence — (map)

          The recurrence of the reports.

          • StartDate — (String)

            The start date.

        • LastBusinessReport — (map)

          The details of the last business report delivery for a specified time interval.

          • Status — (String)

            The status of the report generation execution (RUNNING, SUCCEEDED, or FAILED).

            Possible values include:
            • "RUNNING"
            • "SUCCEEDED"
            • "FAILED"
          • FailureCode — (String)

            The failure code.

            Possible values include:
            • "ACCESS_DENIED"
            • "NO_SUCH_BUCKET"
            • "INTERNAL_FAILURE"
          • S3Location — (map)

            The S3 location of the output reports.

            • Path — (String)

              The path of the business report.

            • BucketName — (String)

              The S3 bucket name of the output reports.

          • DeliveryTime — (Date)

            The time of report delivery.

          • DownloadUrl — (String)

            The download link where a user can download the report.

      • NextToken — (String)

        The token used to list the remaining schedules from the previous API call.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listConferenceProviders(params = {}, callback) ⇒ AWS.Request

Lists conference providers under a specific AWS account.

Service Reference:

Examples:

Calling the listConferenceProviders operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
alexaforbusiness.listConferenceProviders(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • NextToken — (String)

      The tokens used for pagination.

    • MaxResults — (Integer)

      The maximum number of conference providers to be returned, per paginated calls.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ConferenceProviders — (Array<map>)

        The conference providers.

        • Arn — (String)

          The ARN of the newly created conference provider.

        • Name — (String)

          The name of the conference provider.

        • Type — (String)

          The type of conference providers.

          Possible values include:
          • "CHIME"
          • "BLUEJEANS"
          • "FUZE"
          • "GOOGLE_HANGOUTS"
          • "POLYCOM"
          • "RINGCENTRAL"
          • "SKYPE_FOR_BUSINESS"
          • "WEBEX"
          • "ZOOM"
          • "CUSTOM"
        • IPDialIn — (map)

          The IP endpoint and protocol for calling.

          • Endpointrequired — (String)

            The IP address.

          • CommsProtocolrequired — (String)

            The protocol, including SIP, SIPS, and H323.

            Possible values include:
            • "SIP"
            • "SIPS"
            • "H323"
        • PSTNDialIn — (map)

          The information for PSTN conferencing.

          • CountryCoderequired — (String)

            The zip code.

          • PhoneNumberrequired — (String)

            The phone number to call to join the conference.

          • OneClickIdDelayrequired — (String)

            The delay duration before Alexa enters the conference ID with dual-tone multi-frequency (DTMF). Each number on the dial pad corresponds to a DTMF tone, which is how we send data over the telephone network.

          • OneClickPinDelayrequired — (String)

            The delay duration before Alexa enters the conference pin with dual-tone multi-frequency (DTMF). Each number on the dial pad corresponds to a DTMF tone, which is how we send data over the telephone network.

        • MeetingSetting — (map)

          The meeting settings for the conference provider.

          • RequirePinrequired — (String)

            The values that indicate whether the pin is always required.

            Possible values include:
            • "YES"
            • "NO"
            • "OPTIONAL"
      • NextToken — (String)

        The tokens used for pagination.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listDeviceEvents(params = {}, callback) ⇒ AWS.Request

Lists the device event history, including device connection status, for up to 30 days.

Service Reference:

Examples:

Calling the listDeviceEvents operation

var params = {
  DeviceArn: 'STRING_VALUE', /* required */
  EventType: CONNECTION_STATUS | DEVICE_STATUS,
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
alexaforbusiness.listDeviceEvents(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DeviceArn — (String)

      The ARN of a device.

    • EventType — (String)

      The event type to filter device events. If EventType isn't specified, this returns a list of all device events in reverse chronological order. If EventType is specified, this returns a list of device events for that EventType in reverse chronological order.

      Possible values include:
      • "CONNECTION_STATUS"
      • "DEVICE_STATUS"
    • NextToken — (String)

      An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response only includes results beyond the token, up to the value specified by MaxResults. When the end of results is reached, the response has a value of null.

    • MaxResults — (Integer)

      The maximum number of results to include in the response. The default value is 50. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DeviceEvents — (Array<map>)

        The device events requested for the device ARN.

        • Type — (String)

          The type of device event.

          Possible values include:
          • "CONNECTION_STATUS"
          • "DEVICE_STATUS"
        • Value — (String)

          The value of the event.

        • Timestamp — (Date)

          The time (in epoch) when the event occurred.

      • NextToken — (String)

        The token returned to indicate that there is more data available.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listSkills(params = {}, callback) ⇒ AWS.Request

Lists all enabled skills in a specific skill group.

Service Reference:

Examples:

Calling the listSkills operation

var params = {
  EnablementType: ENABLED | PENDING,
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  SkillGroupArn: 'STRING_VALUE',
  SkillType: PUBLIC | PRIVATE | ALL
};
alexaforbusiness.listSkills(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • SkillGroupArn — (String)

      The ARN of the skill group for which to list enabled skills. Required.

    • EnablementType — (String)

      Whether the skill is enabled under the user's account, or if it requires linking to be used.

      Possible values include:
      • "ENABLED"
      • "PENDING"
    • SkillType — (String)

      Whether the skill is publicly available or is a private skill.

      Possible values include:
      • "PUBLIC"
      • "PRIVATE"
      • "ALL"
    • NextToken — (String)

      An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults. Required.

    • MaxResults — (Integer)

      The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved. Required.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SkillSummaries — (Array<map>)

        The list of enabled skills requested. Required.

        • SkillId — (String)

          The ARN of the skill summary.

        • SkillName — (String)

          The name of the skill.

        • SupportsLinking — (Boolean)

          Linking support for a skill.

        • EnablementType — (String)

          Whether the skill is enabled under the user's account, or if it requires linking to be used.

          Possible values include:
          • "ENABLED"
          • "PENDING"
        • SkillType — (String)

          Whether the skill is publicly available or is a private skill.

          Possible values include:
          • "PUBLIC"
          • "PRIVATE"
      • NextToken — (String)

        The token returned to indicate that there is more data available.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listSkillsStoreCategories(params = {}, callback) ⇒ AWS.Request

Lists all categories in the Alexa skill store.

Service Reference:

Examples:

Calling the listSkillsStoreCategories operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
alexaforbusiness.listSkillsStoreCategories(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • NextToken — (String)

      The tokens used for pagination.

    • MaxResults — (Integer)

      The maximum number of categories returned, per paginated calls.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • CategoryList — (Array<map>)

        The list of categories.

        • CategoryId — (Integer)

          The ID of the skill store category.

        • CategoryName — (String)

          The name of the skill store category.

      • NextToken — (String)

        The tokens used for pagination.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listSkillsStoreSkillsByCategory(params = {}, callback) ⇒ AWS.Request

Lists all skills in the Alexa skill store by category.

Service Reference:

Examples:

Calling the listSkillsStoreSkillsByCategory operation

var params = {
  CategoryId: 'NUMBER_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
alexaforbusiness.listSkillsStoreSkillsByCategory(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • CategoryId — (Integer)

      The category ID for which the skills are being retrieved from the skill store.

    • NextToken — (String)

      The tokens used for pagination.

    • MaxResults — (Integer)

      The maximum number of skills returned per paginated calls.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SkillsStoreSkills — (Array<map>)

        The skill store skills.

        • SkillId — (String)

          The ARN of the skill.

        • SkillName — (String)

          The name of the skill.

        • ShortDescription — (String)

          Short description about the skill.

        • IconUrl — (String)

          The URL where the skill icon resides.

        • SampleUtterances — (Array<String>)

          Sample utterances that interact with the skill.

        • SkillDetails — (map)

          Information about the skill.

          • ProductDescription — (String)

            The description of the product.

          • InvocationPhrase — (String)

            The phrase used to trigger the skill.

          • ReleaseDate — (String)

            The date when the skill was released.

          • EndUserLicenseAgreement — (String)

            The URL of the end user license agreement.

          • GenericKeywords — (Array<String>)

            The generic keywords associated with the skill that can be used to find a skill.

          • BulletPoints — (Array<String>)

            The details about what the skill supports organized as bullet points.

          • NewInThisVersionBulletPoints — (Array<String>)

            The updates added in bullet points.

          • SkillTypes — (Array<String>)

            The types of skills.

          • Reviews — (map<String>)

            The list of reviews for the skill, including Key and Value pair.

          • DeveloperInfo — (map)

            The details about the developer that published the skill.

            • DeveloperName — (String)

              The name of the developer.

            • PrivacyPolicy — (String)

              The URL of the privacy policy.

            • Email — (String)

              The email of the developer.

            • Url — (String)

              The website of the developer.

        • SupportsLinking — (Boolean)

          Linking support for a skill.

      • NextToken — (String)

        The tokens used for pagination.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listSmartHomeAppliances(params = {}, callback) ⇒ AWS.Request

Lists all of the smart home appliances associated with a room.

Service Reference:

Examples:

Calling the listSmartHomeAppliances operation

var params = {
  RoomArn: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
alexaforbusiness.listSmartHomeAppliances(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • RoomArn — (String)

      The room that the appliances are associated with.

    • MaxResults — (Integer)

      The maximum number of appliances to be returned, per paginated calls.

    • NextToken — (String)

      The tokens used for pagination.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SmartHomeAppliances — (Array<map>)

        The smart home appliances.

        • FriendlyName — (String)

          The friendly name of the smart home appliance.

        • Description — (String)

          The description of the smart home appliance.

        • ManufacturerName — (String)

          The name of the manufacturer of the smart home appliance.

      • NextToken — (String)

        The tokens used for pagination.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listTags(params = {}, callback) ⇒ AWS.Request

Lists all tags for the specified resource.

Service Reference:

Examples:

Calling the listTags operation

var params = {
  Arn: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
alexaforbusiness.listTags(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Arn — (String)

      The ARN of the specified resource for which to list tags.

    • NextToken — (String)

      An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

    • MaxResults — (Integer)

      The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Tags — (Array<map>)

        The tags requested for the specified resource.

        • Keyrequired — (String)

          The key of a tag. Tag keys are case-sensitive.

        • Valuerequired — (String)

          The value of a tag. Tag values are case-sensitive and can be null.

      • NextToken — (String)

        The token returned to indicate that there is more data available.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

putConferencePreference(params = {}, callback) ⇒ AWS.Request

Sets the conference preferences on a specific conference provider at the account level.

Service Reference:

Examples:

Calling the putConferencePreference operation

var params = {
  ConferencePreference: { /* required */
    DefaultConferenceProviderArn: 'STRING_VALUE'
  }
};
alexaforbusiness.putConferencePreference(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ConferencePreference — (map)

      The conference preference of a specific conference provider.

      • DefaultConferenceProviderArn — (String)

        The ARN of the default conference provider.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

putInvitationConfiguration(params = {}, callback) ⇒ AWS.Request

Configures the email template for the user enrollment invitation with the specified attributes.

Service Reference:

Examples:

Calling the putInvitationConfiguration operation

var params = {
  OrganizationName: 'STRING_VALUE', /* required */
  ContactEmail: 'STRING_VALUE',
  PrivateSkillIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
alexaforbusiness.putInvitationConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • OrganizationName — (String)

      The name of the organization sending the enrollment invite to a user.

    • ContactEmail — (String)

      The email ID of the organization or individual contact that the enrolled user can use.

    • PrivateSkillIds — (Array<String>)

      The list of private skill IDs that you want to recommend to the user to enable in the invitation.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

putRoomSkillParameter(params = {}, callback) ⇒ AWS.Request

Updates room skill parameter details by room, skill, and parameter key ID. Not all skills have a room skill parameter.

Service Reference:

Examples:

Calling the putRoomSkillParameter operation

var params = {
  RoomSkillParameter: { /* required */
    ParameterKey: 'STRING_VALUE', /* required */
    ParameterValue: 'STRING_VALUE' /* required */
  },
  SkillId: 'STRING_VALUE', /* required */
  RoomArn: 'STRING_VALUE'
};
alexaforbusiness.putRoomSkillParameter(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • RoomArn — (String)

      The ARN of the room associated with the room skill parameter. Required.

    • SkillId — (String)

      The ARN of the skill associated with the room skill parameter. Required.

    • RoomSkillParameter — (map)

      The updated room skill parameter. Required.

      • ParameterKeyrequired — (String)

        The parameter key of a room skill parameter. ParameterKey is an enumerated type that only takes “DEFAULT” or “SCOPE” as valid values.

      • ParameterValuerequired — (String)

        The parameter value of a room skill parameter.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

putSkillAuthorization(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the putSkillAuthorization operation

var params = {
  AuthorizationResult: { /* required */
    '<Key>': 'STRING_VALUE',
    /* '<Key>': ... */
  },
  SkillId: 'STRING_VALUE', /* required */
  RoomArn: 'STRING_VALUE'
};
alexaforbusiness.putSkillAuthorization(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AuthorizationResult — (map<String>)

      The authorization result specific to OAUTH code grant output. "Code” must be populated in the AuthorizationResult map to establish the authorization.

    • SkillId — (String)

      The unique identifier of a skill.

    • RoomArn — (String)

      The room that the skill is authorized for.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

registerAVSDevice(params = {}, callback) ⇒ AWS.Request

Registers an Alexa-enabled device built by an Original Equipment Manufacturer (OEM) using Alexa Voice Service (AVS).

Service Reference:

Examples:

Calling the registerAVSDevice operation

var params = {
  AmazonId: 'STRING_VALUE', /* required */
  ClientId: 'STRING_VALUE', /* required */
  DeviceSerialNumber: 'STRING_VALUE', /* required */
  ProductId: 'STRING_VALUE', /* required */
  UserCode: 'STRING_VALUE' /* required */
};
alexaforbusiness.registerAVSDevice(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ClientId — (String)

      The client ID of the OEM used for code-based linking authorization on an AVS device.

    • UserCode — (String)

      The code that is obtained after your AVS device has made a POST request to LWA as a part of the Device Authorization Request component of the OAuth code-based linking specification.

    • ProductId — (String)

      The product ID used to identify your AVS device during authorization.

    • DeviceSerialNumber — (String)

      The key generated by the OEM that uniquely identifies a specified instance of your AVS device.

    • AmazonId — (String)

      The device type ID for your AVS device generated by Amazon when the OEM creates a new product on Amazon's Developer Console.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DeviceArn — (String)

        The ARN of the device.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

rejectSkill(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the rejectSkill operation

var params = {
  SkillId: 'STRING_VALUE' /* required */
};
alexaforbusiness.rejectSkill(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • SkillId — (String)

      The unique identifier of the skill.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

resolveRoom(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the resolveRoom operation

var params = {
  SkillId: 'STRING_VALUE', /* required */
  UserId: 'STRING_VALUE' /* required */
};
alexaforbusiness.resolveRoom(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • UserId — (String)

      The ARN of the user. Required.

    • SkillId — (String)

      The ARN of the skill that was requested. Required.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • RoomArn — (String)

        The ARN of the room from which the skill request was invoked.

      • RoomName — (String)

        The name of the room from which the skill request was invoked.

      • RoomSkillParameters — (Array<map>)

        Response to get the room profile request. Required.

        • ParameterKeyrequired — (String)

          The parameter key of a room skill parameter. ParameterKey is an enumerated type that only takes “DEFAULT” or “SCOPE” as valid values.

        • ParameterValuerequired — (String)

          The parameter value of a room skill parameter.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

revokeInvitation(params = {}, callback) ⇒ AWS.Request

Revokes an invitation and invalidates the enrollment URL.

Service Reference:

Examples:

Calling the revokeInvitation operation

var params = {
  EnrollmentId: 'STRING_VALUE',
  UserArn: 'STRING_VALUE'
};
alexaforbusiness.revokeInvitation(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • UserArn — (String)

      The ARN of the user for whom to revoke an enrollment invitation. Required.

    • EnrollmentId — (String)

      The ARN of the enrollment invitation to revoke. Required.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

searchAddressBooks(params = {}, callback) ⇒ AWS.Request

Searches address books and lists the ones that meet a set of filter and sort criteria.

Service Reference:

Examples:

Calling the searchAddressBooks operation

var params = {
  Filters: [
    {
      Key: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  SortCriteria: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: ASC | DESC /* required */
    },
    /* more items */
  ]
};
alexaforbusiness.searchAddressBooks(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Filters — (Array<map>)

      The filters to use to list a specified set of address books. The supported filter key is AddressBookName.

      • Keyrequired — (String)

        The key of a filter.

      • Valuesrequired — (Array<String>)

        The values of a filter.

    • SortCriteria — (Array<map>)

      The sort order to use in listing the specified set of address books. The supported sort key is AddressBookName.

      • Keyrequired — (String)

        The sort key of a sort object.

      • Valuerequired — (String)

        The sort value of a sort object.

        Possible values include:
        • "ASC"
        • "DESC"
    • NextToken — (String)

      An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response only includes results beyond the token, up to the value specified by MaxResults.

    • MaxResults — (Integer)

      The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AddressBooks — (Array<map>)

        The address books that meet the specified set of filter criteria, in sort order.

        • AddressBookArn — (String)

          The ARN of the address book.

        • Name — (String)

          The name of the address book.

        • Description — (String)

          The description of the address book.

      • NextToken — (String)

        The token returned to indicate that there is more data available.

      • TotalCount — (Integer)

        The total number of address books returned.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

searchContacts(params = {}, callback) ⇒ AWS.Request

Searches contacts and lists the ones that meet a set of filter and sort criteria.

Service Reference:

Examples:

Calling the searchContacts operation

var params = {
  Filters: [
    {
      Key: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  SortCriteria: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: ASC | DESC /* required */
    },
    /* more items */
  ]
};
alexaforbusiness.searchContacts(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Filters — (Array<map>)

      The filters to use to list a specified set of address books. The supported filter keys are DisplayName, FirstName, LastName, and AddressBookArns.

      • Keyrequired — (String)

        The key of a filter.

      • Valuesrequired — (Array<String>)

        The values of a filter.

    • SortCriteria — (Array<map>)

      The sort order to use in listing the specified set of contacts. The supported sort keys are DisplayName, FirstName, and LastName.

      • Keyrequired — (String)

        The sort key of a sort object.

      • Valuerequired — (String)

        The sort value of a sort object.

        Possible values include:
        • "ASC"
        • "DESC"
    • NextToken — (String)

      An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response only includes results beyond the token, up to the value specified by MaxResults.

    • MaxResults — (Integer)

      The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Contacts — (Array<map>)

        The contacts that meet the specified set of filter criteria, in sort order.

        • ContactArn — (String)

          The ARN of the contact.

        • DisplayName — (String)

          The name of the contact to display on the console.

        • FirstName — (String)

          The first name of the contact, used to call the contact on the device.

        • LastName — (String)

          The last name of the contact, used to call the contact on the device.

        • PhoneNumber — (String)

          The phone number of the contact.

      • NextToken — (String)

        The token returned to indicate that there is more data available.

      • TotalCount — (Integer)

        The total number of contacts returned.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

searchDevices(params = {}, callback) ⇒ AWS.Request

Searches devices and lists the ones that meet a set of filter criteria.

Service Reference:

Examples:

Calling the searchDevices operation

var params = {
  Filters: [
    {
      Key: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  SortCriteria: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: ASC | DESC /* required */
    },
    /* more items */
  ]
};
alexaforbusiness.searchDevices(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • NextToken — (String)

      An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

    • MaxResults — (Integer)

      The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

    • Filters — (Array<map>)

      The filters to use to list a specified set of devices. Supported filter keys are DeviceName, DeviceStatus, DeviceStatusDetailCode, RoomName, DeviceType, DeviceSerialNumber, UnassociatedOnly, and ConnectionStatus (ONLINE and OFFLINE).

      • Keyrequired — (String)

        The key of a filter.

      • Valuesrequired — (Array<String>)

        The values of a filter.

    • SortCriteria — (Array<map>)

      The sort order to use in listing the specified set of devices. Supported sort keys are DeviceName, DeviceStatus, RoomName, DeviceType, DeviceSerialNumber, and ConnectionStatus.

      • Keyrequired — (String)

        The sort key of a sort object.

      • Valuerequired — (String)

        The sort value of a sort object.

        Possible values include:
        • "ASC"
        • "DESC"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Devices — (Array<map>)

        The devices that meet the specified set of filter criteria, in sort order.

        • DeviceArn — (String)

          The ARN of a device.

        • DeviceSerialNumber — (String)

          The serial number of a device.

        • DeviceType — (String)

          The type of a device.

        • DeviceName — (String)

          The name of a device.

        • SoftwareVersion — (String)

          The software version of a device.

        • MacAddress — (String)

          The MAC address of a device.

        • DeviceStatus — (String)

          The status of a device.

          Possible values include:
          • "READY"
          • "PENDING"
          • "WAS_OFFLINE"
          • "DEREGISTERED"
        • RoomArn — (String)

          The room ARN associated with a device.

        • RoomName — (String)

          The name of the room associated with a device.

        • DeviceStatusInfo — (map)

          Detailed information about a device's status.

          • DeviceStatusDetails — (Array<map>)

            One or more device status detail descriptions.

            • Code — (String)

              The device status detail code.

              Possible values include:
              • "DEVICE_SOFTWARE_UPDATE_NEEDED"
              • "DEVICE_WAS_OFFLINE"
          • ConnectionStatus — (String)

            The latest available information about the connection status of a device.

            Possible values include:
            • "ONLINE"
            • "OFFLINE"
      • NextToken — (String)

        The token returned to indicate that there is more data available.

      • TotalCount — (Integer)

        The total number of devices returned.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

searchProfiles(params = {}, callback) ⇒ AWS.Request

Searches room profiles and lists the ones that meet a set of filter criteria.

Service Reference:

Examples:

Calling the searchProfiles operation

var params = {
  Filters: [
    {
      Key: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  SortCriteria: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: ASC | DESC /* required */
    },
    /* more items */
  ]
};
alexaforbusiness.searchProfiles(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • NextToken — (String)

      An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

    • MaxResults — (Integer)

      The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

    • Filters — (Array<map>)

      The filters to use to list a specified set of room profiles. Supported filter keys are ProfileName and Address. Required.

      • Keyrequired — (String)

        The key of a filter.

      • Valuesrequired — (Array<String>)

        The values of a filter.

    • SortCriteria — (Array<map>)

      The sort order to use in listing the specified set of room profiles. Supported sort keys are ProfileName and Address.

      • Keyrequired — (String)

        The sort key of a sort object.

      • Valuerequired — (String)

        The sort value of a sort object.

        Possible values include:
        • "ASC"
        • "DESC"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Profiles — (Array<map>)

        The profiles that meet the specified set of filter criteria, in sort order.

        • ProfileArn — (String)

          The ARN of a room profile.

        • ProfileName — (String)

          The name of a room profile.

        • IsDefault — (Boolean)

          Retrieves if the profile data is default or not.

        • Address — (String)

          The address of a room profile.

        • Timezone — (String)

          The timezone of a room profile.

        • DistanceUnit — (String)

          The distance unit of a room profile.

          Possible values include:
          • "METRIC"
          • "IMPERIAL"
        • TemperatureUnit — (String)

          The temperature unit of a room profile.

          Possible values include:
          • "FAHRENHEIT"
          • "CELSIUS"
        • WakeWord — (String)

          The wake word of a room profile.

          Possible values include:
          • "ALEXA"
          • "AMAZON"
          • "ECHO"
          • "COMPUTER"
      • NextToken — (String)

        The token returned to indicate that there is more data available.

      • TotalCount — (Integer)

        The total number of room profiles returned.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

searchRooms(params = {}, callback) ⇒ AWS.Request

Searches rooms and lists the ones that meet a set of filter and sort criteria.

Service Reference:

Examples:

Calling the searchRooms operation

var params = {
  Filters: [
    {
      Key: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  SortCriteria: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: ASC | DESC /* required */
    },
    /* more items */
  ]
};
alexaforbusiness.searchRooms(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • NextToken — (String)

      An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

    • MaxResults — (Integer)

      The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

    • Filters — (Array<map>)

      The filters to use to list a specified set of rooms. The supported filter keys are RoomName and ProfileName.

      • Keyrequired — (String)

        The key of a filter.

      • Valuesrequired — (Array<String>)

        The values of a filter.

    • SortCriteria — (Array<map>)

      The sort order to use in listing the specified set of rooms. The supported sort keys are RoomName and ProfileName.

      • Keyrequired — (String)

        The sort key of a sort object.

      • Valuerequired — (String)

        The sort value of a sort object.

        Possible values include:
        • "ASC"
        • "DESC"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Rooms — (Array<map>)

        The rooms that meet the specified set of filter criteria, in sort order.

        • RoomArn — (String)

          The ARN of a room.

        • RoomName — (String)

          The name of a room.

        • Description — (String)

          The description of a room.

        • ProviderCalendarId — (String)

          The provider calendar ARN of a room.

        • ProfileArn — (String)

          The profile ARN of a room.

        • ProfileName — (String)

          The profile name of a room.

      • NextToken — (String)

        The token returned to indicate that there is more data available.

      • TotalCount — (Integer)

        The total number of rooms returned.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

searchSkillGroups(params = {}, callback) ⇒ AWS.Request

Searches skill groups and lists the ones that meet a set of filter and sort criteria.

Service Reference:

Examples:

Calling the searchSkillGroups operation

var params = {
  Filters: [
    {
      Key: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  SortCriteria: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: ASC | DESC /* required */
    },
    /* more items */
  ]
};
alexaforbusiness.searchSkillGroups(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • NextToken — (String)

      An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults. Required.

    • MaxResults — (Integer)

      The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

    • Filters — (Array<map>)

      The filters to use to list a specified set of skill groups. The supported filter key is SkillGroupName.

      • Keyrequired — (String)

        The key of a filter.

      • Valuesrequired — (Array<String>)

        The values of a filter.

    • SortCriteria — (Array<map>)

      The sort order to use in listing the specified set of skill groups. The supported sort key is SkillGroupName.

      • Keyrequired — (String)

        The sort key of a sort object.

      • Valuerequired — (String)

        The sort value of a sort object.

        Possible values include:
        • "ASC"
        • "DESC"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SkillGroups — (Array<map>)

        The skill groups that meet the filter criteria, in sort order.

        • SkillGroupArn — (String)

          The skill group ARN of a skill group.

        • SkillGroupName — (String)

          The skill group name of a skill group.

        • Description — (String)

          The description of a skill group.

      • NextToken — (String)

        The token returned to indicate that there is more data available.

      • TotalCount — (Integer)

        The total number of skill groups returned.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

searchUsers(params = {}, callback) ⇒ AWS.Request

Searches users and lists the ones that meet a set of filter and sort criteria.

Service Reference:

Examples:

Calling the searchUsers operation

var params = {
  Filters: [
    {
      Key: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  SortCriteria: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: ASC | DESC /* required */
    },
    /* more items */
  ]
};
alexaforbusiness.searchUsers(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • NextToken — (String)

      An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults. Required.

    • MaxResults — (Integer)

      The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved. Required.

    • Filters — (Array<map>)

      The filters to use for listing a specific set of users. Required. Supported filter keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.

      • Keyrequired — (String)

        The key of a filter.

      • Valuesrequired — (Array<String>)

        The values of a filter.

    • SortCriteria — (Array<map>)

      The sort order to use in listing the filtered set of users. Required. Supported sort keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.

      • Keyrequired — (String)

        The sort key of a sort object.

      • Valuerequired — (String)

        The sort value of a sort object.

        Possible values include:
        • "ASC"
        • "DESC"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Users — (Array<map>)

        The users that meet the specified set of filter criteria, in sort order.

        • UserArn — (String)

          The ARN of a user.

        • FirstName — (String)

          The first name of a user.

        • LastName — (String)

          The last name of a user.

        • Email — (String)

          The email of a user.

        • EnrollmentStatus — (String)

          The enrollment status of a user.

          Possible values include:
          • "INITIALIZED"
          • "PENDING"
          • "REGISTERED"
          • "DISASSOCIATING"
          • "DEREGISTERING"
        • EnrollmentId — (String)

          The enrollment ARN of a user.

      • NextToken — (String)

        The token returned to indicate that there is more data available.

      • TotalCount — (Integer)

        The total number of users returned.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

sendInvitation(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the sendInvitation operation

var params = {
  UserArn: 'STRING_VALUE'
};
alexaforbusiness.sendInvitation(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • UserArn — (String)

      The ARN of the user to whom to send an invitation. Required.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

startDeviceSync(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the startDeviceSync operation

var params = {
  Features: [ /* required */
    BLUETOOTH | VOLUME | NOTIFICATIONS | LISTS | SKILLS | ALL,
    /* more items */
  ],
  DeviceArn: 'STRING_VALUE',
  RoomArn: 'STRING_VALUE'
};
alexaforbusiness.startDeviceSync(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • RoomArn — (String)

      The ARN of the room with which the device to sync is associated. Required.

    • DeviceArn — (String)

      The ARN of the device to sync. Required.

    • Features — (Array<String>)

      Request structure to start the device sync. Required.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

startSmartHomeApplianceDiscovery(params = {}, callback) ⇒ AWS.Request

Initiates the discovery of any smart home appliances associated with the room.

Examples:

Calling the startSmartHomeApplianceDiscovery operation

var params = {
  RoomArn: 'STRING_VALUE' /* required */
};
alexaforbusiness.startSmartHomeApplianceDiscovery(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • RoomArn — (String)

      The room where smart home appliance discovery was initiated.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

tagResource(params = {}, callback) ⇒ AWS.Request

Adds metadata tags to a specified resource.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  Arn: 'STRING_VALUE', /* required */
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
alexaforbusiness.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Arn — (String)

      The ARN of the resource to which to add metadata tags. Required.

    • Tags — (Array<map>)

      The tags to be added to the specified resource. Do not provide system tags. Required.

      • Keyrequired — (String)

        The key of a tag. Tag keys are case-sensitive.

      • Valuerequired — (String)

        The value of a tag. Tag values are case-sensitive and can be null.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

untagResource(params = {}, callback) ⇒ AWS.Request

Removes metadata tags from a specified resource.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  Arn: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
alexaforbusiness.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Arn — (String)

      The ARN of the resource from which to remove metadata tags. Required.

    • TagKeys — (Array<String>)

      The tags to be removed from the specified resource. Do not provide system tags. Required.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateAddressBook(params = {}, callback) ⇒ AWS.Request

Updates address book details by the address book ARN.

Service Reference:

Examples:

Calling the updateAddressBook operation

var params = {
  AddressBookArn: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  Name: 'STRING_VALUE'
};
alexaforbusiness.updateAddressBook(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AddressBookArn — (String)

      The ARN of the room to update.

    • Name — (String)

      The updated name of the room.

    • Description — (String)

      The updated description of the room.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateBusinessReportSchedule(params = {}, callback) ⇒ AWS.Request

Updates the configuration of the report delivery schedule with the specified schedule ARN.

Service Reference:

Examples:

Calling the updateBusinessReportSchedule operation

var params = {
  ScheduleArn: 'STRING_VALUE', /* required */
  Format: CSV | CSV_ZIP,
  Recurrence: {
    StartDate: 'STRING_VALUE'
  },
  S3BucketName: 'STRING_VALUE',
  S3KeyPrefix: 'STRING_VALUE',
  ScheduleName: 'STRING_VALUE'
};
alexaforbusiness.updateBusinessReportSchedule(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ScheduleArn — (String)

      The ARN of the business report schedule.

    • S3BucketName — (String)

      The S3 location of the output reports.

    • S3KeyPrefix — (String)

      The S3 key where the report is delivered.

    • Format — (String)

      The format of the generated report (individual CSV files or zipped files of individual files).

      Possible values include:
      • "CSV"
      • "CSV_ZIP"
    • ScheduleName — (String)

      The name identifier of the schedule.

    • Recurrence — (map)

      The recurrence of the reports.

      • StartDate — (String)

        The start date.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateConferenceProvider(params = {}, callback) ⇒ AWS.Request

Updates an existing conference provider's settings.

Service Reference:

Examples:

Calling the updateConferenceProvider operation

var params = {
  ConferenceProviderArn: 'STRING_VALUE', /* required */
  ConferenceProviderType: CHIME | BLUEJEANS | FUZE | GOOGLE_HANGOUTS | POLYCOM | RINGCENTRAL | SKYPE_FOR_BUSINESS | WEBEX | ZOOM | CUSTOM, /* required */
  MeetingSetting: { /* required */
    RequirePin: YES | NO | OPTIONAL /* required */
  },
  IPDialIn: {
    CommsProtocol: SIP | SIPS | H323, /* required */
    Endpoint: 'STRING_VALUE' /* required */
  },
  PSTNDialIn: {
    CountryCode: 'STRING_VALUE', /* required */
    OneClickIdDelay: 'STRING_VALUE', /* required */
    OneClickPinDelay: 'STRING_VALUE', /* required */
    PhoneNumber: 'STRING_VALUE' /* required */
  }
};
alexaforbusiness.updateConferenceProvider(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ConferenceProviderArn — (String)

      The ARN of the conference provider.

    • ConferenceProviderType — (String)

      The type of the conference provider.

      Possible values include:
      • "CHIME"
      • "BLUEJEANS"
      • "FUZE"
      • "GOOGLE_HANGOUTS"
      • "POLYCOM"
      • "RINGCENTRAL"
      • "SKYPE_FOR_BUSINESS"
      • "WEBEX"
      • "ZOOM"
      • "CUSTOM"
    • IPDialIn — (map)

      The IP endpoint and protocol for calling.

      • Endpointrequired — (String)

        The IP address.

      • CommsProtocolrequired — (String)

        The protocol, including SIP, SIPS, and H323.

        Possible values include:
        • "SIP"
        • "SIPS"
        • "H323"
    • PSTNDialIn — (map)

      The information for PSTN conferencing.

      • CountryCoderequired — (String)

        The zip code.

      • PhoneNumberrequired — (String)

        The phone number to call to join the conference.

      • OneClickIdDelayrequired — (String)

        The delay duration before Alexa enters the conference ID with dual-tone multi-frequency (DTMF). Each number on the dial pad corresponds to a DTMF tone, which is how we send data over the telephone network.

      • OneClickPinDelayrequired — (String)

        The delay duration before Alexa enters the conference pin with dual-tone multi-frequency (DTMF). Each number on the dial pad corresponds to a DTMF tone, which is how we send data over the telephone network.

    • MeetingSetting — (map)

      The meeting settings for the conference provider.

      • RequirePinrequired — (String)

        The values that indicate whether the pin is always required.

        Possible values include:
        • "YES"
        • "NO"
        • "OPTIONAL"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateContact(params = {}, callback) ⇒ AWS.Request

Updates the contact details by the contact ARN.

Service Reference:

Examples:

Calling the updateContact operation

var params = {
  ContactArn: 'STRING_VALUE', /* required */
  DisplayName: 'STRING_VALUE',
  FirstName: 'STRING_VALUE',
  LastName: 'STRING_VALUE',
  PhoneNumber: 'STRING_VALUE'
};
alexaforbusiness.updateContact(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ContactArn — (String)

      The ARN of the contact to update.

    • DisplayName — (String)

      The updated display name of the contact.

    • FirstName — (String)

      The updated first name of the contact.

    • LastName — (String)

      The updated last name of the contact.

    • PhoneNumber — (String)

      The updated phone number of the contact.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateDevice(params = {}, callback) ⇒ AWS.Request

Updates the device name by device ARN.

Service Reference:

Examples:

Calling the updateDevice operation

var params = {
  DeviceArn: 'STRING_VALUE',
  DeviceName: 'STRING_VALUE'
};
alexaforbusiness.updateDevice(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DeviceArn — (String)

      The ARN of the device to update. Required.

    • DeviceName — (String)

      The updated device name. Required.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateProfile(params = {}, callback) ⇒ AWS.Request

Updates an existing room profile by room profile ARN.

Service Reference:

Examples:

Calling the updateProfile operation

var params = {
  Address: 'STRING_VALUE',
  DistanceUnit: METRIC | IMPERIAL,
  IsDefault: true || false,
  MaxVolumeLimit: 'NUMBER_VALUE',
  PSTNEnabled: true || false,
  ProfileArn: 'STRING_VALUE',
  ProfileName: 'STRING_VALUE',
  SetupModeDisabled: true || false,
  TemperatureUnit: FAHRENHEIT | CELSIUS,
  Timezone: 'STRING_VALUE',
  WakeWord: ALEXA | AMAZON | ECHO | COMPUTER
};
alexaforbusiness.updateProfile(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ProfileArn — (String)

      The ARN of the room profile to update. Required.

    • ProfileName — (String)

      The updated name for the room profile.

    • IsDefault — (Boolean)

      Sets the profile as default if selected. If this is missing, no update is done to the default status.

    • Timezone — (String)

      The updated timezone for the room profile.

    • Address — (String)

      The updated address for the room profile.

    • DistanceUnit — (String)

      The updated distance unit for the room profile.

      Possible values include:
      • "METRIC"
      • "IMPERIAL"
    • TemperatureUnit — (String)

      The updated temperature unit for the room profile.

      Possible values include:
      • "FAHRENHEIT"
      • "CELSIUS"
    • WakeWord — (String)

      The updated wake word for the room profile.

      Possible values include:
      • "ALEXA"
      • "AMAZON"
      • "ECHO"
      • "COMPUTER"
    • SetupModeDisabled — (Boolean)

      Whether the setup mode of the profile is enabled.

    • MaxVolumeLimit — (Integer)

      The updated maximum volume limit for the room profile.

    • PSTNEnabled — (Boolean)

      Whether the PSTN setting of the room profile is enabled.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateRoom(params = {}, callback) ⇒ AWS.Request

Updates room details by room ARN.

Service Reference:

Examples:

Calling the updateRoom operation

var params = {
  Description: 'STRING_VALUE',
  ProfileArn: 'STRING_VALUE',
  ProviderCalendarId: 'STRING_VALUE',
  RoomArn: 'STRING_VALUE',
  RoomName: 'STRING_VALUE'
};
alexaforbusiness.updateRoom(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • RoomArn — (String)

      The ARN of the room to update.

    • RoomName — (String)

      The updated name for the room.

    • Description — (String)

      The updated description for the room.

    • ProviderCalendarId — (String)

      The updated provider calendar ARN for the room.

    • ProfileArn — (String)

      The updated profile ARN for the room.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateSkillGroup(params = {}, callback) ⇒ AWS.Request

Updates skill group details by skill group ARN.

Service Reference:

Examples:

Calling the updateSkillGroup operation

var params = {
  Description: 'STRING_VALUE',
  SkillGroupArn: 'STRING_VALUE',
  SkillGroupName: 'STRING_VALUE'
};
alexaforbusiness.updateSkillGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • SkillGroupArn — (String)

      The ARN of the skill group to update.

    • SkillGroupName — (String)

      The updated name for the skill group.

    • Description — (String)

      The updated description for the skill group.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.