AWS SDK for PHP 3.x

Client: Aws\ChimeSDKMeetings\ChimeSDKMeetingsClient

Service ID: chime-sdk-meetings

Version: 2021-07-15

This page describes the parameters and results for the operations of the Amazon Chime SDK Meetings (2021-07-15), and shows how to use the Aws\ChimeSDKMeetings\ChimeSDKMeetingsClient object to call the described operations. This documentation is specific to the 2021-07-15 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

BatchCreateAttendee ( array $params = [] )
Creates up to 100 attendees for an active Amazon Chime SDK meeting.
BatchUpdateAttendeeCapabilitiesExcept ( array $params = [] )
Updates AttendeeCapabilities except the capabilities listed in an ExcludedAttendeeIds table.
CreateAttendee ( array $params = [] )
Creates a new attendee for an active Amazon Chime SDK meeting.
CreateMeeting ( array $params = [] )
Creates a new Amazon Chime SDK meeting in the specified media Region with no initial attendees.
CreateMeetingWithAttendees ( array $params = [] )
Creates a new Amazon Chime SDK meeting in the specified media Region, with attendees.
DeleteAttendee ( array $params = [] )
Deletes an attendee from the specified Amazon Chime SDK meeting and deletes their JoinToken.
DeleteMeeting ( array $params = [] )
Deletes the specified Amazon Chime SDK meeting.
GetAttendee ( array $params = [] )
Gets the Amazon Chime SDK attendee details for a specified meeting ID and attendee ID.
GetMeeting ( array $params = [] )
Gets the Amazon Chime SDK meeting details for the specified meeting ID.
ListAttendees ( array $params = [] )
Lists the attendees for the specified Amazon Chime SDK meeting.
ListTagsForResource ( array $params = [] )
Returns a list of the tags available for the specified resource.
StartMeetingTranscription ( array $params = [] )
Starts transcription for the specified meetingId.
StopMeetingTranscription ( array $params = [] )
Stops transcription for the specified meetingId.
TagResource ( array $params = [] )
The resource that supports tags.
UntagResource ( array $params = [] )
Removes the specified tags from the specified resources.
UpdateAttendeeCapabilities ( array $params = [] )
The capabilties that you want to update.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListAttendees

Operations

BatchCreateAttendee

$result = $client->batchCreateAttendee([/* ... */]);
$promise = $client->batchCreateAttendeeAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->batchCreateAttendee([
    'Attendees' => [ // REQUIRED
        [
            'Capabilities' => [
                'Audio' => 'SendReceive|Send|Receive|None', // REQUIRED
                'Content' => 'SendReceive|Send|Receive|None', // REQUIRED
                'Video' => 'SendReceive|Send|Receive|None', // REQUIRED
            ],
            'ExternalUserId' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'MeetingId' => '<string>', // REQUIRED
]);

Parameter Details

Members

Attendees

Required: Yes
Type: Array of CreateAttendeeRequestItem structures

The attendee information, including attendees' IDs and join tokens.

MeetingId

Required: Yes
Type: string

The Amazon Chime SDK ID of the meeting to which you're adding attendees.

Result Syntax

[
    'Attendees' => [
        [
            'AttendeeId' => '<string>',
            'Capabilities' => [
                'Audio' => 'SendReceive|Send|Receive|None',
                'Content' => 'SendReceive|Send|Receive|None',
                'Video' => 'SendReceive|Send|Receive|None',
            ],
            'ExternalUserId' => '<string>',
            'JoinToken' => '<string>',
        ],
        // ...
    ],
    'Errors' => [
        [
            'ErrorCode' => '<string>',
            'ErrorMessage' => '<string>',
            'ExternalUserId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

Attendees

Type: Array of Attendee structures

The attendee information, including attendees' IDs and join tokens.

Errors

Type: Array of CreateAttendeeError structures

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.

Errors

BadRequestException:
The input parameters don't match the service's restrictions.
ForbiddenException:
The client is permanently forbidden from making the request.
NotFoundException:
One or more of the resources in the request does not exist in the system.
UnauthorizedException:
The user isn't authorized to request a resource.
UnprocessableEntityException:
The request was well-formed but was unable to be followed due to semantic errors.
LimitExceededException:
The request exceeds the resource limit.
ServiceUnavailableException:
The service is currently unavailable.
ServiceFailureException:
The service encountered an unexpected error.
ThrottlingException:
The number of customer requests exceeds the request rate limit.

BatchUpdateAttendeeCapabilitiesExcept

$result = $client->batchUpdateAttendeeCapabilitiesExcept([/* ... */]);
$promise = $client->batchUpdateAttendeeCapabilitiesExceptAsync([/* ... */]);

Updates AttendeeCapabilities except the capabilities listed in an ExcludedAttendeeIds table.

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:

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 attendess can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.

Parameter Syntax

$result = $client->batchUpdateAttendeeCapabilitiesExcept([
    'Capabilities' => [ // REQUIRED
        'Audio' => 'SendReceive|Send|Receive|None', // REQUIRED
        'Content' => 'SendReceive|Send|Receive|None', // REQUIRED
        'Video' => 'SendReceive|Send|Receive|None', // REQUIRED
    ],
    'ExcludedAttendeeIds' => [ // REQUIRED
        [
            'AttendeeId' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'MeetingId' => '<string>', // REQUIRED
]);

Parameter Details

Members

Capabilities

Required: Yes
Type: AttendeeCapabilities structure

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

ExcludedAttendeeIds

Required: Yes
Type: Array of AttendeeIdItem structures

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

MeetingId

Required: Yes
Type: string

The ID of the meeting associated with the update request.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

BadRequestException:
The input parameters don't match the service's restrictions.
ConflictException:
Multiple instances of the same request have been made simultaneously.
UnauthorizedException:
The user isn't authorized to request a resource.
NotFoundException:
One or more of the resources in the request does not exist in the system.
ForbiddenException:
The client is permanently forbidden from making the request.
ServiceUnavailableException:
The service is currently unavailable.

CreateAttendee

$result = $client->createAttendee([/* ... */]);
$promise = $client->createAttendeeAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createAttendee([
    'Capabilities' => [
        'Audio' => 'SendReceive|Send|Receive|None', // REQUIRED
        'Content' => 'SendReceive|Send|Receive|None', // REQUIRED
        'Video' => 'SendReceive|Send|Receive|None', // REQUIRED
    ],
    'ExternalUserId' => '<string>', // REQUIRED
    'MeetingId' => '<string>', // REQUIRED
]);

Parameter Details

Members

Capabilities

Type: AttendeeCapabilities structure

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.

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:

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 attendess can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.

ExternalUserId

Required: Yes
Type: string

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

MeetingId

Required: Yes
Type: string

The unique ID of the meeting.

Result Syntax

[
    'Attendee' => [
        'AttendeeId' => '<string>',
        'Capabilities' => [
            'Audio' => 'SendReceive|Send|Receive|None',
            'Content' => 'SendReceive|Send|Receive|None',
            'Video' => 'SendReceive|Send|Receive|None',
        ],
        'ExternalUserId' => '<string>',
        'JoinToken' => '<string>',
    ],
]

Result Details

Members

Attendee

Type: Attendee structure

The attendee information, including attendee ID and join token.

Errors

BadRequestException:
The input parameters don't match the service's restrictions.
ForbiddenException:
The client is permanently forbidden from making the request.
NotFoundException:
One or more of the resources in the request does not exist in the system.
UnauthorizedException:
The user isn't authorized to request a resource.
UnprocessableEntityException:
The request was well-formed but was unable to be followed due to semantic errors.
LimitExceededException:
The request exceeds the resource limit.
ServiceUnavailableException:
The service is currently unavailable.
ServiceFailureException:
The service encountered an unexpected error.
ThrottlingException:
The number of customer requests exceeds the request rate limit.

CreateMeeting

$result = $client->createMeeting([/* ... */]);
$promise = $client->createMeetingAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createMeeting([
    'ClientRequestToken' => '<string>', // REQUIRED
    'ExternalMeetingId' => '<string>', // REQUIRED
    'MediaRegion' => '<string>', // REQUIRED
    'MeetingFeatures' => [
        'Audio' => [
            'EchoReduction' => 'AVAILABLE|UNAVAILABLE',
        ],
    ],
    'MeetingHostId' => '<string>',
    'NotificationsConfiguration' => [
        'LambdaFunctionArn' => '<string>',
        'SnsTopicArn' => '<string>',
        'SqsQueueArn' => '<string>',
    ],
    'PrimaryMeetingId' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'TenantIds' => ['<string>', ...],
]);

Parameter Details

Members

ClientRequestToken

Required: Yes
Type: string

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

ExternalMeetingId

Required: Yes
Type: string

The external meeting ID.

MediaRegion

Required: Yes
Type: 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 AWS GovCloud (US) Regions: us-gov-east-1, us-gov-west-1.

MeetingFeatures

Type: MeetingFeaturesConfiguration structure

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

MeetingHostId

Type: string

Reserved.

NotificationsConfiguration

Type: NotificationsConfiguration structure

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

PrimaryMeetingId

Type: string

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

Tags

Type: Array of Tag structures

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 AWS Region for the AWS 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

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.

TenantIds

Type: Array of strings

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

Result Syntax

[
    'Meeting' => [
        'ExternalMeetingId' => '<string>',
        'MediaPlacement' => [
            'AudioFallbackUrl' => '<string>',
            'AudioHostUrl' => '<string>',
            'EventIngestionUrl' => '<string>',
            'ScreenDataUrl' => '<string>',
            'ScreenSharingUrl' => '<string>',
            'ScreenViewingUrl' => '<string>',
            'SignalingUrl' => '<string>',
            'TurnControlUrl' => '<string>',
        ],
        'MediaRegion' => '<string>',
        'MeetingArn' => '<string>',
        'MeetingFeatures' => [
            'Audio' => [
                'EchoReduction' => 'AVAILABLE|UNAVAILABLE',
            ],
        ],
        'MeetingHostId' => '<string>',
        'MeetingId' => '<string>',
        'PrimaryMeetingId' => '<string>',
        'TenantIds' => ['<string>', ...],
    ],
]

Result Details

Members

Meeting

Type: Meeting structure

The meeting information, including the meeting ID and MediaPlacement.

Errors

BadRequestException:
The input parameters don't match the service's restrictions.
ForbiddenException:
The client is permanently forbidden from making the request.
UnauthorizedException:
The user isn't authorized to request a resource.
ThrottlingException:
The number of customer requests exceeds the request rate limit.
ServiceFailureException:
The service encountered an unexpected error.
ServiceUnavailableException:
The service is currently unavailable.
LimitExceededException:
The request exceeds the resource limit.

CreateMeetingWithAttendees

$result = $client->createMeetingWithAttendees([/* ... */]);
$promise = $client->createMeetingWithAttendeesAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createMeetingWithAttendees([
    'Attendees' => [ // REQUIRED
        [
            'Capabilities' => [
                'Audio' => 'SendReceive|Send|Receive|None', // REQUIRED
                'Content' => 'SendReceive|Send|Receive|None', // REQUIRED
                'Video' => 'SendReceive|Send|Receive|None', // REQUIRED
            ],
            'ExternalUserId' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'ClientRequestToken' => '<string>', // REQUIRED
    'ExternalMeetingId' => '<string>', // REQUIRED
    'MediaRegion' => '<string>', // REQUIRED
    'MeetingFeatures' => [
        'Audio' => [
            'EchoReduction' => 'AVAILABLE|UNAVAILABLE',
        ],
    ],
    'MeetingHostId' => '<string>',
    'NotificationsConfiguration' => [
        'LambdaFunctionArn' => '<string>',
        'SnsTopicArn' => '<string>',
        'SqsQueueArn' => '<string>',
    ],
    'PrimaryMeetingId' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'TenantIds' => ['<string>', ...],
]);

Parameter Details

Members

Attendees

Required: Yes
Type: Array of CreateAttendeeRequestItem structures

The attendee information, including attendees' IDs and join tokens.

ClientRequestToken

Required: Yes
Type: string

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

ExternalMeetingId

Required: Yes
Type: string

The external meeting ID.

MediaRegion

Required: Yes
Type: string

The Region in which to create the meeting.

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

MeetingFeatures

Type: MeetingFeaturesConfiguration structure

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

MeetingHostId

Type: string

Reserved.

NotificationsConfiguration

Type: NotificationsConfiguration structure

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

PrimaryMeetingId

Type: string

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

Tags

Type: Array of Tag structures

The tags in the request.

TenantIds

Type: Array of strings

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

Result Syntax

[
    'Attendees' => [
        [
            'AttendeeId' => '<string>',
            'Capabilities' => [
                'Audio' => 'SendReceive|Send|Receive|None',
                'Content' => 'SendReceive|Send|Receive|None',
                'Video' => 'SendReceive|Send|Receive|None',
            ],
            'ExternalUserId' => '<string>',
            'JoinToken' => '<string>',
        ],
        // ...
    ],
    'Errors' => [
        [
            'ErrorCode' => '<string>',
            'ErrorMessage' => '<string>',
            'ExternalUserId' => '<string>',
        ],
        // ...
    ],
    'Meeting' => [
        'ExternalMeetingId' => '<string>',
        'MediaPlacement' => [
            'AudioFallbackUrl' => '<string>',
            'AudioHostUrl' => '<string>',
            'EventIngestionUrl' => '<string>',
            'ScreenDataUrl' => '<string>',
            'ScreenSharingUrl' => '<string>',
            'ScreenViewingUrl' => '<string>',
            'SignalingUrl' => '<string>',
            'TurnControlUrl' => '<string>',
        ],
        'MediaRegion' => '<string>',
        'MeetingArn' => '<string>',
        'MeetingFeatures' => [
            'Audio' => [
                'EchoReduction' => 'AVAILABLE|UNAVAILABLE',
            ],
        ],
        'MeetingHostId' => '<string>',
        'MeetingId' => '<string>',
        'PrimaryMeetingId' => '<string>',
        'TenantIds' => ['<string>', ...],
    ],
]

Result Details

Members

Attendees

Type: Array of Attendee structures

The attendee information, including attendees' IDs and join tokens.

Errors

Type: Array of CreateAttendeeError structures

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.

Meeting

Type: Meeting structure

The meeting information, including the meeting ID and MediaPlacement.

Errors

BadRequestException:
The input parameters don't match the service's restrictions.
ForbiddenException:
The client is permanently forbidden from making the request.
UnauthorizedException:
The user isn't authorized to request a resource.
ThrottlingException:
The number of customer requests exceeds the request rate limit.
ServiceFailureException:
The service encountered an unexpected error.
ServiceUnavailableException:
The service is currently unavailable.
LimitExceededException:
The request exceeds the resource limit.

DeleteAttendee

$result = $client->deleteAttendee([/* ... */]);
$promise = $client->deleteAttendeeAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteAttendee([
    'AttendeeId' => '<string>', // REQUIRED
    'MeetingId' => '<string>', // REQUIRED
]);

Parameter Details

Members

AttendeeId

Required: Yes
Type: string

The Amazon Chime SDK attendee ID.

MeetingId

Required: Yes
Type: string

The Amazon Chime SDK meeting ID.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

BadRequestException:
The input parameters don't match the service's restrictions.
ForbiddenException:
The client is permanently forbidden from making the request.
NotFoundException:
One or more of the resources in the request does not exist in the system.
UnauthorizedException:
The user isn't authorized to request a resource.
ServiceUnavailableException:
The service is currently unavailable.
ServiceFailureException:
The service encountered an unexpected error.
ThrottlingException:
The number of customer requests exceeds the request rate limit.

DeleteMeeting

$result = $client->deleteMeeting([/* ... */]);
$promise = $client->deleteMeetingAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteMeeting([
    'MeetingId' => '<string>', // REQUIRED
]);

Parameter Details

Members

MeetingId

Required: Yes
Type: string

The Amazon Chime SDK meeting ID.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

BadRequestException:
The input parameters don't match the service's restrictions.
ForbiddenException:
The client is permanently forbidden from making the request.
UnauthorizedException:
The user isn't authorized to request a resource.
NotFoundException:
One or more of the resources in the request does not exist in the system.
ServiceUnavailableException:
The service is currently unavailable.
ServiceFailureException:
The service encountered an unexpected error.
ThrottlingException:
The number of customer requests exceeds the request rate limit.

GetAttendee

$result = $client->getAttendee([/* ... */]);
$promise = $client->getAttendeeAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getAttendee([
    'AttendeeId' => '<string>', // REQUIRED
    'MeetingId' => '<string>', // REQUIRED
]);

Parameter Details

Members

AttendeeId

Required: Yes
Type: string

The Amazon Chime SDK attendee ID.

MeetingId

Required: Yes
Type: string

The Amazon Chime SDK meeting ID.

Result Syntax

[
    'Attendee' => [
        'AttendeeId' => '<string>',
        'Capabilities' => [
            'Audio' => 'SendReceive|Send|Receive|None',
            'Content' => 'SendReceive|Send|Receive|None',
            'Video' => 'SendReceive|Send|Receive|None',
        ],
        'ExternalUserId' => '<string>',
        'JoinToken' => '<string>',
    ],
]

Result Details

Members

Attendee

Type: Attendee structure

The Amazon Chime SDK attendee information.

Errors

BadRequestException:
The input parameters don't match the service's restrictions.
ForbiddenException:
The client is permanently forbidden from making the request.
NotFoundException:
One or more of the resources in the request does not exist in the system.
UnauthorizedException:
The user isn't authorized to request a resource.
ServiceUnavailableException:
The service is currently unavailable.
ServiceFailureException:
The service encountered an unexpected error.
ThrottlingException:
The number of customer requests exceeds the request rate limit.

GetMeeting

$result = $client->getMeeting([/* ... */]);
$promise = $client->getMeetingAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getMeeting([
    'MeetingId' => '<string>', // REQUIRED
]);

Parameter Details

Members

MeetingId

Required: Yes
Type: string

The Amazon Chime SDK meeting ID.

Result Syntax

[
    'Meeting' => [
        'ExternalMeetingId' => '<string>',
        'MediaPlacement' => [
            'AudioFallbackUrl' => '<string>',
            'AudioHostUrl' => '<string>',
            'EventIngestionUrl' => '<string>',
            'ScreenDataUrl' => '<string>',
            'ScreenSharingUrl' => '<string>',
            'ScreenViewingUrl' => '<string>',
            'SignalingUrl' => '<string>',
            'TurnControlUrl' => '<string>',
        ],
        'MediaRegion' => '<string>',
        'MeetingArn' => '<string>',
        'MeetingFeatures' => [
            'Audio' => [
                'EchoReduction' => 'AVAILABLE|UNAVAILABLE',
            ],
        ],
        'MeetingHostId' => '<string>',
        'MeetingId' => '<string>',
        'PrimaryMeetingId' => '<string>',
        'TenantIds' => ['<string>', ...],
    ],
]

Result Details

Members

Meeting

Type: Meeting structure

The Amazon Chime SDK meeting information.

Errors

NotFoundException:
One or more of the resources in the request does not exist in the system.
BadRequestException:
The input parameters don't match the service's restrictions.
ForbiddenException:
The client is permanently forbidden from making the request.
UnauthorizedException:
The user isn't authorized to request a resource.
ServiceUnavailableException:
The service is currently unavailable.
ServiceFailureException:
The service encountered an unexpected error.
ThrottlingException:
The number of customer requests exceeds the request rate limit.

ListAttendees

$result = $client->listAttendees([/* ... */]);
$promise = $client->listAttendeesAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listAttendees([
    'MaxResults' => <integer>,
    'MeetingId' => '<string>', // REQUIRED
    'NextToken' => '<string>',
]);

Parameter Details

Members

MaxResults

Type: int

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

MeetingId

Required: Yes
Type: string

The Amazon Chime SDK meeting ID.

NextToken

Type: string

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

Result Syntax

[
    'Attendees' => [
        [
            'AttendeeId' => '<string>',
            'Capabilities' => [
                'Audio' => 'SendReceive|Send|Receive|None',
                'Content' => 'SendReceive|Send|Receive|None',
                'Video' => 'SendReceive|Send|Receive|None',
            ],
            'ExternalUserId' => '<string>',
            'JoinToken' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

Attendees

Type: Array of Attendee structures

The Amazon Chime SDK attendee information.

NextToken

Type: string

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

Errors

BadRequestException:
The input parameters don't match the service's restrictions.
ForbiddenException:
The client is permanently forbidden from making the request.
NotFoundException:
One or more of the resources in the request does not exist in the system.
UnauthorizedException:
The user isn't authorized to request a resource.
ServiceUnavailableException:
The service is currently unavailable.
ServiceFailureException:
The service encountered an unexpected error.
ThrottlingException:
The number of customer requests exceeds the request rate limit.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listTagsForResource([
    'ResourceARN' => '<string>', // REQUIRED
]);

Parameter Details

Members

ResourceARN

Required: Yes
Type: string

The ARN of the resource.

Result Syntax

[
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

Tags

Type: Array of Tag structures

The tags requested for the specified resource.

Errors

ResourceNotFoundException:
The resource that you want to tag couldn't be found.

StartMeetingTranscription

$result = $client->startMeetingTranscription([/* ... */]);
$promise = $client->startMeetingTranscriptionAsync([/* ... */]);

Starts transcription for the specified meetingId.

Parameter Syntax

$result = $client->startMeetingTranscription([
    'MeetingId' => '<string>', // REQUIRED
    'TranscriptionConfiguration' => [ // REQUIRED
        'EngineTranscribeMedicalSettings' => [
            'ContentIdentificationType' => 'PHI',
            'LanguageCode' => 'en-US', // REQUIRED
            'Region' => 'us-east-1|us-east-2|us-west-2|ap-southeast-2|ca-central-1|eu-west-1|auto',
            'Specialty' => 'PRIMARYCARE|CARDIOLOGY|NEUROLOGY|ONCOLOGY|RADIOLOGY|UROLOGY', // REQUIRED
            'Type' => 'CONVERSATION|DICTATION', // REQUIRED
            'VocabularyName' => '<string>',
        ],
        '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',
            'LanguageModelName' => '<string>',
            'LanguageOptions' => '<string>',
            'PartialResultsStability' => 'low|medium|high',
            'PiiEntityTypes' => '<string>',
            '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',
            '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>',
            'VocabularyName' => '<string>',
        ],
    ],
]);

Parameter Details

Members

MeetingId

Required: Yes
Type: string

The unique ID of the meeting being transcribed.

TranscriptionConfiguration

Required: Yes
Type: TranscriptionConfiguration structure

The configuration for the current transcription operation. Must contain EngineTranscribeSettings or EngineTranscribeMedicalSettings.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

NotFoundException:
One or more of the resources in the request does not exist in the system.
ForbiddenException:
The client is permanently forbidden from making the request.
BadRequestException:
The input parameters don't match the service's restrictions.
UnauthorizedException:
The user isn't authorized to request a resource.
LimitExceededException:
The request exceeds the resource limit.
UnprocessableEntityException:
The request was well-formed but was unable to be followed due to semantic errors.
ThrottlingException:
The number of customer requests exceeds the request rate limit.
ServiceUnavailableException:
The service is currently unavailable.
ServiceFailureException:
The service encountered an unexpected error.

StopMeetingTranscription

$result = $client->stopMeetingTranscription([/* ... */]);
$promise = $client->stopMeetingTranscriptionAsync([/* ... */]);

Stops transcription for the specified meetingId.

Parameter Syntax

$result = $client->stopMeetingTranscription([
    'MeetingId' => '<string>', // REQUIRED
]);

Parameter Details

Members

MeetingId

Required: Yes
Type: string

The unique ID of the meeting for which you stop transcription.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ForbiddenException:
The client is permanently forbidden from making the request.
NotFoundException:
One or more of the resources in the request does not exist in the system.
BadRequestException:
The input parameters don't match the service's restrictions.
UnauthorizedException:
The user isn't authorized to request a resource.
UnprocessableEntityException:
The request was well-formed but was unable to be followed due to semantic errors.
ThrottlingException:
The number of customer requests exceeds the request rate limit.
ServiceUnavailableException:
The service is currently unavailable.
ServiceFailureException:
The service encountered an unexpected error.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

The resource that supports tags.

Parameter Syntax

$result = $client->tagResource([
    'ResourceARN' => '<string>', // REQUIRED
    'Tags' => [ // REQUIRED
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

ResourceARN

Required: Yes
Type: string

The ARN of the resource.

Tags

Required: Yes
Type: Array of Tag structures

Lists the requested tags.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

BadRequestException:
The input parameters don't match the service's restrictions.
ResourceNotFoundException:
The resource that you want to tag couldn't be found.
TooManyTagsException:
Too many tags were added to the specified resource.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

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 AWS Region for the calling AWS 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

Parameter Syntax

$result = $client->untagResource([
    'ResourceARN' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

ResourceARN

Required: Yes
Type: string

The ARN of the resource that you're removing tags from.

TagKeys

Required: Yes
Type: Array of strings

The tag keys being removed from the resources.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

BadRequestException:
The input parameters don't match the service's restrictions.
ResourceNotFoundException:
The resource that you want to tag couldn't be found.

UpdateAttendeeCapabilities

$result = $client->updateAttendeeCapabilities([/* ... */]);
$promise = $client->updateAttendeeCapabilitiesAsync([/* ... */]);

The capabilties that you want to update.

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:

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 attendess can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.

Parameter Syntax

$result = $client->updateAttendeeCapabilities([
    'AttendeeId' => '<string>', // REQUIRED
    'Capabilities' => [ // REQUIRED
        'Audio' => 'SendReceive|Send|Receive|None', // REQUIRED
        'Content' => 'SendReceive|Send|Receive|None', // REQUIRED
        'Video' => 'SendReceive|Send|Receive|None', // REQUIRED
    ],
    'MeetingId' => '<string>', // REQUIRED
]);

Parameter Details

Members

AttendeeId

Required: Yes
Type: string

The ID of the attendee associated with the update request.

Capabilities

Required: Yes
Type: AttendeeCapabilities structure

The capabilties that you want to update.

MeetingId

Required: Yes
Type: string

The ID of the meeting associated with the update request.

Result Syntax

[
    'Attendee' => [
        'AttendeeId' => '<string>',
        'Capabilities' => [
            'Audio' => 'SendReceive|Send|Receive|None',
            'Content' => 'SendReceive|Send|Receive|None',
            'Video' => 'SendReceive|Send|Receive|None',
        ],
        'ExternalUserId' => '<string>',
        'JoinToken' => '<string>',
    ],
]

Result Details

Members

Attendee

Type: Attendee structure

The updated attendee data.

Errors

BadRequestException:
The input parameters don't match the service's restrictions.
ConflictException:
Multiple instances of the same request have been made simultaneously.
UnauthorizedException:
The user isn't authorized to request a resource.
NotFoundException:
One or more of the resources in the request does not exist in the system.
ForbiddenException:
The client is permanently forbidden from making the request.
ServiceUnavailableException:
The service is currently unavailable.

Shapes

Attendee

Description

An Amazon Chime SDK meeting attendee. Includes a unique AttendeeId and JoinToken. The JoinToken allows a client to authenticate and join as the specified attendee. The JoinToken expires when the meeting ends, or when DeleteAttendee is called. After that, the attendee is unable to join the meeting.

We recommend securely transferring each JoinToken from your server application to the client so that no other client has access to the token except for the one authorized to represent the attendee.

Members

AttendeeId

Type: string

The Amazon Chime SDK attendee ID.

Capabilities

Type: AttendeeCapabilities structure

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

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:

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 attendess can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.

ExternalUserId

Type: string

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

JoinToken

Type: string

The join token used by the Amazon Chime SDK attendee.

AttendeeCapabilities

Description

The media capabilities of an attendee: audio, video, or content.

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:

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 attendess can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.

Members

Audio

Required: Yes
Type: string

The audio capability assigned to an attendee.

Content

Required: Yes
Type: string

The content capability assigned to an attendee.

Video

Required: Yes
Type: string

The video capability assigned to an attendee.

AttendeeIdItem

Description

A structure that contains one or more attendee IDs.

Members

AttendeeId

Required: Yes
Type: string

A list of one or more attendee IDs.

AudioFeatures

Description

An optional category of meeting features that contains audio-specific configurations, such as operating parameters for Amazon Voice Focus.

Members

EchoReduction

Type: string

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

BadRequestException

Description

The input parameters don't match the service's restrictions.

Members

Code

Type: string

Message

Type: string

RequestId

Type: string

The request id associated with the call responsible for the exception.

ConflictException

Description

Multiple instances of the same request have been made simultaneously.

Members

Code

Type: string

Message

Type: string

RequestId

Type: string

The ID of the request involved in the conflict.

CreateAttendeeError

Description

The list of errors returned when errors are encountered during the BatchCreateAttendee and CreateAttendee actions. This includes external user IDs, error codes, and error messages.

Members

ErrorCode

Type: string

The error code.

ErrorMessage

Type: string

The error message.

ExternalUserId

Type: string

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

CreateAttendeeRequestItem

Description

The Amazon Chime SDK attendee fields to create, used with the BatchCreateAttendee action.

Members

Capabilities

Type: AttendeeCapabilities structure

A list of one or more capabilities.

ExternalUserId

Required: Yes
Type: string

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

EngineTranscribeMedicalSettings

Description

Settings specific to the Amazon Transcribe Medical engine.

Members

ContentIdentificationType

Type: string

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

LanguageCode

Required: Yes
Type: string

The language code specified for the Amazon Transcribe Medical engine.

Region

Type: string

The AWS Region passed to Amazon Transcribe Medical. If you don't specify a Region, Amazon Chime uses the meeting's Region.

Specialty

Required: Yes
Type: string

The specialty specified for the Amazon Transcribe Medical engine.

Type

Required: Yes
Type: string

The type of transcription.

VocabularyName

Type: string

The name of the vocabulary passed to Amazon Transcribe Medical.

EngineTranscribeSettings

Description

Settings specific to the Amazon Transcribe engine.

Members

ContentIdentificationType

Type: string

Set this field to PII to identify personally identifiable information in the transcription output.

ContentRedactionType

Type: string

Set this field to PII to redact personally identifiable information in the transcription output. Content redaction is performed only upon complete transcription of the audio segments.

You can’t set ContentRedactionType and ContentIdentificationType in the same request. If you set both, your request returns a BadRequestException.

EnablePartialResultsStabilization

Type: boolean

Generates partial transcription results that are less likely to change as meeting attendees speak. It does so by only allowing the last few words from the partial results to change.

IdentifyLanguage

Type: boolean

Automatically identifies the language spoken in media files.

LanguageCode

Type: string

The language code specified for the Amazon Transcribe engine.

LanguageModelName

Type: string

The name of the language model used during transcription.

LanguageOptions

Type: string

Language codes for the languages that you want to identify. You must provide at least 2 codes.

PartialResultsStability

Type: string

The stabity level of a partial results transcription. Determines how stable you want the transcription results to be. A higher level means the transcription results are less likely to change.

PiiEntityTypes

Type: string

Lists the PII entity types you want to identify or redact. To specify entity types, you must enable ContentIdentificationType or ContentRedactionType.

PIIEntityTypes must be comma-separated. The available values are: BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_NUMBER, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, PIN, EMAIL, ADDRESS, NAME, PHONE, SSN, and ALL.

PiiEntityTypes is an optional parameter with a default value of ALL.

PreferredLanguage

Type: string

Language code for the preferred language.

Region

Type: string

The AWS Region passed to Amazon Transcribe. If you don't specify a Region, Amazon Chime uses the meeting's Region.

VocabularyFilterMethod

Type: string

The filtering method passed to Amazon Transcribe.

VocabularyFilterName

Type: string

The name of the vocabulary filter passed to Amazon Transcribe.

VocabularyName

Type: string

The name of the vocabulary passed to Amazon Transcribe.

ForbiddenException

Description

The client is permanently forbidden from making the request.

Members

Code

Type: string

Message

Type: string

RequestId

Type: string

The request id associated with the call responsible for the exception.

LimitExceededException

Description

The request exceeds the resource limit.

Members

Code

Type: string

Message

Type: string

RequestId

Type: string

The request id associated with the call responsible for the exception.

MediaPlacement

Description

A set of endpoints used by clients to connect to the media service group for an Amazon Chime SDK meeting.

Members

AudioFallbackUrl

Type: string

The audio fallback URL.

AudioHostUrl

Type: string

The audio host URL.

EventIngestionUrl

Type: string

The event ingestion URL.

ScreenDataUrl

Type: string

The screen data URL.

ScreenSharingUrl

Type: string

The screen sharing URL.

ScreenViewingUrl

Type: string

The screen viewing URL.

SignalingUrl

Type: string

The signaling URL.

TurnControlUrl

Type: string

The turn control URL.

Meeting

Description

A meeting created using the Amazon Chime SDK.

Members

ExternalMeetingId

Type: string

The external meeting ID.

MediaPlacement

Type: MediaPlacement structure

The media placement for the meeting.

MediaRegion

Type: 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 AWS GovCloud (US) Regions: us-gov-east-1, us-gov-west-1.

MeetingArn

Type: string

The ARN of the meeting.

MeetingFeatures

Type: MeetingFeaturesConfiguration structure

The features available to a meeting, such as Amazon Voice Focus.

MeetingHostId

Type: string

Reserved.

MeetingId

Type: string

The Amazon Chime SDK meeting ID.

PrimaryMeetingId

Type: string

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

TenantIds

Type: Array of strings

Array of strings.

MeetingFeaturesConfiguration

Description

The configuration settings of the features available to a meeting.>

Members

Audio

Type: AudioFeatures structure

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

NotFoundException

Description

One or more of the resources in the request does not exist in the system.

Members

Code

Type: string

Message

Type: string

RequestId

Type: string

The request ID associated with the call responsible for the exception.

NotificationsConfiguration

Description

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

Members

LambdaFunctionArn

Type: string

The ARN of the AWS Lambda function in the notifications configuration.

SnsTopicArn

Type: string

The ARN of the SNS topic.

SqsQueueArn

Type: string

The ARN of the SQS queue.

ResourceNotFoundException

Description

The resource that you want to tag couldn't be found.

Members

Code

Type: string

Message

Type: string

RequestId

Type: string

The ID of the resource that couldn't be found.

ResourceName

Type: string

The name of the resource that couldn't be found.

ServiceFailureException

Description

The service encountered an unexpected error.

Members

Code

Type: string

Message

Type: string

RequestId

Type: string

The ID of the failed request.

ServiceUnavailableException

Description

The service is currently unavailable.

Members

Code

Type: string

Message

Type: string

RequestId

Type: string

The request id associated with the call responsible for the exception.

RetryAfterSeconds

Type: string

The number of seconds the caller should wait before retrying.

ThrottlingException

Description

The number of customer requests exceeds the request rate limit.

Members

Code

Type: string

Message

Type: string

RequestId

Type: string

The ID of the request that exceeded the throttling limit.

TooManyTagsException

Description

Too many tags were added to the specified resource.

Members

Code

Type: string

Message

Type: string

RequestId

Type: string

The ID of the request that contains too many tags.

ResourceName

Type: string

The name of the resource that received too many tags.

TranscriptionConfiguration

Description

The configuration for the current transcription operation. Must contain EngineTranscribeSettings or EngineTranscribeMedicalSettings.

Members

EngineTranscribeMedicalSettings

Type: EngineTranscribeMedicalSettings structure

The transcription configuration settings passed to Amazon Transcribe Medical.

EngineTranscribeSettings

Type: EngineTranscribeSettings structure

The transcription configuration settings passed to Amazon Transcribe.

UnauthorizedException

Description

The user isn't authorized to request a resource.

Members

Code

Type: string

Message

Type: string

RequestId

Type: string

The request id associated with the call responsible for the exception.

UnprocessableEntityException

Description

The request was well-formed but was unable to be followed due to semantic errors.

Members

Code

Type: string

Message

Type: string

RequestId

Type: string

The request id associated with the call responsible for the exception.

Namespaces

Classes

Interfaces

Traits

Exceptions

Functions

Amazon Chime SDK Meetings 2021-07-15

Operation Summary

Paginators

Operations

BatchCreateAttendee

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

BatchUpdateAttendeeCapabilitiesExcept

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

CreateAttendee

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateMeeting

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateMeetingWithAttendees

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteAttendee

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteMeeting

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

GetAttendee

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetMeeting

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListAttendees