Class: AWS.ChimeSDKMeetings

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.

    • AttendeeId — required — (String)

      A list of one or more attendee IDs.

  • Capabilities — (map)

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

    • Audio — required — (String)

      The audio capability assigned to an attendee.

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

      The video capability assigned to an attendee.

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

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.

    • Audio — required — (String)

      The audio capability assigned to an attendee.

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

      The video capability assigned to an attendee.

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

        • Audio — required — (String)

          The audio capability assigned to an attendee.

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

          The video capability assigned to an attendee.

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

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.
    • Key — required — (String)

      The tag's key.

    • Value — required — (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.

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.

    • ExternalUserId — required — (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.

      • Audio — required — (String)

        The audio capability assigned to an attendee.

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

        The video capability assigned to an attendee.

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

    • Key — required — (String)

      The tag's key.

    • Value — required — (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.

        • Audio — required — (String)

          The audio capability assigned to an attendee.

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

          The video capability assigned to an attendee.

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

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.

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.

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.

        • Audio — required — (String)

          The audio capability assigned to an attendee.

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

          The video capability assigned to an attendee.

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

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.

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.

        • Audio — required — (String)

          The audio capability assigned to an attendee.

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

          The video capability assigned to an attendee.

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

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.

      • Key — required — (String)

        The tag's key.

      • Value — required — (String)

        The tag's value.

Returns:

• (AWS.Request) —

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

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.

      • LanguageCode — required — (String)

        The language code specified for the Amazon Transcribe Medical engine.

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

        The specialty specified for the Amazon Transcribe Medical engine.

        Possible values include:
        • "PRIMARYCARE"
        • "CARDIOLOGY"
        • "NEUROLOGY"
        • "ONCOLOGY"
        • "RADIOLOGY"
        • "UROLOGY"
      • Type — required — (String)

        The type of transcription.

        Possible values include:
        • "CONVERSATION"
        • "DICTATION"
      • VocabularyName — (String)

        The name of the vocabulary passed to Amazon Transcribe Medical.

      • Region — (String)

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

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.

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.

    • Key — required — (String)

      The tag's key.

    • Value — required — (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.

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.

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.

    • Audio — required — (String)

      The audio capability assigned to an attendee.

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

      The video capability assigned to an attendee.

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

        • Audio — required — (String)

          The audio capability assigned to an attendee.

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

          The video capability assigned to an attendee.

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