You are viewing the documentation for an older major version of the AWS SDK for JavaScript.

The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.ChimeSDKMeetings

Inherits:

AWS.Service

Object
AWS.Service
AWS.ChimeSDKMeetings

show all

Identifier:: chimesdkmeetings

API Version:: 2021-07-15

Defined in:: (unknown)

Overview

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

Service Description

The Amazon Chime SDK meetings APIs in this section allow software developers to create Amazon Chime SDK meetings, set the AWS Regions for meetings, create and manage users, and send and receive meeting notifications. For more information about the meeting APIs, see Amazon Chime SDK meetings.

Sending a Request Using ChimeSDKMeetings

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

var chimesdkmeetings = new AWS.ChimeSDKMeetings({apiVersion: '2021-07-15'});

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

AWS.config.apiVersions = {
  chimesdkmeetings: '2021-07-15',
  // other service API versions
};

var chimesdkmeetings = new AWS.ChimeSDKMeetings();

Version:

2021-07-15

Constructor Summary collapse

new AWS.ChimeSDKMeetings(options = {}) ⇒ Object constructor
Constructs a service object.

Property Summary collapse

endpoint ⇒ AWS.Endpoint readwrite
An Endpoint object representing the endpoint URL for service requests.

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

batchCreateAttendee(params = {}, callback) ⇒ AWS.Request
Creates a group of meeting attendees.

.
createAttendee(params = {}, callback) ⇒ AWS.Request
Creates a new attendee for an active Amazon Chime SDK meeting.
createMeeting(params = {}, callback) ⇒ AWS.Request
Creates a new Amazon Chime SDK meeting in the specified media Region with no initial attendees.
createMeetingWithAttendees(params = {}, callback) ⇒ AWS.Request
Creates a new Amazon Chime SDK meeting in the specified media Region, with attendees.
deleteAttendee(params = {}, callback) ⇒ AWS.Request
Deletes an attendee from the specified Amazon Chime SDK meeting and deletes their JoinToken.
deleteMeeting(params = {}, callback) ⇒ AWS.Request
Deletes the specified Amazon Chime SDK meeting.
getAttendee(params = {}, callback) ⇒ AWS.Request
Gets the Amazon Chime SDK attendee details for a specified meeting ID and attendee ID.
getMeeting(params = {}, callback) ⇒ AWS.Request
Gets the Amazon Chime SDK meeting details for the specified meeting ID.
listAttendees(params = {}, callback) ⇒ AWS.Request
Lists the attendees for the specified Amazon Chime SDK meeting.
startMeetingTranscription(params = {}, callback) ⇒ AWS.Request
Starts transcription for the specified meetingId.

.
stopMeetingTranscription(params = {}, callback) ⇒ AWS.Request
Stops transcription for the specified meetingId.

.

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.ChimeSDKMeetings(options = {}) ⇒ `Object`

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

Examples:

Constructing a ChimeSDKMeetings object

var chimesdkmeetings = new AWS.ChimeSDKMeetings({apiVersion: '2021-07-15'});

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.ChimeSDKMeetings.region for more information.
maxRetries (Integer) —
the maximum amount of retries to attempt with a request. See AWS.ChimeSDKMeetings.maxRetries for more information.
maxRedirects (Integer) —
the maximum amount of redirects to follow with a request. See AWS.ChimeSDKMeetings.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

endpoint ⇒ `AWS.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

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

Creates a group of meeting attendees.

Service Reference:

BatchCreateAttendee

Examples:

Calling the batchCreateAttendee operation

var params = {
  Attendees: [ /* required */
    {
      ExternalUserId: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  MeetingId: 'STRING_VALUE' /* required */
};
chimesdkmeetings.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 ID of the meeting to which you're adding attendees.
- Attendees — (Array<map>)
  The attendee information, including attendees' IDs and join tokens.
  - ExternalUserId — required — (String)
    The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder 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:
  - 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.

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:

CreateAttendee

Examples:

Calling the createAttendee operation

var params = {
  ExternalUserId: 'STRING_VALUE', /* required */
  MeetingId: 'STRING_VALUE' /* required */
};
chimesdkmeetings.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 unique ID of the meeting.
- ExternalUserId — (String)
  The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder 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:
  - 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.

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:

CreateMeeting

Examples:

Calling the createMeeting operation

var params = {
  ClientRequestToken: 'STRING_VALUE', /* required */
  ExternalMeetingId: 'STRING_VALUE', /* required */
  MediaRegion: 'STRING_VALUE', /* required */
  MeetingHostId: 'STRING_VALUE',
  NotificationsConfiguration: {
    LambdaFunctionArn: 'STRING_VALUE',
    SnsTopicArn: 'STRING_VALUE',
    SqsQueueArn: 'STRING_VALUE'
  }
};
chimesdkmeetings.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.
- MediaRegion — (String)
  The Region in which to 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 .
- MeetingHostId — (String)
  Reserved.
- ExternalMeetingId — (String)
  The external meeting ID.
- NotificationsConfiguration — (map)
  The configuration for resource targets to receive notifications when meeting and attendee events occur.
  - LambdaFunctionArn — (String)
    The ARN of the AWS Lambda function in the notifications configuration.
  - SnsTopicArn — (String)
    The ARN of the SNS topic.
  - SqsQueueArn — (String)
    The ARN of the SQS queue.

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.
    
    MeetingHostId — (String)
    Reserved.
    
    ExternalMeetingId — (String)
    The external meeting ID.
    
    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.
    
    MediaPlacement — (map)
    The media placement for the meeting.
    
    AudioHostUrl — (String)
    The audio host URL.
    
    AudioFallbackUrl — (String)
    The audio fallback URL.
    
    SignalingUrl — (String)
    The signaling URL.
    
    TurnControlUrl — (String)
    The turn control URL.
    
    ScreenDataUrl — (String)
    The screen data URL.
    
    ScreenViewingUrl — (String)
    The screen viewing URL.
    
    ScreenSharingUrl — (String)
    The screen sharing URL.
    
    EventIngestionUrl — (String)
    The event ingestion URL.

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:

CreateMeetingWithAttendees

Examples:

Calling the createMeetingWithAttendees operation

var params = {
  Attendees: [ /* required */
    {
      ExternalUserId: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  ClientRequestToken: 'STRING_VALUE', /* required */
  ExternalMeetingId: 'STRING_VALUE', /* required */
  MediaRegion: 'STRING_VALUE', /* required */
  MeetingHostId: 'STRING_VALUE',
  NotificationsConfiguration: {
    LambdaFunctionArn: 'STRING_VALUE',
    SnsTopicArn: 'STRING_VALUE',
    SqsQueueArn: 'STRING_VALUE'
  }
};
chimesdkmeetings.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.
- MediaRegion — (String)
  The Region in which to create the meeting.
- MeetingHostId — (String)
  Reserved.
- ExternalMeetingId — (String)
  The external meeting ID.
- NotificationsConfiguration — (map)
  The configuration for resource targets to receive notifications when meeting and attendee events occur.
  - LambdaFunctionArn — (String)
    The ARN of the AWS Lambda function in the notifications configuration.
  - SnsTopicArn — (String)
    The ARN of the SNS topic.
  - SqsQueueArn — (String)
    The ARN of the SQS queue.
- Attendees — (Array<map>)
  The attendee information, including attendees' IDs and join tokens.
  - ExternalUserId — required — (String)
    The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder 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:
  - Meeting — (map)
    The meeting information, including the meeting ID and MediaPlacement.
    
    MeetingId — (String)
    The Amazon Chime SDK meeting ID.
    
    MeetingHostId — (String)
    Reserved.
    
    ExternalMeetingId — (String)
    The external meeting ID.
    
    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.
    
    MediaPlacement — (map)
    The media placement for the meeting.
    
    AudioHostUrl — (String)
    The audio host URL.
    
    AudioFallbackUrl — (String)
    The audio fallback URL.
    
    SignalingUrl — (String)
    The signaling URL.
    
    TurnControlUrl — (String)
    The turn control URL.
    
    ScreenDataUrl — (String)
    The screen data URL.
    
    ScreenViewingUrl — (String)
    The screen viewing URL.
    
    ScreenSharingUrl — (String)
    The screen sharing URL.
    
    EventIngestionUrl — (String)
    The event ingestion URL.
  - 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.

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:

DeleteAttendee

Examples:

Calling the deleteAttendee operation

var params = {
  AttendeeId: 'STRING_VALUE', /* required */
  MeetingId: 'STRING_VALUE' /* required */
};
chimesdkmeetings.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.

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

Deletes the specified Amazon Chime SDK meeting. The operation deletes all attendees, disconnects all clients, and prevents new clients from joining the meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.

Service Reference:

DeleteMeeting

Examples:

Calling the deleteMeeting operation

var params = {
  MeetingId: 'STRING_VALUE' /* required */
};
chimesdkmeetings.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.

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:

GetAttendee

Examples:

Calling the getAttendee operation

var params = {
  AttendeeId: 'STRING_VALUE', /* required */
  MeetingId: 'STRING_VALUE' /* required */
};
chimesdkmeetings.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.

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:

GetMeeting

Examples:

Calling the getMeeting operation

var params = {
  MeetingId: 'STRING_VALUE' /* required */
};
chimesdkmeetings.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.
    
    MeetingHostId — (String)
    Reserved.
    
    ExternalMeetingId — (String)
    The external meeting ID.
    
    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.
    
    MediaPlacement — (map)
    The media placement for the meeting.
    
    AudioHostUrl — (String)
    The audio host URL.
    
    AudioFallbackUrl — (String)
    The audio fallback URL.
    
    SignalingUrl — (String)
    The signaling URL.
    
    TurnControlUrl — (String)
    The turn control URL.
    
    ScreenDataUrl — (String)
    The screen data URL.
    
    ScreenViewingUrl — (String)
    The screen viewing URL.
    
    ScreenSharingUrl — (String)
    The screen sharing URL.
    
    EventIngestionUrl — (String)
    The event ingestion URL.

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:

ListAttendees

Examples:

Calling the listAttendees operation

var params = {
  MeetingId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
chimesdkmeetings.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.

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

Starts transcription for the specified meetingId.

Service Reference:

StartMeetingTranscription

Examples:

Calling the startMeetingTranscription operation

var params = {
  MeetingId: 'STRING_VALUE', /* required */
  TranscriptionConfiguration: { /* required */
    EngineTranscribeMedicalSettings: {
      LanguageCode: en-US, /* required */
      Specialty: PRIMARYCARE | CARDIOLOGY | NEUROLOGY | ONCOLOGY | RADIOLOGY | UROLOGY, /* required */
      Type: CONVERSATION | DICTATION, /* required */
      Region: us-east-1 | us-east-2 | us-west-2 | ap-southeast-2 | ca-central-1 | eu-west-1 | auto,
      VocabularyName: 'STRING_VALUE'
    },
    EngineTranscribeSettings: {
      LanguageCode: en-US | en-GB | es-US | fr-CA | fr-FR | en-AU | it-IT | de-DE | pt-BR | ja-JP | ko-KR | zh-CN, /* required */
      Region: us-east-2 | us-east-1 | us-west-2 | ap-northeast-2 | ap-southeast-2 | ap-northeast-1 | ca-central-1 | eu-central-1 | eu-west-1 | eu-west-2 | sa-east-1 | auto,
      VocabularyFilterMethod: remove | mask | tag,
      VocabularyFilterName: 'STRING_VALUE',
      VocabularyName: 'STRING_VALUE'
    }
  }
};
chimesdkmeetings.startMeetingTranscription(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 unique ID of the meeting being transcribed.
- TranscriptionConfiguration — (map)
  The configuration for the current transcription operation. Must contain EngineTranscribeSettings or EngineTranscribeMedicalSettings.
  - EngineTranscribeSettings — (map)
    The transcription configuration settings passed to Amazon Transcribe.
    - LanguageCode — required — (String)
      The language code specified for the Amazon Transcribe engine.
      Possible values include:
      
      "en-US"
      
      "en-GB"
      
      "es-US"
      
      "fr-CA"
      
      "fr-FR"
      
      "en-AU"
      
      "it-IT"
      
      "de-DE"
      
      "pt-BR"
      
      "ja-JP"
      
      "ko-KR"
      
      "zh-CN"
    - VocabularyFilterMethod — (String)
      The filtering method passed to Amazon Transcribe.
      Possible values include:
      
      "remove"
      
      "mask"
      
      "tag"
    - VocabularyFilterName — (String)
      The name of the vocabulary filter passed to Amazon Transcribe.
    - VocabularyName — (String)
      The name of the vocabulary passed to Amazon Transcribe.
    - Region — (String)
      The AWS Region passed to Amazon Transcribe. If you don't specify a Region, Amazon Chime uses the meeting's Region.
      Possible values include:
      
      "us-east-2"
      
      "us-east-1"
      
      "us-west-2"
      
      "ap-northeast-2"
      
      "ap-southeast-2"
      
      "ap-northeast-1"
      
      "ca-central-1"
      
      "eu-central-1"
      
      "eu-west-1"
      
      "eu-west-2"
      
      "sa-east-1"
      
      "auto"
  - EngineTranscribeMedicalSettings — (map)
    The transcription configuration settings passed to Amazon Transcribe Medical.
    - LanguageCode — required — (String)
      The language code specified for the Amazon Transcribe Medical engine.
      Possible values include:
      
      "en-US"
    - Specialty — required — (String)
      The specialty specified for the Amazon Transcribe Medical engine.
      Possible values include:
      
      "PRIMARYCARE"
      
      "CARDIOLOGY"
      
      "NEUROLOGY"
      
      "ONCOLOGY"
      
      "RADIOLOGY"
      
      "UROLOGY"
    - Type — required — (String)
      The type of transcription.
      Possible values include:
      
      "CONVERSATION"
      
      "DICTATION"
    - VocabularyName — (String)
      The name of the vocabulary passed to Amazon Transcribe Medical.
    - Region — (String)
      The AWS Region passed to Amazon Transcribe Medical. If you don't specify a Region, Amazon Chime uses the meeting's Region.
      Possible values include:
      
      "us-east-1"
      
      "us-east-2"
      
      "us-west-2"
      
      "ap-southeast-2"
      
      "ca-central-1"
      
      "eu-west-1"
      
      "auto"

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.

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

Stops transcription for the specified meetingId.

Service Reference:

StopMeetingTranscription

Examples:

Calling the stopMeetingTranscription operation

var params = {
  MeetingId: 'STRING_VALUE' /* required */
};
chimesdkmeetings.stopMeetingTranscription(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 unique ID of the meeting for which you stop transcription.

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.

Class: AWS.ChimeSDKMeetings

Overview

Service Description

Sending a Request Using ChimeSDKMeetings

Locking the API Version

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

Method Summary collapse

Methods inherited from AWS.Service

Constructor Details

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

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Method Details

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

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

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

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

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

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

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

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

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

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

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

new AWS.ChimeSDKMeetings(options = {}) ⇒ `Object`

endpoint ⇒ `AWS.Endpoint` (readwrite)

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

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

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

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

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

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

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

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

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

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

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