amazonka-chime-sdk-meetings-2.0: Amazon Chime SDK Meetings SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.ChimeSdkMeetings.Lens

Description

 
Synopsis

Operations

BatchCreateAttendee

batchCreateAttendee_meetingId :: Lens' BatchCreateAttendee Text Source #

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

batchCreateAttendee_attendees :: Lens' BatchCreateAttendee (NonEmpty CreateAttendeeRequestItem) Source #

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

batchCreateAttendeeResponse_attendees :: Lens' BatchCreateAttendeeResponse (Maybe [Attendee]) Source #

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

batchCreateAttendeeResponse_errors :: Lens' BatchCreateAttendeeResponse (Maybe [CreateAttendeeError]) Source #

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.

BatchUpdateAttendeeCapabilitiesExcept

CreateAttendee

createAttendee_capabilities :: Lens' CreateAttendee (Maybe AttendeeCapabilities) Source #

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.

createAttendee_meetingId :: Lens' CreateAttendee Text Source #

The unique ID of the meeting.

createAttendee_externalUserId :: Lens' CreateAttendee Text Source #

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

createAttendeeResponse_attendee :: Lens' CreateAttendeeResponse (Maybe Attendee) Source #

The attendee information, including attendee ID and join token.

CreateMeeting

createMeeting_meetingFeatures :: Lens' CreateMeeting (Maybe MeetingFeaturesConfiguration) Source #

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

createMeeting_notificationsConfiguration :: Lens' CreateMeeting (Maybe NotificationsConfiguration) Source #

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

createMeeting_primaryMeetingId :: Lens' CreateMeeting (Maybe Text) Source #

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

createMeeting_tags :: Lens' CreateMeeting (Maybe [Tag]) Source #

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.

createMeeting_tenantIds :: Lens' CreateMeeting (Maybe (NonEmpty Text)) Source #

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

createMeeting_clientRequestToken :: Lens' CreateMeeting Text Source #

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

createMeeting_mediaRegion :: Lens' CreateMeeting Text Source #

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.

createMeetingResponse_meeting :: Lens' CreateMeetingResponse (Maybe Meeting) Source #

The meeting information, including the meeting ID and MediaPlacement.

CreateMeetingWithAttendees

createMeetingWithAttendees_meetingFeatures :: Lens' CreateMeetingWithAttendees (Maybe MeetingFeaturesConfiguration) Source #

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

createMeetingWithAttendees_notificationsConfiguration :: Lens' CreateMeetingWithAttendees (Maybe NotificationsConfiguration) Source #

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

createMeetingWithAttendees_primaryMeetingId :: Lens' CreateMeetingWithAttendees (Maybe Text) Source #

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

createMeetingWithAttendees_tenantIds :: Lens' CreateMeetingWithAttendees (Maybe (NonEmpty Text)) Source #

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

createMeetingWithAttendees_clientRequestToken :: Lens' CreateMeetingWithAttendees Text Source #

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

createMeetingWithAttendees_mediaRegion :: Lens' CreateMeetingWithAttendees Text Source #

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.

createMeetingWithAttendees_attendees :: Lens' CreateMeetingWithAttendees (NonEmpty CreateAttendeeRequestItem) Source #

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

createMeetingWithAttendeesResponse_attendees :: Lens' CreateMeetingWithAttendeesResponse (Maybe [Attendee]) Source #

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

createMeetingWithAttendeesResponse_errors :: Lens' CreateMeetingWithAttendeesResponse (Maybe [CreateAttendeeError]) Source #

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.

createMeetingWithAttendeesResponse_meeting :: Lens' CreateMeetingWithAttendeesResponse (Maybe Meeting) Source #

The meeting information, including the meeting ID and MediaPlacement.

DeleteAttendee

deleteAttendee_meetingId :: Lens' DeleteAttendee Text Source #

The Amazon Chime SDK meeting ID.

deleteAttendee_attendeeId :: Lens' DeleteAttendee Text Source #

The Amazon Chime SDK attendee ID.

DeleteMeeting

deleteMeeting_meetingId :: Lens' DeleteMeeting Text Source #

The Amazon Chime SDK meeting ID.

GetAttendee

getAttendee_meetingId :: Lens' GetAttendee Text Source #

The Amazon Chime SDK meeting ID.

getAttendee_attendeeId :: Lens' GetAttendee Text Source #

The Amazon Chime SDK attendee ID.

getAttendeeResponse_attendee :: Lens' GetAttendeeResponse (Maybe Attendee) Source #

The Amazon Chime SDK attendee information.

GetMeeting

getMeeting_meetingId :: Lens' GetMeeting Text Source #

The Amazon Chime SDK meeting ID.

getMeetingResponse_meeting :: Lens' GetMeetingResponse (Maybe Meeting) Source #

The Amazon Chime SDK meeting information.

ListAttendees

listAttendees_maxResults :: Lens' ListAttendees (Maybe Natural) Source #

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

listAttendees_nextToken :: Lens' ListAttendees (Maybe Text) Source #

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

listAttendees_meetingId :: Lens' ListAttendees Text Source #

The Amazon Chime SDK meeting ID.

listAttendeesResponse_attendees :: Lens' ListAttendeesResponse (Maybe [Attendee]) Source #

The Amazon Chime SDK attendee information.

listAttendeesResponse_nextToken :: Lens' ListAttendeesResponse (Maybe Text) Source #

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

ListTagsForResource

listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe [Tag]) Source #

The tags requested for the specified resource.

StartMeetingTranscription

startMeetingTranscription_meetingId :: Lens' StartMeetingTranscription Text Source #

The unique ID of the meeting being transcribed.

startMeetingTranscription_transcriptionConfiguration :: Lens' StartMeetingTranscription TranscriptionConfiguration Source #

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

StopMeetingTranscription

stopMeetingTranscription_meetingId :: Lens' StopMeetingTranscription Text Source #

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

TagResource

tagResource_tags :: Lens' TagResource [Tag] Source #

Lists the requested tags.

UntagResource

untagResource_resourceARN :: Lens' UntagResource Text Source #

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

untagResource_tagKeys :: Lens' UntagResource [Text] Source #

The tag keys being removed from the resources.

UpdateAttendeeCapabilities

updateAttendeeCapabilities_meetingId :: Lens' UpdateAttendeeCapabilities Text Source #

The ID of the meeting associated with the update request.

updateAttendeeCapabilities_attendeeId :: Lens' UpdateAttendeeCapabilities Text Source #

The ID of the attendee associated with the update request.

Types

Attendee

attendee_attendeeId :: Lens' Attendee (Maybe Text) Source #

The Amazon Chime SDK attendee ID.

attendee_capabilities :: Lens' Attendee (Maybe AttendeeCapabilities) Source #

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.

attendee_externalUserId :: Lens' Attendee (Maybe Text) Source #

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

attendee_joinToken :: Lens' Attendee (Maybe Text) Source #

The join token used by the Amazon Chime SDK attendee.

AttendeeCapabilities

attendeeCapabilities_audio :: Lens' AttendeeCapabilities MediaCapabilities Source #

The audio capability assigned to an attendee.

attendeeCapabilities_video :: Lens' AttendeeCapabilities MediaCapabilities Source #

The video capability assigned to an attendee.

attendeeCapabilities_content :: Lens' AttendeeCapabilities MediaCapabilities Source #

The content capability assigned to an attendee.

AttendeeIdItem

attendeeIdItem_attendeeId :: Lens' AttendeeIdItem Text Source #

A list of one or more attendee IDs.

AudioFeatures

audioFeatures_echoReduction :: Lens' AudioFeatures (Maybe MeetingFeatureStatus) Source #

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

CreateAttendeeError

createAttendeeError_externalUserId :: Lens' CreateAttendeeError (Maybe Text) Source #

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

CreateAttendeeRequestItem

createAttendeeRequestItem_externalUserId :: Lens' CreateAttendeeRequestItem Text Source #

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

EngineTranscribeMedicalSettings

engineTranscribeMedicalSettings_contentIdentificationType :: Lens' EngineTranscribeMedicalSettings (Maybe TranscribeMedicalContentIdentificationType) Source #

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

engineTranscribeMedicalSettings_region :: Lens' EngineTranscribeMedicalSettings (Maybe TranscribeMedicalRegion) Source #

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

engineTranscribeMedicalSettings_vocabularyName :: Lens' EngineTranscribeMedicalSettings (Maybe Text) Source #

The name of the vocabulary passed to Amazon Transcribe Medical.

EngineTranscribeSettings

engineTranscribeSettings_contentIdentificationType :: Lens' EngineTranscribeSettings (Maybe TranscribeContentIdentificationType) Source #

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

engineTranscribeSettings_contentRedactionType :: Lens' EngineTranscribeSettings (Maybe TranscribeContentRedactionType) Source #

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.

engineTranscribeSettings_enablePartialResultsStabilization :: Lens' EngineTranscribeSettings (Maybe Bool) Source #

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.

engineTranscribeSettings_identifyLanguage :: Lens' EngineTranscribeSettings (Maybe Bool) Source #

Automatically identifies the language spoken in media files.

engineTranscribeSettings_languageCode :: Lens' EngineTranscribeSettings (Maybe TranscribeLanguageCode) Source #

The language code specified for the Amazon Transcribe engine.

engineTranscribeSettings_languageModelName :: Lens' EngineTranscribeSettings (Maybe Text) Source #

The name of the language model used during transcription.

engineTranscribeSettings_languageOptions :: Lens' EngineTranscribeSettings (Maybe Text) Source #

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

engineTranscribeSettings_partialResultsStability :: Lens' EngineTranscribeSettings (Maybe TranscribePartialResultsStability) Source #

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.

engineTranscribeSettings_piiEntityTypes :: Lens' EngineTranscribeSettings (Maybe Text) Source #

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.

engineTranscribeSettings_region :: Lens' EngineTranscribeSettings (Maybe TranscribeRegion) Source #

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

engineTranscribeSettings_vocabularyFilterName :: Lens' EngineTranscribeSettings (Maybe Text) Source #

The name of the vocabulary filter passed to Amazon Transcribe.

engineTranscribeSettings_vocabularyName :: Lens' EngineTranscribeSettings (Maybe Text) Source #

The name of the vocabulary passed to Amazon Transcribe.

MediaPlacement

Meeting

meeting_mediaPlacement :: Lens' Meeting (Maybe MediaPlacement) Source #

The media placement for the meeting.

meeting_mediaRegion :: Lens' Meeting (Maybe Text) Source #

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.

meeting_meetingArn :: Lens' Meeting (Maybe Text) Source #

The ARN of the meeting.

meeting_meetingFeatures :: Lens' Meeting (Maybe MeetingFeaturesConfiguration) Source #

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

meeting_meetingId :: Lens' Meeting (Maybe Text) Source #

The Amazon Chime SDK meeting ID.

meeting_primaryMeetingId :: Lens' Meeting (Maybe Text) Source #

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

MeetingFeaturesConfiguration

meetingFeaturesConfiguration_audio :: Lens' MeetingFeaturesConfiguration (Maybe AudioFeatures) Source #

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

NotificationsConfiguration

notificationsConfiguration_lambdaFunctionArn :: Lens' NotificationsConfiguration (Maybe Text) Source #

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

Tag

tag_key :: Lens' Tag Text Source #

The tag's key.

tag_value :: Lens' Tag Text Source #

The tag's value.

TranscriptionConfiguration

transcriptionConfiguration_engineTranscribeMedicalSettings :: Lens' TranscriptionConfiguration (Maybe EngineTranscribeMedicalSettings) Source #

The transcription configuration settings passed to Amazon Transcribe Medical.

transcriptionConfiguration_engineTranscribeSettings :: Lens' TranscriptionConfiguration (Maybe EngineTranscribeSettings) Source #

The transcription configuration settings passed to Amazon Transcribe.