We announced the upcoming end-of-support for AWS SDK for JavaScript v2.
We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Class: AWS.ChimeSDKMeetings

Inherits:
AWS.Service 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 Amazon Web Services 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

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

  • useFipsEndpoint (Boolean)

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean)

    Enables IPv6 dualstack endpoint. Defaults to false.

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

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

Creates up to 100 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 */
      Capabilities: {
        Audio: SendReceive | Send | Receive | None, /* required */
        Content: SendReceive | Send | Receive | None, /* required */
        Video: SendReceive | Send | Receive | None /* 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.

      • ExternalUserIdrequired — (String)

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

        Pattern: [-_&@+=,(){}[]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*

        Values that begin with aws: are reserved. You can't configure a value that uses this prefix. Case insensitive.

      • Capabilities — (map)

        A list of one or more capabilities.

        • Audiorequired — (String)

          The audio capability assigned to an attendee.

          Possible values include:
          • "SendReceive"
          • "Send"
          • "Receive"
          • "None"
        • Videorequired — (String)

          The video capability assigned to an attendee.

          Possible values include:
          • "SendReceive"
          • "Send"
          • "Receive"
          • "None"
        • Contentrequired — (String)

          The content capability assigned to an attendee.

          Possible values include:
          • "SendReceive"
          • "Send"
          • "Receive"
          • "None"

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

      the error object returned from the request. Set to 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.

          Pattern: [-_&@+=,(){}[]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*

          Values that begin with aws: are reserved. You can't configure a value that uses this prefix. Case insensitive.

        • AttendeeId — (String)

          The Amazon Chime SDK attendee ID.

        • JoinToken — (String)

          The join token used by the Amazon Chime SDK attendee.

        • Capabilities — (map)

          The capabilities assigned to an attendee: audio, video, or content.

          Note: You use the capabilities with a set of values that control what the capabilities can do, such as SendReceive data. For more information about those values, see .

          When using capabilities, be aware of these corner cases:

          • If you specify MeetingFeatures:Video:MaxResolution:None when you create a meeting, all API requests that include SendReceive, Send, or Receive for AttendeeCapabilities:Video will be rejected with ValidationError 400.

          • If you specify MeetingFeatures:Content:MaxResolution:None when you create a meeting, all API requests that include SendReceive, Send, or Receive for AttendeeCapabilities:Content will be rejected with ValidationError 400.

          • You can't set content capabilities to SendReceive or Receive unless you also set video capabilities to SendReceive or Receive. If you don't set the video capability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set your video capability to receive and you set your content capability to not receive.

          • When you change an audio capability from None or Receive to Send or SendReceive , and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants.

          • When you change a video or content capability from None or Receive to Send or SendReceive , and if the attendee turned on their video or content streams, remote attendees can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.

          • Audiorequired — (String)

            The audio capability assigned to an attendee.

            Possible values include:
            • "SendReceive"
            • "Send"
            • "Receive"
            • "None"
          • Videorequired — (String)

            The video capability assigned to an attendee.

            Possible values include:
            • "SendReceive"
            • "Send"
            • "Receive"
            • "None"
          • Contentrequired — (String)

            The content capability assigned to an attendee.

            Possible values include:
            • "SendReceive"
            • "Send"
            • "Receive"
            • "None"
      • 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.

          Pattern: [-_&@+=,(){}[]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*

          Values that begin with aws: are reserved. You can't configure a value that uses this prefix. Case insensitive.

        • ErrorCode — (String)

          The error code.

        • ErrorMessage — (String)

          The error message.

Returns:

  • (AWS.Request)

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

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

Updates AttendeeCapabilities except the capabilities listed in an ExcludedAttendeeIds table.

Note: You use the capabilities with a set of values that control what the capabilities can do, such as SendReceive data. For more information about those values, see .

When using capabilities, be aware of these corner cases:

  • If you specify MeetingFeatures:Video:MaxResolution:None when you create a meeting, all API requests that include SendReceive, Send, or Receive for AttendeeCapabilities:Video will be rejected with ValidationError 400.

  • If you specify MeetingFeatures:Content:MaxResolution:None when you create a meeting, all API requests that include SendReceive, Send, or Receive for AttendeeCapabilities:Content will be rejected with ValidationError 400.

  • You can't set content capabilities to SendReceive or Receive unless you also set video capabilities to SendReceive or Receive. If you don't set the video capability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set your video capability to receive and you set your content capability to not receive.

  • When you change an audio capability from None or Receive to Send or SendReceive , and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants.

  • When you change a video or content capability from None or Receive to Send or SendReceive , and if the attendee turned on their video or content streams, remote attendees can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.

Examples:

Calling the batchUpdateAttendeeCapabilitiesExcept operation

var params = {
  Capabilities: { /* required */
    Audio: SendReceive | Send | Receive | None, /* required */
    Content: SendReceive | Send | Receive | None, /* required */
    Video: SendReceive | Send | Receive | None /* required */
  },
  ExcludedAttendeeIds: [ /* required */
    {
      AttendeeId: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  MeetingId: 'STRING_VALUE' /* required */
};
chimesdkmeetings.batchUpdateAttendeeCapabilitiesExcept(params, 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 ID of the meeting associated with the update request.

    • ExcludedAttendeeIds — (Array<map>)

      The AttendeeIDs that you want to exclude from one or more capabilities.

      • AttendeeIdrequired — (String)

        A list of one or more attendee IDs.

    • Capabilities — (map)

      The capabilities (audio, video, or content) that you want to update.

      • Audiorequired — (String)

        The audio capability assigned to an attendee.

        Possible values include:
        • "SendReceive"
        • "Send"
        • "Receive"
        • "None"
      • Videorequired — (String)

        The video capability assigned to an attendee.

        Possible values include:
        • "SendReceive"
        • "Send"
        • "Receive"
        • "None"
      • Contentrequired — (String)

        The content capability assigned to an attendee.

        Possible values include:
        • "SendReceive"
        • "Send"
        • "Receive"
        • "None"

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

      the error object returned from the request. Set to 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.

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 */
  Capabilities: {
    Audio: SendReceive | Send | Receive | None, /* required */
    Content: SendReceive | Send | Receive | None, /* required */
    Video: SendReceive | Send | Receive | None /* 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.

      Pattern: [-_&@+=,(){}[]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*

      Values that begin with aws: are reserved. You can't configure a value that uses this prefix.

    • Capabilities — (map)

      The capabilities (audio, video, or content) that you want to grant an attendee. If you don't specify capabilities, all users have send and receive capabilities on all media channels by default.

      Note: You use the capabilities with a set of values that control what the capabilities can do, such as SendReceive data. For more information about those values, see .

      When using capabilities, be aware of these corner cases:

      • If you specify MeetingFeatures:Video:MaxResolution:None when you create a meeting, all API requests that include SendReceive, Send, or Receive for AttendeeCapabilities:Video will be rejected with ValidationError 400.

      • If you specify MeetingFeatures:Content:MaxResolution:None when you create a meeting, all API requests that include SendReceive, Send, or Receive for AttendeeCapabilities:Content will be rejected with ValidationError 400.

      • You can't set content capabilities to SendReceive or Receive unless you also set video capabilities to SendReceive or Receive. If you don't set the video capability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set your video capability to receive and you set your content capability to not receive.

      • When you change an audio capability from None or Receive to Send or SendReceive , and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants.

      • When you change a video or content capability from None or Receive to Send or SendReceive , and if the attendee turned on their video or content streams, remote attendees can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.

      • Audiorequired — (String)

        The audio capability assigned to an attendee.

        Possible values include:
        • "SendReceive"
        • "Send"
        • "Receive"
        • "None"
      • Videorequired — (String)

        The video capability assigned to an attendee.

        Possible values include:
        • "SendReceive"
        • "Send"
        • "Receive"
        • "None"
      • Contentrequired — (String)

        The content capability assigned to an attendee.

        Possible values include:
        • "SendReceive"
        • "Send"
        • "Receive"
        • "None"

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

      the error object returned from the request. Set to 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.

          Pattern: [-_&@+=,(){}[]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*

          Values that begin with aws: are reserved. You can't configure a value that uses this prefix. Case insensitive.

        • AttendeeId — (String)

          The Amazon Chime SDK attendee ID.

        • JoinToken — (String)

          The join token used by the Amazon Chime SDK attendee.

        • Capabilities — (map)

          The capabilities assigned to an attendee: audio, video, or content.

          Note: You use the capabilities with a set of values that control what the capabilities can do, such as SendReceive data. For more information about those values, see .

          When using capabilities, be aware of these corner cases:

          • If you specify MeetingFeatures:Video:MaxResolution:None when you create a meeting, all API requests that include SendReceive, Send, or Receive for AttendeeCapabilities:Video will be rejected with ValidationError 400.

          • If you specify MeetingFeatures:Content:MaxResolution:None when you create a meeting, all API requests that include SendReceive, Send, or Receive for AttendeeCapabilities:Content will be rejected with ValidationError 400.

          • You can't set content capabilities to SendReceive or Receive unless you also set video capabilities to SendReceive or Receive. If you don't set the video capability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set your video capability to receive and you set your content capability to not receive.

          • When you change an audio capability from None or Receive to Send or SendReceive , and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants.

          • When you change a video or content capability from None or Receive to Send or SendReceive , and if the attendee turned on their video or content streams, remote attendees can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.

          • Audiorequired — (String)

            The audio capability assigned to an attendee.

            Possible values include:
            • "SendReceive"
            • "Send"
            • "Receive"
            • "None"
          • Videorequired — (String)

            The video capability assigned to an attendee.

            Possible values include:
            • "SendReceive"
            • "Send"
            • "Receive"
            • "None"
          • Contentrequired — (String)

            The content capability assigned to an attendee.

            Possible values include:
            • "SendReceive"
            • "Send"
            • "Receive"
            • "None"

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', /* required */
  MediaRegion: 'STRING_VALUE', /* required */
  MeetingFeatures: {
    Attendee: {
      MaxCount: 'NUMBER_VALUE'
    },
    Audio: {
      EchoReduction: AVAILABLE | UNAVAILABLE
    },
    Content: {
      MaxResolution: None | FHD | UHD
    },
    Video: {
      MaxResolution: None | HD | FHD
    }
  },
  MeetingHostId: 'STRING_VALUE',
  NotificationsConfiguration: {
    LambdaFunctionArn: 'STRING_VALUE',
    SnsTopicArn: 'STRING_VALUE',
    SqsQueueArn: 'STRING_VALUE'
  },
  PrimaryMeetingId: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  TenantIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
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.

      Available values in Amazon Web Services GovCloud (US) Regions: us-gov-east-1, us-gov-west-1.

    • MeetingHostId — (String)

      Reserved.

    • ExternalMeetingId — (String)

      The external meeting ID.

      Pattern: [-_&@+=,(){}[]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*

      Values that begin with aws: are reserved. You can't configure a value that uses this prefix. Case insensitive.

    • NotificationsConfiguration — (map)

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

      • LambdaFunctionArn — (String)

        The ARN of the Amazon Web Services Lambda function in the notifications configuration.

      • SnsTopicArn — (String)

        The ARN of the SNS topic.

      • SqsQueueArn — (String)

        The ARN of the SQS queue.

    • MeetingFeatures — (map)

      Lists the audio and video features enabled for a meeting, such as echo reduction.

      • Audio — (map)

        The configuration settings for the audio features available to a meeting.

        • EchoReduction — (String)

          Makes echo reduction available to clients who connect to the meeting.

          Possible values include:
          • "AVAILABLE"
          • "UNAVAILABLE"
      • Video — (map)

        The configuration settings for the video features available to a meeting.

        • MaxResolution — (String)

          The maximum video resolution for the meeting. Applies to all attendees.

          Note: Defaults to HD. To use FHD, you must also provide a MeetingFeatures:Attendee:MaxCount value and override the default size limit of 250 attendees.
          Possible values include:
          • "None"
          • "HD"
          • "FHD"
      • Content — (map)

        The configuration settings for the content features available to a meeting.

        • MaxResolution — (String)

          The maximum resolution for the meeting content.

          Note: Defaults to FHD. To use UHD, you must also provide a MeetingFeatures:Attendee:MaxCount value and override the default size limit of 250 attendees.
          Possible values include:
          • "None"
          • "FHD"
          • "UHD"
      • Attendee — (map)

        The configuration settings for the attendee features available to a meeting.

        • MaxCount — (Integer)

          The maximum number of attendees allowed into the meeting.

    • PrimaryMeetingId — (String)

      When specified, replicates the media from the primary meeting to the new meeting.

    • TenantIds — (Array<String>)

      A consistent and opaque identifier, created and maintained by the builder to represent a segment of their users.

    • Tags — (Array<map>)

      Applies one or more tags to an Amazon Chime SDK meeting. Note the following:

      • Not all resources have tags. For a list of services with resources that support tagging using this operation, see Services that support the Resource Groups Tagging API. If the resource doesn't yet support this operation, the resource's service might support tagging using its own API operations. For more information, refer to the documentation for that service.

      • Each resource can have up to 50 tags. For other limits, see Tag Naming and Usage Conventions in the AWS General Reference.

      • You can only tag resources that are located in the specified Amazon Web Services Region for the Amazon Web Services account.

      • To add tags to a resource, you need the necessary permissions for the service that the resource belongs to as well as permissions for adding tags. For more information, see the documentation for each service.

      Do not store personally identifiable information (PII) or other confidential or sensitive information in tags. We use tags to provide you with billing and administration services. Tags are not intended to be used for private or sensitive data.

      Minimum permissions

      In addition to the tag:TagResources permission required by this operation, you must also have the tagging permission defined by the service that created the resource. For example, to tag a ChimeSDKMeetings instance using the TagResources operation, you must have both of the following permissions:

      tag:TagResources

      ChimeSDKMeetings:CreateTags

      Note: Some services might have specific requirements for tagging some resources. For example, to tag an Amazon S3 bucket, you must also have the s3:GetBucketTagging permission. If the expected minimum permissions don't work, check the documentation for that service's tagging APIs for more information.
      • Keyrequired — (String)

        The tag's key.

      • Valuerequired — (String)

        The tag's value.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

      the error object returned from the request. Set to 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.

          Pattern: [-_&@+=,(){}[]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*

          Values that begin with aws: are reserved. You can't configure a value that uses this prefix. Case insensitive.

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

          Available values in Amazon Web Services GovCloud (US) Regions: us-gov-east-1, us-gov-west-1.

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

            This parameter is deprecated and no longer used by the Amazon Chime SDK.

          • ScreenDataUrl — (String)

            The screen data URL.

            This parameter is deprecated and no longer used by the Amazon Chime SDK.

          • ScreenViewingUrl — (String)

            The screen viewing URL.

            This parameter is deprecated and no longer used by the Amazon Chime SDK.

          • ScreenSharingUrl — (String)

            The screen sharing URL.

            This parameter is deprecated and no longer used by the Amazon Chime SDK.

          • EventIngestionUrl — (String)

            The event ingestion URL.

        • MeetingFeatures — (map)

          The features available to a meeting, such as echo reduction.

          • Audio — (map)

            The configuration settings for the audio features available to a meeting.

            • EchoReduction — (String)

              Makes echo reduction available to clients who connect to the meeting.

              Possible values include:
              • "AVAILABLE"
              • "UNAVAILABLE"
          • Video — (map)

            The configuration settings for the video features available to a meeting.

            • MaxResolution — (String)

              The maximum video resolution for the meeting. Applies to all attendees.

              Note: Defaults to HD. To use FHD, you must also provide a MeetingFeatures:Attendee:MaxCount value and override the default size limit of 250 attendees.
              Possible values include:
              • "None"
              • "HD"
              • "FHD"
          • Content — (map)

            The configuration settings for the content features available to a meeting.

            • MaxResolution — (String)

              The maximum resolution for the meeting content.

              Note: Defaults to FHD. To use UHD, you must also provide a MeetingFeatures:Attendee:MaxCount value and override the default size limit of 250 attendees.
              Possible values include:
              • "None"
              • "FHD"
              • "UHD"
          • Attendee — (map)

            The configuration settings for the attendee features available to a meeting.

            • MaxCount — (Integer)

              The maximum number of attendees allowed into the meeting.

        • PrimaryMeetingId — (String)

          When specified, replicates the media from the primary meeting to this meeting.

        • TenantIds — (Array<String>)

          Array of strings.

        • MeetingArn — (String)

          The ARN of the meeting.

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 = {
  Attendees: [ /* required */
    {
      ExternalUserId: 'STRING_VALUE', /* required */
      Capabilities: {
        Audio: SendReceive | Send | Receive | None, /* required */
        Content: SendReceive | Send | Receive | None, /* required */
        Video: SendReceive | Send | Receive | None /* required */
      }
    },
    /* more items */
  ],
  ClientRequestToken: 'STRING_VALUE', /* required */
  ExternalMeetingId: 'STRING_VALUE', /* required */
  MediaRegion: 'STRING_VALUE', /* required */
  MeetingFeatures: {
    Attendee: {
      MaxCount: 'NUMBER_VALUE'
    },
    Audio: {
      EchoReduction: AVAILABLE | UNAVAILABLE
    },
    Content: {
      MaxResolution: None | FHD | UHD
    },
    Video: {
      MaxResolution: None | HD | FHD
    }
  },
  MeetingHostId: 'STRING_VALUE',
  NotificationsConfiguration: {
    LambdaFunctionArn: 'STRING_VALUE',
    SnsTopicArn: 'STRING_VALUE',
    SqsQueueArn: 'STRING_VALUE'
  },
  PrimaryMeetingId: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  TenantIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
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.

      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.

      Available values in Amazon Web Services GovCloud (US) Regions: us-gov-east-1, us-gov-west-1.

    • MeetingHostId — (String)

      Reserved.

    • ExternalMeetingId — (String)

      The external meeting ID.

      Pattern: [-_&@+=,(){}[]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*

      Values that begin with aws: are reserved. You can't configure a value that uses this prefix. Case insensitive.

    • MeetingFeatures — (map)

      Lists the audio and video features enabled for a meeting, such as echo reduction.

      • Audio — (map)

        The configuration settings for the audio features available to a meeting.

        • EchoReduction — (String)

          Makes echo reduction available to clients who connect to the meeting.

          Possible values include:
          • "AVAILABLE"
          • "UNAVAILABLE"
      • Video — (map)

        The configuration settings for the video features available to a meeting.

        • MaxResolution — (String)

          The maximum video resolution for the meeting. Applies to all attendees.

          Note: Defaults to HD. To use FHD, you must also provide a MeetingFeatures:Attendee:MaxCount value and override the default size limit of 250 attendees.
          Possible values include:
          • "None"
          • "HD"
          • "FHD"
      • Content — (map)

        The configuration settings for the content features available to a meeting.

        • MaxResolution — (String)

          The maximum resolution for the meeting content.

          Note: Defaults to FHD. To use UHD, you must also provide a MeetingFeatures:Attendee:MaxCount value and override the default size limit of 250 attendees.
          Possible values include:
          • "None"
          • "FHD"
          • "UHD"
      • Attendee — (map)

        The configuration settings for the attendee features available to a meeting.

        • MaxCount — (Integer)

          The maximum number of attendees allowed into the meeting.

    • NotificationsConfiguration — (map)

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

      • LambdaFunctionArn — (String)

        The ARN of the Amazon Web Services 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.

      • ExternalUserIdrequired — (String)

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

        Pattern: [-_&@+=,(){}[]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*

        Values that begin with aws: are reserved. You can't configure a value that uses this prefix. Case insensitive.

      • Capabilities — (map)

        A list of one or more capabilities.

        • Audiorequired — (String)

          The audio capability assigned to an attendee.

          Possible values include:
          • "SendReceive"
          • "Send"
          • "Receive"
          • "None"
        • Videorequired — (String)

          The video capability assigned to an attendee.

          Possible values include:
          • "SendReceive"
          • "Send"
          • "Receive"
          • "None"
        • Contentrequired — (String)

          The content capability assigned to an attendee.

          Possible values include:
          • "SendReceive"
          • "Send"
          • "Receive"
          • "None"
    • PrimaryMeetingId — (String)

      When specified, replicates the media from the primary meeting to the new meeting.

    • TenantIds — (Array<String>)

      A consistent and opaque identifier, created and maintained by the builder to represent a segment of their users.

    • Tags — (Array<map>)

      The tags in the request.

      • Keyrequired — (String)

        The tag's key.

      • Valuerequired — (String)

        The tag's value.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

      the error object returned from the request. Set to 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.

          Pattern: [-_&@+=,(){}[]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*

          Values that begin with aws: are reserved. You can't configure a value that uses this prefix. Case insensitive.

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

          Available values in Amazon Web Services GovCloud (US) Regions: us-gov-east-1, us-gov-west-1.

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

            This parameter is deprecated and no longer used by the Amazon Chime SDK.

          • ScreenDataUrl — (String)

            The screen data URL.

            This parameter is deprecated and no longer used by the Amazon Chime SDK.

          • ScreenViewingUrl — (String)

            The screen viewing URL.

            This parameter is deprecated and no longer used by the Amazon Chime SDK.

          • ScreenSharingUrl — (String)

            The screen sharing URL.

            This parameter is deprecated and no longer used by the Amazon Chime SDK.

          • EventIngestionUrl — (String)

            The event ingestion URL.

        • MeetingFeatures — (map)

          The features available to a meeting, such as echo reduction.

          • Audio — (map)

            The configuration settings for the audio features available to a meeting.

            • EchoReduction — (String)

              Makes echo reduction available to clients who connect to the meeting.

              Possible values include:
              • "AVAILABLE"
              • "UNAVAILABLE"
          • Video — (map)

            The configuration settings for the video features available to a meeting.

            • MaxResolution — (String)

              The maximum video resolution for the meeting. Applies to all attendees.

              Note: Defaults to HD. To use FHD, you must also provide a MeetingFeatures:Attendee:MaxCount value and override the default size limit of 250 attendees.
              Possible values include:
              • "None"
              • "HD"
              • "FHD"
          • Content — (map)

            The configuration settings for the content features available to a meeting.

            • MaxResolution — (String)

              The maximum resolution for the meeting content.

              Note: Defaults to FHD. To use UHD, you must also provide a MeetingFeatures:Attendee:MaxCount value and override the default size limit of 250 attendees.
              Possible values include:
              • "None"
              • "FHD"
              • "UHD"
          • Attendee — (map)

            The configuration settings for the attendee features available to a meeting.

            • MaxCount — (Integer)

              The maximum number of attendees allowed into the meeting.

        • PrimaryMeetingId — (String)

          When specified, replicates the media from the primary meeting to this meeting.

        • TenantIds — (Array<String>)

          Array of strings.

        • MeetingArn — (String)

          The ARN of the meeting.

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

          Pattern: [-_&@+=,(){}[]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*

          Values that begin with aws: are reserved. You can't configure a value that uses this prefix. Case insensitive.

        • AttendeeId — (String)

          The Amazon Chime SDK attendee ID.

        • JoinToken — (String)

          The join token used by the Amazon Chime SDK attendee.

        • Capabilities — (map)

          The capabilities assigned to an attendee: audio, video, or content.

          Note: You use the capabilities with a set of values that control what the capabilities can do, such as SendReceive data. For more information about those values, see .

          When using capabilities, be aware of these corner cases:

          • If you specify MeetingFeatures:Video:MaxResolution:None when you create a meeting, all API requests that include SendReceive, Send, or Receive for AttendeeCapabilities:Video will be rejected with ValidationError 400.

          • If you specify MeetingFeatures:Content:MaxResolution:None when you create a meeting, all API requests that include SendReceive, Send, or Receive for AttendeeCapabilities:Content will be rejected with ValidationError 400.

          • You can't set content capabilities to SendReceive or Receive unless you also set video capabilities to SendReceive or Receive. If you don't set the video capability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set your video capability to receive and you set your content capability to not receive.

          • When you change an audio capability from None or Receive to Send or SendReceive , and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants.

          • When you change a video or content capability from None or Receive to Send or SendReceive , and if the attendee turned on their video or content streams, remote attendees can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.

          • Audiorequired — (String)

            The audio capability assigned to an attendee.

            Possible values include:
            • "SendReceive"
            • "Send"
            • "Receive"
            • "None"
          • Videorequired — (String)

            The video capability assigned to an attendee.

            Possible values include:
            • "SendReceive"
            • "Send"
            • "Receive"
            • "None"
          • Contentrequired — (String)

            The content capability assigned to an attendee.

            Possible values include:
            • "SendReceive"
            • "Send"
            • "Receive"
            • "None"
      • 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.

          Pattern: [-_&@+=,(){}[]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*

          Values that begin with aws: are reserved. You can't configure a value that uses this prefix. Case insensitive.

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

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:

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:

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.

          Pattern: [-_&@+=,(){}[]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*

          Values that begin with aws: are reserved. You can't configure a value that uses this prefix. Case insensitive.

        • AttendeeId — (String)

          The Amazon Chime SDK attendee ID.

        • JoinToken — (String)

          The join token used by the Amazon Chime SDK attendee.

        • Capabilities — (map)

          The capabilities assigned to an attendee: audio, video, or content.

          Note: You use the capabilities with a set of values that control what the capabilities can do, such as SendReceive data. For more information about those values, see .

          When using capabilities, be aware of these corner cases:

          • If you specify MeetingFeatures:Video:MaxResolution:None when you create a meeting, all API requests that include SendReceive, Send, or Receive for AttendeeCapabilities:Video will be rejected with ValidationError 400.

          • If you specify MeetingFeatures:Content:MaxResolution:None when you create a meeting, all API requests that include SendReceive, Send, or Receive for AttendeeCapabilities:Content will be rejected with ValidationError 400.

          • You can't set content capabilities to SendReceive or Receive unless you also set video capabilities to SendReceive or Receive. If you don't set the video capability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set your video capability to receive and you set your content capability to not receive.

          • When you change an audio capability from None or Receive to Send or SendReceive , and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants.

          • When you change a video or content capability from None or Receive to Send or SendReceive , and if the attendee turned on their video or content streams, remote attendees can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.

          • Audiorequired — (String)

            The audio capability assigned to an attendee.

            Possible values include:
            • "SendReceive"
            • "Send"
            • "Receive"
            • "None"
          • Videorequired — (String)

            The video capability assigned to an attendee.

            Possible values include:
            • "SendReceive"
            • "Send"
            • "Receive"
            • "None"
          • Contentrequired — (String)

            The content capability assigned to an attendee.

            Possible values include:
            • "SendReceive"
            • "Send"
            • "Receive"
            • "None"

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 */
};
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.

          Pattern: [-_&@+=,(){}[]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*

          Values that begin with aws: are reserved. You can't configure a value that uses this prefix. Case insensitive.

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

          Available values in Amazon Web Services GovCloud (US) Regions: us-gov-east-1, us-gov-west-1.

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

            This parameter is deprecated and no longer used by the Amazon Chime SDK.

          • ScreenDataUrl — (String)

            The screen data URL.

            This parameter is deprecated and no longer used by the Amazon Chime SDK.

          • ScreenViewingUrl — (String)

            The screen viewing URL.

            This parameter is deprecated and no longer used by the Amazon Chime SDK.

          • ScreenSharingUrl — (String)

            The screen sharing URL.

            This parameter is deprecated and no longer used by the Amazon Chime SDK.

          • EventIngestionUrl — (String)

            The event ingestion URL.

        • MeetingFeatures — (map)

          The features available to a meeting, such as echo reduction.

          • Audio — (map)

            The configuration settings for the audio features available to a meeting.

            • EchoReduction — (String)

              Makes echo reduction available to clients who connect to the meeting.

              Possible values include:
              • "AVAILABLE"
              • "UNAVAILABLE"
          • Video — (map)

            The configuration settings for the video features available to a meeting.

            • MaxResolution — (String)

              The maximum video resolution for the meeting. Applies to all attendees.

              Note: Defaults to HD. To use FHD, you must also provide a MeetingFeatures:Attendee:MaxCount value and override the default size limit of 250 attendees.
              Possible values include:
              • "None"
              • "HD"
              • "FHD"
          • Content — (map)

            The configuration settings for the content features available to a meeting.

            • MaxResolution — (String)

              The maximum resolution for the meeting content.

              Note: Defaults to FHD. To use UHD, you must also provide a MeetingFeatures:Attendee:MaxCount value and override the default size limit of 250 attendees.
              Possible values include:
              • "None"
              • "FHD"
              • "UHD"
          • Attendee — (map)

            The configuration settings for the attendee features available to a meeting.

            • MaxCount — (Integer)

              The maximum number of attendees allowed into the meeting.

        • PrimaryMeetingId — (String)

          When specified, replicates the media from the primary meeting to this meeting.

        • TenantIds — (Array<String>)

          Array of strings.

        • MeetingArn — (String)

          The ARN of the meeting.

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'
};
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.

          Pattern: [-_&@+=,(){}[]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*

          Values that begin with aws: are reserved. You can't configure a value that uses this prefix. Case insensitive.

        • AttendeeId — (String)

          The Amazon Chime SDK attendee ID.

        • JoinToken — (String)

          The join token used by the Amazon Chime SDK attendee.

        • Capabilities — (map)

          The capabilities assigned to an attendee: audio, video, or content.

          Note: You use the capabilities with a set of values that control what the capabilities can do, such as SendReceive data. For more information about those values, see .

          When using capabilities, be aware of these corner cases:

          • If you specify MeetingFeatures:Video:MaxResolution:None when you create a meeting, all API requests that include SendReceive, Send, or Receive for AttendeeCapabilities:Video will be rejected with ValidationError 400.

          • If you specify MeetingFeatures:Content:MaxResolution:None when you create a meeting, all API requests that include SendReceive, Send, or Receive for AttendeeCapabilities:Content will be rejected with ValidationError 400.

          • You can't set content capabilities to SendReceive or Receive unless you also set video capabilities to SendReceive or Receive. If you don't set the video capability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set your video capability to receive and you set your content capability to not receive.

          • When you change an audio capability from None or Receive to Send or SendReceive , and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants.

          • When you change a video or content capability from None or Receive to Send or SendReceive , and if the attendee turned on their video or content streams, remote attendees can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.

          • Audiorequired — (String)

            The audio capability assigned to an attendee.

            Possible values include:
            • "SendReceive"
            • "Send"
            • "Receive"
            • "None"
          • Videorequired — (String)

            The video capability assigned to an attendee.

            Possible values include:
            • "SendReceive"
            • "Send"
            • "Receive"
            • "None"
          • Contentrequired — (String)

            The content capability assigned to an attendee.

            Possible values include:
            • "SendReceive"
            • "Send"
            • "Receive"
            • "None"
      • 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

Returns a list of the tags available for the specified resource.

Service Reference:

Examples:

Calling the listTagsForResource operation

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

      • Tags — (Array<map>)

        The tags requested for the specified resource.

        • Keyrequired — (String)

          The tag's key.

        • Valuerequired — (String)

          The tag's value.

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. For more information, refer to Using Amazon Chime SDK live transcription in the Amazon Chime SDK Developer Guide.

If you specify an invalid configuration, a TranscriptFailed event will be sent with the contents of the BadRequestException generated by Amazon Transcribe. For more information on each parameter and which combinations are valid, refer to the StartStreamTranscription API in the Amazon Transcribe Developer Guide.

Note: By default, Amazon Transcribe may use and store audio content processed by the service to develop and improve Amazon Web Services AI/ML services as further described in section 50 of the Amazon Web Services Service Terms. Using Amazon Transcribe may be subject to federal and state laws or regulations regarding the recording or interception of electronic communications. It is your and your end users’ responsibility to comply with all applicable laws regarding the recording, including properly notifying all participants in a recorded session or communication that the session or communication is being recorded, and obtaining all necessary consents. You can opt out from Amazon Web Services using audio content to develop and improve AWS AI/ML services by configuring an AI services opt out policy using Amazon Web Services Organizations.

Service Reference:

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 */
      ContentIdentificationType: PHI,
      Region: us-east-1 | us-east-2 | us-west-2 | ap-southeast-2 | ca-central-1 | eu-west-1 | auto,
      VocabularyName: 'STRING_VALUE'
    },
    EngineTranscribeSettings: {
      ContentIdentificationType: PII,
      ContentRedactionType: PII,
      EnablePartialResultsStabilization: true || false,
      IdentifyLanguage: true || false,
      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 | th-TH | hi-IN,
      LanguageModelName: 'STRING_VALUE',
      LanguageOptions: 'STRING_VALUE',
      PartialResultsStability: low | medium | high,
      PiiEntityTypes: 'STRING_VALUE',
      PreferredLanguage: en-US | en-GB | es-US | fr-CA | fr-FR | en-AU | it-IT | de-DE | pt-BR | ja-JP | ko-KR | zh-CN | th-TH | hi-IN,
      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 | us-gov-west-1,
      VocabularyFilterMethod: remove | mask | tag,
      VocabularyFilterName: 'STRING_VALUE',
      VocabularyFilterNames: 'STRING_VALUE',
      VocabularyName: 'STRING_VALUE',
      VocabularyNames: '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 — (String)

          Specify the language code that represents the language spoken.

          If you're unsure of the language spoken in your audio, consider using IdentifyLanguage to enable automatic language identification.

          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"
          • "th-TH"
          • "hi-IN"
        • VocabularyFilterMethod — (String)

          Specify how you want your vocabulary filter applied to your transcript.

          To replace words with ***, choose mask.

          To delete words, choose remove.

          To flag words without changing them, choose tag.

          Possible values include:
          • "remove"
          • "mask"
          • "tag"
        • VocabularyFilterName — (String)

          Specify the name of the custom vocabulary filter that you want to use when processing your transcription. Note that vocabulary filter names are case sensitive.

          If you use Amazon Transcribe in multiple Regions, the vocabulary filter must be available in Amazon Transcribe in each Region.

          If you include IdentifyLanguage and want to use one or more vocabulary filters with your transcription, use the VocabularyFilterNames parameter instead.

        • VocabularyName — (String)

          Specify the name of the custom vocabulary that you want to use when processing your transcription. Note that vocabulary names are case sensitive.

          If you use Amazon Transcribe multiple Regions, the vocabulary must be available in Amazon Transcribe in each Region.

          If you include IdentifyLanguage and want to use one or more custom vocabularies with your transcription, use the VocabularyNames parameter instead.

        • Region — (String)

          The Amazon Web Services Region in which to use Amazon Transcribe.

          If you don't specify a Region, then the MediaRegion of the meeting is used. However, if Amazon Transcribe is not available in the MediaRegion, then a TranscriptFailed event is sent.

          Use auto to use Amazon Transcribe in a Region near the meeting’s MediaRegion. For more information, refer to Choosing a transcription Region in the Amazon Chime SDK Developer Guide.

          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"
          • "us-gov-west-1"
        • EnablePartialResultsStabilization — (Boolean)

          Enables partial result stabilization for your transcription. Partial result stabilization can reduce latency in your output, but may impact accuracy.

        • PartialResultsStability — (String)

          Specify the level of stability to use when you enable partial results stabilization (EnablePartialResultsStabilization).

          Low stability provides the highest accuracy. High stability transcribes faster, but with slightly lower accuracy.

          Possible values include:
          • "low"
          • "medium"
          • "high"
        • ContentIdentificationType — (String)

          Labels all personally identifiable information (PII) identified in your transcript. If you don't include PiiEntityTypes, all PII is identified.

          Note: You can’t set ContentIdentificationType and ContentRedactionType.
          Possible values include:
          • "PII"
        • ContentRedactionType — (String)

          Content redaction is performed at the segment level. If you don't include PiiEntityTypes, all PII is redacted.

          Note: You can’t set ContentRedactionType and ContentIdentificationType.
          Possible values include:
          • "PII"
        • PiiEntityTypes — (String)

          Specify which types of personally identifiable information (PII) you want to redact in your transcript. You can include as many types as you'd like, or you can select ALL.

          Values must be comma-separated and can include: ADDRESS, BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY CREDIT_DEBIT_NUMBER, EMAIL,NAME, PHONE, PIN, SSN, or ALL.

          Note that if you include PiiEntityTypes, you must also include ContentIdentificationType or ContentRedactionType.

          If you include ContentRedactionType or ContentIdentificationType, but do not include PiiEntityTypes, all PII is redacted or identified.

        • LanguageModelName — (String)

          Specify the name of the custom language model that you want to use when processing your transcription. Note that language model names are case sensitive.

          The language of the specified language model must match the language code. If the languages don't match, the custom language model isn't applied. There are no errors or warnings associated with a language mismatch.

          If you use Amazon Transcribe in multiple Regions, the custom language model must be available in Amazon Transcribe in each Region.

        • IdentifyLanguage — (Boolean)

          Enables automatic language identification for your transcription.

          If you include IdentifyLanguage, you can optionally use LanguageOptions to include a list of language codes that you think may be present in your audio stream. Including language options can improve transcription accuracy.

          You can also use PreferredLanguage to include a preferred language. Doing so can help Amazon Transcribe identify the language faster.

          You must include either LanguageCode or IdentifyLanguage.

          Language identification can't be combined with custom language models or redaction.

        • LanguageOptions — (String)

          Specify two or more language codes that represent the languages you think may be present in your media; including more than five is not recommended. If you're unsure what languages are present, do not include this parameter.

          Including language options can improve the accuracy of language identification.

          If you include LanguageOptions, you must also include IdentifyLanguage.

          You can only include one language dialect per language. For example, you cannot include en-US and en-AU.

        • PreferredLanguage — (String)

          Specify a preferred language from the subset of languages codes you specified in LanguageOptions.

          You can only use this parameter if you include IdentifyLanguage and LanguageOptions.

          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"
          • "th-TH"
          • "hi-IN"
        • VocabularyNames — (String)

          Specify the names of the custom vocabularies that you want to use when processing your transcription. Note that vocabulary names are case sensitive.

          If you use Amazon Transcribe in multiple Regions, the vocabulary must be available in Amazon Transcribe in each Region.

          If you don't include IdentifyLanguage and want to use a custom vocabulary with your transcription, use the VocabularyName parameter instead.

        • VocabularyFilterNames — (String)

          Specify the names of the custom vocabulary filters that you want to use when processing your transcription. Note that vocabulary filter names are case sensitive.

          If you use Amazon Transcribe in multiple Regions, the vocabulary filter must be available in Amazon Transcribe in each Region.

          If you're not including IdentifyLanguage and want to use a custom vocabulary filter with your transcription, use the VocabularyFilterName parameter instead.

      • EngineTranscribeMedicalSettings — (map)

        The transcription configuration settings passed to Amazon Transcribe Medical.

        • LanguageCoderequired — (String)

          The language code specified for the Amazon Transcribe Medical engine.

          Possible values include:
          • "en-US"
        • Specialtyrequired — (String)

          The specialty specified for the Amazon Transcribe Medical engine.

          Possible values include:
          • "PRIMARYCARE"
          • "CARDIOLOGY"
          • "NEUROLOGY"
          • "ONCOLOGY"
          • "RADIOLOGY"
          • "UROLOGY"
        • Typerequired — (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 Amazon Web Services 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"
        • ContentIdentificationType — (String)

          Set this field to PHI to identify personal health information in the transcription output.

          Possible values include:
          • "PHI"

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

      the error object returned from the request. Set to 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. For more information, refer to Using Amazon Chime SDK live transcription in the Amazon Chime SDK Developer Guide.

By default, Amazon Transcribe may use and store audio content processed by the service to develop and improve Amazon Web Services AI/ML services as further described in section 50 of the Amazon Web Services Service Terms. Using Amazon Transcribe may be subject to federal and state laws or regulations regarding the recording or interception of electronic communications. It is your and your end users’ responsibility to comply with all applicable laws regarding the recording, including properly notifying all participants in a recorded session or communication that the session or communication is being recorded, and obtaining all necessary consents. You can opt out from Amazon Web Services using audio content to develop and improve Amazon Web Services AI/ML services by configuring an AI services opt out policy using Amazon Web Services Organizations.

Service Reference:

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.

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

The resource that supports tags.

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 */
  ]
};
chimesdkmeetings.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 ARN of the resource.

    • Tags — (Array<map>)

      Lists the requested tags.

      • Keyrequired — (String)

        The tag's key.

      • Valuerequired — (String)

        The tag's value.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

Returns:

  • (AWS.Request)

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

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

Removes the specified tags from the specified resources. When you specify a tag key, the action removes both that key and its associated value. The operation succeeds even if you attempt to remove tags from a resource that were already removed. Note the following:

  • To remove tags from a resource, you need the necessary permissions for the service that the resource belongs to as well as permissions for removing tags. For more information, see the documentation for the service whose resource you want to untag.

  • You can only tag resources that are located in the specified Amazon Web Services Region for the calling Amazon Web Services account.

Minimum permissions

In addition to the tag:UntagResources permission required by this operation, you must also have the remove tags permission defined by the service that created the resource. For example, to remove the tags from an Amazon EC2 instance using the UntagResources operation, you must have both of the following permissions:

tag:UntagResource

ChimeSDKMeetings:DeleteTags

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  ResourceARN: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
chimesdkmeetings.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 ARN of the resource that you're removing tags from.

    • TagKeys — (Array<String>)

      The tag keys being removed from the resources.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

      the error object returned from the request. Set to 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.

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

The capabilities that you want to update.

Note: You use the capabilities with a set of values that control what the capabilities can do, such as SendReceive data. For more information about those values, see .

When using capabilities, be aware of these corner cases:

  • If you specify MeetingFeatures:Video:MaxResolution:None when you create a meeting, all API requests that include SendReceive, Send, or Receive for AttendeeCapabilities:Video will be rejected with ValidationError 400.

  • If you specify MeetingFeatures:Content:MaxResolution:None when you create a meeting, all API requests that include SendReceive, Send, or Receive for AttendeeCapabilities:Content will be rejected with ValidationError 400.

  • You can't set content capabilities to SendReceive or Receive unless you also set video capabilities to SendReceive or Receive. If you don't set the video capability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set your video capability to receive and you set your content capability to not receive.

  • When you change an audio capability from None or Receive to Send or SendReceive , and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants.

  • When you change a video or content capability from None or Receive to Send or SendReceive , and if the attendee turned on their video or content streams, remote attendees can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.

Service Reference:

Examples:

Calling the updateAttendeeCapabilities operation

var params = {
  AttendeeId: 'STRING_VALUE', /* required */
  Capabilities: { /* required */
    Audio: SendReceive | Send | Receive | None, /* required */
    Content: SendReceive | Send | Receive | None, /* required */
    Video: SendReceive | Send | Receive | None /* required */
  },
  MeetingId: 'STRING_VALUE' /* required */
};
chimesdkmeetings.updateAttendeeCapabilities(params, 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 ID of the meeting associated with the update request.

    • AttendeeId — (String)

      The ID of the attendee associated with the update request.

    • Capabilities — (map)

      The capabilities that you want to update.

      • Audiorequired — (String)

        The audio capability assigned to an attendee.

        Possible values include:
        • "SendReceive"
        • "Send"
        • "Receive"
        • "None"
      • Videorequired — (String)

        The video capability assigned to an attendee.

        Possible values include:
        • "SendReceive"
        • "Send"
        • "Receive"
        • "None"
      • Contentrequired — (String)

        The content capability assigned to an attendee.

        Possible values include:
        • "SendReceive"
        • "Send"
        • "Receive"
        • "None"

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

      the error object returned from the request. Set to 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 updated attendee data.

        • ExternalUserId — (String)

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

          Pattern: [-_&@+=,(){}[]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*

          Values that begin with aws: are reserved. You can't configure a value that uses this prefix. Case insensitive.

        • AttendeeId — (String)

          The Amazon Chime SDK attendee ID.

        • JoinToken — (String)

          The join token used by the Amazon Chime SDK attendee.

        • Capabilities — (map)

          The capabilities assigned to an attendee: audio, video, or content.

          Note: You use the capabilities with a set of values that control what the capabilities can do, such as SendReceive data. For more information about those values, see .

          When using capabilities, be aware of these corner cases:

          • If you specify MeetingFeatures:Video:MaxResolution:None when you create a meeting, all API requests that include SendReceive, Send, or Receive for AttendeeCapabilities:Video will be rejected with ValidationError 400.

          • If you specify MeetingFeatures:Content:MaxResolution:None when you create a meeting, all API requests that include SendReceive, Send, or Receive for AttendeeCapabilities:Content will be rejected with ValidationError 400.

          • You can't set content capabilities to SendReceive or Receive unless you also set video capabilities to SendReceive or Receive. If you don't set the video capability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set your video capability to receive and you set your content capability to not receive.

          • When you change an audio capability from None or Receive to Send or SendReceive , and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants.

          • When you change a video or content capability from None or Receive to Send or SendReceive , and if the attendee turned on their video or content streams, remote attendees can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.

          • Audiorequired — (String)

            The audio capability assigned to an attendee.

            Possible values include:
            • "SendReceive"
            • "Send"
            • "Receive"
            • "None"
          • Videorequired — (String)

            The video capability assigned to an attendee.

            Possible values include:
            • "SendReceive"
            • "Send"
            • "Receive"
            • "None"
          • Contentrequired — (String)

            The content capability assigned to an attendee.

            Possible values include:
            • "SendReceive"
            • "Send"
            • "Receive"
            • "None"

Returns:

  • (AWS.Request)

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