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

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

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.

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.

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

Result Syntax

[]

Result Details

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.

ServiceFailureException:

The service encountered an unexpected error.

ThrottlingException:

The number of customer requests exceeds the request rate limit.

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

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

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' => [
        'Attendee' => [
            'MaxCount' => <integer>,
        ],
        'Audio' => [
            'EchoReduction' => 'AVAILABLE|UNAVAILABLE',
        ],
        'Content' => [
            'MaxResolution' => 'None|FHD|UHD',
        ],
        'Video' => [
            'MaxResolution' => 'None|HD|FHD',
        ],
    ],
    'MeetingHostId' => '<string>',
    'NotificationsConfiguration' => [
        'LambdaFunctionArn' => '<string>',
        'SnsTopicArn' => '<string>',
        'SqsQueueArn' => '<string>',
    ],
    'PrimaryMeetingId' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'TenantIds' => ['<string>', ...],
]);

Parameter Details

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' => [
            'Attendee' => [
                'MaxCount' => <integer>,
            ],
            'Audio' => [
                'EchoReduction' => 'AVAILABLE|UNAVAILABLE',
            ],
            'Content' => [
                'MaxResolution' => 'None|FHD|UHD',
            ],
            'Video' => [
                'MaxResolution' => 'None|HD|FHD',
            ],
        ],
        'MeetingHostId' => '<string>',
        'MeetingId' => '<string>',
        'PrimaryMeetingId' => '<string>',
        'TenantIds' => ['<string>', ...],
    ],
]

Result Details

Errors

BadRequestException:

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

ConflictException:

Multiple instances of the same request have been made simultaneously.

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' => [
        'Attendee' => [
            'MaxCount' => <integer>,
        ],
        'Audio' => [
            'EchoReduction' => 'AVAILABLE|UNAVAILABLE',
        ],
        'Content' => [
            'MaxResolution' => 'None|FHD|UHD',
        ],
        'Video' => [
            'MaxResolution' => 'None|HD|FHD',
        ],
    ],
    'MeetingHostId' => '<string>',
    'NotificationsConfiguration' => [
        'LambdaFunctionArn' => '<string>',
        'SnsTopicArn' => '<string>',
        'SqsQueueArn' => '<string>',
    ],
    'PrimaryMeetingId' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'TenantIds' => ['<string>', ...],
]);

Parameter Details

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' => [
            'Attendee' => [
                'MaxCount' => <integer>,
            ],
            'Audio' => [
                'EchoReduction' => 'AVAILABLE|UNAVAILABLE',
            ],
            'Content' => [
                'MaxResolution' => 'None|FHD|UHD',
            ],
            'Video' => [
                'MaxResolution' => 'None|HD|FHD',
            ],
        ],
        'MeetingHostId' => '<string>',
        'MeetingId' => '<string>',
        'PrimaryMeetingId' => '<string>',
        'TenantIds' => ['<string>', ...],
    ],
]

Result Details

Errors

BadRequestException:

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

ConflictException:

Multiple instances of the same request have been made simultaneously.

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

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

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

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' => [
            'Attendee' => [
                'MaxCount' => <integer>,
            ],
            'Audio' => [
                'EchoReduction' => 'AVAILABLE|UNAVAILABLE',
            ],
            'Content' => [
                'MaxResolution' => 'None|FHD|UHD',
            ],
            'Video' => [
                'MaxResolution' => 'None|HD|FHD',
            ],
        ],
        'MeetingHostId' => '<string>',
        'MeetingId' => '<string>',
        'PrimaryMeetingId' => '<string>',
        'TenantIds' => ['<string>', ...],
    ],
]

Result Details

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

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

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

Result Syntax

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

Result Details

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.

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.

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

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

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|th-TH|hi-IN',
            '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|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>',
            'VocabularyFilterNames' => '<string>',
            'VocabularyName' => '<string>',
            'VocabularyNames' => '<string>',
        ],
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

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

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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.

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.

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 Amazon Web Services Region for the calling Amazon Web Services account.

Minimum permissions

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

tag:UntagResource

ChimeSDKMeetings:DeleteTags

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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.

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.

ResourceNotFoundException:

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

UpdateAttendeeCapabilities

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

The capabilities that you want to update.

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.

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

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

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.

ServiceFailureException:

The service encountered an unexpected error.

ThrottlingException:

The number of customer requests exceeds the request rate limit.