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

Class: AWS.Chime

Inherits:
AWS.Service show all
Identifier:
chime
API Version:
2018-05-01
Defined in:
(unknown)

Overview

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

Service Description

The Amazon Chime API (application programming interface) is designed for developers to perform key tasks, such as creating and managing Amazon Chime accounts, users, and Voice Connectors. This guide provides detailed information about the Amazon Chime API, including operations, types, inputs and outputs, and error codes. It also includes some server-side API actions to use with the Amazon Chime SDK. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.

You can use an AWS SDK, the AWS Command Line Interface (AWS CLI), or the REST API to make API calls. We recommend using an AWS SDK or the AWS CLI. Each API operation includes links to information about using it with a language-specific AWS SDK or the AWS CLI.

Using an AWS SDK

You don't need to write code to calculate a signature for request authentication. The SDK clients authenticate your requests by using access keys that you provide. For more information about AWS SDKs, see the AWS Developer Center.

Using the AWS CLI

Use your access keys with the AWS CLI to make API calls. For information about setting up the AWS CLI, see Installing the AWS Command Line Interface in the AWS Command Line Interface User Guide. For a list of available Amazon Chime commands, see the Amazon Chime commands in the AWS CLI Command Reference.

Using REST APIs

If you use REST to make API calls, you must authenticate your request by providing a signature. Amazon Chime supports signature version 4. For more information, see Signature Version 4 Signing Process in the Amazon Web Services General Reference.

When making REST API calls, use the service name chime and REST endpoint https://service.chime.aws.amazon.com.

Administrative permissions are controlled using AWS Identity and Access Management (IAM). For more information, see Identity and Access Management for Amazon Chime in the Amazon Chime Administration Guide.

Sending a Request Using Chime

var chime = new AWS.Chime();
chime.associatePhoneNumberWithUser(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 Chime object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var chime = new AWS.Chime({apiVersion: '2018-05-01'});

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

AWS.config.apiVersions = {
  chime: '2018-05-01',
  // other service API versions
};

var chime = new AWS.Chime();

Version:

  • 2018-05-01

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.Chime(options = {}) ⇒ Object

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

Examples:

Constructing a Chime object

var chime = new AWS.Chime({apiVersion: '2018-05-01'});

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|AWS.Endpoint)

    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' or an Endpoint object.

  • 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.Chime.region for more information.

  • maxRetries (Integer)

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

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.Chime.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.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean)

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets 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 error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • 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|undefined)

    whether to call operations with endpoints given by service dynamically. Setting this

  • 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.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

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

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

Associates phone numbers with the specified Amazon Chime Voice Connector.

Examples:

Calling the associatePhoneNumbersWithVoiceConnector operation

var params = {
  E164PhoneNumbers: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  VoiceConnectorId: 'STRING_VALUE', /* required */
  ForceAssociate: true || false
};
chime.associatePhoneNumbersWithVoiceConnector(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: {})
    • VoiceConnectorId — (String)

      The Amazon Chime Voice Connector ID.

    • E164PhoneNumbers — (Array<String>)

      List of phone numbers, in E.164 format.

    • ForceAssociate — (Boolean)

      If true, associates the provided phone numbers with the provided Amazon Chime Voice Connector and removes any previously existing associations. If false, does not associate any phone numbers that have previously existing associations.

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:

      • PhoneNumberErrors — (Array<map>)

        If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.

        • PhoneNumberId — (String)

          The phone number ID for which the action failed.

        • ErrorCode — (String)

          The error code.

          Possible values include:
          • "BadRequest"
          • "Conflict"
          • "Forbidden"
          • "NotFound"
          • "PreconditionFailed"
          • "ResourceLimitExceeded"
          • "ServiceFailure"
          • "AccessDenied"
          • "ServiceUnavailable"
          • "Throttled"
          • "Throttling"
          • "Unauthorized"
          • "Unprocessable"
          • "VoiceConnectorGroupAssociationsExist"
          • "PhoneNumberAssociationsExist"
        • ErrorMessage — (String)

          The error message.

Returns:

  • (AWS.Request)

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

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

Associates phone numbers with the specified Amazon Chime Voice Connector group.

Examples:

Calling the associatePhoneNumbersWithVoiceConnectorGroup operation

var params = {
  E164PhoneNumbers: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  VoiceConnectorGroupId: 'STRING_VALUE', /* required */
  ForceAssociate: true || false
};
chime.associatePhoneNumbersWithVoiceConnectorGroup(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: {})
    • VoiceConnectorGroupId — (String)

      The Amazon Chime Voice Connector group ID.

    • E164PhoneNumbers — (Array<String>)

      List of phone numbers, in E.164 format.

    • ForceAssociate — (Boolean)

      If true, associates the provided phone numbers with the provided Amazon Chime Voice Connector Group and removes any previously existing associations. If false, does not associate any phone numbers that have previously existing associations.

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:

      • PhoneNumberErrors — (Array<map>)

        If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.

        • PhoneNumberId — (String)

          The phone number ID for which the action failed.

        • ErrorCode — (String)

          The error code.

          Possible values include:
          • "BadRequest"
          • "Conflict"
          • "Forbidden"
          • "NotFound"
          • "PreconditionFailed"
          • "ResourceLimitExceeded"
          • "ServiceFailure"
          • "AccessDenied"
          • "ServiceUnavailable"
          • "Throttled"
          • "Throttling"
          • "Unauthorized"
          • "Unprocessable"
          • "VoiceConnectorGroupAssociationsExist"
          • "PhoneNumberAssociationsExist"
        • ErrorMessage — (String)

          The error message.

Returns:

  • (AWS.Request)

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

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

Associates a phone number with the specified Amazon Chime user.

Service Reference:

Examples:

Calling the associatePhoneNumberWithUser operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  E164PhoneNumber: 'STRING_VALUE', /* required */
  UserId: 'STRING_VALUE' /* required */
};
chime.associatePhoneNumberWithUser(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: {})
    • AccountId — (String)

      The Amazon Chime account ID.

    • UserId — (String)

      The user ID.

    • E164PhoneNumber — (String)

      The phone number, in E.164 format.

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.

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

Associates the specified sign-in delegate groups with the specified Amazon Chime account.

Examples:

Calling the associateSigninDelegateGroupsWithAccount operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  SigninDelegateGroups: [ /* required */
    {
      GroupName: 'STRING_VALUE'
    },
    /* more items */
  ]
};
chime.associateSigninDelegateGroupsWithAccount(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: {})
    • AccountId — (String)

      The Amazon Chime account ID.

    • SigninDelegateGroups — (Array<map>)

      The sign-in delegate groups.

      • GroupName — (String)

        The group name.

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.

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

Creates up to 100 new attendees for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.

Service Reference:

Examples:

Calling the batchCreateAttendee operation

var params = {
  Attendees: [ /* required */
    {
      ExternalUserId: 'STRING_VALUE', /* required */
      Tags: [
        {
          Key: 'STRING_VALUE', /* required */
          Value: 'STRING_VALUE' /* required */
        },
        /* more items */
      ]
    },
    /* more items */
  ],
  MeetingId: 'STRING_VALUE' /* required */
};
chime.batchCreateAttendee(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: {})
    • MeetingId — (String)

      The Amazon Chime SDK meeting ID.

    • Attendees — (Array<map>)

      The request containing the attendees to create.

      • ExternalUserIdrequired — (String)

        The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.

      • Tags — (Array<map>)

        The tag key-value pairs.

        • Keyrequired — (String)

          The key of the tag.

        • Valuerequired — (String)

          The value of the tag.

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:

      • Attendees — (Array<map>)

        The attendee information, including attendees IDs and join tokens.

        • ExternalUserId — (String)

          The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.

        • AttendeeId — (String)

          The Amazon Chime SDK attendee ID.

        • JoinToken — (String)

          The join token used by the Amazon Chime SDK attendee.

      • Errors — (Array<map>)

        If the action fails for one or more of the attendees in the request, a list of the attendees is returned, along with error codes and error messages.

        • ExternalUserId — (String)

          The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.

        • ErrorCode — (String)

          The error code.

        • ErrorMessage — (String)

          The error message.

Returns:

  • (AWS.Request)

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

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

Adds up to 50 members to a chat room in an Amazon Chime Enterprise account. Members can be users or bots. The member role designates whether the member is a chat room administrator or a general chat room member.

Service Reference:

Examples:

Calling the batchCreateRoomMembership operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  MembershipItemList: [ /* required */
    {
      MemberId: 'STRING_VALUE',
      Role: Administrator | Member
    },
    /* more items */
  ],
  RoomId: 'STRING_VALUE' /* required */
};
chime.batchCreateRoomMembership(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: {})
    • AccountId — (String)

      The Amazon Chime account ID.

    • RoomId — (String)

      The room ID.

    • MembershipItemList — (Array<map>)

      The list of membership items.

      • MemberId — (String)

        The member ID.

      • Role — (String)

        The member role.

        Possible values include:
        • "Administrator"
        • "Member"

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:

      • Errors — (Array<map>)

        If the action fails for one or more of the member IDs in the request, a list of the member IDs is returned, along with error codes and error messages.

        • MemberId — (String)

          The member ID.

        • ErrorCode — (String)

          The error code.

          Possible values include:
          • "BadRequest"
          • "Conflict"
          • "Forbidden"
          • "NotFound"
          • "PreconditionFailed"
          • "ResourceLimitExceeded"
          • "ServiceFailure"
          • "AccessDenied"
          • "ServiceUnavailable"
          • "Throttled"
          • "Throttling"
          • "Unauthorized"
          • "Unprocessable"
          • "VoiceConnectorGroupAssociationsExist"
          • "PhoneNumberAssociationsExist"
        • ErrorMessage — (String)

          The error message.

Returns:

  • (AWS.Request)

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

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

Moves phone numbers into the Deletion queue. Phone numbers must be disassociated from any users or Amazon Chime Voice Connectors before they can be deleted.

Phone numbers remain in the Deletion queue for 7 days before they are deleted permanently.

Service Reference:

Examples:

Calling the batchDeletePhoneNumber operation

var params = {
  PhoneNumberIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
chime.batchDeletePhoneNumber(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: {})
    • PhoneNumberIds — (Array<String>)

      List of phone number IDs.

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:

      • PhoneNumberErrors — (Array<map>)

        If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.

        • PhoneNumberId — (String)

          The phone number ID for which the action failed.

        • ErrorCode — (String)

          The error code.

          Possible values include:
          • "BadRequest"
          • "Conflict"
          • "Forbidden"
          • "NotFound"
          • "PreconditionFailed"
          • "ResourceLimitExceeded"
          • "ServiceFailure"
          • "AccessDenied"
          • "ServiceUnavailable"
          • "Throttled"
          • "Throttling"
          • "Unauthorized"
          • "Unprocessable"
          • "VoiceConnectorGroupAssociationsExist"
          • "PhoneNumberAssociationsExist"
        • ErrorMessage — (String)

          The error message.

Returns:

  • (AWS.Request)

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

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

Suspends up to 50 users from a Team or EnterpriseLWA Amazon Chime account. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.

Users suspended from a Team account are disassociated from the account,but they can continue to use Amazon Chime as free users. To remove the suspension from suspended Team account users, invite them to the Team account again. You can use the InviteUsers action to do so.

Users suspended from an EnterpriseLWA account are immediately signed out of Amazon Chime and can no longer sign in. To remove the suspension from suspended EnterpriseLWA account users, use the BatchUnsuspendUser action.

To sign out users without suspending them, use the LogoutUser action.

Service Reference:

Examples:

Calling the batchSuspendUser operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  UserIdList: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
chime.batchSuspendUser(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: {})
    • AccountId — (String)

      The Amazon Chime account ID.

    • UserIdList — (Array<String>)

      The request containing the user IDs to suspend.

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:

      • UserErrors — (Array<map>)

        If the BatchSuspendUser action fails for one or more of the user IDs in the request, a list of the user IDs is returned, along with error codes and error messages.

        • UserId — (String)

          The user ID for which the action failed.

        • ErrorCode — (String)

          The error code.

          Possible values include:
          • "BadRequest"
          • "Conflict"
          • "Forbidden"
          • "NotFound"
          • "PreconditionFailed"
          • "ResourceLimitExceeded"
          • "ServiceFailure"
          • "AccessDenied"
          • "ServiceUnavailable"
          • "Throttled"
          • "Throttling"
          • "Unauthorized"
          • "Unprocessable"
          • "VoiceConnectorGroupAssociationsExist"
          • "PhoneNumberAssociationsExist"
        • ErrorMessage — (String)

          The error message.

Returns:

  • (AWS.Request)

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

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

Removes the suspension from up to 50 previously suspended users for the specified Amazon Chime EnterpriseLWA account. Only users on EnterpriseLWA accounts can be unsuspended using this action. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.

Previously suspended users who are unsuspended using this action are returned to Registered status. Users who are not previously suspended are ignored.

Service Reference:

Examples:

Calling the batchUnsuspendUser operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  UserIdList: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
chime.batchUnsuspendUser(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: {})
    • AccountId — (String)

      The Amazon Chime account ID.

    • UserIdList — (Array<String>)

      The request containing the user IDs to unsuspend.

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:

      • UserErrors — (Array<map>)

        If the BatchUnsuspendUser action fails for one or more of the user IDs in the request, a list of the user IDs is returned, along with error codes and error messages.

        • UserId — (String)

          The user ID for which the action failed.

        • ErrorCode — (String)

          The error code.

          Possible values include:
          • "BadRequest"
          • "Conflict"
          • "Forbidden"
          • "NotFound"
          • "PreconditionFailed"
          • "ResourceLimitExceeded"
          • "ServiceFailure"
          • "AccessDenied"
          • "ServiceUnavailable"
          • "Throttled"
          • "Throttling"
          • "Unauthorized"
          • "Unprocessable"
          • "VoiceConnectorGroupAssociationsExist"
          • "PhoneNumberAssociationsExist"
        • ErrorMessage — (String)

          The error message.

Returns:

  • (AWS.Request)

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

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

Updates phone number product types or calling names. You can update one attribute at a time for each UpdatePhoneNumberRequestItem . For example, you can update either the product type or the calling name.

For product types, choose from Amazon Chime Business Calling and Amazon Chime Voice Connector. For toll-free numbers, you must use the Amazon Chime Voice Connector product type.

Updates to outbound calling names can take up to 72 hours to complete. Pending updates to outbound calling names must be complete before you can request another update.

Service Reference:

Examples:

Calling the batchUpdatePhoneNumber operation

var params = {
  UpdatePhoneNumberRequestItems: [ /* required */
    {
      PhoneNumberId: 'STRING_VALUE', /* required */
      CallingName: 'STRING_VALUE',
      ProductType: BusinessCalling | VoiceConnector
    },
    /* more items */
  ]
};
chime.batchUpdatePhoneNumber(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: {})
    • UpdatePhoneNumberRequestItems — (Array<map>)

      The request containing the phone number IDs and product types or calling names to update.

      • PhoneNumberIdrequired — (String)

        The phone number ID to update.

      • ProductType — (String)

        The product type to update.

        Possible values include:
        • "BusinessCalling"
        • "VoiceConnector"
      • CallingName — (String)

        The outbound calling name to update.

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:

      • PhoneNumberErrors — (Array<map>)

        If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.

        • PhoneNumberId — (String)

          The phone number ID for which the action failed.

        • ErrorCode — (String)

          The error code.

          Possible values include:
          • "BadRequest"
          • "Conflict"
          • "Forbidden"
          • "NotFound"
          • "PreconditionFailed"
          • "ResourceLimitExceeded"
          • "ServiceFailure"
          • "AccessDenied"
          • "ServiceUnavailable"
          • "Throttled"
          • "Throttling"
          • "Unauthorized"
          • "Unprocessable"
          • "VoiceConnectorGroupAssociationsExist"
          • "PhoneNumberAssociationsExist"
        • ErrorMessage — (String)

          The error message.

Returns:

  • (AWS.Request)

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

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

Updates user details within the UpdateUserRequestItem object for up to 20 users for the specified Amazon Chime account. Currently, only LicenseType updates are supported for this action.

Service Reference:

Examples:

Calling the batchUpdateUser operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  UpdateUserRequestItems: [ /* required */
    {
      UserId: 'STRING_VALUE', /* required */
      AlexaForBusinessMetadata: {
        AlexaForBusinessRoomArn: 'STRING_VALUE',
        IsAlexaForBusinessEnabled: true || false
      },
      LicenseType: Basic | Plus | Pro | ProTrial,
      UserType: PrivateUser | SharedDevice
    },
    /* more items */
  ]
};
chime.batchUpdateUser(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: {})
    • AccountId — (String)

      The Amazon Chime account ID.

    • UpdateUserRequestItems — (Array<map>)

      The request containing the user IDs and details to update.

      • UserIdrequired — (String)

        The user ID.

      • LicenseType — (String)

        The user license type.

        Possible values include:
        • "Basic"
        • "Plus"
        • "Pro"
        • "ProTrial"
      • UserType — (String)

        The user type.

        Possible values include:
        • "PrivateUser"
        • "SharedDevice"
      • AlexaForBusinessMetadata — (map)

        The Alexa for Business metadata.

        • IsAlexaForBusinessEnabled — (Boolean)

          Starts or stops Alexa for Business.

        • AlexaForBusinessRoomArn — (String)

          The ARN of the room resource.

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:

      • UserErrors — (Array<map>)

        If the BatchUpdateUser action fails for one or more of the user IDs in the request, a list of the user IDs is returned, along with error codes and error messages.

        • UserId — (String)

          The user ID for which the action failed.

        • ErrorCode — (String)

          The error code.

          Possible values include:
          • "BadRequest"
          • "Conflict"
          • "Forbidden"
          • "NotFound"
          • "PreconditionFailed"
          • "ResourceLimitExceeded"
          • "ServiceFailure"
          • "AccessDenied"
          • "ServiceUnavailable"
          • "Throttled"
          • "Throttling"
          • "Unauthorized"
          • "Unprocessable"
          • "VoiceConnectorGroupAssociationsExist"
          • "PhoneNumberAssociationsExist"
        • ErrorMessage — (String)

          The error message.

Returns:

  • (AWS.Request)

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

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

Creates an Amazon Chime account under the administrator's AWS account. Only Team account types are currently supported for this action. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.

Service Reference:

Examples:

Calling the createAccount operation

var params = {
  Name: 'STRING_VALUE' /* required */
};
chime.createAccount(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 Amazon Chime account.

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:

      • Account — (map)

        The Amazon Chime account details.

        • AwsAccountIdrequired — (String)

          The AWS account ID.

        • AccountIdrequired — (String)

          The Amazon Chime account ID.

        • Namerequired — (String)

          The Amazon Chime account name.

        • AccountType — (String)

          The Amazon Chime account type. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.

          Possible values include:
          • "Team"
          • "EnterpriseDirectory"
          • "EnterpriseLWA"
          • "EnterpriseOIDC"
        • CreatedTimestamp — (Date)

          The Amazon Chime account creation timestamp, in ISO 8601 format.

        • DefaultLicense — (String)

          The default license for the Amazon Chime account.

          Possible values include:
          • "Basic"
          • "Plus"
          • "Pro"
          • "ProTrial"
        • SupportedLicenses — (Array<String>)

          Supported licenses for the Amazon Chime account.

        • SigninDelegateGroups — (Array<map>)

          The sign-in delegate groups associated with the account.

          • GroupName — (String)

            The group name.

Returns:

  • (AWS.Request)

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

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

Creates an Amazon Chime SDK messaging AppInstance under an AWS account. Only SDK messaging customers use this API. CreateAppInstance supports idempotency behavior as described in the AWS API Standard.

Service Reference:

Examples:

Calling the createAppInstance operation

var params = {
  ClientRequestToken: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  Metadata: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
chime.createAppInstance(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 AppInstance.

    • Metadata — (String)

      The metadata of the AppInstance. Limited to a 1KB string in UTF-8.

    • ClientRequestToken — (String)

      The ClientRequestToken of the AppInstance.

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

      Tags assigned to the AppInstanceUser.

      • Keyrequired — (String)

        The key of the tag.

      • Valuerequired — (String)

        The value of the tag.

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:

      • AppInstanceArn — (String)

        The Amazon Resource Number (ARN) of the AppInstance.

Returns:

  • (AWS.Request)

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

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

Promotes an AppInstanceUser to an AppInstanceAdmin. The promoted user can perform the following actions.

  • ChannelModerator actions across all channels in the AppInstance.

  • DeleteChannelMessage actions.

Only an AppInstanceUser can be promoted to an AppInstanceAdmin role.

Service Reference:

Examples:

Calling the createAppInstanceAdmin operation

var params = {
  AppInstanceAdminArn: 'STRING_VALUE', /* required */
  AppInstanceArn: 'STRING_VALUE' /* required */
};
chime.createAppInstanceAdmin(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: {})
    • AppInstanceAdminArn — (String)

      The ARN of the administrator of the current AppInstance.

    • AppInstanceArn — (String)

      The ARN of the AppInstance.

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:

      • AppInstanceAdmin — (map)

        The name and ARN of the admin for the AppInstance.

        • Arn — (String)

          The ARN in an Identity.

        • Name — (String)

          The name in an Identity.

      • AppInstanceArn — (String)

        The ARN of the of the admin for the AppInstance.

Returns:

  • (AWS.Request)

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

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

Creates a user under an Amazon Chime AppInstance. The request consists of a unique appInstanceUserId and Name for that user.

Service Reference:

Examples:

Calling the createAppInstanceUser operation

var params = {
  AppInstanceArn: 'STRING_VALUE', /* required */
  AppInstanceUserId: 'STRING_VALUE', /* required */
  ClientRequestToken: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  Metadata: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
chime.createAppInstanceUser(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: {})
    • AppInstanceArn — (String)

      The ARN of the AppInstance request.

    • AppInstanceUserId — (String)

      The user ID of the AppInstance.

    • Name — (String)

      The user's name.

    • Metadata — (String)

      The request's metadata. Limited to a 1KB string in UTF-8.

    • ClientRequestToken — (String)

      The token assigned to the user requesting an AppInstance.

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

      Tags assigned to the AppInstanceUser.

      • Keyrequired — (String)

        The key of the tag.

      • Valuerequired — (String)

        The value of the tag.

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:

      • AppInstanceUserArn — (String)

        The user's ARN.

Returns:

  • (AWS.Request)

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

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

Creates a new attendee for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.

Service Reference:

Examples:

Calling the createAttendee operation

var params = {
  ExternalUserId: 'STRING_VALUE', /* required */
  MeetingId: 'STRING_VALUE', /* required */
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
chime.createAttendee(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: {})
    • MeetingId — (String)

      The Amazon Chime SDK meeting ID.

    • ExternalUserId — (String)

      The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.

    • Tags — (Array<map>)

      The tag key-value pairs.

      • Keyrequired — (String)

        The key of the tag.

      • Valuerequired — (String)

        The value of the tag.

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:

      • Attendee — (map)

        The attendee information, including attendee ID and join token.

        • ExternalUserId — (String)

          The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.

        • AttendeeId — (String)

          The Amazon Chime SDK attendee ID.

        • JoinToken — (String)

          The join token used by the Amazon Chime SDK attendee.

Returns:

  • (AWS.Request)

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

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

Creates a bot for an Amazon Chime Enterprise account.

Service Reference:

Examples:

Calling the createBot operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  DisplayName: 'STRING_VALUE', /* required */
  Domain: 'STRING_VALUE'
};
chime.createBot(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: {})
    • AccountId — (String)

      The Amazon Chime account ID.

    • DisplayName — (String)

      The bot display name.

    • Domain — (String)

      The domain of the Amazon Chime Enterprise account.

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:

      • Bot — (map)

        The bot details.

        • BotId — (String)

          The bot ID.

        • UserId — (String)

          The unique ID for the bot user.

        • DisplayName — (String)

          The bot display name.

        • BotType — (String)

          The bot type.

          Possible values include:
          • "ChatBot"
        • Disabled — (Boolean)

          When true, the bot is stopped from running in your account.

        • CreatedTimestamp — (Date)

          The bot creation timestamp, in ISO 8601 format.

        • UpdatedTimestamp — (Date)

          The updated bot timestamp, in ISO 8601 format.

        • BotEmail — (String)

          The bot email address.

        • SecurityToken — (String)

          The security token used to authenticate Amazon Chime with the outgoing event endpoint.

Returns:

  • (AWS.Request)

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

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

Creates a channel to which you can add users and send messages.

Restriction: You can't change a channel's privacy.

Note: The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

Service Reference:

Examples:

Calling the createChannel operation

var params = {
  AppInstanceArn: 'STRING_VALUE', /* required */
  ClientRequestToken: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  ChimeBearer: 'STRING_VALUE',
  Metadata: 'STRING_VALUE',
  Mode: UNRESTRICTED | RESTRICTED,
  Privacy: PUBLIC | PRIVATE,
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
chime.createChannel(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: {})
    • AppInstanceArn — (String)

      The ARN of the channel request.

    • Name — (String)

      The name of the channel.

    • Mode — (String)

      The channel mode: UNRESTRICTED or RESTRICTED. Administrators, moderators, and channel members can add themselves and other members to unrestricted channels. Only administrators and moderators can add members to restricted channels.

      Possible values include:
      • "UNRESTRICTED"
      • "RESTRICTED"
    • Privacy — (String)

      The channel's privacy level: PUBLIC or PRIVATE. Private channels aren't discoverable by users outside the channel. Public channels are discoverable by anyone in the AppInstance.

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

      The metadata of the creation request. Limited to 1KB and UTF-8.

    • ClientRequestToken — (String)

      The client token for the request. An Idempotency token.

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

      The tags for the creation request.

      • Keyrequired — (String)

        The key of the tag.

      • Valuerequired — (String)

        The value of the tag.

    • ChimeBearer — (String)

      The AppInstanceUserArn of the user that makes the API 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:

      • ChannelArn — (String)

        The ARN of the channel.

Returns:

  • (AWS.Request)

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

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

Permanently bans a member from a channel. Moderators can't add banned members to a channel. To undo a ban, you first have to DeleteChannelBan, and then CreateChannelMembership. Bans are cleaned up when you delete users or channels.

If you ban a user who is already part of a channel, that user is automatically kicked from the channel.

Note: The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

Service Reference:

Examples:

Calling the createChannelBan operation

var params = {
  ChannelArn: 'STRING_VALUE', /* required */
  MemberArn: 'STRING_VALUE', /* required */
  ChimeBearer: 'STRING_VALUE'
};
chime.createChannelBan(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: {})
    • ChannelArn — (String)

      The ARN of the ban request.

    • MemberArn — (String)

      The ARN of the member being banned.

    • ChimeBearer — (String)

      The AppInstanceUserArn of the user that makes the API 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:

      • ChannelArn — (String)

        The ARN of the response to the ban request.

      • Member — (map)

        The ChannelArn and BannedIdentity of the member in the ban response.

        • Arn — (String)

          The ARN in an Identity.

        • Name — (String)

          The name in an Identity.

Returns:

  • (AWS.Request)

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

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

Adds a user to a channel. The InvitedBy response field is derived from the request header. A channel member can:

  • List messages

  • Send messages

  • Receive messages

  • Edit their own messages

  • Leave the channel

Privacy settings impact this action as follows:

  • Public Channels: You do not need to be a member to list messages, but you must be a member to send messages.

  • Private Channels: You must be a member to list or send messages.

Note: The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

Service Reference:

Examples:

Calling the createChannelMembership operation

var params = {
  ChannelArn: 'STRING_VALUE', /* required */
  MemberArn: 'STRING_VALUE', /* required */
  Type: DEFAULT | HIDDEN, /* required */
  ChimeBearer: 'STRING_VALUE'
};
chime.createChannelMembership(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: {})
    • ChannelArn — (String)

      The ARN of the channel to which you're adding users.

    • MemberArn — (String)

      The ARN of the member you want to add to the channel.

    • Type — (String)

      The membership type of a user, DEFAULT or HIDDEN. Default members are always returned as part of ListChannelMemberships. Hidden members are only returned if the type filter in ListChannelMemberships equals HIDDEN. Otherwise hidden members are not returned. This is only supported by moderators.

      Possible values include:
      • "DEFAULT"
      • "HIDDEN"
    • ChimeBearer — (String)

      The AppInstanceUserArn of the user that makes the API 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:

      • ChannelArn — (String)

        The ARN of the channel.

      • Member — (map)

        The ARN and metadata of the member being added.

        • Arn — (String)

          The ARN in an Identity.

        • Name — (String)

          The name in an Identity.

Returns:

  • (AWS.Request)

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

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

Creates a new ChannelModerator. A channel moderator can:

  • Add and remove other members of the channel.

  • Add and remove other moderators of the channel.

  • Add and remove user bans for the channel.

  • Redact messages in the channel.

  • List messages in the channel.

Note: The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

Service Reference:

Examples:

Calling the createChannelModerator operation

var params = {
  ChannelArn: 'STRING_VALUE', /* required */
  ChannelModeratorArn: 'STRING_VALUE', /* required */
  ChimeBearer: 'STRING_VALUE'
};
chime.createChannelModerator(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: {})
    • ChannelArn — (String)

      The ARN of the channel.

    • ChannelModeratorArn — (String)

      The ARN of the moderator.

    • ChimeBearer — (String)

      The AppInstanceUserArn of the user that makes the API 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:

      • ChannelArn — (String)

        The ARN of the channel.

      • ChannelModerator — (map)

        The ARNs of the channel and the moderator.

        • Arn — (String)

          The ARN in an Identity.

        • Name — (String)

          The name in an Identity.

Returns:

  • (AWS.Request)

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

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

Creates a new Amazon Chime SDK meeting in the specified media Region with no initial attendees. For more information about specifying media Regions, see Amazon Chime SDK Media Regions in the Amazon Chime Developer Guide . For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide .

Service Reference:

Examples:

Calling the createMeeting operation

var params = {
  ClientRequestToken: 'STRING_VALUE', /* required */
  ExternalMeetingId: 'STRING_VALUE',
  MediaRegion: 'STRING_VALUE',
  MeetingHostId: 'STRING_VALUE',
  NotificationsConfiguration: {
    SnsTopicArn: 'STRING_VALUE',
    SqsQueueArn: 'STRING_VALUE'
  },
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
chime.createMeeting(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: {})
    • ClientRequestToken — (String)

      The unique identifier for the client request. Use a different token for different meetings.

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

      The external meeting ID.

    • MeetingHostId — (String)

      Reserved.

    • MediaRegion — (String)

      The Region in which to create the meeting. Default: us-east-1.

      Available values: af-south-1 , ap-northeast-1 , ap-northeast-2 , ap-south-1 , ap-southeast-1 , ap-southeast-2 , ca-central-1 , eu-central-1 , eu-north-1 , eu-south-1 , eu-west-1 , eu-west-2 , eu-west-3 , sa-east-1 , us-east-1 , us-east-2 , us-west-1 , us-west-2 .

    • Tags — (Array<map>)

      The tag key-value pairs.

      • Keyrequired — (String)

        The key of the tag.

      • Valuerequired — (String)

        The value of the tag.

    • NotificationsConfiguration — (map)

      The configuration for resource targets to receive notifications when meeting and attendee events occur.

      • SnsTopicArn — (String)

        The SNS topic ARN.

      • SqsQueueArn — (String)

        The SQS queue ARN.

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:

      • Meeting — (map)

        The meeting information, including the meeting ID and MediaPlacement .

        • MeetingId — (String)

          The Amazon Chime SDK meeting ID.

        • ExternalMeetingId — (String)

          The external meeting ID.

        • MediaPlacement — (map)

          The media placement for the meeting.

          • AudioHostUrl — (String)

            The audio host URL.

          • AudioFallbackUrl — (String)

            The audio fallback URL.

          • ScreenDataUrl — (String)

            The screen data URL.

          • ScreenSharingUrl — (String)

            The screen sharing URL.

          • ScreenViewingUrl — (String)

            The screen viewing URL.

          • SignalingUrl — (String)

            The signaling URL.

          • TurnControlUrl — (String)

            The turn control URL.

        • MediaRegion — (String)

          The Region in which you create the meeting. Available values: af-south-1 , ap-northeast-1 , ap-northeast-2 , ap-south-1 , ap-southeast-1 , ap-southeast-2 , ca-central-1 , eu-central-1 , eu-north-1 , eu-south-1 , eu-west-1 , eu-west-2 , eu-west-3 , sa-east-1 , us-east-1 , us-east-2 , us-west-1 , us-west-2 .

Returns:

  • (AWS.Request)

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

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

Uses the join token and call metadata in a meeting request (From number, To number, and so forth) to initiate an outbound call to a public switched telephone network (PSTN) and join them into a Chime meeting. Also ensures that the From number belongs to the customer.

To play welcome audio or implement an interactive voice response (IVR), use the CreateSipMediaApplicationCall action with the corresponding SIP media application ID.

Service Reference:

Examples:

Calling the createMeetingDialOut operation

var params = {
  FromPhoneNumber: 'STRING_VALUE', /* required */
  JoinToken: 'STRING_VALUE', /* required */
  MeetingId: 'STRING_VALUE', /* required */
  ToPhoneNumber: 'STRING_VALUE' /* required */
};
chime.createMeetingDialOut(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: {})
    • MeetingId — (String)

      The Amazon Chime SDK meeting ID.

    • FromPhoneNumber — (String)

      Phone number used as the caller ID when the remote party receives a call.

    • ToPhoneNumber — (String)

      Phone number called when inviting someone to a meeting.

    • JoinToken — (String)

      Token used by the Amazon Chime SDK attendee. Call the CreateAttendee action to get a join token.

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:

      • TransactionId — (String)

        Unique ID that tracks API calls.

Returns:

  • (AWS.Request)

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

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

Creates a new Amazon Chime SDK meeting in the specified media Region, with attendees. For more information about specifying media Regions, see Amazon Chime SDK Media Regions in the Amazon Chime Developer Guide . For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide .

Service Reference:

Examples:

Calling the createMeetingWithAttendees operation

var params = {
  ClientRequestToken: 'STRING_VALUE', /* required */
  Attendees: [
    {
      ExternalUserId: 'STRING_VALUE', /* required */
      Tags: [
        {
          Key: 'STRING_VALUE', /* required */
          Value: 'STRING_VALUE' /* required */
        },
        /* more items */
      ]
    },
    /* more items */
  ],
  ExternalMeetingId: 'STRING_VALUE',
  MediaRegion: 'STRING_VALUE',
  MeetingHostId: 'STRING_VALUE',
  NotificationsConfiguration: {
    SnsTopicArn: 'STRING_VALUE',
    SqsQueueArn: 'STRING_VALUE'
  },
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
chime.createMeetingWithAttendees(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: {})
    • ClientRequestToken — (String)

      The unique identifier for the client request. Use a different token for different meetings.

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

      The external meeting ID.

    • MeetingHostId — (String)

      Reserved.

    • MediaRegion — (String)

      The Region in which to create the meeting. Default: us-east-1 .

      Available values: af-south-1 , ap-northeast-1 , ap-northeast-2 , ap-south-1 , ap-southeast-1 , ap-southeast-2 , ca-central-1 , eu-central-1 , eu-north-1 , eu-south-1 , eu-west-1 , eu-west-2 , eu-west-3 , sa-east-1 , us-east-1 , us-east-2 , us-west-1 , us-west-2 .

    • Tags — (Array<map>)

      The tag key-value pairs.

      • Keyrequired — (String)

        The key of the tag.

      • Valuerequired — (String)

        The value of the tag.

    • NotificationsConfiguration — (map)

      The resource target configurations for receiving Amazon Chime SDK meeting and attendee event notifications. The Amazon Chime SDK supports resource targets located in the US East (N. Virginia) AWS Region (us-east-1).

      • SnsTopicArn — (String)

        The SNS topic ARN.

      • SqsQueueArn — (String)

        The SQS queue ARN.

    • Attendees — (Array<map>)

      The request containing the attendees to create.

      • ExternalUserIdrequired — (String)

        The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.

      • Tags — (Array<map>)

        The tag key-value pairs.

        • Keyrequired — (String)

          The key of the tag.

        • Valuerequired — (String)

          The value of the tag.

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:

      • Meeting — (map)

        A meeting created using the Amazon Chime SDK.

        • MeetingId — (String)

          The Amazon Chime SDK meeting ID.

        • ExternalMeetingId — (String)

          The external meeting ID.

        • MediaPlacement — (map)

          The media placement for the meeting.

          • AudioHostUrl — (String)

            The audio host URL.

          • AudioFallbackUrl — (String)

            The audio fallback URL.

          • ScreenDataUrl — (String)

            The screen data URL.

          • ScreenSharingUrl — (String)

            The screen sharing URL.

          • ScreenViewingUrl — (String)

            The screen viewing URL.

          • SignalingUrl — (String)

            The signaling URL.

          • TurnControlUrl — (String)

            The turn control URL.

        • MediaRegion — (String)

          The Region in which you create the meeting. Available values: af-south-1 , ap-northeast-1 , ap-northeast-2 , ap-south-1 , ap-southeast-1 , ap-southeast-2 , ca-central-1 , eu-central-1 , eu-north-1 , eu-south-1 , eu-west-1 , eu-west-2 , eu-west-3 , sa-east-1 , us-east-1 , us-east-2 , us-west-1 , us-west-2 .

      • Attendees — (Array<map>)

        The attendee information, including attendees IDs and join tokens.

        • ExternalUserId — (String)

          The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.

        • AttendeeId — (String)

          The Amazon Chime SDK attendee ID.

        • JoinToken — (String)

          The join token used by the Amazon Chime SDK attendee.

      • Errors — (Array<map>)

        If the action fails for one or more of the attendees in the request, a list of the attendees is returned, along with error codes and error messages.

        • ExternalUserId — (String)

          The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.

        • ErrorCode — (String)

          The error code.

        • ErrorMessage — (String)

          The error message.

Returns:

  • (AWS.Request)

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

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

Creates an order for phone numbers to be provisioned. Choose from Amazon Chime Business Calling and Amazon Chime Voice Connector product types. For toll-free numbers, you must use the Amazon Chime Voice Connector product type.

Service Reference:

Examples:

Calling the createPhoneNumberOrder operation

var params = {
  E164PhoneNumbers: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  ProductType: BusinessCalling | VoiceConnector /* required */
};
chime.createPhoneNumberOrder(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: {})
    • ProductType — (String)

      The phone number product type.

      Possible values include:
      • "BusinessCalling"
      • "VoiceConnector"
    • E164PhoneNumbers — (Array<String>)

      List of phone numbers, in E.164 format.

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:

      • PhoneNumberOrder — (map)

        The phone number order details.

        • PhoneNumberOrderId — (String)

          The phone number order ID.

        • ProductType — (String)

          The phone number order product type.

          Possible values include:
          • "BusinessCalling"
          • "VoiceConnector"
        • Status — (String)

          The status of the phone number order.

          Possible values include:
          • "Processing"
          • "Successful"
          • "Failed"
          • "Partial"
        • OrderedPhoneNumbers — (Array<map>)

          The ordered phone number details, such as the phone number in E.164 format and the phone number status.

          • E164PhoneNumber — (String)

            The phone number, in E.164 format.

          • Status — (String)

            The phone number status.

            Possible values include:
            • "Processing"
            • "Acquired"
            • "Failed"
        • CreatedTimestamp — (Date)

          The phone number order creation time stamp, in ISO 8601 format.

        • UpdatedTimestamp — (Date)

          The updated phone number order time stamp, in ISO 8601 format.

Returns:

  • (AWS.Request)

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

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

Creates a proxy session on the specified Amazon Chime Voice Connector for the specified participant phone numbers.

Service Reference:

Examples:

Calling the createProxySession operation

var params = {
  Capabilities: [ /* required */
    Voice | SMS,
    /* more items */
  ],
  ParticipantPhoneNumbers: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  VoiceConnectorId: 'STRING_VALUE', /* required */
  ExpiryMinutes: 'NUMBER_VALUE',
  GeoMatchLevel: Country | AreaCode,
  GeoMatchParams: {
    AreaCode: 'STRING_VALUE', /* required */
    Country: 'STRING_VALUE' /* required */
  },
  Name: 'STRING_VALUE',
  NumberSelectionBehavior: PreferSticky | AvoidSticky
};
chime.createProxySession(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: {})
    • VoiceConnectorId — (String)

      The Amazon Chime voice connector ID.

    • ParticipantPhoneNumbers — (Array<String>)

      The participant phone numbers.

    • Name — (String)

      The name of the proxy session.

    • ExpiryMinutes — (Integer)

      The number of minutes allowed for the proxy session.

    • Capabilities — (Array<String>)

      The proxy session capabilities.

    • NumberSelectionBehavior — (String)

      The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.

      Possible values include:
      • "PreferSticky"
      • "AvoidSticky"
    • GeoMatchLevel — (String)

      The preference for matching the country or area code of the proxy phone number with that of the first participant.

      Possible values include:
      • "Country"
      • "AreaCode"
    • GeoMatchParams — (map)

      The country and area code for the proxy phone number.

      • Countryrequired — (String)

        The country.

      • AreaCoderequired — (String)

        The area code.

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:

      • ProxySession — (map)

        The proxy session details.

        • VoiceConnectorId — (String)

          The Amazon Chime voice connector ID.

        • ProxySessionId — (String)

          The proxy session ID.

        • Name — (String)

          The name of the proxy session.

        • Status — (String)

          The status of the proxy session.

          Possible values include:
          • "Open"
          • "InProgress"
          • "Closed"
        • ExpiryMinutes — (Integer)

          The number of minutes allowed for the proxy session.

        • Capabilities — (Array<String>)

          The proxy session capabilities.

        • CreatedTimestamp — (Date)

          The created time stamp, in ISO 8601 format.

        • UpdatedTimestamp — (Date)

          The updated time stamp, in ISO 8601 format.

        • EndedTimestamp — (Date)

          The ended time stamp, in ISO 8601 format.

        • Participants — (Array<map>)

          The proxy session participants.

          • PhoneNumber — (String)

            The participant's phone number.

          • ProxyPhoneNumber — (String)

            The participant's proxy phone number.

        • NumberSelectionBehavior — (String)

          The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.

          Possible values include:
          • "PreferSticky"
          • "AvoidSticky"
        • GeoMatchLevel — (String)

          The preference for matching the country or area code of the proxy phone number with that of the first participant.

          Possible values include:
          • "Country"
          • "AreaCode"
        • GeoMatchParams — (map)

          The country and area code for the proxy phone number.

          • Countryrequired — (String)

            The country.

          • AreaCoderequired — (String)

            The area code.

Returns:

  • (AWS.Request)

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

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

Creates a chat room for the specified Amazon Chime Enterprise account.

Service Reference:

Examples:

Calling the createRoom operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  ClientRequestToken: 'STRING_VALUE'
};
chime.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: {})
    • AccountId — (String)

      The Amazon Chime account ID.

    • Name — (String)

      The room name.

    • ClientRequestToken — (String)

      The idempotency token for the request.

      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:

      • Room — (map)

        The room details.

        • RoomId — (String)

          The room ID.

        • Name — (String)

          The room name.

        • AccountId — (String)

          The Amazon Chime account ID.

        • CreatedBy — (String)

          The identifier of the room creator.

        • CreatedTimestamp — (Date)

          The room creation timestamp, in ISO 8601 format.

        • UpdatedTimestamp — (Date)

          The room update timestamp, in ISO 8601 format.

Returns:

  • (AWS.Request)

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

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

Adds a member to a chat room in an Amazon Chime Enterprise account. A member can be either a user or a bot. The member role designates whether the member is a chat room administrator or a general chat room member.

Service Reference:

Examples:

Calling the createRoomMembership operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  MemberId: 'STRING_VALUE', /* required */
  RoomId: 'STRING_VALUE', /* required */
  Role: Administrator | Member
};
chime.createRoomMembership(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: {})
    • AccountId — (String)

      The Amazon Chime account ID.

    • RoomId — (String)

      The room ID.

    • MemberId — (String)

      The Amazon Chime member ID (user ID or bot ID).

    • Role — (String)

      The role of the member.

      Possible values include:
      • "Administrator"
      • "Member"

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:

      • RoomMembership — (map)

        The room membership details.

        • RoomId — (String)

          The room ID.

        • Member — (map)

          The member details, such as email address, name, member ID, and member type.

          • MemberId — (String)

            The member ID (user ID or bot ID).

          • MemberType — (String)

            The member type.

            Possible values include:
            • "User"
            • "Bot"
            • "Webhook"
          • Email — (String)

            The member email address.

          • FullName — (String)

            The member name.

          • AccountId — (String)

            The Amazon Chime account ID.

        • Role — (String)

          The membership role.

          Possible values include:
          • "Administrator"
          • "Member"
        • InvitedBy — (String)

          The identifier of the user that invited the room member.

        • UpdatedTimestamp — (Date)

          The room membership update timestamp, in ISO 8601 format.

Returns:

  • (AWS.Request)

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

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

Creates a SIP media application.

Service Reference:

Examples:

Calling the createSipMediaApplication operation

var params = {
  AwsRegion: 'STRING_VALUE', /* required */
  Endpoints: [ /* required */
    {
      LambdaArn: 'STRING_VALUE'
    },
    /* more items */
  ],
  Name: 'STRING_VALUE' /* required */
};
chime.createSipMediaApplication(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: {})
    • AwsRegion — (String)

      The AWS Region assigned to the SIP media application.

    • Name — (String)

      The SIP media application name.

    • Endpoints — (Array<map>)

      List of endpoints (Lambda Amazon Resource Names) specified for the SIP media application. Currently, only one endpoint is supported.

      • LambdaArn — (String)

        Valid Amazon Resource Name (ARN) of the Lambda function. The function must be created in the same AWS Region as the SIP media application.

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:

      • SipMediaApplication — (map)

        The SIP media application details.

        • SipMediaApplicationId — (String)

          The SIP media application ID.

        • AwsRegion — (String)

          The AWS Region in which the SIP media application is created.

        • Name — (String)

          The name of the SIP media application.

        • Endpoints — (Array<map>)

          List of endpoints for SIP media application. Currently, only one endpoint per SIP media application is permitted.

          • LambdaArn — (String)

            Valid Amazon Resource Name (ARN) of the Lambda function. The function must be created in the same AWS Region as the SIP media application.

        • CreatedTimestamp — (Date)

          The SIP media application creation timestamp, in ISO 8601 format.

        • UpdatedTimestamp — (Date)

          The SIP media application updated timestamp, in ISO 8601 format.

Returns:

  • (AWS.Request)

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

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

Creates an outbound call to a phone number from the phone number specified in the request, and it invokes the endpoint of the specified sipMediaApplicationId.

Service Reference:

Examples:

Calling the createSipMediaApplicationCall operation

var params = {
  FromPhoneNumber: 'STRING_VALUE', /* required */
  SipMediaApplicationId: 'STRING_VALUE', /* required */
  ToPhoneNumber: 'STRING_VALUE' /* required */
};
chime.createSipMediaApplicationCall(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: {})
    • FromPhoneNumber — (String)

      The phone number that a user calls from.

    • ToPhoneNumber — (String)

      The phone number that the user dials in order to connect to a meeting.

    • SipMediaApplicationId — (String)

      The ID of the SIP media application.

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:

      • SipMediaApplicationCall — (map)

        The actual call.

        • TransactionId — (String)

          The transaction ID of a call.

Returns:

  • (AWS.Request)

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

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

Creates a SIP rule which can be used to run a SIP media application as a target for a specific trigger type.

Service Reference:

Examples:

Calling the createSipRule operation

var params = {
  Name: 'STRING_VALUE', /* required */
  TargetApplications: [ /* required */
    {
      AwsRegion: 'STRING_VALUE',
      Priority: 'NUMBER_VALUE',
      SipMediaApplicationId: 'STRING_VALUE'
    },
    /* more items */
  ],
  TriggerType: ToPhoneNumber | RequestUriHostname, /* required */
  TriggerValue: 'STRING_VALUE', /* required */
  Disabled: true || false
};
chime.createSipRule(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 SIP rule.

    • TriggerType — (String)

      The type of trigger assigned to the SIP rule in TriggerValue, currently RequestUriHostname or ToPhoneNumber.

      Possible values include:
      • "ToPhoneNumber"
      • "RequestUriHostname"
    • TriggerValue — (String)

      If TriggerType is RequestUriHostname, the value can be the outbound host name of an Amazon Chime Voice Connector. If TriggerType is ToPhoneNumber, the value can be a customer-owned phone number in the E164 format. The SipMediaApplication specified in the SipRule is triggered if the request URI in an incoming SIP request matches the RequestUriHostname, or if the To header in the incoming SIP request matches the ToPhoneNumber value.

    • Disabled — (Boolean)

      Enables or disables a rule. You must disable rules before you can delete them.

    • TargetApplications — (Array<map>)

      List of SIP media applications with priority and AWS Region. Only one SIP application per AWS Region can be used.

      • SipMediaApplicationId — (String)

        The SIP media application ID.

      • Priority — (Integer)

        Priority of the SIP media application in the target list.

      • AwsRegion — (String)

        The AWS Region of the target application.

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:

      • SipRule — (map)

        Returns the SIP rule information, including the rule ID, triggers, and target applications.

        • SipRuleId — (String)

          The SIP rule ID.

        • Name — (String)

          The name of the SIP rule.

        • Disabled — (Boolean)

          Indicates whether the SIP rule is enabled or disabled. You must disable a rule before you can delete it.

        • TriggerType — (String)

          The type of trigger assigned to the SIP rule in TriggerValue, currently RequestUriHostname or ToPhoneNumber.

          Possible values include:
          • "ToPhoneNumber"
          • "RequestUriHostname"
        • TriggerValue — (String)

          If TriggerType is RequestUriHostname, then the value can be the outbound host name of the Amazon Chime Voice Connector. If TriggerType is ToPhoneNumber, then the value can be a customer-owned phone number in E164 format. SipRule is triggered when a SIP rule requests host name or ToPhoneNumber matches in the incoming SIP request.

        • TargetApplications — (Array<map>)

          Target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.

          • SipMediaApplicationId — (String)

            The SIP media application ID.

          • Priority — (Integer)

            Priority of the SIP media application in the target list.

          • AwsRegion — (String)

            The AWS Region of the target application.

        • CreatedTimestamp — (Date)

          The time at which the SIP rule was created, in ISO 8601 format.

        • UpdatedTimestamp — (Date)

          The time at which the SIP rule was last updated, in ISO 8601 format.

Returns:

  • (AWS.Request)

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

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

Creates a user under the specified Amazon Chime account.

Service Reference:

Examples:

Calling the createUser operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  Email: 'STRING_VALUE',
  UserType: PrivateUser | SharedDevice,
  Username: 'STRING_VALUE'
};
chime.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: {})
    • AccountId — (String)

      The Amazon Chime account ID.

    • Username — (String)

      The user name.

    • Email — (String)

      The user's email address.

    • UserType — (String)

      The user type.

      Possible values include:
      • "PrivateUser"
      • "SharedDevice"

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:

      • User — (map)

        The user on the Amazon Chime account.

        • UserIdrequired — (String)

          The user ID.

        • AccountId — (String)

          The Amazon Chime account ID.

        • PrimaryEmail — (String)

          The primary email address of the user.

        • PrimaryProvisionedNumber — (String)

          The primary phone number associated with the user.

        • DisplayName — (String)

          The display name of the user.

        • LicenseType — (String)

          The license type for the user.

          Possible values include:
          • "Basic"
          • "Plus"
          • "Pro"
          • "ProTrial"
        • UserType — (String)

          The user type.

          Possible values include:
          • "PrivateUser"
          • "SharedDevice"
        • UserRegistrationStatus — (String)

          The user registration status.

          Possible values include:
          • "Unregistered"
          • "Registered"
          • "Suspended"
        • UserInvitationStatus — (String)

          The user invite status.

          Possible values include:
          • "Pending"
          • "Accepted"
          • "Failed"
        • RegisteredOn — (Date)

          Date and time when the user is registered, in ISO 8601 format.

        • InvitedOn — (Date)

          Date and time when the user is invited to the Amazon Chime account, in ISO 8601 format.

        • AlexaForBusinessMetadata — (map)

          The Alexa for Business metadata.

          • IsAlexaForBusinessEnabled — (Boolean)

            Starts or stops Alexa for Business.

          • AlexaForBusinessRoomArn — (String)

            The ARN of the room resource.

        • PersonalPIN — (String)

          The user's personal meeting PIN.

Returns:

  • (AWS.Request)

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

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

Creates an Amazon Chime Voice Connector under the administrator's AWS account. You can choose to create an Amazon Chime Voice Connector in a specific AWS Region.

Enabling CreateVoiceConnectorRequest$RequireEncryption configures your Amazon Chime Voice Connector to use TLS transport for SIP signaling and Secure RTP (SRTP) for media. Inbound calls use TLS transport, and unencrypted outbound calls are blocked.

Service Reference:

Examples:

Calling the createVoiceConnector operation

var params = {
  Name: 'STRING_VALUE', /* required */
  RequireEncryption: true || false, /* required */
  AwsRegion: us-east-1 | us-west-2
};
chime.createVoiceConnector(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 Amazon Chime Voice Connector.

    • AwsRegion — (String)

      The AWS Region in which the Amazon Chime Voice Connector is created. Default value: us-east-1 .

      Possible values include:
      • "us-east-1"
      • "us-west-2"
    • RequireEncryption — (Boolean)

      When enabled, requires encryption for the Amazon Chime Voice Connector.

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:

      • VoiceConnector — (map)

        The Amazon Chime Voice Connector details.

        • VoiceConnectorId — (String)

          The Amazon Chime Voice Connector ID.

        • AwsRegion — (String)

          The AWS Region in which the Amazon Chime Voice Connector is created. Default: us-east-1.

          Possible values include:
          • "us-east-1"
          • "us-west-2"
        • Name — (String)

          The name of the Amazon Chime Voice Connector.

        • OutboundHostName — (String)

          The outbound host name for the Amazon Chime Voice Connector.

        • RequireEncryption — (Boolean)

          Designates whether encryption is required for the Amazon Chime Voice Connector.

        • CreatedTimestamp — (Date)

          The Amazon Chime Voice Connector creation timestamp, in ISO 8601 format.

        • UpdatedTimestamp — (Date)

          The updated Amazon Chime Voice Connector timestamp, in ISO 8601 format.

Returns:

  • (AWS.Request)

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

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

Creates an Amazon Chime Voice Connector group under the administrator's AWS account. You can associate Amazon Chime Voice Connectors with the Amazon Chime Voice Connector group by including VoiceConnectorItems in the request.

You can include Amazon Chime Voice Connectors from different AWS Regions in your group. This creates a fault tolerant mechanism for fallback in case of availability events.

Service Reference:

Examples:

Calling the createVoiceConnectorGroup operation

var params = {
  Name: 'STRING_VALUE', /* required */
  VoiceConnectorItems: [
    {
      Priority: 'NUMBER_VALUE', /* required */
      VoiceConnectorId: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
chime.createVoiceConnectorGroup(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 Amazon Chime Voice Connector group.

    • VoiceConnectorItems — (Array<map>)

      The Amazon Chime Voice Connectors to route inbound calls to.

      • VoiceConnectorIdrequired — (String)

        The Amazon Chime Voice Connector ID.

      • Priorityrequired — (Integer)

        The priority associated with the Amazon Chime Voice Connector, with 1 being the highest priority. Higher priority Amazon Chime Voice Connectors are attempted first.

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:

      • VoiceConnectorGroup — (map)

        The Amazon Chime Voice Connector group details.

        • VoiceConnectorGroupId — (String)

          The Amazon Chime Voice Connector group ID.

        • Name — (String)

          The name of the Amazon Chime Voice Connector group.

        • VoiceConnectorItems — (Array<map>)

          The Amazon Chime Voice Connectors to which to route inbound calls.

          • VoiceConnectorIdrequired — (String)

            The Amazon Chime Voice Connector ID.

          • Priorityrequired — (Integer)

            The priority associated with the Amazon Chime Voice Connector, with 1 being the highest priority. Higher priority Amazon Chime Voice Connectors are attempted first.

        • CreatedTimestamp — (Date)

          The Amazon Chime Voice Connector group creation time stamp, in ISO 8601 format.

        • UpdatedTimestamp — (Date)

          The updated Amazon Chime Voice Connector group time stamp, in ISO 8601 format.

Returns:

  • (AWS.Request)

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

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

Deletes the specified Amazon Chime account. You must suspend all users before deleting Team account. You can use the BatchSuspendUser action to dodo.

For EnterpriseLWA and EnterpriseAD accounts, you must release the claimed domains for your Amazon Chime account before deletion. As soon as you release the domain, all users under that account are suspended.

Deleted accounts appear in your Disabled accounts list for 90 days. To restore deleted account from your Disabled accounts list, you must contact AWS Support.

After 90 days, deleted accounts are permanently removed from your Disabled accounts list.

Service Reference:

Examples:

Calling the deleteAccount operation

var params = {
  AccountId: 'STRING_VALUE' /* required */
};
chime.deleteAccount(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: {})
    • AccountId — (String)

      The Amazon Chime account ID.

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.

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

Deletes an AppInstance and all associated data asynchronously.

Service Reference:

Examples:

Calling the deleteAppInstance operation

var params = {
  AppInstanceArn: 'STRING_VALUE' /* required */
};
chime.deleteAppInstance(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: {})
    • AppInstanceArn — (String)

      The ARN of the AppInstance.

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.

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

Demotes an AppInstanceAdmin to an AppInstanceUser. This action does not delete the user.

Service Reference:

Examples:

Calling the deleteAppInstanceAdmin operation

var params = {
  AppInstanceAdminArn: 'STRING_VALUE', /* required */
  AppInstanceArn: 'STRING_VALUE' /* required */
};
chime.deleteAppInstanceAdmin(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: {})
    • AppInstanceAdminArn — (String)

      The ARN of the AppInstance's administrator.

    • AppInstanceArn — (String)

      The ARN of the AppInstance.

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.

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

Deletes the streaming configurations of an AppInstance.

Examples:

Calling the deleteAppInstanceStreamingConfigurations operation

var params = {
  AppInstanceArn: 'STRING_VALUE' /* required */
};
chime.deleteAppInstanceStreamingConfigurations(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: {})
    • AppInstanceArn — (String)

      The ARN of the streaming configurations being deleted.

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.

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

Deletes an AppInstanceUser.

Service Reference:

Examples:

Calling the deleteAppInstanceUser operation

var params = {
  AppInstanceUserArn: 'STRING_VALUE' /* required */
};
chime.deleteAppInstanceUser(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: {})
    • AppInstanceUserArn — (String)

      The ARN of the user request being deleted.

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.

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

Deletes an attendee from the specified Amazon Chime SDK meeting and deletes their JoinToken . Attendees are automatically deleted when a Amazon Chime SDK meeting is deleted. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide .

Service Reference:

Examples:

Calling the deleteAttendee operation

var params = {
  AttendeeId: 'STRING_VALUE', /* required */
  MeetingId: 'STRING_VALUE' /* required */
};
chime.deleteAttendee(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: {})
    • MeetingId — (String)

      The Amazon Chime SDK meeting ID.

    • AttendeeId — (String)

      The Amazon Chime SDK attendee ID.

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.

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

Immediately makes a channel and its memberships inaccessible and marks them for deletion. This is an irreversible process.

Note: The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

Service Reference:

Examples:

Calling the deleteChannel operation

var params = {
  ChannelArn: 'STRING_VALUE', /* required */
  ChimeBearer: 'STRING_VALUE'
};
chime.deleteChannel(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: {})
    • ChannelArn — (String)

      The ARN of the channel being deleted.

    • ChimeBearer — (String)

      The AppInstanceUserArn of the user that makes the API 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.

Returns:

  • (AWS.Request)

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

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

Removes a user from a channel's ban list.

Note: The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

Service Reference:

Examples:

Calling the deleteChannelBan operation

var params = {
  ChannelArn: 'STRING_VALUE', /* required */
  MemberArn: 'STRING_VALUE', /* required */
  ChimeBearer: 'STRING_VALUE'
};
chime.deleteChannelBan(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: {})
    • ChannelArn — (String)

      The ARN of the channel from which the AppInstanceUser was banned.

    • MemberArn — (String)

      The ARN of the AppInstanceUser that you want to reinstate.

    • ChimeBearer — (String)

      The AppInstanceUserArn of the user that makes the API 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.

Returns:

  • (AWS.Request)

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

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

Removes a member from a channel.

Note: The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

Service Reference:

Examples:

Calling the deleteChannelMembership operation

var params = {
  ChannelArn: 'STRING_VALUE', /* required */
  MemberArn: 'STRING_VALUE', /* required */
  ChimeBearer: 'STRING_VALUE'
};
chime.deleteChannelMembership(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: {})
    • ChannelArn — (String)

      The ARN of the channel from which you want to remove the user.

    • MemberArn — (String)

      The ARN of the member that you're removing from the channel.

    • ChimeBearer — (String)

      The AppInstanceUserArn of the user that makes the API 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.

Returns:

  • (AWS.Request)

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

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

Deletes a channel message. Only admins can perform this action. Deletion makes messages inaccessible immediately. A background process deletes any revisions created by UpdateChannelMessage.

Note: The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

Service Reference:

Examples:

Calling the deleteChannelMessage operation

var params = {
  ChannelArn: 'STRING_VALUE', /* required */
  MessageId: 'STRING_VALUE', /* required */
  ChimeBearer: 'STRING_VALUE'
};
chime.deleteChannelMessage(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: {})
    • ChannelArn — (String)

      The ARN of the channel.

    • MessageId — (String)

      The ID of the message being deleted.

    • ChimeBearer — (String)

      The AppInstanceUserArn of the user that makes the API 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.

Returns:

  • (AWS.Request)

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

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

Deletes a channel moderator.

Note: The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

Service Reference:

Examples:

Calling the deleteChannelModerator operation

var params = {
  ChannelArn: 'STRING_VALUE', /* required */
  ChannelModeratorArn: 'STRING_VALUE', /* required */
  ChimeBearer: 'STRING_VALUE'
};
chime.deleteChannelModerator(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: {})
    • ChannelArn — (String)

      The ARN of the channel.

    • ChannelModeratorArn — (String)

      The ARN of the moderator being deleted.

    • ChimeBearer — (String)

      The AppInstanceUserArn of the user that makes the API 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.

Returns:

  • (AWS.Request)

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

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

Deletes the events configuration that allows a bot to receive outgoing events.

Service Reference:

Examples:

Calling the deleteEventsConfiguration operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  BotId: 'STRING_VALUE' /* required */
};
chime.deleteEventsConfiguration(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: {})
    • AccountId — (String)

      The Amazon Chime account ID.

    • BotId — (String)

      The bot ID.

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.

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

Deletes the specified Amazon Chime SDK meeting. When a meeting is deleted, its attendees are also deleted, clients connected to the meeting are disconnected, and clients can no longer join the meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.

Service Reference:

Examples:

Calling the deleteMeeting operation

var params = {
  MeetingId: 'STRING_VALUE' /* required */
};
chime.deleteMeeting(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: {})
    • MeetingId — (String)

      The Amazon Chime SDK meeting ID.

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.

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

Moves the specified phone number into the Deletionqueue. A phone number must be disassociated from any users or Amazon Chime Voice Connectors before it can be deleted.

Deleted phone numbers remain in the Deletion queue for 7 days before they are deleted permanently.

Service Reference:

Examples:

Calling the deletePhoneNumber operation

var params = {
  PhoneNumberId: 'STRING_VALUE' /* required */
};
chime.deletePhoneNumber(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: {})
    • PhoneNumberId — (String)

      The phone number ID.

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.

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

Deletes the specified proxy session from the specified Amazon Chime Voice Connector.

Service Reference:

Examples:

Calling the deleteProxySession operation

var params = {
  ProxySessionId: 'STRING_VALUE', /* required */
  VoiceConnectorId: 'STRING_VALUE' /* required */
};
chime.deleteProxySession(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: {})
    • VoiceConnectorId — (String)

      The Amazon Chime voice connector ID.

    • ProxySessionId — (String)

      The proxy session ID.

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 chat room in an Amazon Chime Enterprise account.

Service Reference:

Examples:

Calling the deleteRoom operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  RoomId: 'STRING_VALUE' /* required */
};
chime.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: {})
    • AccountId — (String)

      The Amazon Chime account ID.

    • RoomId — (String)

      The chat room ID.

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.

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

Removes a member from a chat room in an Amazon Chime Enterprise account.

Service Reference:

Examples:

Calling the deleteRoomMembership operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  MemberId: 'STRING_VALUE', /* required */
  RoomId: 'STRING_VALUE' /* required */
};
chime.deleteRoomMembership(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: {})
    • AccountId — (String)

      The Amazon Chime account ID.

    • RoomId — (String)

      The room ID.

    • MemberId — (String)

      The member ID (user ID or bot ID).

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.

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

Deletes a SIP media application.

Service Reference:

Examples:

Calling the deleteSipMediaApplication operation

var params = {
  SipMediaApplicationId: 'STRING_VALUE' /* required */
};
chime.deleteSipMediaApplication(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: {})
    • SipMediaApplicationId — (String)

      The SIP media application ID.

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.

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

Deletes a SIP rule. You must disable a SIP rule before you can delete it.

Service Reference:

Examples:

Calling the deleteSipRule operation

var params = {
  SipRuleId: 'STRING_VALUE' /* required */
};
chime.deleteSipRule(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: {})
    • SipRuleId — (String)

      The SIP rule ID.

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.

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

Deletes the specified Amazon Chime Voice Connector. Any phone numbers associated with the Amazon Chime Voice Connector must be disassociated from it before it can be deleted.

Service Reference:

Examples:

Calling the deleteVoiceConnector operation

var params = {
  VoiceConnectorId: 'STRING_VALUE' /* required */
};
chime.deleteVoiceConnector(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: {})
    • VoiceConnectorId — (String)

      The Amazon Chime Voice Connector ID.

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.

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

Deletes the emergency calling configuration details from the specified Amazon Chime Voice Connector.

Examples:

Calling the deleteVoiceConnectorEmergencyCallingConfiguration operation

var params = {
  VoiceConnectorId: 'STRING_VALUE' /* required */
};
chime.deleteVoiceConnectorEmergencyCallingConfiguration(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: {})
    • VoiceConnectorId — (String)

      The Amazon Chime Voice Connector ID.

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.

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

Deletes the specified Amazon Chime Voice Connector group. Any VoiceConnectorItems and phone numbers associated with the group must be removed before it can be deleted.

Service Reference:

Examples:

Calling the deleteVoiceConnectorGroup operation

var params = {
  VoiceConnectorGroupId: 'STRING_VALUE' /* required */
};
chime.deleteVoiceConnectorGroup(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: {})
    • VoiceConnectorGroupId — (String)

      The Amazon Chime Voice Connector group ID.

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.

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

Deletes the origination settings for the specified Amazon Chime Voice Connector.

Note: If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to deleting the origination settings.

Service Reference:

Examples:

Calling the deleteVoiceConnectorOrigination operation

var params = {
  VoiceConnectorId: 'STRING_VALUE' /* required */
};
chime.deleteVoiceConnectorOrigination(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: {})
    • VoiceConnectorId — (String)

      The Amazon Chime Voice Connector ID.

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.

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

Deletes the proxy configuration from the specified Amazon Chime Voice Connector.

Service Reference:

Examples:

Calling the deleteVoiceConnectorProxy operation

var params = {
  VoiceConnectorId: 'STRING_VALUE' /* required */
};
chime.deleteVoiceConnectorProxy(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: {})
    • VoiceConnectorId — (String)

      The Amazon Chime Voice Connector ID.

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.

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

Deletes the streaming configuration for the specified Amazon Chime Voice Connector.

Examples:

Calling the deleteVoiceConnectorStreamingConfiguration operation

var params = {
  VoiceConnectorId: 'STRING_VALUE' /* required */
};
chime.deleteVoiceConnectorStreamingConfiguration(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: {})
    • VoiceConnectorId — (String)

      The Amazon Chime Voice Connector ID.

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.

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

Deletes the termination settings for the specified Amazon Chime Voice Connector.

Note: If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to deleting the termination settings.

Service Reference:

Examples:

Calling the deleteVoiceConnectorTermination operation

var params = {
  VoiceConnectorId: 'STRING_VALUE' /* required */
};
chime.deleteVoiceConnectorTermination(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: {})
    • VoiceConnectorId — (String)

      The Amazon Chime Voice Connector ID.

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.

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

Deletes the specified SIP credentials used by your equipment to authenticate during call termination.

Examples:

Calling the deleteVoiceConnectorTerminationCredentials operation

var params = {
  Usernames: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  VoiceConnectorId: 'STRING_VALUE' /* required */
};
chime.deleteVoiceConnectorTerminationCredentials(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: {})
    • VoiceConnectorId — (String)

      The Amazon Chime Voice Connector ID.

    • Usernames — (Array<String>)

      The RFC2617 compliant username associated with the SIP credentials, in US-ASCII format.

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.

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

Returns the full details of an AppInstance.

Service Reference:

Examples:

Calling the describeAppInstance operation

var params = {
  AppInstanceArn: 'STRING_VALUE' /* required */
};
chime.describeAppInstance(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: {})
    • AppInstanceArn — (String)

      The ARN of the AppInstance.

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:

      • AppInstance — (map)

        The ARN, metadata, created and last-updated timestamps, and the name of the AppInstance. All timestamps use epoch milliseconds.

        • AppInstanceArn — (String)

          The ARN of the messaging instance.

        • Name — (String)

          The name of an AppInstance.

        • Metadata — (String)

          The metadata of an AppInstance.

        • CreatedTimestamp — (Date)

          The time at which an AppInstance was created. In epoch milliseconds.

        • LastUpdatedTimestamp — (Date)

          The time an AppInstance was last updated. In epoch milliseconds.

Returns:

  • (AWS.Request)

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

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

Returns the full details of an AppInstanceAdmin.

Service Reference:

Examples:

Calling the describeAppInstanceAdmin operation

var params = {
  AppInstanceAdminArn: 'STRING_VALUE', /* required */
  AppInstanceArn: 'STRING_VALUE' /* required */
};
chime.describeAppInstanceAdmin(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: {})
    • AppInstanceAdminArn — (String)

      The ARN of the AppInstanceAdmin.

    • AppInstanceArn — (String)

      The ARN of the AppInstance.

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:

      • AppInstanceAdmin — (map)

        The ARN and name of the AppInstanceUser, the ARN of the AppInstance, and the created and last-updated timestamps. All timestamps use epoch milliseconds.

        • Admin — (map)

          The AppInstanceAdmin data.

          • Arn — (String)

            The ARN in an Identity.

          • Name — (String)

            The name in an Identity.

        • AppInstanceArn — (String)

          The ARN of the AppInstance for which the user is an administrator.

        • CreatedTimestamp — (Date)

          The time at which an administrator was created.

Returns:

  • (AWS.Request)

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

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

Returns the full details of an AppInstanceUser .

Service Reference:

Examples:

Calling the describeAppInstanceUser operation

var params = {
  AppInstanceUserArn: 'STRING_VALUE' /* required */
};
chime.describeAppInstanceUser(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: {})
    • AppInstanceUserArn — (String)

      The ARN of the AppInstanceUser.

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:

      • AppInstanceUser — (map)

        The name of the AppInstanceUser.

        • AppInstanceUserArn — (String)

          The ARN of the AppInstanceUser.

        • Name — (String)

          The name of the AppInstanceUser.

        • CreatedTimestamp — (Date)

          The time at which the AppInstanceUser was created.

        • Metadata — (String)

          The metadata of the AppInstanceUser.

        • LastUpdatedTimestamp — (Date)

          The time at which the AppInstanceUser was last updated.

Returns:

  • (AWS.Request)

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

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

Returns the full details of a channel in an Amazon Chime AppInstance.

Note: The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

Service Reference:

Examples:

Calling the describeChannel operation

var params = {
  ChannelArn: 'STRING_VALUE', /* required */
  ChimeBearer: 'STRING_VALUE'
};
chime.describeChannel(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: {})
    • ChannelArn — (String)

      The ARN of the channel.

    • ChimeBearer — (String)

      The AppInstanceUserArn of the user that makes the API 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:

      • Channel — (map)

        The channel details.

        • Name — (String)

          The name of the channel.

        • ChannelArn — (String)

          The ARN of the channel.

        • Mode — (String)

          The mode of the channel.

          Possible values include:
          • "UNRESTRICTED"
          • "RESTRICTED"
        • Privacy — (String)

          The channel's privacy setting.

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

          The channel's metadata.

        • CreatedBy — (map)

          The AppInstanceUser who created the channel.

          • Arn — (String)

            The ARN in an Identity.

          • Name — (String)

            The name in an Identity.

        • CreatedTimestamp — (Date)

          The time at which the AppInstanceUser created the channel.

        • LastMessageTimestamp — (Date)

          The time at which a member sent the last message in the channel.

        • LastUpdatedTimestamp — (Date)

          The time at which a channel was last updated.

Returns:

  • (AWS.Request)

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

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

Returns the full details of a channel ban.

Note: The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

Service Reference:

Examples:

Calling the describeChannelBan operation

var params = {
  ChannelArn: 'STRING_VALUE', /* required */
  MemberArn: 'STRING_VALUE', /* required */
  ChimeBearer: 'STRING_VALUE'
};
chime.describeChannelBan(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: {})
    • ChannelArn — (String)

      The ARN of the channel from which the user is banned.

    • MemberArn — (String)

      The ARN of the member being banned.

    • ChimeBearer — (String)

      The AppInstanceUserArn of the user that makes the API 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:

      • ChannelBan — (map)

        The the details of the ban.

        • Member — (map)

          The member being banned from the channel.

          • Arn — (String)

            The ARN in an Identity.

          • Name — (String)

            The name in an Identity.

        • ChannelArn — (String)

          The ARN of the channel from which a member is being banned.

        • CreatedTimestamp — (Date)

          The time at which the ban was created.

        • CreatedBy — (map)

          The AppInstanceUser who created the ban.

          • Arn — (String)

            The ARN in an Identity.

          • Name — (String)

            The name in an Identity.

Returns:

  • (AWS.Request)

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

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

Returns the full details of a user's channel membership.

Note: The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

Service Reference:

Examples:

Calling the describeChannelMembership operation

var params = {
  ChannelArn: 'STRING_VALUE', /* required */
  MemberArn: 'STRING_VALUE', /* required */
  ChimeBearer: 'STRING_VALUE'
};
chime.describeChannelMembership(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: {})
    • ChannelArn — (String)

      The ARN of the channel.

    • MemberArn — (String)

      The ARN of the member.

    • ChimeBearer — (String)

      The AppInstanceUserArn of the user that makes the API 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:

      • ChannelMembership — (map)

        The details of the membership.

        • InvitedBy — (map)

          The identifier of the member who invited another member.

          • Arn — (String)

            The ARN in an Identity.

          • Name — (String)

            The name in an Identity.

        • Type — (String)

          The membership type set for the channel member.

          Possible values include:
          • "DEFAULT"
          • "HIDDEN"
        • Member — (map)

          The data of the channel member.

          • Arn — (String)

            The ARN in an Identity.

          • Name — (String)

            The name in an Identity.

        • ChannelArn — (String)

          The ARN of the member's channel.

        • CreatedTimestamp — (Date)

          The time at which the channel membership was created.

        • LastUpdatedTimestamp — (Date)

          The time at which a channel membership was last updated.

Returns:

  • (AWS.Request)

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

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

Returns the details of a channel based on the membership of the specified AppInstanceUser.

Note: The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

Examples:

Calling the describeChannelMembershipForAppInstanceUser operation

var params = {
  AppInstanceUserArn: 'STRING_VALUE', /* required */
  ChannelArn: 'STRING_VALUE', /* required */
  ChimeBearer: 'STRING_VALUE'
};
chime.describeChannelMembershipForAppInstanceUser(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: {})
    • ChannelArn — (String)

      The ARN of the channel to which the user belongs.

    • AppInstanceUserArn — (String)

      The ARN of the user in a channel.

    • ChimeBearer — (String)

      The AppInstanceUserArn of the user that makes the API 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:

      • ChannelMembership — (map)

        The channel to which a user belongs.

        • ChannelSummary — (map)

          Summary of the details of a Channel.

          • Name — (String)

            The name of the channel.

          • ChannelArn — (String)

            The ARN of the channel.

          • Mode — (String)

            The mode of the channel.

            Possible values include:
            • "UNRESTRICTED"
            • "RESTRICTED"
          • Privacy — (String)

            The privacy setting of the channel.

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

            The metadata of the channel.

          • LastMessageTimestamp — (Date)

            The time at which the last message in a channel was sent.

        • AppInstanceUserMembershipSummary — (map)

          Returns the channel membership data for an AppInstance.

          • Type — (String)

            The type of ChannelMembership.

            Possible values include:
            • "DEFAULT"
            • "HIDDEN"
          • ReadMarkerTimestamp — (Date)

            The time at which a message was last read.

Returns:

  • (AWS.Request)

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

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

Returns the full details of a channel moderated by the specified AppInstanceUser.

Note: The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

Examples:

Calling the describeChannelModeratedByAppInstanceUser operation

var params = {
  AppInstanceUserArn: 'STRING_VALUE', /* required */
  ChannelArn: 'STRING_VALUE', /* required */
  ChimeBearer: 'STRING_VALUE'
};
chime.describeChannelModeratedByAppInstanceUser(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: {})
    • ChannelArn — (String)

      The ARN of the moderated channel.

    • AppInstanceUserArn — (String)

      The ARN of the AppInstanceUser in the moderated channel.

    • ChimeBearer — (String)

      The AppInstanceUserArn of the user that makes the API 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:

      • Channel — (map)

        The moderated channel.

        • ChannelSummary — (map)

          Summary of the details of a Channel.

          • Name — (String)

            The name of the channel.

          • ChannelArn — (String)

            The ARN of the channel.

          • Mode — (String)

            The mode of the channel.

            Possible values include:
            • "UNRESTRICTED"
            • "RESTRICTED"
          • Privacy — (String)

            The privacy setting of the channel.

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

            The metadata of the channel.

          • LastMessageTimestamp — (Date)

            The time at which the last message in a channel was sent.

Returns:

  • (AWS.Request)

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

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

Returns the full details of a single ChannelModerator.

Note: The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

Service Reference:

Examples:

Calling the describeChannelModerator operation

var params = {
  ChannelArn: 'STRING_VALUE', /* required */
  ChannelModeratorArn: 'STRING_VALUE', /* required */
  ChimeBearer: 'STRING_VALUE'
};
chime.describeChannelModerator(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: {})
    • ChannelArn — (String)

      The ARN of the channel.

    • ChannelModeratorArn — (String)

      The ARN of the channel moderator.

    • ChimeBearer — (String)

      The AppInstanceUserArn of the user that makes the API 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:

      • ChannelModerator — (map)

        The details of the channel moderator.

        • Moderator — (map)

          The moderator's data.

          • Arn — (String)

            The ARN in an Identity.

          • Name — (String)

            The name in an Identity.

        • ChannelArn — (String)

          The ARN of the moderator's channel.

        • CreatedTimestamp — (Date)

          The time at which the moderator was created.

        • CreatedBy — (map)

          The AppInstanceUser who created the moderator.

          • Arn — (String)

            The ARN in an Identity.

          • Name — (String)

            The name in an Identity.

Returns:

  • (AWS.Request)

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

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

Disassociates the primary provisioned phone number from the specified Amazon Chime user.

Service Reference:

Examples:

Calling the disassociatePhoneNumberFromUser operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  UserId: 'STRING_VALUE' /* required */
};
chime.disassociatePhoneNumberFromUser(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: {})
    • AccountId — (String)

      The Amazon Chime account ID.

    • UserId — (String)

      The user ID.

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.

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

Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector.

Examples:

Calling the disassociatePhoneNumbersFromVoiceConnector operation

var params = {
  E164PhoneNumbers: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  VoiceConnectorId: 'STRING_VALUE' /* required */
};
chime.disassociatePhoneNumbersFromVoiceConnector(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: {})
    • VoiceConnectorId — (String)

      The Amazon Chime Voice Connector ID.

    • E164PhoneNumbers — (Array<String>)

      List of phone numbers, in E.164 format.

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:

      • PhoneNumberErrors — (Array<map>)

        If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.

        • PhoneNumberId — (String)

          The phone number ID for which the action failed.

        • ErrorCode — (String)

          The error code.

          Possible values include:
          • "BadRequest"
          • "Conflict"
          • "Forbidden"
          • "NotFound"
          • "PreconditionFailed"
          • "ResourceLimitExceeded"
          • "ServiceFailure"
          • "AccessDenied"
          • "ServiceUnavailable"
          • "Throttled"
          • "Throttling"
          • "Unauthorized"
          • "Unprocessable"
          • "VoiceConnectorGroupAssociationsExist"
          • "PhoneNumberAssociationsExist"
        • ErrorMessage — (String)

          The error message.

Returns:

  • (AWS.Request)

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

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

Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector group.

Examples:

Calling the disassociatePhoneNumbersFromVoiceConnectorGroup operation

var params = {
  E164PhoneNumbers: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  VoiceConnectorGroupId: 'STRING_VALUE' /* required */
};
chime.disassociatePhoneNumbersFromVoiceConnectorGroup(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: {})
    • VoiceConnectorGroupId — (String)

      The Amazon Chime Voice Connector group ID.

    • E164PhoneNumbers — (Array<String>)

      List of phone numbers, in E.164 format.

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:

      • PhoneNumberErrors — (Array<map>)

        If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.

        • PhoneNumberId — (String)

          The phone number ID for which the action failed.

        • ErrorCode — (String)

          The error code.

          Possible values include:
          • "BadRequest"
          • "Conflict"
          • "Forbidden"
          • "NotFound"
          • "PreconditionFailed"
          • "ResourceLimitExceeded"
          • "ServiceFailure"
          • "AccessDenied"
          • "ServiceUnavailable"
          • "Throttled"
          • "Throttling"
          • "Unauthorized"
          • "Unprocessable"
          • "VoiceConnectorGroupAssociationsExist"
          • "PhoneNumberAssociationsExist"
        • ErrorMessage — (String)

          The error message.

Returns:

  • (AWS.Request)

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

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

Disassociates the specified sign-in delegate groups from the specified Amazon Chime account.

Examples:

Calling the disassociateSigninDelegateGroupsFromAccount operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  GroupNames: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
chime.disassociateSigninDelegateGroupsFromAccount(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: {})
    • AccountId — (String)

      The Amazon Chime account ID.

    • GroupNames — (Array<String>)

      The sign-in delegate group names.

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.

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

Retrieves details for the specified Amazon Chime account, such as account type and supported licenses.

Service Reference:

Examples:

Calling the getAccount operation

var params = {
  AccountId: 'STRING_VALUE' /* required */
};
chime.getAccount(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: {})
    • AccountId — (String)

      The Amazon Chime account ID.

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:

      • Account — (map)

        The Amazon Chime account details.

        • AwsAccountIdrequired — (String)

          The AWS account ID.

        • AccountIdrequired — (String)

          The Amazon Chime account ID.

        • Namerequired — (String)

          The Amazon Chime account name.

        • AccountType — (String)

          The Amazon Chime account type. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.

          Possible values include:
          • "Team"
          • "EnterpriseDirectory"
          • "EnterpriseLWA"
          • "EnterpriseOIDC"
        • CreatedTimestamp — (Date)

          The Amazon Chime account creation timestamp, in ISO 8601 format.

        • DefaultLicense — (String)

          The default license for the Amazon Chime account.

          Possible values include:
          • "Basic"
          • "Plus"
          • "Pro"
          • "ProTrial"
        • SupportedLicenses — (Array<String>)

          Supported licenses for the Amazon Chime account.

        • SigninDelegateGroups — (Array<map>)

          The sign-in delegate groups associated with the account.

          • GroupName — (String)

            The group name.

Returns:

  • (AWS.Request)

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

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

Retrieves account settings for the specified Amazon Chime account ID, such as remote control and dialout settings. For more information about these settings, see Use the Policies Page in the Amazon Chime Administration Guide.

Service Reference:

Examples:

Calling the getAccountSettings operation

var params = {
  AccountId: 'STRING_VALUE' /* required */
};
chime.getAccountSettings(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: {})
    • AccountId — (String)

      The Amazon Chime account ID.

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:

      • AccountSettings — (map)

        The Amazon Chime account settings.

        • DisableRemoteControl — (Boolean)

          Setting that stops or starts remote control of shared screens during meetings.

        • EnableDialOut — (Boolean)

          Setting that allows meeting participants to choose the Call me at a phone number option. For more information, see Join a Meeting without the Amazon Chime App.

Returns:

  • (AWS.Request)

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

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

Gets the retention settings for an AppInstance.

Service Reference:

Examples:

Calling the getAppInstanceRetentionSettings operation

var params = {
  AppInstanceArn: 'STRING_VALUE' /* required */
};
chime.getAppInstanceRetentionSettings(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: {})
    • AppInstanceArn — (String)

      The ARN of the AppInstance.

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:

      • AppInstanceRetentionSettings — (map)

        The retention settings for the AppInstance.

        • ChannelRetentionSettings — (map)

          The length of time in days to retain the messages in a channel.

          • RetentionDays — (Integer)

            The time in days to retain the messages in a channel.

      • InitiateDeletionTimestamp — (Date)

        The timestamp representing the time at which the specified items are retained, in Epoch Seconds.

Returns:

  • (AWS.Request)

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

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

Gets the streaming settings for an AppInstance.

Examples:

Calling the getAppInstanceStreamingConfigurations operation

var params = {
  AppInstanceArn: 'STRING_VALUE' /* required */
};
chime.getAppInstanceStreamingConfigurations(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: {})
    • AppInstanceArn — (String)

      The ARN of the AppInstance.

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:

      • AppInstanceStreamingConfigurations — (Array<map>)

        The streaming settings.

        • AppInstanceDataTyperequired — (String)

          The type of data to be streamed.

          Possible values include:
          • "Channel"
          • "ChannelMessage"
        • ResourceArnrequired — (String)

          The resource ARN.

Returns:

  • (AWS.Request)

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

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

Gets the Amazon Chime SDK attendee details for a specified meeting ID and attendee ID. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide .

Service Reference:

Examples:

Calling the getAttendee operation

var params = {
  AttendeeId: 'STRING_VALUE', /* required */
  MeetingId: 'STRING_VALUE' /* required */
};
chime.getAttendee(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: {})
    • MeetingId — (String)

      The Amazon Chime SDK meeting ID.

    • AttendeeId — (String)

      The Amazon Chime SDK attendee ID.

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:

      • Attendee — (map)

        The Amazon Chime SDK attendee information.

        • ExternalUserId — (String)

          The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.

        • AttendeeId — (String)

          The Amazon Chime SDK attendee ID.

        • JoinToken — (String)

          The join token used by the Amazon Chime SDK attendee.

Returns:

  • (AWS.Request)

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

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

Retrieves details for the specified bot, such as bot email address, bot type, status, and display name.

Service Reference:

Examples:

Calling the getBot operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  BotId: 'STRING_VALUE' /* required */
};
chime.getBot(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: {})
    • AccountId — (String)

      The Amazon Chime account ID.

    • BotId — (String)

      The bot ID.

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:

      • Bot — (map)

        The chat bot details.

        • BotId — (String)

          The bot ID.

        • UserId — (String)

          The unique ID for the bot user.

        • DisplayName — (String)

          The bot display name.

        • BotType — (String)

          The bot type.

          Possible values include:
          • "ChatBot"
        • Disabled — (Boolean)

          When true, the bot is stopped from running in your account.

        • CreatedTimestamp — (Date)

          The bot creation timestamp, in ISO 8601 format.

        • UpdatedTimestamp — (Date)

          The updated bot timestamp, in ISO 8601 format.

        • BotEmail — (String)

          The bot email address.

        • SecurityToken — (String)

          The security token used to authenticate Amazon Chime with the outgoing event endpoint.

Returns:

  • (AWS.Request)

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

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

Gets the full details of a channel message.

Note: The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

Service Reference:

Examples:

Calling the getChannelMessage operation

var params = {
  ChannelArn: 'STRING_VALUE', /* required */
  MessageId: 'STRING_VALUE', /* required */
  ChimeBearer: 'STRING_VALUE'
};
chime.getChannelMessage(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: {})
    • ChannelArn — (String)

      The ARN of the channel.

    • MessageId — (String)

      The ID of the message.

    • ChimeBearer — (String)

      The AppInstanceUserArn of the user that makes the API 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:

      • ChannelMessage — (map)

        The details of and content in the message.

        • ChannelArn — (String)

          The ARN of the channel.

        • MessageId — (String)

          The ID of a message.

        • Content — (String)

          The message content.

        • Metadata — (String)

          The message metadata.

        • Type — (String)

          The message type.

          Possible values include:
          • "STANDARD"
          • "CONTROL"
        • CreatedTimestamp — (Date)

          The time at which the message was created.

        • LastEditedTimestamp — (Date)

          The time at which a message was edited.

        • LastUpdatedTimestamp — (Date)

          The time at which a message was updated.

        • Sender — (map)

          The message sender.

          • Arn — (String)

            The ARN in an Identity.

          • Name — (String)

            The name in an Identity.

        • Redacted — (Boolean)

          Hides the content of a message.

        • Persistence — (String)

          The persistence setting for a channel message.

          Possible values include:
          • "PERSISTENT"
          • "NON_PERSISTENT"

Returns:

  • (AWS.Request)

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

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

Gets details for an events configuration that allows a bot to receive outgoing events, such as an HTTPS endpoint or Lambda function ARN.

Service Reference:

Examples:

Calling the getEventsConfiguration operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  BotId: 'STRING_VALUE' /* required */
};
chime.getEventsConfiguration(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: {})
    • AccountId — (String)

      The Amazon Chime account ID.

    • BotId — (String)

      The bot ID.

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:

      • EventsConfiguration — (map)

        The events configuration details.

        • BotId — (String)

          The bot ID.

        • OutboundEventsHTTPSEndpoint — (String)

          HTTPS endpoint that allows a bot to receive outgoing events.

        • LambdaFunctionArn — (String)

          Lambda function ARN that allows a bot to receive outgoing events.

Returns:

  • (AWS.Request)

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

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

Retrieves global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.

Service Reference:

Examples:

Calling the getGlobalSettings operation

chime.getGlobalSettings(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:

      • BusinessCalling — (map)

        The Amazon Chime Business Calling settings.

        • CdrBucket — (String)

          The Amazon S3 bucket designated for call detail record storage.

      • VoiceConnector — (map)

        The Amazon Chime Voice Connector settings.

        • CdrBucket — (String)

          The Amazon S3 bucket designated for call detail record storage.

Returns:

  • (AWS.Request)

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

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

Gets the Amazon Chime SDK meeting details for the specified meeting ID. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide .

Service Reference:

Examples:

Calling the getMeeting operation

var params = {
  MeetingId: 'STRING_VALUE' /* required */
};
chime.getMeeting(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: {})
    • MeetingId — (String)

      The Amazon Chime SDK meeting ID.

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:

      • Meeting — (map)

        The Amazon Chime SDK meeting information.

        • MeetingId — (String)

          The Amazon Chime SDK meeting ID.

        • ExternalMeetingId — (String)

          The external meeting ID.

        • MediaPlacement — (map)

          The media placement for the meeting.

          • AudioHostUrl — (String)

            The audio host URL.

          • AudioFallbackUrl — (String)

            The audio fallback URL.

          • ScreenDataUrl — (String)

            The screen data URL.

          • ScreenSharingUrl — (String)

            The screen sharing URL.

          • ScreenViewingUrl — (String)

            The screen viewing URL.

          • SignalingUrl — (String)

            The signaling URL.

          • TurnControlUrl — (String)

            The turn control URL.

        • MediaRegion — (String)

          The Region in which you create the meeting. Available values: af-south-1 , ap-northeast-1 , ap-northeast-2 , ap-south-1 , ap-southeast-1 , ap-southeast-2 , ca-central-1 , eu-central-1 , eu-north-1 , eu-south-1 , eu-west-1 , eu-west-2 , eu-west-3 , sa-east-1 , us-east-1 , us-east-2 , us-west-1 , us-west-2 .

Returns:

  • (AWS.Request)

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

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

The details of the endpoint for the messaging session.

Service Reference:

Examples:

Calling the getMessagingSessionEndpoint operation

var params = {
};
chime.getMessagingSessionEndpoint(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:

      • Endpoint — (map)

        The endpoint returned in the response.

        • Url — (String)

          The endpoint to which you establish a websocket connection.

Returns:

  • (AWS.Request)

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

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

Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.

Service Reference:

Examples:

Calling the getPhoneNumber operation

var params = {
  PhoneNumberId: 'STRING_VALUE' /* required */
};
chime.getPhoneNumber(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: {})
    • PhoneNumberId — (String)

      The phone number ID.

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:

      • PhoneNumber — (map)

        The phone number details.

        • PhoneNumberId — (String)

          The phone number ID.

        • E164PhoneNumber — (String)

          The phone number, in E.164 format.

        • Type — (String)

          The phone number type.

          Possible values include:
          • "Local"
          • "TollFree"
        • ProductType — (String)

          The phone number product type.

          Possible values include:
          • "BusinessCalling"
          • "VoiceConnector"
        • Status — (String)

          The phone number status.

          Possible values include:
          • "AcquireInProgress"
          • "AcquireFailed"
          • "Unassigned"
          • "Assigned"
          • "ReleaseInProgress"
          • "DeleteInProgress"
          • "ReleaseFailed"
          • "DeleteFailed"
        • Capabilities — (map)

          The phone number capabilities.

          • InboundCall — (Boolean)

            Allows or denies inbound calling for the specified phone number.

          • OutboundCall — (Boolean)

            Allows or denies outbound calling for the specified phone number.

          • InboundSMS — (Boolean)

            Allows or denies inbound SMS messaging for the specified phone number.

          • OutboundSMS — (Boolean)

            Allows or denies outbound SMS messaging for the specified phone number.

          • InboundMMS — (Boolean)

            Allows or denies inbound MMS messaging for the specified phone number.

          • OutboundMMS — (Boolean)

            Allows or denies outbound MMS messaging for the specified phone number.

        • Associations — (Array<map>)

          The phone number associations.

          • Value — (String)

            Contains the ID for the entity specified in Name.

          • Name — (String)

            Defines the association with an Amazon Chime account ID, user ID, Amazon Chime Voice Connector ID, or Amazon Chime Voice Connector group ID.

            Possible values include:
            • "AccountId"
            • "UserId"
            • "VoiceConnectorId"
            • "VoiceConnectorGroupId"
            • "SipRuleId"
          • AssociatedTimestamp — (Date)

            The timestamp of the phone number association, in ISO 8601 format.

        • CallingName — (String)

          The outbound calling name associated with the phone number.

        • CallingNameStatus — (String)

          The outbound calling name status.

          Possible values include:
          • "Unassigned"
          • "UpdateInProgress"
          • "UpdateSucceeded"
          • "UpdateFailed"
        • CreatedTimestamp — (Date)

          The phone number creation timestamp, in ISO 8601 format.

        • UpdatedTimestamp — (Date)

          The updated phone number timestamp, in ISO 8601 format.

        • DeletionTimestamp — (Date)

          The deleted phone number timestamp, in ISO 8601 format.

Returns:

  • (AWS.Request)

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

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

Retrieves details for the specified phone number order, such as the order creation timestamp, phone numbers in E.164 format, product type, and order status.

Service Reference:

Examples:

Calling the getPhoneNumberOrder operation

var params = {
  PhoneNumberOrderId: 'STRING_VALUE' /* required */
};
chime.getPhoneNumberOrder(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: {})
    • PhoneNumberOrderId — (String)

      The ID for the phone number order.

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:

      • PhoneNumberOrder — (map)

        The phone number order details.

        • PhoneNumberOrderId — (String)

          The phone number order ID.

        • ProductType — (String)

          The phone number order product type.

          Possible values include:
          • "BusinessCalling"
          • "VoiceConnector"
        • Status — (String)

          The status of the phone number order.

          Possible values include:
          • "Processing"
          • "Successful"
          • "Failed"
          • "Partial"
        • OrderedPhoneNumbers — (Array<map>)

          The ordered phone number details, such as the phone number in E.164 format and the phone number status.

          • E164PhoneNumber — (String)

            The phone number, in E.164 format.

          • Status — (String)

            The phone number status.

            Possible values include:
            • "Processing"
            • "Acquired"
            • "Failed"
        • CreatedTimestamp — (Date)

          The phone number order creation time stamp, in ISO 8601 format.

        • UpdatedTimestamp — (Date)

          The updated phone number order time stamp, in ISO 8601 format.

Returns:

  • (AWS.Request)

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

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

Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name.

Service Reference:

Examples:

Calling the getPhoneNumberSettings operation

chime.getPhoneNumberSettings(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:

      • CallingName — (String)

        The default outbound calling name for the account.

      • CallingNameUpdatedTimestamp — (Date)

        The updated outbound calling name timestamp, in ISO 8601 format.

Returns:

  • (AWS.Request)

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

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

Gets the specified proxy session details for the specified Amazon Chime Voice Connector.

Service Reference:

Examples:

Calling the getProxySession operation

var params = {
  ProxySessionId: 'STRING_VALUE', /* required */
  VoiceConnectorId: 'STRING_VALUE' /* required */
};
chime.getProxySession(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: {})
    • VoiceConnectorId — (String)

      The Amazon Chime voice connector ID.

    • ProxySessionId — (String)

      The proxy session ID.

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:

      • ProxySession — (map)

        The proxy session details.

        • VoiceConnectorId — (String)

          The Amazon Chime voice connector ID.

        • ProxySessionId — (String)

          The proxy session ID.

        • Name — (String)

          The name of the proxy session.

        • Status — (String)

          The status of the proxy session.

          Possible values include:
          • "Open"
          • "InProgress"
          • "Closed"
        • ExpiryMinutes — (Integer)

          The number of minutes allowed for the proxy session.

        • Capabilities — (Array<String>)

          The proxy session capabilities.

        • CreatedTimestamp — (Date)

          The created time stamp, in ISO 8601 format.

        • UpdatedTimestamp — (Date)

          The updated time stamp, in ISO 8601 format.

        • EndedTimestamp — (Date)

          The ended time stamp, in ISO 8601 format.

        • Participants — (Array<map>)

          The proxy session participants.

          • PhoneNumber — (String)

            The participant's phone number.

          • ProxyPhoneNumber — (String)

            The participant's proxy phone number.

        • NumberSelectionBehavior — (String)

          The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.

          Possible values include:
          • "PreferSticky"
          • "AvoidSticky"
        • GeoMatchLevel — (String)

          The preference for matching the country or area code of the proxy phone number with that of the first participant.

          Possible values include:
          • "Country"
          • "AreaCode"
        • GeoMatchParams — (map)

          The country and area code for the proxy phone number.

          • Countryrequired — (String)

            The country.

          • AreaCoderequired — (String)

            The area code.

Returns:

  • (AWS.Request)

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

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

Gets the retention settings for the specified Amazon Chime Enterprise account. For more information about retention settings, see Managing Chat Retention Policies in the Amazon Chime Administration Guide .

Service Reference:

Examples:

Calling the getRetentionSettings operation

var params = {
  AccountId: 'STRING_VALUE' /* required */
};
chime.getRetentionSettings(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: {})
    • AccountId — (String)

      The Amazon Chime account ID.

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:

      • RetentionSettings — (map)

        The retention settings.

        • RoomRetentionSettings — (map)

          The chat room retention settings.

          • RetentionDays — (Integer)

            The number of days for which to retain chat-room messages.

        • ConversationRetentionSettings — (map)

          The chat conversation retention settings.

          • RetentionDays — (Integer)

            The number of days for which to retain conversation messages.

      • InitiateDeletionTimestamp — (Date)

        The timestamp representing the time at which the specified items are permanently deleted, in ISO 8601 format.

Returns:

  • (AWS.Request)

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

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

Retrieves room details, such as the room name, for a room in an Amazon Chime Enterprise account.

Service Reference:

Examples:

Calling the getRoom operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  RoomId: 'STRING_VALUE' /* required */
};
chime.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: {})
    • AccountId — (String)

      The Amazon Chime account ID.

    • RoomId — (String)

      The room ID.

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 room details.

        • RoomId — (String)

          The room ID.

        • Name — (String)

          The room name.

        • AccountId — (String)

          The Amazon Chime account ID.

        • CreatedBy — (String)

          The identifier of the room creator.

        • CreatedTimestamp — (Date)

          The room creation timestamp, in ISO 8601 format.

        • UpdatedTimestamp — (Date)

          The room update timestamp, in ISO 8601 format.

Returns:

  • (AWS.Request)

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

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

Retrieves the information for a SIP media application, including name, AWS Region, and endpoints.

Service Reference:

Examples:

Calling the getSipMediaApplication operation

var params = {
  SipMediaApplicationId: 'STRING_VALUE' /* required */
};
chime.getSipMediaApplication(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: {})
    • SipMediaApplicationId — (String)

      The SIP media application ID.

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:

      • SipMediaApplication — (map)

        The SIP media application details.

        • SipMediaApplicationId — (String)

          The SIP media application ID.

        • AwsRegion — (String)

          The AWS Region in which the SIP media application is created.

        • Name — (String)

          The name of the SIP media application.

        • Endpoints — (Array<map>)

          List of endpoints for SIP media application. Currently, only one endpoint per SIP media application is permitted.

          • LambdaArn — (String)

            Valid Amazon Resource Name (ARN) of the Lambda function. The function must be created in the same AWS Region as the SIP media application.

        • CreatedTimestamp — (Date)

          The SIP media application creation timestamp, in ISO 8601 format.

        • UpdatedTimestamp — (Date)

          The SIP media application updated timestamp, in ISO 8601 format.

Returns:

  • (AWS.Request)

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

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

Returns the logging configuration for the specified SIP media application.

Examples:

Calling the getSipMediaApplicationLoggingConfiguration operation

var params = {
  SipMediaApplicationId: 'STRING_VALUE' /* required */
};
chime.getSipMediaApplicationLoggingConfiguration(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: {})
    • SipMediaApplicationId — (String)

      The SIP media application ID.

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:

      • SipMediaApplicationLoggingConfiguration — (map)

        The actual logging configuration.

        • EnableSipMediaApplicationMessageLogs — (Boolean)

          Enables application message logs for the SIP media application.

Returns:

  • (AWS.Request)

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

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

Retrieves the details of a SIP rule, such as the rule ID, name, triggers, and target endpoints.

Service Reference:

Examples:

Calling the getSipRule operation

var params = {
  SipRuleId: 'STRING_VALUE' /* required */
};
chime.getSipRule(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: {})
    • SipRuleId — (String)

      The SIP rule ID.

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:

      • SipRule — (map)

        The SIP rule details.

        • SipRuleId — (String)

          The SIP rule ID.

        • Name — (String)

          The name of the SIP rule.

        • Disabled — (Boolean)

          Indicates whether the SIP rule is enabled or disabled. You must disable a rule before you can delete it.

        • TriggerType — (String)

          The type of trigger assigned to the SIP rule in TriggerValue, currently RequestUriHostname or ToPhoneNumber.

          Possible values include:
          • "ToPhoneNumber"
          • "RequestUriHostname"
        • TriggerValue — (String)

          If TriggerType is RequestUriHostname, then the value can be the outbound host name of the Amazon Chime Voice Connector. If TriggerType is ToPhoneNumber, then the value can be a customer-owned phone number in E164 format. SipRule is triggered when a SIP rule requests host name or ToPhoneNumber matches in the incoming SIP request.

        • TargetApplications — (Array<map>)

          Target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.

          • SipMediaApplicationId — (String)

            The SIP media application ID.

          • Priority — (Integer)

            Priority of the SIP media application in the target list.

          • AwsRegion — (String)

            The AWS Region of the target application.

        • CreatedTimestamp — (Date)

          The time at which the SIP rule was created, in ISO 8601 format.

        • UpdatedTimestamp — (Date)

          The time at which the SIP rule was last updated, in ISO 8601 format.

Returns:

  • (AWS.Request)

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

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

Retrieves details for the specified user ID, such as primary email address, license type,and personal meeting PIN.

To retrieve user details with an email address instead of a user ID, use the ListUsers action, and then filter by email address.

Service Reference:

Examples:

Calling the getUser operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  UserId: 'STRING_VALUE' /* required */
};
chime.getUser(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: {})
    • AccountId — (String)

      The Amazon Chime account ID.

    • UserId — (String)

      The user ID.

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:

      • User — (map)

        The user details.

        • UserIdrequired — (String)

          The user ID.

        • AccountId — (String)

          The Amazon Chime account ID.

        • PrimaryEmail — (String)

          The primary email address of the user.

        • PrimaryProvisionedNumber — (String)

          The primary phone number associated with the user.

        • DisplayName — (String)

          The display name of the user.

        • LicenseType — (String)

          The license type for the user.

          Possible values include:
          • "Basic"
          • "Plus"
          • "Pro"
          • "ProTrial"
        • UserType — (String)

          The user type.

          Possible values include:
          • "PrivateUser"
          • "SharedDevice"
        • UserRegistrationStatus — (String)

          The user registration status.

          Possible values include:
          • "Unregistered"
          • "Registered"
          • "Suspended"
        • UserInvitationStatus — (String)

          The user invite status.

          Possible values include:
          • "Pending"
          • "Accepted"
          • "Failed"
        • RegisteredOn — (Date)

          Date and time when the user is registered, in ISO 8601 format.

        • InvitedOn — (Date)

          Date and time when the user is invited to the Amazon Chime account, in ISO 8601 format.

        • AlexaForBusinessMetadata — (map)

          The Alexa for Business metadata.

          • IsAlexaForBusinessEnabled — (Boolean)

            Starts or stops Alexa for Business.

          • AlexaForBusinessRoomArn — (String)

            The ARN of the room resource.

        • PersonalPIN — (String)

          The user's personal meeting PIN.

Returns:

  • (AWS.Request)

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

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

Retrieves settings for the specified user ID, such as any associated phone number settings.

Service Reference:

Examples:

Calling the getUserSettings operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  UserId: 'STRING_VALUE' /* required */
};
chime.getUserSettings(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: {})
    • AccountId — (String)

      The Amazon Chime account ID.

    • UserId — (String)

      The user ID.

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:

      • UserSettings — (map)

        The user settings.

        • Telephonyrequired — (map)

          The telephony settings associated with the user.

          • InboundCallingrequired — (Boolean)

            Allows or denies inbound calling.

          • OutboundCallingrequired — (Boolean)

            Allows or denies outbound calling.

          • SMSrequired — (Boolean)

            Allows or denies SMS messaging.

Returns:

  • (AWS.Request)

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

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

Retrieves details for the specified Amazon Chime Voice Connector, such as timestamps,name, outbound host, and encryption requirements.

Service Reference:

Examples:

Calling the getVoiceConnector operation

var params = {
  VoiceConnectorId: 'STRING_VALUE' /* required */
};
chime.getVoiceConnector(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: {})
    • VoiceConnectorId — (String)

      The Amazon Chime Voice Connector ID.

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:

      • VoiceConnector — (map)

        The Amazon Chime Voice Connector details.

        • VoiceConnectorId — (String)

          The Amazon Chime Voice Connector ID.

        • AwsRegion — (String)

          The AWS Region in which the Amazon Chime Voice Connector is created. Default: us-east-1.

          Possible values include:
          • "us-east-1"
          • "us-west-2"
        • Name — (String)

          The name of the Amazon Chime Voice Connector.

        • OutboundHostName — (String)

          The outbound host name for the Amazon Chime Voice Connector.

        • RequireEncryption — (Boolean)

          Designates whether encryption is required for the Amazon Chime Voice Connector.

        • CreatedTimestamp — (Date)

          The Amazon Chime Voice Connector creation timestamp, in ISO 8601 format.

        • UpdatedTimestamp — (Date)

          The updated Amazon Chime Voice Connector timestamp, in ISO 8601 format.

Returns:

  • (AWS.Request)

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

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

Gets the emergency calling configuration details for the specified Amazon Chime Voice Connector.

Examples:

Calling the getVoiceConnectorEmergencyCallingConfiguration operation

var params = {
  VoiceConnectorId: 'STRING_VALUE' /* required */
};
chime.getVoiceConnectorEmergencyCallingConfiguration(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: {})
    • VoiceConnectorId — (String)

      The Amazon Chime Voice Connector ID.

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:

      • EmergencyCallingConfiguration — (map)

        The emergency calling configuration details.

        • DNIS — (Array<map>)

          The Dialed Number Identification Service (DNIS) emergency calling configuration details.

          • EmergencyPhoneNumberrequired — (String)

            The DNIS phone number to route emergency calls to, in E.164 format.

          • TestPhoneNumber — (String)

            The DNIS phone number to route test emergency calls to, in E.164 format.

          • CallingCountryrequired — (String)

            The country from which emergency calls are allowed, in ISO 3166-1 alpha-2 format.

Returns:

  • (AWS.Request)

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

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

Retrieves details for the specified Amazon Chime Voice Connector group, such as timestamps,name, and associated VoiceConnectorItems .

Service Reference:

Examples:

Calling the getVoiceConnectorGroup operation

var params = {
  VoiceConnectorGroupId: 'STRING_VALUE' /* required */
};
chime.getVoiceConnectorGroup(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: {})
    • VoiceConnectorGroupId — (String)

      The Amazon Chime Voice Connector group ID.

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:

      • VoiceConnectorGroup — (map)

        The Amazon Chime Voice Connector group details.

        • VoiceConnectorGroupId — (String)

          The Amazon Chime Voice Connector group ID.

        • Name — (String)

          The name of the Amazon Chime Voice Connector group.

        • VoiceConnectorItems — (Array<map>)

          The Amazon Chime Voice Connectors to which to route inbound calls.

          • VoiceConnectorIdrequired — (String)

            The Amazon Chime Voice Connector ID.

          • Priorityrequired — (Integer)

            The priority associated with the Amazon Chime Voice Connector, with 1 being the highest priority. Higher priority Amazon Chime Voice Connectors are attempted first.

        • CreatedTimestamp — (Date)

          The Amazon Chime Voice Connector group creation time stamp, in ISO 8601 format.

        • UpdatedTimestamp — (Date)

          The updated Amazon Chime Voice Connector group time stamp, in ISO 8601 format.

Returns:

  • (AWS.Request)

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

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

Retrieves the logging configuration details for the specified Amazon Chime Voice Connector. Shows whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.

Examples:

Calling the getVoiceConnectorLoggingConfiguration operation

var params = {
  VoiceConnectorId: 'STRING_VALUE' /* required */
};
chime.getVoiceConnectorLoggingConfiguration(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: {})
    • VoiceConnectorId — (String)

      The Amazon Chime Voice Connector ID.

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:

      • LoggingConfiguration — (map)

        The logging configuration details.

        • EnableSIPLogs — (Boolean)

          When true, enables SIP message logs for sending to Amazon CloudWatch Logs.

Returns:

  • (AWS.Request)

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

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

Retrieves origination setting details for the specified Amazon Chime Voice Connector.

Service Reference:

Examples:

Calling the getVoiceConnectorOrigination operation

var params = {
  VoiceConnectorId: 'STRING_VALUE' /* required */
};
chime.getVoiceConnectorOrigination(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: {})
    • VoiceConnectorId — (String)

      The Amazon Chime Voice Connector ID.

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:

      • Origination — (map)

        The origination setting details.

        • Routes — (Array<map>)

          The call distribution properties defined for your SIP hosts. Valid range: Minimum value of 1. Maximum value of 20.

          • Host — (String)

            The FQDN or IP address to contact for origination traffic.

          • Port — (Integer)

            The designated origination route port. Defaults to 5060.

          • Protocol — (String)

            The protocol to use for the origination route. Encryption-enabled Amazon Chime Voice Connectors use TCP protocol by default.

            Possible values include:
            • "TCP"
            • "UDP"
          • Priority — (Integer)

            The priority associated with the host, with 1 being the highest priority. Higher priority hosts are attempted first.

          • Weight — (Integer)

            The weight associated with the host. If hosts are equal in priority, calls are redistributed among them based on their relative weight.

        • Disabled — (Boolean)

          When origination settings are disabled, inbound calls are not enabled for your Amazon Chime Voice Connector.

Returns:

  • (AWS.Request)

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

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

Gets the proxy configuration details for the specified Amazon Chime Voice Connector.

Service Reference:

Examples:

Calling the getVoiceConnectorProxy operation

var params = {
  VoiceConnectorId: 'STRING_VALUE' /* required */
};
chime.getVoiceConnectorProxy(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: {})
    • VoiceConnectorId — (String)

      The Amazon Chime voice connector ID.

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:

      • Proxy — (map)

        The proxy configuration details.

        • DefaultSessionExpiryMinutes — (Integer)

          The default number of minutes allowed for proxy sessions.

        • Disabled — (Boolean)

          When true, stops proxy sessions from being created on the specified Amazon Chime Voice Connector.

        • FallBackPhoneNumber — (String)

          The phone number to route calls to after a proxy session expires.

        • PhoneNumberCountries — (Array<String>)

          The countries for proxy phone numbers to be selected from.

Returns:

  • (AWS.Request)

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

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

Retrieves the streaming configuration details for the specified Amazon Chime Voice Connector. Shows whether media streaming is enabled for sending to Amazon Kinesis. It also shows the retention period, in hours, for the Amazon Kinesis data.

Examples:

Calling the getVoiceConnectorStreamingConfiguration operation

var params = {
  VoiceConnectorId: 'STRING_VALUE' /* required */
};
chime.getVoiceConnectorStreamingConfiguration(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: {})
    • VoiceConnectorId — (String)

      The Amazon Chime Voice Connector ID.

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:

      • StreamingConfiguration — (map)

        The streaming configuration details.

        • DataRetentionInHoursrequired — (Integer)

          The retention period, in hours, for the Amazon Kinesis data.

        • Disabled — (Boolean)

          When true, media streaming to Amazon Kinesis is turned off.

        • StreamingNotificationTargets — (Array<map>)

          The streaming notification targets.

          • NotificationTargetrequired — (String)

            The streaming notification target.

            Possible values include:
            • "EventBridge"
            • "SNS"
            • "SQS"

Returns:

  • (AWS.Request)

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

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

Retrieves termination setting details for the specified Amazon Chime Voice Connector.

Service Reference:

Examples:

Calling the getVoiceConnectorTermination operation

var params = {
  VoiceConnectorId: 'STRING_VALUE' /* required */
};
chime.getVoiceConnectorTermination(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: {})
    • VoiceConnectorId — (String)

      The Amazon Chime Voice Connector ID.

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:

      • Termination — (map)

        The termination setting details.

        • CpsLimit — (Integer)

          The limit on calls per second. Max value based on account service quota. Default value of 1.

        • DefaultPhoneNumber — (String)

          The default caller ID phone number.

        • CallingRegions — (Array<String>)

          The countries to which calls are allowed, in ISO 3166-1 alpha-2 format. Required.

        • CidrAllowedList — (Array<String>)

          The IP addresses allowed to make calls, in CIDR format. Required.

        • Disabled — (Boolean)

          When termination settings are disabled, outbound calls can not be made.

Returns:

  • (AWS.Request)

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

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

Retrieves information about the last time a SIP OPTIONS ping was received from your SIP infrastructure for the specified Amazon Chime Voice Connector.

Examples:

Calling the getVoiceConnectorTerminationHealth operation

var params = {
  VoiceConnectorId: 'STRING_VALUE' /* required */
};
chime.getVoiceConnectorTerminationHealth(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: {})
    • VoiceConnectorId — (String)

      The Amazon Chime Voice Connector ID.

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:

      • TerminationHealth — (map)

        The termination health details.

        • Timestamp — (Date)

          The timestamp, in ISO 8601 format.

        • Source — (String)

          The source IP address.

Returns:

  • (AWS.Request)

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

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

Sends email to a maximum of 50 users, inviting them to the specified Amazon Chime Team account. Only Team account types are currently supported for this action.

Service Reference:

Examples:

Calling the inviteUsers operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  UserEmailList: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  UserType: PrivateUser | SharedDevice
};
chime.inviteUsers(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: {})
    • AccountId — (String)

      The Amazon Chime account ID.

    • UserEmailList — (Array<String>)

      The user email addresses to which to send the email invitation.

    • UserType — (String)

      The user type.

      Possible values include:
      • "PrivateUser"
      • "SharedDevice"

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:

      • Invites — (Array<map>)

        The email invitation details.

        • InviteId — (String)

          The invite ID.

        • Status — (String)

          The status of the invite.

          Possible values include:
          • "Pending"
          • "Accepted"
          • "Failed"
        • EmailAddress — (String)

          The email address to which the invite is sent.

        • EmailStatus — (String)

          The status of the invite email.

          Possible values include:
          • "NotSent"
          • "Sent"
          • "Failed"

Returns:

  • (AWS.Request)

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

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

Lists the Amazon Chime accounts under the administrator's AWS account. You can filter accounts by account name prefix. To find out which Amazon Chime account a user belongs to, toucan filter by the user's email address, which returns one account result.

Service Reference:

Examples:

Calling the listAccounts operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  Name: 'STRING_VALUE',
  NextToken: 'STRING_VALUE',
  UserEmail: 'STRING_VALUE'
};
chime.listAccounts(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)

      Amazon Chime account name prefix with which to filter results.

    • UserEmail — (String)

      User email address with which to filter results.

    • NextToken — (String)

      The token to use to retrieve the next page of results.

    • MaxResults — (Integer)

      The maximum number of results to return in a single call. Defaults to 100.

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:

      • Accounts — (Array<map>)

        List of Amazon Chime accounts and account details.

        • AwsAccountIdrequired — (String)

          The AWS account ID.

        • AccountIdrequired — (String)

          The Amazon Chime account ID.

        • Namerequired — (String)

          The Amazon Chime account name.

        • AccountType — (String)

          The Amazon Chime account type. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.

          Possible values include:
          • "Team"
          • "EnterpriseDirectory"
          • "EnterpriseLWA"
          • "EnterpriseOIDC"
        • CreatedTimestamp — (Date)

          The Amazon Chime account creation timestamp, in ISO 8601 format.

        • DefaultLicense — (String)

          The default license for the Amazon Chime account.

          Possible values include:
          • "Basic"
          • "Plus"
          • "Pro"
          • "ProTrial"
        • SupportedLicenses — (Array<String>)

          Supported licenses for the Amazon Chime account.

        • SigninDelegateGroups — (Array<map>)

          The sign-in delegate groups associated with the account.

          • GroupName — (String)

            The group name.

      • NextToken — (String)

        The token to use to retrieve the next page of results.

Returns:

  • (AWS.Request)

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

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

Returns a list of the administrators in the AppInstance.

Service Reference:

Examples:

Calling the listAppInstanceAdmins operation

var params = {
  AppInstanceArn: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
chime.listAppInstanceAdmins(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: {})
    • AppInstanceArn — (String)

      The ARN of the AppInstance.

    • MaxResults — (Integer)

      The maximum number of administrators that you want to return.

    • NextToken — (String)

      The token returned from previous API requests until the number of administrators is reached.

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:

      • AppInstanceArn — (String)

        The ARN of the AppInstance.

      • AppInstanceAdmins — (Array<map>)

        The information for each administrator.

        • Admin — (map)

          The details of the AppInstanceAdmin.

          • Arn — (String)

            The ARN in an Identity.

          • Name — (String)

            The name in an Identity.

      • NextToken — (String)

        The token returned from previous API requests until the number of administrators is reached.

Returns:

  • (AWS.Request)

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

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

Lists all Amazon Chime AppInstances created under a single AWS account.

Service Reference:

Examples:

Calling the listAppInstances operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
chime.listAppInstances(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: {})
    • MaxResults — (Integer)

      The maximum number of AppInstances that you want to return.

    • NextToken — (String)

      The token passed by previous API requests until you reach the maximum number of AppInstances.

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:

      • AppInstances — (Array<map>)

        The information for each AppInstance.

        • AppInstanceArn — (String)

          The AppInstance ARN.

        • Name — (String)

          The name of the AppInstance.

        • Metadata — (String)

          The metadata of the AppInstance.

      • NextToken — (String)

        The token passed by previous API requests until the maximum number of AppInstances is reached.

Returns:

  • (AWS.Request)

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

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

List all AppInstanceUsers created under a single AppInstance.

Service Reference:

Examples:

Calling the listAppInstanceUsers operation

var params = {
  AppInstanceArn: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
chime.listAppInstanceUsers(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: {})
    • AppInstanceArn — (String)

      The ARN of the AppInstance.

    • MaxResults — (Integer)

      The maximum number of requests that you want returned.

    • NextToken — (String)

      The token passed by previous API calls until all requested users are returned.

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:

      • AppInstanceArn — (String)

        The ARN of the AppInstance.

      • AppInstanceUsers — (Array<map>)

        The information for each requested AppInstanceUser.

        • AppInstanceUserArn — (String)

          The ARN of the AppInstanceUser.

        • Name — (String)

          The name of an AppInstanceUser.

        • Metadata — (String)

          The metadata of the AppInstanceUser.

      • NextToken — (String)

        The token passed by previous API calls until all requested users are returned.

Returns:

  • (AWS.Request)

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

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

Lists the attendees for the specified Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide .

Service Reference:

Examples:

Calling the listAttendees operation

var params = {
  MeetingId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
chime.listAttendees(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: {})
    • MeetingId — (String)

      The Amazon Chime SDK meeting ID.

    • NextToken — (String)

      The token to use to retrieve the next page of results.

    • MaxResults — (Integer)

      The maximum number of results to return in a single 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:

      • Attendees — (Array<map>)

        The Amazon Chime SDK attendee information.

        • ExternalUserId — (String)

          The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.

        • AttendeeId — (String)

          The Amazon Chime SDK attendee ID.

        • JoinToken — (String)

          The join token used by the Amazon Chime SDK attendee.

      • NextToken — (String)

        The token to use to retrieve the next page of results.

Returns:

  • (AWS.Request)

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

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

Lists the tags applied to an Amazon Chime SDK attendee resource.

Service Reference:

Examples:

Calling the listAttendeeTags operation

var params = {
  AttendeeId: 'STRING_VALUE', /* required */
  MeetingId: 'STRING_VALUE' /* required */
};
chime.listAttendeeTags(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: {})
    • MeetingId — (String)

      The Amazon Chime SDK meeting ID.

    • AttendeeId — (String)

      The Amazon Chime SDK attendee ID.

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>)

        A list of tag key-value pairs.

        • Keyrequired — (String)

          The key of the tag.

        • Valuerequired — (String)

          The value of the tag.

Returns:

  • (AWS.Request)

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

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

Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.

Service Reference:

Examples:

Calling the listBots operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
chime.listBots(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: {})
    • AccountId — (String)

      The Amazon Chime account ID.

    • MaxResults — (Integer)

      The maximum number of results to return in a single call. The default is 10.

    • NextToken — (String)

      The token to use to retrieve the next page of results.

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:

      • Bots — (Array<map>)

        List of bots and bot details.

        • BotId — (String)

          The bot ID.

        • UserId — (String)

          The unique ID for the bot user.

        • DisplayName — (String)

          The bot display name.

        • BotType — (String)

          The bot type.

          Possible values include:
          • "ChatBot"
        • Disabled — (Boolean)

          When true, the bot is stopped from running in your account.

        • CreatedTimestamp — (Date)

          The bot creation timestamp, in ISO 8601 format.

        • UpdatedTimestamp — (Date)

          The updated bot timestamp, in ISO 8601 format.

        • BotEmail — (String)

          The bot email address.

        • SecurityToken — (String)

          The security token used to authenticate Amazon Chime with the outgoing event endpoint.

      • NextToken — (String)

        The token to use to retrieve the next page of results.

Returns:

  • (AWS.Request)

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

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

Lists all the users banned from a particular channel.

Note: The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

Service Reference:

Examples:

Calling the listChannelBans operation

var params = {
  ChannelArn: 'STRING_VALUE', /* required */
  ChimeBearer: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
chime.listChannelBans(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: {})
    • ChannelArn — (String)

      The ARN of the channel.

    • MaxResults — (Integer)

      The maximum number of bans that you want returned.

    • NextToken — (String)

      The token passed by previous API calls until all requested bans are returned.

    • ChimeBearer — (String)

      The AppInstanceUserArn of the user that makes the API 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:

      • ChannelArn — (String)

        The ARN of the channel.

      • NextToken — (String)

        The token passed by previous API calls until all requested bans are returned.

      • ChannelBans — (Array<map>)

        The information for each requested ban.

        • Member — (map)

          The member being banned from a channel.

          • Arn — (String)

            The ARN in an Identity.

          • Name — (String)

            The name in an Identity.

Returns:

  • (AWS.Request)

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

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

Lists all channel memberships in a channel.

Note: The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

Service Reference:

Examples:

Calling the listChannelMemberships operation

var params = {
  ChannelArn: 'STRING_VALUE', /* required */
  ChimeBearer: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  Type: DEFAULT | HIDDEN
};
chime.listChannelMemberships(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: {})
    • ChannelArn — (String)

      The maximum number of channel memberships that you want returned.

    • Type — (String)

      The membership type of a user, DEFAULT or HIDDEN. Default members are always returned as part of ListChannelMemberships. Hidden members are only returned if the type filter in ListChannelMemberships equals HIDDEN. Otherwise hidden members are not returned.

      Possible values include:
      • "DEFAULT"
      • "HIDDEN"
    • MaxResults — (Integer)

      The maximum number of channel memberships that you want returned.

    • NextToken — (String)

      The token passed by previous API calls until all requested channel memberships are returned.

    • ChimeBearer — (String)

      The AppInstanceUserArn of the user that makes the API 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:

      • ChannelArn — (String)

        The ARN of the channel.

      • ChannelMemberships — (Array<map>)

        The information for the requested channel memberships.

        • Member — (map)

          A member's summary data.

          • Arn — (String)

            The ARN in an Identity.

          • Name — (String)

            The name in an Identity.

      • NextToken — (String)

        The token passed by previous API calls until all requested channel memberships are returned.

Returns:

  • (AWS.Request)

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

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

Lists all channels that a particular AppInstanceUser is a part of. Only an AppInstanceAdmin can call the API with a user ARN that is not their own.

Note: The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

Examples:

Calling the listChannelMembershipsForAppInstanceUser operation

var params = {
  AppInstanceUserArn: 'STRING_VALUE',
  ChimeBearer: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
chime.listChannelMembershipsForAppInstanceUser(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: {})
    • AppInstanceUserArn — (String)

      The ARN of the AppInstanceUsers

    • MaxResults — (Integer)

      The maximum number of users that you want returned.

    • NextToken — (String)

      The token returned from previous API requests until the number of channel memberships is reached.

    • ChimeBearer — (String)

      The AppInstanceUserArn of the user that makes the API 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:

      • ChannelMemberships — (Array<map>)

        The token passed by previous API calls until all requested users are returned.

        • ChannelSummary — (map)

          Summary of the details of a Channel.

          • Name — (String)

            The name of the channel.

          • ChannelArn — (String)

            The ARN of the channel.

          • Mode — (String)

            The mode of the channel.

            Possible values include:
            • "UNRESTRICTED"
            • "RESTRICTED"
          • Privacy — (String)

            The privacy setting of the channel.

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

            The metadata of the channel.

          • LastMessageTimestamp — (Date)

            The time at which the last message in a channel was sent.

        • AppInstanceUserMembershipSummary — (map)

          Returns the channel membership data for an AppInstance.

          • Type — (String)

            The type of ChannelMembership.

            Possible values include:
            • "DEFAULT"
            • "HIDDEN"
          • ReadMarkerTimestamp — (Date)

            The time at which a message was last read.

      • NextToken — (String)

        The token passed by previous API calls until all requested users are returned.

Returns:

  • (AWS.Request)

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

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

List all the messages in a channel. Returns a paginated list of ChannelMessages. By default, sorted by creation timestamp in descending order .

Note: Redacted messages appear in the results as empty, since they are only redacted, not deleted. Deleted messages do not appear in the results. This action always returns the latest version of an edited message. Also, the x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

Service Reference:

Examples:

Calling the listChannelMessages operation

var params = {
  ChannelArn: 'STRING_VALUE', /* required */
  ChimeBearer: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  NotAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  NotBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  SortOrder: ASCENDING | DESCENDING
};
chime.listChannelMessages(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: {})
    • ChannelArn — (String)

      The ARN of the channel.

    • SortOrder — (String)

      The order in which you want messages sorted. Default is Descending, based on time created.

      Possible values include:
      • "ASCENDING"
      • "DESCENDING"
    • NotBefore — (Date)

      The initial or starting time stamp for your requested messages.

    • NotAfter — (Date)

      The final or ending time stamp for your requested messages.

    • MaxResults — (Integer)

      The maximum number of messages that you want returned.

    • NextToken — (String)

      The token passed by previous API calls until all requested messages are returned.

    • ChimeBearer — (String)

      The AppInstanceUserArn of the user that makes the API 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:

      • ChannelArn — (String)

        The ARN of the channel containing the requested messages.

      • NextToken — (String)

        The token passed by previous API calls until all requested messages are returned.

      • ChannelMessages — (Array<map>)

        The information about, and content of, each requested message.

        • MessageId — (String)

          The ID of the message.

        • Content — (String)

          The content of the message.

        • Metadata — (String)

          The metadata of the message.

        • Type — (String)

          The type of message.

          Possible values include:
          • "STANDARD"
          • "CONTROL"
        • CreatedTimestamp — (Date)

          The time at which the message summary was created.

        • LastUpdatedTimestamp — (Date)

          The time at which a message was last updated.

        • LastEditedTimestamp — (Date)

          The time at which a message was last edited.

        • Sender — (map)

          The message sender.

          • Arn — (String)

            The ARN in an Identity.

          • Name — (String)

            The name in an Identity.

        • Redacted — (Boolean)

          Indicates whether a message was redacted.

Returns:

  • (AWS.Request)

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

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

Lists all the moderators for a channel.

Note: The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

Service Reference:

Examples:

Calling the listChannelModerators operation

var params = {
  ChannelArn: 'STRING_VALUE', /* required */
  ChimeBearer: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
chime.listChannelModerators(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: {})
    • ChannelArn — (String)

      The ARN of the channel.

    • MaxResults — (Integer)

      The maximum number of moderators that you want returned.

    • NextToken — (String)

      The token passed by previous API calls until all requested moderators are returned.

    • ChimeBearer — (String)

      The AppInstanceUserArn of the user that makes the API 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:

      • ChannelArn — (String)

        The ARN of the channel.

      • NextToken — (String)

        The token passed by previous API calls until all requested moderators are returned.

      • ChannelModerators — (Array<map>)

        The information about and names of each moderator.

        • Moderator — (map)

          The data for a moderator.

          • Arn — (String)

            The ARN in an Identity.

          • Name — (String)

            The name in an Identity.

Returns:

  • (AWS.Request)

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

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

Lists all Channels created under a single Chime App as a paginated list. You can specify filters to narrow results.

Functionality & restrictions

  • Use privacy = PUBLIC to retrieve all public channels in the account

  • Only an AppInstanceAdmin can set privacy = PRIVATE to list the private channels in an account.

Note: The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

Service Reference:

Examples:

Calling the listChannels operation

var params = {
  AppInstanceArn: 'STRING_VALUE', /* required */
  ChimeBearer: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  Privacy: PUBLIC | PRIVATE
};
chime.listChannels(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: {})
    • AppInstanceArn — (String)

      The ARN of the AppInstance.

    • Privacy — (String)

      The privacy setting. PUBLIC retrieves all the public channels. PRIVATE retrieves private channels. Only an AppInstanceAdmin can retrieve private channels.

      Possible values include:
      • "PUBLIC"
      • "PRIVATE"
    • MaxResults — (Integer)

      The maximum number of channels that you want to return.

    • NextToken — (String)

      The token passed by previous API calls until all requested channels are returned.

    • ChimeBearer — (String)

      The AppInstanceUserArn of the user that makes the API 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:

      • Channels — (Array<map>)

        The information about each channel.

        • Name — (String)

          The name of the channel.

        • ChannelArn — (String)

          The ARN of the channel.

        • Mode — (String)

          The mode of the channel.

          Possible values include:
          • "UNRESTRICTED"
          • "RESTRICTED"
        • Privacy — (String)

          The privacy setting of the channel.

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

          The metadata of the channel.

        • LastMessageTimestamp — (Date)

          The time at which the last message in a channel was sent.

      • NextToken — (String)

        The token returned from previous API requests until the number of channels is reached.

Returns:

  • (AWS.Request)

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

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

A list of the channels moderated by an AppInstanceUser.

Note: The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

Examples:

Calling the listChannelsModeratedByAppInstanceUser operation

var params = {
  AppInstanceUserArn: 'STRING_VALUE',
  ChimeBearer: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
chime.listChannelsModeratedByAppInstanceUser(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: {})
    • AppInstanceUserArn — (String)

      The ARN of the user in the moderated channel.

    • MaxResults — (Integer)

      The maximum number of channels in the request.

    • NextToken — (String)

      The token returned from previous API requests until the number of channels moderated by the user is reached.

    • ChimeBearer — (String)

      The AppInstanceUserArn of the user that makes the API 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:

      • Channels — (Array<map>)

        The moderated channels in the request.

        • ChannelSummary — (map)

          Summary of the details of a Channel.

          • Name — (String)

            The name of the channel.

          • ChannelArn — (String)

            The ARN of the channel.

          • Mode — (String)

            The mode of the channel.

            Possible values include:
            • "UNRESTRICTED"
            • "RESTRICTED"
          • Privacy — (String)

            The privacy setting of the channel.

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

            The metadata of the channel.

          • LastMessageTimestamp — (Date)

            The time at which the last message in a channel was sent.

      • NextToken — (String)

        The token returned from previous API requests until the number of channels moderated by the user is reached.

Returns:

  • (AWS.Request)

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

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

Lists up to 100 active Amazon Chime SDK meetings. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide .

Service Reference:

Examples:

Calling the listMeetings operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
chime.listMeetings(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 to use to retrieve the next page of results.

    • MaxResults — (Integer)

      The maximum number of results to return in a single 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:

      • Meetings — (Array<map>)

        The Amazon Chime SDK meeting information.

        • MeetingId — (String)

          The Amazon Chime SDK meeting ID.

        • ExternalMeetingId — (String)

          The external meeting ID.

        • MediaPlacement — (map)

          The media placement for the meeting.

          • AudioHostUrl — (String)

            The audio host URL.

          • AudioFallbackUrl — (String)

            The audio fallback URL.

          • ScreenDataUrl — (String)

            The screen data URL.

          • ScreenSharingUrl — (String)

            The screen sharing URL.

          • ScreenViewingUrl — (String)

            The screen viewing URL.

          • SignalingUrl — (String)

            The signaling URL.

          • TurnControlUrl — (String)

            The turn control URL.

        • MediaRegion — (String)

          The Region in which you create the meeting. Available values: af-south-1 , ap-northeast-1 , ap-northeast-2 , ap-south-1 , ap-southeast-1 , ap-southeast-2 , ca-central-1 , eu-central-1 , eu-north-1 , eu-south-1 , eu-west-1 , eu-west-2 , eu-west-3 , sa-east-1 , us-east-1 , us-east-2 , us-west-1 , us-west-2 .

      • NextToken — (String)

        The token to use to retrieve the next page of results.

Returns:

  • (AWS.Request)

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

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

Lists the tags applied to an Amazon Chime SDK meeting resource.

Service Reference:

Examples:

Calling the listMeetingTags operation

var params = {
  MeetingId: 'STRING_VALUE' /* required */
};
chime.listMeetingTags(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: {})
    • MeetingId — (String)

      The Amazon Chime SDK meeting ID.

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>)

        A list of tag key-value pairs.

        • Keyrequired — (String)

          The key of the tag.

        • Valuerequired — (String)

          The value of the tag.

Returns:

  • (AWS.Request)

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

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

Lists the phone number orders for the administrator's Amazon Chime account.

Service Reference:

Examples:

Calling the listPhoneNumberOrders operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
chime.listPhoneNumberOrders(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 to use to retrieve the next page of results.

    • MaxResults — (Integer)

      The maximum number of results to return in a single 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:

      • PhoneNumberOrders — (Array<map>)

        The phone number order details.

        • PhoneNumberOrderId — (String)

          The phone number order ID.

        • ProductType — (String)

          The phone number order product type.

          Possible values include:
          • "BusinessCalling"
          • "VoiceConnector"
        • Status — (String)

          The status of the phone number order.

          Possible values include:
          • "Processing"
          • "Successful"
          • "Failed"
          • "Partial"
        • OrderedPhoneNumbers — (Array<map>)

          The ordered phone number details, such as the phone number in E.164 format and the phone number status.

          • E164PhoneNumber — (String)

            The phone number, in E.164 format.

          • Status — (String)

            The phone number status.

            Possible values include:
            • "Processing"
            • "Acquired"
            • "Failed"
        • CreatedTimestamp — (Date)

          The phone number order creation time stamp, in ISO 8601 format.

        • UpdatedTimestamp — (Date)

          The updated phone number order time stamp, in ISO 8601 format.

      • NextToken — (String)

        The token to use to retrieve the next page of results.

Returns:

  • (AWS.Request)

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

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

Lists the phone numbers for the specified Amazon Chime account, Amazon Chime user, Amazon Chime Voice Connector, or Amazon Chime Voice Connector group.

Service Reference:

Examples:

Calling the listPhoneNumbers operation

var params = {
  FilterName: AccountId | UserId | VoiceConnectorId | VoiceConnectorGroupId | SipRuleId,
  FilterValue: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  ProductType: BusinessCalling | VoiceConnector,
  Status: AcquireInProgress | AcquireFailed | Unassigned | Assigned | ReleaseInProgress | DeleteInProgress | ReleaseFailed | DeleteFailed
};
chime.listPhoneNumbers(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: {})
    • Status — (String)

      The phone number status.

      Possible values include:
      • "AcquireInProgress"
      • "AcquireFailed"
      • "Unassigned"
      • "Assigned"
      • "ReleaseInProgress"
      • "DeleteInProgress"
      • "ReleaseFailed"
      • "DeleteFailed"
    • ProductType — (String)

      The phone number product type.

      Possible values include:
      • "BusinessCalling"
      • "VoiceConnector"
    • FilterName — (String)

      The filter to use to limit the number of results.

      Possible values include:
      • "AccountId"
      • "UserId"
      • "VoiceConnectorId"
      • "VoiceConnectorGroupId"
      • "SipRuleId"
    • FilterValue — (String)

      The value to use for the filter.

    • MaxResults — (Integer)

      The maximum number of results to return in a single call.

    • NextToken — (String)

      The token to use to retrieve the next page of results.

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:

      • PhoneNumbers — (Array<map>)

        The phone number details.

        • PhoneNumberId — (String)

          The phone number ID.

        • E164PhoneNumber — (String)

          The phone number, in E.164 format.

        • Type — (String)

          The phone number type.

          Possible values include:
          • "Local"
          • "TollFree"
        • ProductType — (String)

          The phone number product type.

          Possible values include:
          • "BusinessCalling"
          • "VoiceConnector"
        • Status — (String)

          The phone number status.

          Possible values include:
          • "AcquireInProgress"
          • "AcquireFailed"
          • "Unassigned"
          • "Assigned"
          • "ReleaseInProgress"
          • "DeleteInProgress"
          • "ReleaseFailed"
          • "DeleteFailed"
        • Capabilities — (map)

          The phone number capabilities.

          • InboundCall — (Boolean)

            Allows or denies inbound calling for the specified phone number.

          • OutboundCall — (Boolean)

            Allows or denies outbound calling for the specified phone number.

          • InboundSMS — (Boolean)

            Allows or denies inbound SMS messaging for the specified phone number.

          • OutboundSMS — (Boolean)

            Allows or denies outbound SMS messaging for the specified phone number.

          • InboundMMS — (Boolean)

            Allows or denies inbound MMS messaging for the specified phone number.

          • OutboundMMS — (Boolean)

            Allows or denies outbound MMS messaging for the specified phone number.

        • Associations — (Array<map>)

          The phone number associations.

          • Value — (String)

            Contains the ID for the entity specified in Name.

          • Name — (String)

            Defines the association with an Amazon Chime account ID, user ID, Amazon Chime Voice Connector ID, or Amazon Chime Voice Connector group ID.

            Possible values include:
            • "AccountId"
            • "UserId"
            • "VoiceConnectorId"
            • "VoiceConnectorGroupId"
            • "SipRuleId"
          • AssociatedTimestamp — (Date)

            The timestamp of the phone number association, in ISO 8601 format.

        • CallingName — (String)

          The outbound calling name associated with the phone number.

        • CallingNameStatus — (String)

          The outbound calling name status.

          Possible values include:
          • "Unassigned"
          • "UpdateInProgress"
          • "UpdateSucceeded"
          • "UpdateFailed"
        • CreatedTimestamp — (Date)

          The phone number creation timestamp, in ISO 8601 format.

        • UpdatedTimestamp — (Date)

          The updated phone number timestamp, in ISO 8601 format.

        • DeletionTimestamp — (Date)

          The deleted phone number timestamp, in ISO 8601 format.

      • NextToken — (String)

        The token to use to retrieve the next page of results.

Returns:

  • (AWS.Request)

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

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

Lists the proxy sessions for the specified Amazon Chime Voice Connector.

Service Reference:

Examples:

Calling the listProxySessions operation

var params = {
  VoiceConnectorId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  Status: Open | InProgress | Closed
};
chime.listProxySessions(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: {})
    • VoiceConnectorId — (String)

      The Amazon Chime voice connector ID.

    • Status — (String)

      The proxy session status.

      Possible values include:
      • "Open"
      • "InProgress"
      • "Closed"
    • NextToken — (String)

      The token to use to retrieve the next page of results.

    • MaxResults — (Integer)

      The maximum number of results to return in a single 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:

      • ProxySessions — (Array<map>)

        The proxy session details.

        • VoiceConnectorId — (String)

          The Amazon Chime voice connector ID.

        • ProxySessionId — (String)

          The proxy session ID.

        • Name — (String)

          The name of the proxy session.

        • Status — (String)

          The status of the proxy session.

          Possible values include:
          • "Open"
          • "InProgress"
          • "Closed"
        • ExpiryMinutes — (Integer)

          The number of minutes allowed for the proxy session.

        • Capabilities — (Array<String>)

          The proxy session capabilities.

        • CreatedTimestamp — (Date)

          The created time stamp, in ISO 8601 format.

        • UpdatedTimestamp — (Date)

          The updated time stamp, in ISO 8601 format.

        • EndedTimestamp — (Date)

          The ended time stamp, in ISO 8601 format.

        • Participants — (Array<map>)

          The proxy session participants.

          • PhoneNumber — (String)

            The participant's phone number.

          • ProxyPhoneNumber — (String)

            The participant's proxy phone number.

        • NumberSelectionBehavior — (String)

          The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.

          Possible values include:
          • "PreferSticky"
          • "AvoidSticky"
        • GeoMatchLevel — (String)

          The preference for matching the country or area code of the proxy phone number with that of the first participant.

          Possible values include:
          • "Country"
          • "AreaCode"
        • GeoMatchParams — (map)

          The country and area code for the proxy phone number.

          • Countryrequired — (String)

            The country.

          • AreaCoderequired — (String)

            The area code.

      • NextToken — (String)

        The token to use to retrieve the next page of results.

Returns:

  • (AWS.Request)

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

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

Lists the membership details for the specified room in an Amazon Chime Enterprise account, such as the members' IDs, email addresses, and names.

Service Reference:

Examples:

Calling the listRoomMemberships operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  RoomId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
chime.listRoomMemberships(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: {})
    • AccountId — (String)

      The Amazon Chime account ID.

    • RoomId — (String)

      The room ID.

    • MaxResults — (Integer)

      The maximum number of results to return in a single call.

    • NextToken — (String)

      The token to use to retrieve the next page of results.

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:

      • RoomMemberships — (Array<map>)

        The room membership details.

        • RoomId — (String)

          The room ID.

        • Member — (map)

          The member details, such as email address, name, member ID, and member type.

          • MemberId — (String)

            The member ID (user ID or bot ID).

          • MemberType — (String)

            The member type.

            Possible values include:
            • "User"
            • "Bot"
            • "Webhook"
          • Email — (String)

            The member email address.

          • FullName — (String)

            The member name.

          • AccountId — (String)

            The Amazon Chime account ID.

        • Role — (String)

          The membership role.

          Possible values include:
          • "Administrator"
          • "Member"
        • InvitedBy — (String)

          The identifier of the user that invited the room member.

        • UpdatedTimestamp — (Date)

          The room membership update timestamp, in ISO 8601 format.

      • NextToken — (String)

        The token to use to retrieve the next page of results.

Returns:

  • (AWS.Request)

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

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

Lists the room details for the specified Amazon Chime Enterprise account. Optionally, filter the results by a member ID (user ID or bot ID) to see a list of rooms that the member belongs to.

Service Reference:

Examples:

Calling the listRooms operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  MemberId: 'STRING_VALUE',
  NextToken: 'STRING_VALUE'
};
chime.listRooms(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: {})
    • AccountId — (String)

      The Amazon Chime account ID.

    • MemberId — (String)

      The member ID (user ID or bot ID).

    • MaxResults — (Integer)

      The maximum number of results to return in a single call.

    • NextToken — (String)

      The token to use to retrieve the next page of results.

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 room details.

        • RoomId — (String)

          The room ID.

        • Name — (String)

          The room name.

        • AccountId — (String)

          The Amazon Chime account ID.

        • CreatedBy — (String)

          The identifier of the room creator.

        • CreatedTimestamp — (Date)

          The room creation timestamp, in ISO 8601 format.

        • UpdatedTimestamp — (Date)

          The room update timestamp, in ISO 8601 format.

      • NextToken — (String)

        The token to use to retrieve the next page of results.

Returns:

  • (AWS.Request)

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

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

Lists the SIP media applications under the administrator's AWS account.

Service Reference:

Examples:

Calling the listSipMediaApplications operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
chime.listSipMediaApplications(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: {})
    • MaxResults — (Integer)

      The maximum number of results to return in a single call. Defaults to 100.

    • NextToken — (String)

      The token to use to retrieve the next page of results.

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:

      • SipMediaApplications — (Array<map>)

        List of SIP media applications and application details.

        • SipMediaApplicationId — (String)

          The SIP media application ID.

        • AwsRegion — (String)

          The AWS Region in which the SIP media application is created.

        • Name — (String)

          The name of the SIP media application.

        • Endpoints — (Array<map>)

          List of endpoints for SIP media application. Currently, only one endpoint per SIP media application is permitted.

          • LambdaArn — (String)

            Valid Amazon Resource Name (ARN) of the Lambda function. The function must be created in the same AWS Region as the SIP media application.

        • CreatedTimestamp — (Date)

          The SIP media application creation timestamp, in ISO 8601 format.

        • UpdatedTimestamp — (Date)

          The SIP media application updated timestamp, in ISO 8601 format.

      • NextToken — (String)

        The token to use to retrieve the next page of results.

Returns:

  • (AWS.Request)

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

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

Lists the SIP rules under the administrator's AWS account.

Service Reference:

Examples:

Calling the listSipRules operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  SipMediaApplicationId: 'STRING_VALUE'
};
chime.listSipRules(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: {})
    • SipMediaApplicationId — (String)

      The SIP media application ID.

    • MaxResults — (Integer)

      The maximum number of results to return in a single call. Defaults to 100.

    • NextToken — (String)

      The token to use to retrieve the next page of results.

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:

      • SipRules — (Array<map>)

        List of SIP rules and rule details.

        • SipRuleId — (String)

          The SIP rule ID.

        • Name — (String)

          The name of the SIP rule.

        • Disabled — (Boolean)

          Indicates whether the SIP rule is enabled or disabled. You must disable a rule before you can delete it.

        • TriggerType — (String)

          The type of trigger assigned to the SIP rule in TriggerValue, currently RequestUriHostname or ToPhoneNumber.

          Possible values include:
          • "ToPhoneNumber"
          • "RequestUriHostname"
        • TriggerValue — (String)

          If TriggerType is RequestUriHostname, then the value can be the outbound host name of the Amazon Chime Voice Connector. If TriggerType is ToPhoneNumber, then the value can be a customer-owned phone number in E164 format. SipRule is triggered when a SIP rule requests host name or ToPhoneNumber matches in the incoming SIP request.

        • TargetApplications — (Array<map>)

          Target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.

          • SipMediaApplicationId — (String)

            The SIP media application ID.

          • Priority — (Integer)

            Priority of the SIP media application in the target list.

          • AwsRegion — (String)

            The AWS Region of the target application.

        • CreatedTimestamp — (Date)

          The time at which the SIP rule was created, in ISO 8601 format.

        • UpdatedTimestamp — (Date)

          The time at which the SIP rule was last updated, in ISO 8601 format.

      • NextToken — (String)

        The token to use to retrieve the next page of results.

Returns:

  • (AWS.Request)

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

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

Lists the tags applied to an Amazon Chime SDK meeting resource.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  ResourceARN: 'STRING_VALUE' /* required */
};
chime.listTagsForResource(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: {})
    • ResourceARN — (String)

      The resource ARN.

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>)

        A list of tag-key value pairs.

        • Keyrequired — (String)

          The key of the tag.

        • Valuerequired — (String)

          The value of the tag.

Returns:

  • (AWS.Request)

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

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

Lists the users that belong to the specified Amazon Chime account. You can specify an email address to list only the user that the email address belongs to.

Service Reference:

Examples:

Calling the listUsers operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  UserEmail: 'STRING_VALUE',
  UserType: PrivateUser | SharedDevice
};
chime.listUsers(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: {})
    • AccountId — (String)

      The Amazon Chime account ID.

    • UserEmail — (String)

      Optional. The user email address used to filter results. Maximum 1.

    • UserType — (String)

      The user type.

      Possible values include:
      • "PrivateUser"
      • "SharedDevice"
    • MaxResults — (Integer)

      The maximum number of results to return in a single call. Defaults to 100.

    • NextToken — (String)

      The token to use to retrieve the next page of results.

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>)

        List of users and user details.

        • UserIdrequired — (String)

          The user ID.

        • AccountId — (String)

          The Amazon Chime account ID.

        • PrimaryEmail — (String)

          The primary email address of the user.

        • PrimaryProvisionedNumber — (String)

          The primary phone number associated with the user.

        • DisplayName — (String)

          The display name of the user.

        • LicenseType — (String)

          The license type for the user.

          Possible values include:
          • "Basic"
          • "Plus"
          • "Pro"
          • "ProTrial"
        • UserType — (String)

          The user type.

          Possible values include:
          • "PrivateUser"
          • "SharedDevice"
        • UserRegistrationStatus — (String)

          The user registration status.

          Possible values include:
          • "Unregistered"
          • "Registered"
          • "Suspended"
        • UserInvitationStatus — (String)

          The user invite status.

          Possible values include:
          • "Pending"
          • "Accepted"
          • "Failed"
        • RegisteredOn — (Date)

          Date and time when the user is registered, in ISO 8601 format.

        • InvitedOn — (Date)

          Date and time when the user is invited to the Amazon Chime account, in ISO 8601 format.

        • AlexaForBusinessMetadata — (map)

          The Alexa for Business metadata.

          • IsAlexaForBusinessEnabled — (Boolean)

            Starts or stops Alexa for Business.

          • AlexaForBusinessRoomArn — (String)

            The ARN of the room resource.

        • PersonalPIN — (String)

          The user's personal meeting PIN.

      • NextToken — (String)

        The token to use to retrieve the next page of results.

Returns:

  • (AWS.Request)

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

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

Lists the Amazon Chime Voice Connector groups for the administrator's AWS account.

Service Reference:

Examples:

Calling the listVoiceConnectorGroups operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
chime.listVoiceConnectorGroups(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 to use to retrieve the next page of results.

    • MaxResults — (Integer)

      The maximum number of results to return in a single 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:

      • VoiceConnectorGroups — (Array<map>)

        The details of the Amazon Chime Voice Connector groups.

        • VoiceConnectorGroupId — (String)

          The Amazon Chime Voice Connector group ID.

        • Name — (String)

          The name of the Amazon Chime Voice Connector group.

        • VoiceConnectorItems — (Array<map>)

          The Amazon Chime Voice Connectors to which to route inbound calls.

          • VoiceConnectorIdrequired — (String)

            The Amazon Chime Voice Connector ID.

          • Priorityrequired — (Integer)

            The priority associated with the Amazon Chime Voice Connector, with 1 being the highest priority. Higher priority Amazon Chime Voice Connectors are attempted first.

        • CreatedTimestamp — (Date)

          The Amazon Chime Voice Connector group creation time stamp, in ISO 8601 format.

        • UpdatedTimestamp — (Date)

          The updated Amazon Chime Voice Connector group time stamp, in ISO 8601 format.

      • NextToken — (String)

        The token to use to retrieve the next page of results.

Returns:

  • (AWS.Request)

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

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

Lists the Amazon Chime Voice Connectors for the administrator's AWS account.

Service Reference:

Examples:

Calling the listVoiceConnectors operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
chime.listVoiceConnectors(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 to use to retrieve the next page of results.

    • MaxResults — (Integer)

      The maximum number of results to return in a single 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:

      • VoiceConnectors — (Array<map>)

        The details of the Amazon Chime Voice Connectors.

        • VoiceConnectorId — (String)

          The Amazon Chime Voice Connector ID.

        • AwsRegion — (String)

          The AWS Region in which the Amazon Chime Voice Connector is created. Default: us-east-1.

          Possible values include:
          • "us-east-1"
          • "us-west-2"
        • Name — (String)

          The name of the Amazon Chime Voice Connector.

        • OutboundHostName — (String)

          The outbound host name for the Amazon Chime Voice Connector.

        • RequireEncryption — (Boolean)

          Designates whether encryption is required for the Amazon Chime Voice Connector.

        • CreatedTimestamp — (Date)

          The Amazon Chime Voice Connector creation timestamp, in ISO 8601 format.

        • UpdatedTimestamp — (Date)

          The updated Amazon Chime Voice Connector timestamp, in ISO 8601 format.

      • NextToken — (String)

        The token to use to retrieve the next page of results.

Returns:

  • (AWS.Request)

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

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

Lists the SIP credentials for the specified Amazon Chime Voice Connector.

Examples:

Calling the listVoiceConnectorTerminationCredentials operation

var params = {
  VoiceConnectorId: 'STRING_VALUE' /* required */
};
chime.listVoiceConnectorTerminationCredentials(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: {})
    • VoiceConnectorId — (String)

      The Amazon Chime Voice Connector ID.

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:

      • Usernames — (Array<String>)

        A list of user names.

Returns:

  • (AWS.Request)

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

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

Logs out the specified user from all of the devices they are currently logged into.

Service Reference:

Examples:

Calling the logoutUser operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  UserId: 'STRING_VALUE' /* required */
};
chime.logoutUser(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: {})
    • AccountId — (String)

      The Amazon Chime account ID.

    • UserId — (String)

      The user ID.

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.

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

Sets the amount of time in days that a given AppInstance retains data.

Service Reference:

Examples:

Calling the putAppInstanceRetentionSettings operation

var params = {
  AppInstanceArn: 'STRING_VALUE', /* required */
  AppInstanceRetentionSettings: { /* required */
    ChannelRetentionSettings: {
      RetentionDays: 'NUMBER_VALUE'
    }
  }
};
chime.putAppInstanceRetentionSettings(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: {})
    • AppInstanceArn — (String)

      The ARN of the AppInstance.

    • AppInstanceRetentionSettings — (map)

      The time in days to retain data. Data type: number.

      • ChannelRetentionSettings — (map)

        The length of time in days to retain the messages in a channel.

        • RetentionDays — (Integer)

          The time in days to retain the messages in a channel.

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:

      • AppInstanceRetentionSettings — (map)

        The time in days to retain data. Data type: number.

        • ChannelRetentionSettings — (map)

          The length of time in days to retain the messages in a channel.

          • RetentionDays — (Integer)

            The time in days to retain the messages in a channel.

      • InitiateDeletionTimestamp — (Date)

        The time at which the API deletes data.

Returns:

  • (AWS.Request)

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

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

The data streaming configurations of an AppInstance.

Examples:

Calling the putAppInstanceStreamingConfigurations operation

var params = {
  AppInstanceArn: 'STRING_VALUE', /* required */
  AppInstanceStreamingConfigurations: [ /* required */
    {
      AppInstanceDataType: Channel | ChannelMessage, /* required */
      ResourceArn: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
chime.putAppInstanceStreamingConfigurations(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: {})
    • AppInstanceArn — (String)

      The ARN of the AppInstance.

    • AppInstanceStreamingConfigurations — (Array<map>)

      The streaming configurations set for an AppInstance.

      • AppInstanceDataTyperequired — (String)

        The type of data to be streamed.

        Possible values include:
        • "Channel"
        • "ChannelMessage"
      • ResourceArnrequired — (String)

        The resource ARN.

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:

      • AppInstanceStreamingConfigurations — (Array<map>)

        The streaming configurations of an AppInstance.

        • AppInstanceDataTyperequired — (String)

          The type of data to be streamed.

          Possible values include:
          • "Channel"
          • "ChannelMessage"
        • ResourceArnrequired — (String)

          The resource ARN.

Returns:

  • (AWS.Request)

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

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

Creates an events configuration that allows a bot to receive outgoing events sent by Amazon Chime. Choose either an HTTPS endpoint or a Lambda function ARN. For more information, see Bot.

Service Reference:

Examples:

Calling the putEventsConfiguration operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  BotId: 'STRING_VALUE', /* required */
  LambdaFunctionArn: 'STRING_VALUE',
  OutboundEventsHTTPSEndpoint: 'STRING_VALUE'
};
chime.putEventsConfiguration(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: {})
    • AccountId — (String)

      The Amazon Chime account ID.

    • BotId — (String)

      The bot ID.

    • OutboundEventsHTTPSEndpoint — (String)

      HTTPS endpoint that allows the bot to receive outgoing events.

    • LambdaFunctionArn — (String)

      Lambda function ARN that allows the bot to receive outgoing events.

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:

      • EventsConfiguration — (map)

        The configuration that allows a bot to receive outgoing events. Can be either an HTTPS endpoint or a Lambda function ARN.

        • BotId — (String)

          The bot ID.

        • OutboundEventsHTTPSEndpoint — (String)

          HTTPS endpoint that allows a bot to receive outgoing events.

        • LambdaFunctionArn — (String)

          Lambda function ARN that allows a bot to receive outgoing events.

Returns:

  • (AWS.Request)

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

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

Puts retention settings for the specified Amazon Chime Enterprise account. We recommend using AWS CloudTrail to monitor usage of this API for your account. For more information, see Logging Amazon Chime API Calls with AWS CloudTrail in the Amazon Chime Administration Guide .

To turn off existing retention settings, remove the number of days from the corresponding RetentionDays field in the RetentionSettings object. For more information about retention settings, see Managing Chat Retention Policies in the Amazon Chime Administration Guide .

Service Reference:

Examples:

Calling the putRetentionSettings operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  RetentionSettings: { /* required */
    ConversationRetentionSettings: {
      RetentionDays: 'NUMBER_VALUE'
    },
    RoomRetentionSettings: {
      RetentionDays: 'NUMBER_VALUE'
    }
  }
};
chime.putRetentionSettings(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: {})
    • AccountId — (String)

      The Amazon Chime account ID.

    • RetentionSettings — (map)

      The retention settings.

      • RoomRetentionSettings — (map)

        The chat room retention settings.

        • RetentionDays — (Integer)

          The number of days for which to retain chat-room messages.

      • ConversationRetentionSettings — (map)

        The chat conversation retention settings.

        • RetentionDays — (Integer)

          The number of days for which to retain conversation messages.

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:

      • RetentionSettings — (map)

        The retention settings.

        • RoomRetentionSettings — (map)

          The chat room retention settings.

          • RetentionDays — (Integer)

            The number of days for which to retain chat-room messages.

        • ConversationRetentionSettings — (map)

          The chat conversation retention settings.

          • RetentionDays — (Integer)

            The number of days for which to retain conversation messages.

      • InitiateDeletionTimestamp — (Date)

        The timestamp representing the time at which the specified items are permanently deleted, in ISO 8601 format.

Returns:

  • (AWS.Request)

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

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

Updates the logging configuration for the specified SIP media application.

Examples:

Calling the putSipMediaApplicationLoggingConfiguration operation

var params = {
  SipMediaApplicationId: 'STRING_VALUE', /* required */
  SipMediaApplicationLoggingConfiguration: {
    EnableSipMediaApplicationMessageLogs: true || false
  }
};
chime.putSipMediaApplicationLoggingConfiguration(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: {})
    • SipMediaApplicationId — (String)

      The SIP media application ID.

    • SipMediaApplicationLoggingConfiguration — (map)

      The actual logging configuration.

      • EnableSipMediaApplicationMessageLogs — (Boolean)

        Enables application message logs for the SIP media application.

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:

      • SipMediaApplicationLoggingConfiguration — (map)

        Logging configuration of the SIP media application.

        • EnableSipMediaApplicationMessageLogs — (Boolean)

          Enables application message logs for the SIP media application.

Returns:

  • (AWS.Request)

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

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

Puts emergency calling configuration details to the specified Amazon Chime Voice Connector, such as emergency phone numbers and calling countries. Origination and termination settings must be enabled for the Amazon Chime Voice Connector before emergency calling can be configured.

Examples:

Calling the putVoiceConnectorEmergencyCallingConfiguration operation

var params = {
  EmergencyCallingConfiguration: { /* required */
    DNIS: [
      {
        CallingCountry: 'STRING_VALUE', /* required */
        EmergencyPhoneNumber: 'STRING_VALUE', /* required */
        TestPhoneNumber: 'STRING_VALUE'
      },
      /* more items */
    ]
  },
  VoiceConnectorId: 'STRING_VALUE' /* required */
};
chime.putVoiceConnectorEmergencyCallingConfiguration(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: {})
    • VoiceConnectorId — (String)

      The Amazon Chime Voice Connector ID.

    • EmergencyCallingConfiguration — (map)

      The emergency calling configuration details.

      • DNIS — (Array<map>)

        The Dialed Number Identification Service (DNIS) emergency calling configuration details.

        • EmergencyPhoneNumberrequired — (String)

          The DNIS phone number to route emergency calls to, in E.164 format.

        • TestPhoneNumber — (String)

          The DNIS phone number to route test emergency calls to, in E.164 format.

        • CallingCountryrequired — (String)

          The country from which emergency calls are allowed, in ISO 3166-1 alpha-2 format.

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:

      • EmergencyCallingConfiguration — (map)

        The emergency calling configuration details.

        • DNIS — (Array<map>)

          The Dialed Number Identification Service (DNIS) emergency calling configuration details.

          • EmergencyPhoneNumberrequired — (String)

            The DNIS phone number to route emergency calls to, in E.164 format.

          • TestPhoneNumber — (String)

            The DNIS phone number to route test emergency calls to, in E.164 format.

          • CallingCountryrequired — (String)

            The country from which emergency calls are allowed, in ISO 3166-1 alpha-2 format.

Returns:

  • (AWS.Request)

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

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

Adds a logging configuration for the specified Amazon Chime Voice Connector. The logging configuration specifies whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.

Examples:

Calling the putVoiceConnectorLoggingConfiguration operation

var params = {
  LoggingConfiguration: { /* required */
    EnableSIPLogs: true || false
  },
  VoiceConnectorId: 'STRING_VALUE' /* required */
};
chime.putVoiceConnectorLoggingConfiguration(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: {})
    • VoiceConnectorId — (String)

      The Amazon Chime Voice Connector ID.

    • LoggingConfiguration — (map)

      The logging configuration details to add.

      • EnableSIPLogs — (Boolean)

        When true, enables SIP message logs for sending to Amazon CloudWatch Logs.

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:

      • LoggingConfiguration — (map)

        The updated logging configuration details.

        • EnableSIPLogs — (Boolean)

          When true, enables SIP message logs for sending to Amazon CloudWatch Logs.

Returns:

  • (AWS.Request)

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

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

Adds origination settings for the specified Amazon Chime Voice Connector.

Note: If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to turning off origination settings.

Service Reference:

Examples:

Calling the putVoiceConnectorOrigination operation

var params = {
  Origination: { /* required */
    Disabled: true || false,
    Routes: [
      {
        Host: 'STRING_VALUE',
        Port: 'NUMBER_VALUE',
        Priority: 'NUMBER_VALUE',
        Protocol: TCP | UDP,
        Weight: 'NUMBER_VALUE'
      },
      /* more items */
    ]
  },
  VoiceConnectorId: 'STRING_VALUE' /* required */
};
chime.putVoiceConnectorOrigination(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: {})
    • VoiceConnectorId — (String)

      The Amazon Chime Voice Connector ID.

    • Origination — (map)

      The origination setting details to add.

      • Routes — (Array<map>)

        The call distribution properties defined for your SIP hosts. Valid range: Minimum value of 1. Maximum value of 20.

        • Host — (String)

          The FQDN or IP address to contact for origination traffic.

        • Port — (Integer)

          The designated origination route port. Defaults to 5060.

        • Protocol — (String)

          The protocol to use for the origination route. Encryption-enabled Amazon Chime Voice Connectors use TCP protocol by default.

          Possible values include:
          • "TCP"
          • "UDP"
        • Priority — (Integer)

          The priority associated with the host, with 1 being the highest priority. Higher priority hosts are attempted first.

        • Weight — (Integer)

          The weight associated with the host. If hosts are equal in priority, calls are redistributed among them based on their relative weight.

      • Disabled — (Boolean)

        When origination settings are disabled, inbound calls are not enabled for your Amazon Chime Voice Connector.

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:

      • Origination — (map)

        The updated origination setting details.

        • Routes — (Array<map>)

          The call distribution properties defined for your SIP hosts. Valid range: Minimum value of 1. Maximum value of 20.

          • Host — (String)

            The FQDN or IP address to contact for origination traffic.

          • Port — (Integer)

            The designated origination route port. Defaults to 5060.

          • Protocol — (String)

            The protocol to use for the origination route. Encryption-enabled Amazon Chime Voice Connectors use TCP protocol by default.

            Possible values include:
            • "TCP"
            • "UDP"
          • Priority — (Integer)

            The priority associated with the host, with 1 being the highest priority. Higher priority hosts are attempted first.

          • Weight — (Integer)

            The weight associated with the host. If hosts are equal in priority, calls are redistributed among them based on their relative weight.

        • Disabled — (Boolean)

          When origination settings are disabled, inbound calls are not enabled for your Amazon Chime Voice Connector.

Returns:

  • (AWS.Request)

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

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

Puts the specified proxy configuration to the specified Amazon Chime Voice Connector.

Service Reference:

Examples:

Calling the putVoiceConnectorProxy operation

var params = {
  DefaultSessionExpiryMinutes: 'NUMBER_VALUE', /* required */
  PhoneNumberPoolCountries: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  VoiceConnectorId: 'STRING_VALUE', /* required */
  Disabled: true || false,
  FallBackPhoneNumber: 'STRING_VALUE'
};
chime.putVoiceConnectorProxy(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: {})
    • VoiceConnectorId — (String)

      The Amazon Chime voice connector ID.

    • DefaultSessionExpiryMinutes — (Integer)

      The default number of minutes allowed for proxy sessions.

    • PhoneNumberPoolCountries — (Array<String>)

      The countries for proxy phone numbers to be selected from.

    • FallBackPhoneNumber — (String)

      The phone number to route calls to after a proxy session expires.

    • Disabled — (Boolean)

      When true, stops proxy sessions from being created on the specified Amazon Chime Voice Connector.

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:

      • Proxy — (map)

        The proxy configuration details.

        • DefaultSessionExpiryMinutes — (Integer)

          The default number of minutes allowed for proxy sessions.

        • Disabled — (Boolean)

          When true, stops proxy sessions from being created on the specified Amazon Chime Voice Connector.

        • FallBackPhoneNumber — (String)

          The phone number to route calls to after a proxy session expires.

        • PhoneNumberCountries — (Array<String>)

          The countries for proxy phone numbers to be selected from.

Returns:

  • (AWS.Request)

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

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

Adds a streaming configuration for the specified Amazon Chime Voice Connector. The streaming configuration specifies whether media streaming is enabled for sending to Indonesians. It also sets the retention period, in hours, for the Amazon Kinesis data.

Examples:

Calling the putVoiceConnectorStreamingConfiguration operation

var params = {
  StreamingConfiguration: { /* required */
    DataRetentionInHours: 'NUMBER_VALUE', /* required */
    Disabled: true || false,
    StreamingNotificationTargets: [
      {
        NotificationTarget: EventBridge | SNS | SQS /* required */
      },
      /* more items */
    ]
  },
  VoiceConnectorId: 'STRING_VALUE' /* required */
};
chime.putVoiceConnectorStreamingConfiguration(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: {})
    • VoiceConnectorId — (String)

      The Amazon Chime Voice Connector ID.

    • StreamingConfiguration — (map)

      The streaming configuration details to add.

      • DataRetentionInHoursrequired — (Integer)

        The retention period, in hours, for the Amazon Kinesis data.

      • Disabled — (Boolean)

        When true, media streaming to Amazon Kinesis is turned off.

      • StreamingNotificationTargets — (Array<map>)

        The streaming notification targets.

        • NotificationTargetrequired — (String)

          The streaming notification target.

          Possible values include:
          • "EventBridge"
          • "SNS"
          • "SQS"

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:

      • StreamingConfiguration — (map)

        The updated streaming configuration details.

        • DataRetentionInHoursrequired — (Integer)

          The retention period, in hours, for the Amazon Kinesis data.

        • Disabled — (Boolean)

          When true, media streaming to Amazon Kinesis is turned off.

        • StreamingNotificationTargets — (Array<map>)

          The streaming notification targets.

          • NotificationTargetrequired — (String)

            The streaming notification target.

            Possible values include:
            • "EventBridge"
            • "SNS"
            • "SQS"

Returns:

  • (AWS.Request)

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

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

Adds termination settings for the specified Amazon Chime Voice Connector.

Note: If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to turning off termination settings.

Service Reference:

Examples:

Calling the putVoiceConnectorTermination operation

var params = {
  Termination: { /* required */
    CallingRegions: [
      'STRING_VALUE',
      /* more items */
    ],
    CidrAllowedList: [
      'STRING_VALUE',
      /* more items */
    ],
    CpsLimit: 'NUMBER_VALUE',
    DefaultPhoneNumber: 'STRING_VALUE',
    Disabled: true || false
  },
  VoiceConnectorId: 'STRING_VALUE' /* required */
};
chime.putVoiceConnectorTermination(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: {})
    • VoiceConnectorId — (String)

      The Amazon Chime Voice Connector ID.

    • Termination — (map)

      The termination setting details to add.

      • CpsLimit — (Integer)

        The limit on calls per second. Max value based on account service quota. Default value of 1.

      • DefaultPhoneNumber — (String)

        The default caller ID phone number.

      • CallingRegions — (Array<String>)

        The countries to which calls are allowed, in ISO 3166-1 alpha-2 format. Required.

      • CidrAllowedList — (Array<String>)

        The IP addresses allowed to make calls, in CIDR format. Required.

      • Disabled — (Boolean)

        When termination settings are disabled, outbound calls can not be made.

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:

      • Termination — (map)

        The updated termination setting details.

        • CpsLimit — (Integer)

          The limit on calls per second. Max value based on account service quota. Default value of 1.

        • DefaultPhoneNumber — (String)

          The default caller ID phone number.

        • CallingRegions — (Array<String>)

          The countries to which calls are allowed, in ISO 3166-1 alpha-2 format. Required.

        • CidrAllowedList — (Array<String>)

          The IP addresses allowed to make calls, in CIDR format. Required.

        • Disabled — (Boolean)

          When termination settings are disabled, outbound calls can not be made.

Returns:

  • (AWS.Request)

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

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

Adds termination SIP credentials for the specified Amazon Chime Voice Connector.

Examples:

Calling the putVoiceConnectorTerminationCredentials operation

var params = {
  VoiceConnectorId: 'STRING_VALUE', /* required */
  Credentials: [
    {
      Password: 'STRING_VALUE',
      Username: 'STRING_VALUE'
    },
    /* more items */
  ]
};
chime.putVoiceConnectorTerminationCredentials(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: {})
    • VoiceConnectorId — (String)

      The Amazon Chime Voice Connector ID.

    • Credentials — (Array<map>)

      The termination SIP credentials.

      • Username — (String)

        The RFC2617 compliant user name associated with the SIP credentials, in US-ASCII format.

      • Password — (String)

        The RFC2617 compliant password associated with the SIP credentials, in US-ASCII format.

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.

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

Redacts message content, but not metadata. The message exists in the back end, but the action returns null content, and the state shows as redacted.

Note: The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

Service Reference:

Examples:

Calling the redactChannelMessage operation

var params = {
  ChannelArn: 'STRING_VALUE', /* required */
  MessageId: 'STRING_VALUE', /* required */
  ChimeBearer: 'STRING_VALUE'
};
chime.redactChannelMessage(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: {})
    • ChannelArn — (String)

      The ARN of the channel containing the messages that you want to redact.

    • MessageId — (String)

      The ID of the message being redacted.

    • ChimeBearer — (String)

      The AppInstanceUserArn of the user that makes the API 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:

      • ChannelArn — (String)

        The ARN of the channel containing the messages that you want to redact.

      • MessageId — (String)

        The ID of the message being redacted.

Returns:

  • (AWS.Request)

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

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

Redacts the specified message from the specified Amazon Chime conversation.

Service Reference:

Examples:

Calling the redactConversationMessage operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  ConversationId: 'STRING_VALUE', /* required */
  MessageId: 'STRING_VALUE' /* required */
};
chime.redactConversationMessage(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: {})
    • AccountId — (String)

      The Amazon Chime account ID.

    • ConversationId — (String)

      The conversation ID.

    • MessageId — (String)

      The message ID.

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.

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

Redacts the specified message from the specified Amazon Chime channel.

Service Reference:

Examples:

Calling the redactRoomMessage operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  MessageId: 'STRING_VALUE', /* required */
  RoomId: 'STRING_VALUE' /* required */
};
chime.redactRoomMessage(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: {})
    • AccountId — (String)

      The Amazon Chime account ID.

    • RoomId — (String)

      The room ID.

    • MessageId — (String)

      The message ID.

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.

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

Regenerates the security token for a bot.

Service Reference:

Examples:

Calling the regenerateSecurityToken operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  BotId: 'STRING_VALUE' /* required */
};
chime.regenerateSecurityToken(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: {})
    • AccountId — (String)

      The Amazon Chime account ID.

    • BotId — (String)

      The bot ID.

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:

      • Bot — (map)

        A resource that allows Enterprise account administrators to configure an interface to receive events from Amazon Chime.

        • BotId — (String)

          The bot ID.

        • UserId — (String)

          The unique ID for the bot user.

        • DisplayName — (String)

          The bot display name.

        • BotType — (String)

          The bot type.

          Possible values include:
          • "ChatBot"
        • Disabled — (Boolean)

          When true, the bot is stopped from running in your account.

        • CreatedTimestamp — (Date)

          The bot creation timestamp, in ISO 8601 format.

        • UpdatedTimestamp — (Date)

          The updated bot timestamp, in ISO 8601 format.

        • BotEmail — (String)

          The bot email address.

        • SecurityToken — (String)

          The security token used to authenticate Amazon Chime with the outgoing event endpoint.

Returns:

  • (AWS.Request)

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

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

Resets the personal meeting PIN for the specified user on an Amazon Chime account. Returns the User object with the updated personal meeting PIN.

Service Reference:

Examples:

Calling the resetPersonalPIN operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  UserId: 'STRING_VALUE' /* required */
};
chime.resetPersonalPIN(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: {})
    • AccountId — (String)

      The Amazon Chime account ID.

    • UserId — (String)

      The user ID.

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:

      • User — (map)

        The user details and new personal meeting PIN.

        • UserIdrequired — (String)

          The user ID.

        • AccountId — (String)

          The Amazon Chime account ID.

        • PrimaryEmail — (String)

          The primary email address of the user.

        • PrimaryProvisionedNumber — (String)

          The primary phone number associated with the user.

        • DisplayName — (String)

          The display name of the user.

        • LicenseType — (String)

          The license type for the user.

          Possible values include:
          • "Basic"
          • "Plus"
          • "Pro"
          • "ProTrial"
        • UserType — (String)

          The user type.

          Possible values include:
          • "PrivateUser"
          • "SharedDevice"
        • UserRegistrationStatus — (String)

          The user registration status.

          Possible values include:
          • "Unregistered"
          • "Registered"
          • "Suspended"
        • UserInvitationStatus — (String)

          The user invite status.

          Possible values include:
          • "Pending"
          • "Accepted"
          • "Failed"
        • RegisteredOn — (Date)

          Date and time when the user is registered, in ISO 8601 format.

        • InvitedOn — (Date)

          Date and time when the user is invited to the Amazon Chime account, in ISO 8601 format.

        • AlexaForBusinessMetadata — (map)

          The Alexa for Business metadata.

          • IsAlexaForBusinessEnabled — (Boolean)

            Starts or stops Alexa for Business.

          • AlexaForBusinessRoomArn — (String)

            The ARN of the room resource.

        • PersonalPIN — (String)

          The user's personal meeting PIN.

Returns:

  • (AWS.Request)

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

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

Moves a phone number from the Deletion queue back into the phone number Inventory.

Service Reference:

Examples:

Calling the restorePhoneNumber operation

var params = {
  PhoneNumberId: 'STRING_VALUE' /* required */
};
chime.restorePhoneNumber(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: {})
    • PhoneNumberId — (String)

      The phone number.

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:

      • PhoneNumber — (map)

        The phone number details.

        • PhoneNumberId — (String)

          The phone number ID.

        • E164PhoneNumber — (String)

          The phone number, in E.164 format.

        • Type — (String)

          The phone number type.

          Possible values include:
          • "Local"
          • "TollFree"
        • ProductType — (String)

          The phone number product type.

          Possible values include:
          • "BusinessCalling"
          • "VoiceConnector"
        • Status — (String)

          The phone number status.

          Possible values include:
          • "AcquireInProgress"
          • "AcquireFailed"
          • "Unassigned"
          • "Assigned"
          • "ReleaseInProgress"
          • "DeleteInProgress"
          • "ReleaseFailed"
          • "DeleteFailed"
        • Capabilities — (map)

          The phone number capabilities.

          • InboundCall — (Boolean)

            Allows or denies inbound calling for the specified phone number.

          • OutboundCall — (Boolean)

            Allows or denies outbound calling for the specified phone number.

          • InboundSMS — (Boolean)

            Allows or denies inbound SMS messaging for the specified phone number.

          • OutboundSMS — (Boolean)

            Allows or denies outbound SMS messaging for the specified phone number.

          • InboundMMS — (Boolean)

            Allows or denies inbound MMS messaging for the specified phone number.

          • OutboundMMS — (Boolean)

            Allows or denies outbound MMS messaging for the specified phone number.

        • Associations — (Array<map>)

          The phone number associations.

          • Value — (String)

            Contains the ID for the entity specified in Name.

          • Name — (String)

            Defines the association with an Amazon Chime account ID, user ID, Amazon Chime Voice Connector ID, or Amazon Chime Voice Connector group ID.

            Possible values include:
            • "AccountId"
            • "UserId"
            • "VoiceConnectorId"
            • "VoiceConnectorGroupId"
            • "SipRuleId"
          • AssociatedTimestamp — (Date)

            The timestamp of the phone number association, in ISO 8601 format.

        • CallingName — (String)

          The outbound calling name associated with the phone number.

        • CallingNameStatus — (String)

          The outbound calling name status.

          Possible values include:
          • "Unassigned"
          • "UpdateInProgress"
          • "UpdateSucceeded"
          • "UpdateFailed"
        • CreatedTimestamp — (Date)

          The phone number creation timestamp, in ISO 8601 format.

        • UpdatedTimestamp — (Date)

          The updated phone number timestamp, in ISO 8601 format.

        • DeletionTimestamp — (Date)

          The deleted phone number timestamp, in ISO 8601 format.

Returns:

  • (AWS.Request)

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

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

Searches phone numbers that can be ordered.

Service Reference:

Examples:

Calling the searchAvailablePhoneNumbers operation

var params = {
  AreaCode: 'STRING_VALUE',
  City: 'STRING_VALUE',
  Country: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  State: 'STRING_VALUE',
  TollFreePrefix: 'STRING_VALUE'
};
chime.searchAvailablePhoneNumbers(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: {})
    • AreaCode — (String)

      The area code used to filter results.

    • City — (String)

      The city used to filter results.

    • Country — (String)

      The country used to filter results.

    • State — (String)

      The state used to filter results.

    • TollFreePrefix — (String)

      The toll-free prefix that you use to filter results.

    • MaxResults — (Integer)

      The maximum number of results to return in a single call.

    • NextToken — (String)

      The token to use to retrieve the next page of results.

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:

      • E164PhoneNumbers — (Array<String>)

        List of phone numbers, in E.164 format.

Returns:

  • (AWS.Request)

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

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

Sends a message to a particular channel that the member is a part of.

Note: The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. Also, STANDARD messages can contain 4KB of data and the 1KB of metadata. CONTROL messages can contain 30 bytes of data and no metadata.

Service Reference:

Examples:

Calling the sendChannelMessage operation

var params = {
  ChannelArn: 'STRING_VALUE', /* required */
  ClientRequestToken: 'STRING_VALUE', /* required */
  Content: 'STRING_VALUE', /* required */
  Persistence: PERSISTENT | NON_PERSISTENT, /* required */
  Type: STANDARD | CONTROL, /* required */
  ChimeBearer: 'STRING_VALUE',
  Metadata: 'STRING_VALUE'
};
chime.sendChannelMessage(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: {})
    • ChannelArn — (String)

      The ARN of the channel.

    • Content — (String)

      The content of the message.

    • Type — (String)

      The type of message, STANDARD or CONTROL.

      Possible values include:
      • "STANDARD"
      • "CONTROL"
    • Persistence — (String)

      Boolean that controls whether the message is persisted on the back end. Required.

      Possible values include:
      • "PERSISTENT"
      • "NON_PERSISTENT"
    • Metadata — (String)

      The optional metadata for each message.

    • ClientRequestToken — (String)

      The Idempotency token for each client request.

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

      The AppInstanceUserArn of the user that makes the API 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:

      • ChannelArn — (String)

        The ARN of the channel.

      • MessageId — (String)

        The ID string assigned to each message.

Returns:

  • (AWS.Request)

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

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

Applies the specified tags to the specified Amazon Chime SDK attendee.

Service Reference:

Examples:

Calling the tagAttendee operation

var params = {
  AttendeeId: 'STRING_VALUE', /* required */
  MeetingId: 'STRING_VALUE', /* required */
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
chime.tagAttendee(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: {})
    • MeetingId — (String)

      The Amazon Chime SDK meeting ID.

    • AttendeeId — (String)

      The Amazon Chime SDK attendee ID.

    • Tags — (Array<map>)

      The tag key-value pairs.

      • Keyrequired — (String)

        The key of the tag.

      • Valuerequired — (String)

        The value of the tag.

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.

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

Applies the specified tags to the specified Amazon Chime SDK meeting.

Service Reference:

Examples:

Calling the tagMeeting operation

var params = {
  MeetingId: 'STRING_VALUE', /* required */
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
chime.tagMeeting(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: {})
    • MeetingId — (String)

      The Amazon Chime SDK meeting ID.

    • Tags — (Array<map>)

      The tag key-value pairs.

      • Keyrequired — (String)

        The key of the tag.

      • Valuerequired — (String)

        The value of the tag.

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

Applies the specified tags to the specified Amazon Chime SDK meeting resource.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  ResourceARN: 'STRING_VALUE', /* required */
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
chime.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: {})
    • ResourceARN — (String)

      The resource ARN.

    • Tags — (Array<map>)

      The tag key-value pairs.

      • Keyrequired — (String)

        The key of the tag.

      • Valuerequired — (String)

        The value of the tag.

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.

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

Untags the specified tags from the specified Amazon Chime SDK attendee.

Service Reference:

Examples:

Calling the untagAttendee operation

var params = {
  AttendeeId: 'STRING_VALUE', /* required */
  MeetingId: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
chime.untagAttendee(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: {})
    • MeetingId — (String)

      The Amazon Chime SDK meeting ID.

    • AttendeeId — (String)

      The Amazon Chime SDK attendee ID.

    • TagKeys — (Array<String>)

      The tag keys.

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.

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

Untags the specified tags from the specified Amazon Chime SDK meeting.

Service Reference:

Examples:

Calling the untagMeeting operation

var params = {
  MeetingId: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
chime.untagMeeting(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: {})
    • MeetingId — (String)

      The Amazon Chime SDK meeting ID.

    • TagKeys — (Array<String>)

      The tag keys.

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

Untags the specified tags from the specified Amazon Chime SDK meeting resource.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  ResourceARN: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
chime.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: {})
    • ResourceARN — (String)

      The resource ARN.

    • TagKeys — (Array<String>)

      The tag keys.

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.

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

Updates account details for the specified Amazon Chime account. Currently, only account name updates are supported for this action.

Service Reference:

Examples:

Calling the updateAccount operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE'
};
chime.updateAccount(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: {})
    • AccountId — (String)

      The Amazon Chime account ID.

    • Name — (String)

      The new name for the specified Amazon Chime account.

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:

      • Account — (map)

        The updated Amazon Chime account details.

        • AwsAccountIdrequired — (String)

          The AWS account ID.

        • AccountIdrequired — (String)

          The Amazon Chime account ID.

        • Namerequired — (String)

          The Amazon Chime account name.

        • AccountType — (String)

          The Amazon Chime account type. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.

          Possible values include:
          • "Team"
          • "EnterpriseDirectory"
          • "EnterpriseLWA"
          • "EnterpriseOIDC"
        • CreatedTimestamp — (Date)

          The Amazon Chime account creation timestamp, in ISO 8601 format.

        • DefaultLicense — (String)

          The default license for the Amazon Chime account.

          Possible values include:
          • "Basic"
          • "Plus"
          • "Pro"
          • "ProTrial"
        • SupportedLicenses — (Array<String>)

          Supported licenses for the Amazon Chime account.

        • SigninDelegateGroups — (Array<map>)

          The sign-in delegate groups associated with the account.

          • GroupName — (String)

            The group name.

Returns:

  • (AWS.Request)

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

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

Updates the settings for the specified Amazon Chime account. You can update settings for remote control of shared screens, or for the dial-out option. For more information about these settings, see Use the Policies Page in the Amazon Chime Administration Guide.

Service Reference:

Examples:

Calling the updateAccountSettings operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  AccountSettings: { /* required */
    DisableRemoteControl: true || false,
    EnableDialOut: true || false
  }
};
chime.updateAccountSettings(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: {})
    • AccountId — (String)

      The Amazon Chime account ID.

    • AccountSettings — (map)

      The Amazon Chime account settings to update.

      • DisableRemoteControl — (Boolean)

        Setting that stops or starts remote control of shared screens during meetings.

      • EnableDialOut — (Boolean)

        Setting that allows meeting participants to choose the Call me at a phone number option. For more information, see Join a Meeting without the Amazon Chime App.

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.

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

Updates AppInstance metadata.

Service Reference:

Examples:

Calling the updateAppInstance operation

var params = {
  AppInstanceArn: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  Metadata: 'STRING_VALUE'
};
chime.updateAppInstance(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: {})
    • AppInstanceArn — (String)

      The ARN of the AppInstance.

    • Name — (String)

      The name that you want to change.

    • Metadata — (String)

      The metadata that you want to change.

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:

      • AppInstanceArn — (String)

        The ARN of the AppInstance.

Returns:

  • (AWS.Request)

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

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

Updates the details of an AppInstanceUser. You can update names and metadata.

Service Reference:

Examples:

Calling the updateAppInstanceUser operation

var params = {
  AppInstanceUserArn: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  Metadata: 'STRING_VALUE'
};
chime.updateAppInstanceUser(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: {})
    • AppInstanceUserArn — (String)

      The ARN of the AppInstanceUser.

    • Name — (String)

      The name of the AppInstanceUser.

    • Metadata — (String)

      The metadata of the AppInstanceUser.

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:

      • AppInstanceUserArn — (String)

        The ARN of the AppInstanceUser.

Returns:

  • (AWS.Request)

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

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

Updates the status of the specified bot, such as starting or stopping the bot from running in your Amazon Chime Enterprise account.

Service Reference:

Examples:

Calling the updateBot operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  BotId: 'STRING_VALUE', /* required */
  Disabled: true || false
};
chime.updateBot(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: {})
    • AccountId — (String)

      The Amazon Chime account ID.

    • BotId — (String)

      The bot ID.

    • Disabled — (Boolean)

      When true, stops the specified bot from running in your account.

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:

      • Bot — (map)

        The updated bot details.

        • BotId — (String)

          The bot ID.

        • UserId — (String)

          The unique ID for the bot user.

        • DisplayName — (String)

          The bot display name.

        • BotType — (String)

          The bot type.

          Possible values include:
          • "ChatBot"
        • Disabled — (Boolean)

          When true, the bot is stopped from running in your account.

        • CreatedTimestamp — (Date)

          The bot creation timestamp, in ISO 8601 format.

        • UpdatedTimestamp — (Date)

          The updated bot timestamp, in ISO 8601 format.

        • BotEmail — (String)

          The bot email address.

        • SecurityToken — (String)

          The security token used to authenticate Amazon Chime with the outgoing event endpoint.

Returns:

  • (AWS.Request)

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

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

Update a channel's attributes.

Restriction: You can't change a channel's privacy.

Note: The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

Service Reference:

Examples:

Calling the updateChannel operation

var params = {
  ChannelArn: 'STRING_VALUE', /* required */
  Mode: UNRESTRICTED | RESTRICTED, /* required */
  Name: 'STRING_VALUE', /* required */
  ChimeBearer: 'STRING_VALUE',
  Metadata: 'STRING_VALUE'
};
chime.updateChannel(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: {})
    • ChannelArn — (String)

      The ARN of the channel.

    • Name — (String)

      The name of the channel.

    • Mode — (String)

      The mode of the update request.

      Possible values include:
      • "UNRESTRICTED"
      • "RESTRICTED"
    • Metadata — (String)

      The metadata for the update request.

    • ChimeBearer — (String)

      The AppInstanceUserArn of the user that makes the API 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:

      • ChannelArn — (String)

        The ARN of the channel.

Returns:

  • (AWS.Request)

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

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

Updates the content of a message.

Note: The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

Service Reference:

Examples:

Calling the updateChannelMessage operation

var params = {
  ChannelArn: 'STRING_VALUE', /* required */
  MessageId: 'STRING_VALUE', /* required */
  ChimeBearer: 'STRING_VALUE',
  Content: 'STRING_VALUE',
  Metadata: 'STRING_VALUE'
};
chime.updateChannelMessage(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: {})
    • ChannelArn — (String)

      The ARN of the channel.

    • MessageId — (String)

      The ID string of the message being updated.

    • Content — (String)

      The content of the message being updated.

    • Metadata — (String)

      The metadata of the message being updated.

    • ChimeBearer — (String)

      The AppInstanceUserArn of the user that makes the API 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:

      • ChannelArn — (String)

        The ARN of the channel.

      • MessageId — (String)

        The ID string of the message being updated.

Returns:

  • (AWS.Request)

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

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

The details of the time when a user last read messages in a channel.

Note: The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

Service Reference:

Examples:

Calling the updateChannelReadMarker operation

var params = {
  ChannelArn: 'STRING_VALUE', /* required */
  ChimeBearer: 'STRING_VALUE'
};
chime.updateChannelReadMarker(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: {})
    • ChannelArn — (String)

      The ARN of the channel.

    • ChimeBearer — (String)

      The AppInstanceUserArn of the user that makes the API 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:

      • ChannelArn — (String)

        The ARN of the channel.

Returns:

  • (AWS.Request)

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

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

Updates global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.

Service Reference:

Examples:

Calling the updateGlobalSettings operation

var params = {
  BusinessCalling: { /* required */
    CdrBucket: 'STRING_VALUE'
  },
  VoiceConnector: { /* required */
    CdrBucket: 'STRING_VALUE'
  }
};
chime.updateGlobalSettings(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: {})
    • BusinessCalling — (map)

      The Amazon Chime Business Calling settings.

      • CdrBucket — (String)

        The Amazon S3 bucket designated for call detail record storage.

    • VoiceConnector — (map)

      The Amazon Chime Voice Connector settings.

      • CdrBucket — (String)

        The Amazon S3 bucket designated for call detail record storage.

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.

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

Updates phone number details, such as product type or calling name, for the specified phone number ID. You can update one phone number detail at a time. For example, you can update either the product type or the calling name in one action.

For toll-free numbers, you must use the Amazon Chime Voice Connector product type.

Updates to outbound calling names can take up to 72 hours to complete. Pending updates to outbound calling names must be complete before you can request another update.

Service Reference:

Examples:

Calling the updatePhoneNumber operation

var params = {
  PhoneNumberId: 'STRING_VALUE', /* required */
  CallingName: 'STRING_VALUE',
  ProductType: BusinessCalling | VoiceConnector
};
chime.updatePhoneNumber(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: {})
    • PhoneNumberId — (String)

      The phone number ID.

    • ProductType — (String)

      The product type.

      Possible values include:
      • "BusinessCalling"
      • "VoiceConnector"
    • CallingName — (String)

      The outbound calling name associated with the phone number.

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.