| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.ChimeSdkMeetings
Contents
- Service Configuration
- Errors
- Waiters
- Operations
- Types
- MediaCapabilities
- MeetingFeatureStatus
- TranscribeContentIdentificationType
- TranscribeContentRedactionType
- TranscribeLanguageCode
- TranscribeMedicalContentIdentificationType
- TranscribeMedicalLanguageCode
- TranscribeMedicalRegion
- TranscribeMedicalSpecialty
- TranscribeMedicalType
- TranscribePartialResultsStability
- TranscribeRegion
- TranscribeVocabularyFilterMethod
- Attendee
- AttendeeCapabilities
- AttendeeIdItem
- AudioFeatures
- CreateAttendeeError
- CreateAttendeeRequestItem
- EngineTranscribeMedicalSettings
- EngineTranscribeSettings
- MediaPlacement
- Meeting
- MeetingFeaturesConfiguration
- NotificationsConfiguration
- Tag
- TranscriptionConfiguration
Description
Derived from API version 2021-07-15 of the AWS service descriptions, licensed under Apache 2.0.
The Amazon Chime SDK meetings APIs in this section allow software developers to create Amazon Chime SDK meetings, set the AWS Regions for meetings, create and manage users, and send and receive meeting notifications. For more information about the meeting APIs, see Amazon Chime SDK meetings.
Synopsis
- defaultService :: Service
- _BadRequestException :: AsError a => Fold a ServiceError
- _ConflictException :: AsError a => Fold a ServiceError
- _ForbiddenException :: AsError a => Fold a ServiceError
- _LimitExceededException :: AsError a => Fold a ServiceError
- _NotFoundException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ServiceFailureException :: AsError a => Fold a ServiceError
- _ServiceUnavailableException :: AsError a => Fold a ServiceError
- _ThrottlingException :: AsError a => Fold a ServiceError
- _TooManyTagsException :: AsError a => Fold a ServiceError
- _UnauthorizedException :: AsError a => Fold a ServiceError
- _UnprocessableEntityException :: AsError a => Fold a ServiceError
- data BatchCreateAttendee = BatchCreateAttendee' Text (NonEmpty CreateAttendeeRequestItem)
- newBatchCreateAttendee :: Text -> NonEmpty CreateAttendeeRequestItem -> BatchCreateAttendee
- data BatchCreateAttendeeResponse = BatchCreateAttendeeResponse' (Maybe [Attendee]) (Maybe [CreateAttendeeError]) Int
- newBatchCreateAttendeeResponse :: Int -> BatchCreateAttendeeResponse
- data BatchUpdateAttendeeCapabilitiesExcept = BatchUpdateAttendeeCapabilitiesExcept' Text (NonEmpty AttendeeIdItem) AttendeeCapabilities
- newBatchUpdateAttendeeCapabilitiesExcept :: Text -> NonEmpty AttendeeIdItem -> AttendeeCapabilities -> BatchUpdateAttendeeCapabilitiesExcept
- data BatchUpdateAttendeeCapabilitiesExceptResponse = BatchUpdateAttendeeCapabilitiesExceptResponse' {
- newBatchUpdateAttendeeCapabilitiesExceptResponse :: BatchUpdateAttendeeCapabilitiesExceptResponse
- data CreateAttendee = CreateAttendee' (Maybe AttendeeCapabilities) Text (Sensitive Text)
- newCreateAttendee :: Text -> Text -> CreateAttendee
- data CreateAttendeeResponse = CreateAttendeeResponse' (Maybe Attendee) Int
- newCreateAttendeeResponse :: Int -> CreateAttendeeResponse
- data CreateMeeting = CreateMeeting' (Maybe MeetingFeaturesConfiguration) (Maybe (Sensitive Text)) (Maybe NotificationsConfiguration) (Maybe Text) (Maybe [Tag]) (Maybe (NonEmpty Text)) (Sensitive Text) Text (Sensitive Text)
- newCreateMeeting :: Text -> Text -> Text -> CreateMeeting
- data CreateMeetingResponse = CreateMeetingResponse' (Maybe Meeting) Int
- newCreateMeetingResponse :: Int -> CreateMeetingResponse
- data CreateMeetingWithAttendees = CreateMeetingWithAttendees' (Maybe MeetingFeaturesConfiguration) (Maybe (Sensitive Text)) (Maybe NotificationsConfiguration) (Maybe Text) (Maybe [Tag]) (Maybe (NonEmpty Text)) (Sensitive Text) Text (Sensitive Text) (NonEmpty CreateAttendeeRequestItem)
- newCreateMeetingWithAttendees :: Text -> Text -> Text -> NonEmpty CreateAttendeeRequestItem -> CreateMeetingWithAttendees
- data CreateMeetingWithAttendeesResponse = CreateMeetingWithAttendeesResponse' (Maybe [Attendee]) (Maybe [CreateAttendeeError]) (Maybe Meeting) Int
- newCreateMeetingWithAttendeesResponse :: Int -> CreateMeetingWithAttendeesResponse
- data DeleteAttendee = DeleteAttendee' Text Text
- newDeleteAttendee :: Text -> Text -> DeleteAttendee
- data DeleteAttendeeResponse = DeleteAttendeeResponse' {
- newDeleteAttendeeResponse :: DeleteAttendeeResponse
- data DeleteMeeting = DeleteMeeting' Text
- newDeleteMeeting :: Text -> DeleteMeeting
- data DeleteMeetingResponse = DeleteMeetingResponse' {
- newDeleteMeetingResponse :: DeleteMeetingResponse
- data GetAttendee = GetAttendee' Text Text
- newGetAttendee :: Text -> Text -> GetAttendee
- data GetAttendeeResponse = GetAttendeeResponse' (Maybe Attendee) Int
- newGetAttendeeResponse :: Int -> GetAttendeeResponse
- data GetMeeting = GetMeeting' Text
- newGetMeeting :: Text -> GetMeeting
- data GetMeetingResponse = GetMeetingResponse' (Maybe Meeting) Int
- newGetMeetingResponse :: Int -> GetMeetingResponse
- data ListAttendees = ListAttendees' (Maybe Natural) (Maybe Text) Text
- newListAttendees :: Text -> ListAttendees
- data ListAttendeesResponse = ListAttendeesResponse' (Maybe [Attendee]) (Maybe Text) Int
- newListAttendeesResponse :: Int -> ListAttendeesResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe [Tag]) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data StartMeetingTranscription = StartMeetingTranscription' Text TranscriptionConfiguration
- newStartMeetingTranscription :: Text -> TranscriptionConfiguration -> StartMeetingTranscription
- data StartMeetingTranscriptionResponse = StartMeetingTranscriptionResponse' {
- newStartMeetingTranscriptionResponse :: StartMeetingTranscriptionResponse
- data StopMeetingTranscription = StopMeetingTranscription' Text
- newStopMeetingTranscription :: Text -> StopMeetingTranscription
- data StopMeetingTranscriptionResponse = StopMeetingTranscriptionResponse' {
- newStopMeetingTranscriptionResponse :: StopMeetingTranscriptionResponse
- data TagResource = TagResource' Text [Tag]
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data UntagResource = UntagResource' Text [Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data UpdateAttendeeCapabilities = UpdateAttendeeCapabilities' Text Text AttendeeCapabilities
- newUpdateAttendeeCapabilities :: Text -> Text -> AttendeeCapabilities -> UpdateAttendeeCapabilities
- data UpdateAttendeeCapabilitiesResponse = UpdateAttendeeCapabilitiesResponse' (Maybe Attendee) Int
- newUpdateAttendeeCapabilitiesResponse :: Int -> UpdateAttendeeCapabilitiesResponse
- newtype MediaCapabilities where
- MediaCapabilities' { }
- pattern MediaCapabilities_None :: MediaCapabilities
- pattern MediaCapabilities_Receive :: MediaCapabilities
- pattern MediaCapabilities_Send :: MediaCapabilities
- pattern MediaCapabilities_SendReceive :: MediaCapabilities
- newtype MeetingFeatureStatus where
- newtype TranscribeContentIdentificationType where
- newtype TranscribeContentRedactionType where
- newtype TranscribeLanguageCode where
- TranscribeLanguageCode' { }
- pattern TranscribeLanguageCode_De_DE :: TranscribeLanguageCode
- pattern TranscribeLanguageCode_En_AU :: TranscribeLanguageCode
- pattern TranscribeLanguageCode_En_GB :: TranscribeLanguageCode
- pattern TranscribeLanguageCode_En_US :: TranscribeLanguageCode
- pattern TranscribeLanguageCode_Es_US :: TranscribeLanguageCode
- pattern TranscribeLanguageCode_Fr_CA :: TranscribeLanguageCode
- pattern TranscribeLanguageCode_Fr_FR :: TranscribeLanguageCode
- pattern TranscribeLanguageCode_It_IT :: TranscribeLanguageCode
- pattern TranscribeLanguageCode_Ja_JP :: TranscribeLanguageCode
- pattern TranscribeLanguageCode_Ko_KR :: TranscribeLanguageCode
- pattern TranscribeLanguageCode_Pt_BR :: TranscribeLanguageCode
- pattern TranscribeLanguageCode_Zh_CN :: TranscribeLanguageCode
- newtype TranscribeMedicalContentIdentificationType where
- newtype TranscribeMedicalLanguageCode where
- newtype TranscribeMedicalRegion where
- TranscribeMedicalRegion' { }
- pattern TranscribeMedicalRegion_Ap_southeast_2 :: TranscribeMedicalRegion
- pattern TranscribeMedicalRegion_Auto :: TranscribeMedicalRegion
- pattern TranscribeMedicalRegion_Ca_central_1 :: TranscribeMedicalRegion
- pattern TranscribeMedicalRegion_Eu_west_1 :: TranscribeMedicalRegion
- pattern TranscribeMedicalRegion_Us_east_1 :: TranscribeMedicalRegion
- pattern TranscribeMedicalRegion_Us_east_2 :: TranscribeMedicalRegion
- pattern TranscribeMedicalRegion_Us_west_2 :: TranscribeMedicalRegion
- newtype TranscribeMedicalSpecialty where
- TranscribeMedicalSpecialty' { }
- pattern TranscribeMedicalSpecialty_CARDIOLOGY :: TranscribeMedicalSpecialty
- pattern TranscribeMedicalSpecialty_NEUROLOGY :: TranscribeMedicalSpecialty
- pattern TranscribeMedicalSpecialty_ONCOLOGY :: TranscribeMedicalSpecialty
- pattern TranscribeMedicalSpecialty_PRIMARYCARE :: TranscribeMedicalSpecialty
- pattern TranscribeMedicalSpecialty_RADIOLOGY :: TranscribeMedicalSpecialty
- pattern TranscribeMedicalSpecialty_UROLOGY :: TranscribeMedicalSpecialty
- newtype TranscribeMedicalType where
- newtype TranscribePartialResultsStability where
- newtype TranscribeRegion where
- TranscribeRegion' { }
- pattern TranscribeRegion_Ap_northeast_1 :: TranscribeRegion
- pattern TranscribeRegion_Ap_northeast_2 :: TranscribeRegion
- pattern TranscribeRegion_Ap_southeast_2 :: TranscribeRegion
- pattern TranscribeRegion_Auto :: TranscribeRegion
- pattern TranscribeRegion_Ca_central_1 :: TranscribeRegion
- pattern TranscribeRegion_Eu_central_1 :: TranscribeRegion
- pattern TranscribeRegion_Eu_west_1 :: TranscribeRegion
- pattern TranscribeRegion_Eu_west_2 :: TranscribeRegion
- pattern TranscribeRegion_Sa_east_1 :: TranscribeRegion
- pattern TranscribeRegion_Us_east_1 :: TranscribeRegion
- pattern TranscribeRegion_Us_east_2 :: TranscribeRegion
- pattern TranscribeRegion_Us_gov_west_1 :: TranscribeRegion
- pattern TranscribeRegion_Us_west_2 :: TranscribeRegion
- newtype TranscribeVocabularyFilterMethod where
- data Attendee = Attendee' (Maybe Text) (Maybe AttendeeCapabilities) (Maybe (Sensitive Text)) (Maybe (Sensitive Text))
- newAttendee :: Attendee
- data AttendeeCapabilities = AttendeeCapabilities' MediaCapabilities MediaCapabilities MediaCapabilities
- newAttendeeCapabilities :: MediaCapabilities -> MediaCapabilities -> MediaCapabilities -> AttendeeCapabilities
- data AttendeeIdItem = AttendeeIdItem' Text
- newAttendeeIdItem :: Text -> AttendeeIdItem
- data AudioFeatures = AudioFeatures' (Maybe MeetingFeatureStatus)
- newAudioFeatures :: AudioFeatures
- data CreateAttendeeError = CreateAttendeeError' (Maybe Text) (Maybe Text) (Maybe (Sensitive Text))
- newCreateAttendeeError :: CreateAttendeeError
- data CreateAttendeeRequestItem = CreateAttendeeRequestItem' (Maybe AttendeeCapabilities) (Sensitive Text)
- newCreateAttendeeRequestItem :: Text -> CreateAttendeeRequestItem
- data EngineTranscribeMedicalSettings = EngineTranscribeMedicalSettings' (Maybe TranscribeMedicalContentIdentificationType) (Maybe TranscribeMedicalRegion) (Maybe Text) TranscribeMedicalLanguageCode TranscribeMedicalSpecialty TranscribeMedicalType
- newEngineTranscribeMedicalSettings :: TranscribeMedicalLanguageCode -> TranscribeMedicalSpecialty -> TranscribeMedicalType -> EngineTranscribeMedicalSettings
- data EngineTranscribeSettings = EngineTranscribeSettings' (Maybe TranscribeContentIdentificationType) (Maybe TranscribeContentRedactionType) (Maybe Bool) (Maybe Bool) (Maybe TranscribeLanguageCode) (Maybe Text) (Maybe Text) (Maybe TranscribePartialResultsStability) (Maybe Text) (Maybe TranscribeLanguageCode) (Maybe TranscribeRegion) (Maybe TranscribeVocabularyFilterMethod) (Maybe Text) (Maybe Text)
- newEngineTranscribeSettings :: EngineTranscribeSettings
- data MediaPlacement = MediaPlacement' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newMediaPlacement :: MediaPlacement
- data Meeting = Meeting' (Maybe (Sensitive Text)) (Maybe MediaPlacement) (Maybe Text) (Maybe Text) (Maybe MeetingFeaturesConfiguration) (Maybe (Sensitive Text)) (Maybe Text) (Maybe Text) (Maybe (NonEmpty Text))
- newMeeting :: Meeting
- data MeetingFeaturesConfiguration = MeetingFeaturesConfiguration' (Maybe AudioFeatures)
- newMeetingFeaturesConfiguration :: MeetingFeaturesConfiguration
- data NotificationsConfiguration = NotificationsConfiguration' (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe (Sensitive Text))
- newNotificationsConfiguration :: NotificationsConfiguration
- data Tag = Tag' Text Text
- newTag :: Text -> Text -> Tag
- data TranscriptionConfiguration = TranscriptionConfiguration' (Maybe EngineTranscribeMedicalSettings) (Maybe EngineTranscribeSettings)
- newTranscriptionConfiguration :: TranscriptionConfiguration
Service Configuration
defaultService :: Service Source #
API version 2021-07-15 of the Amazon Chime SDK Meetings SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by ChimeSdkMeetings.
BadRequestException
_BadRequestException :: AsError a => Fold a ServiceError Source #
The input parameters don't match the service's restrictions.
ConflictException
_ConflictException :: AsError a => Fold a ServiceError Source #
Multiple instances of the same request have been made simultaneously.
ForbiddenException
_ForbiddenException :: AsError a => Fold a ServiceError Source #
The client is permanently forbidden from making the request.
LimitExceededException
_LimitExceededException :: AsError a => Fold a ServiceError Source #
The request exceeds the resource limit.
NotFoundException
_NotFoundException :: AsError a => Fold a ServiceError Source #
One or more of the resources in the request does not exist in the system.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The resource that you want to tag couldn't be found.
ServiceFailureException
_ServiceFailureException :: AsError a => Fold a ServiceError Source #
The service encountered an unexpected error.
ServiceUnavailableException
_ServiceUnavailableException :: AsError a => Fold a ServiceError Source #
The service is currently unavailable.
ThrottlingException
_ThrottlingException :: AsError a => Fold a ServiceError Source #
The number of customer requests exceeds the request rate limit.
TooManyTagsException
_TooManyTagsException :: AsError a => Fold a ServiceError Source #
Too many tags were added to the specified resource.
UnauthorizedException
_UnauthorizedException :: AsError a => Fold a ServiceError Source #
The user isn't authorized to request a resource.
UnprocessableEntityException
_UnprocessableEntityException :: AsError a => Fold a ServiceError Source #
The request was well-formed but was unable to be followed due to semantic errors.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
BatchCreateAttendee
data BatchCreateAttendee Source #
See: newBatchCreateAttendee smart constructor.
Constructors
| BatchCreateAttendee' Text (NonEmpty CreateAttendeeRequestItem) |
Instances
newBatchCreateAttendee Source #
Arguments
| :: Text | |
| -> NonEmpty CreateAttendeeRequestItem | |
| -> BatchCreateAttendee |
Create a value of BatchCreateAttendee with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
BatchCreateAttendee, batchCreateAttendee_meetingId - The Amazon Chime SDK ID of the meeting to which you're adding
attendees.
BatchCreateAttendee, batchCreateAttendee_attendees - The attendee information, including attendees' IDs and join tokens.
data BatchCreateAttendeeResponse Source #
See: newBatchCreateAttendeeResponse smart constructor.
Constructors
| BatchCreateAttendeeResponse' (Maybe [Attendee]) (Maybe [CreateAttendeeError]) Int |
Instances
newBatchCreateAttendeeResponse Source #
Create a value of BatchCreateAttendeeResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
BatchCreateAttendee, batchCreateAttendeeResponse_attendees - The attendee information, including attendees' IDs and join tokens.
$sel:errors:BatchCreateAttendeeResponse', batchCreateAttendeeResponse_errors - 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.
$sel:httpStatus:BatchCreateAttendeeResponse', batchCreateAttendeeResponse_httpStatus - The response's http status code.
BatchUpdateAttendeeCapabilitiesExcept
data BatchUpdateAttendeeCapabilitiesExcept Source #
See: newBatchUpdateAttendeeCapabilitiesExcept smart constructor.
Constructors
| BatchUpdateAttendeeCapabilitiesExcept' Text (NonEmpty AttendeeIdItem) AttendeeCapabilities |
Instances
newBatchUpdateAttendeeCapabilitiesExcept Source #
Arguments
| :: Text | |
| -> NonEmpty AttendeeIdItem |
|
| -> AttendeeCapabilities | |
| -> BatchUpdateAttendeeCapabilitiesExcept |
Create a value of BatchUpdateAttendeeCapabilitiesExcept with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
BatchUpdateAttendeeCapabilitiesExcept, batchUpdateAttendeeCapabilitiesExcept_meetingId - The ID of the meeting associated with the update request.
$sel:excludedAttendeeIds:BatchUpdateAttendeeCapabilitiesExcept', batchUpdateAttendeeCapabilitiesExcept_excludedAttendeeIds - The AttendeeIDs that you want to exclude from one or more
capabilities.
BatchUpdateAttendeeCapabilitiesExcept, batchUpdateAttendeeCapabilitiesExcept_capabilities - The capabilities (audio, video, or content) that you want to
update.
data BatchUpdateAttendeeCapabilitiesExceptResponse Source #
See: newBatchUpdateAttendeeCapabilitiesExceptResponse smart constructor.
Constructors
| BatchUpdateAttendeeCapabilitiesExceptResponse' | |
Instances
newBatchUpdateAttendeeCapabilitiesExceptResponse :: BatchUpdateAttendeeCapabilitiesExceptResponse Source #
Create a value of BatchUpdateAttendeeCapabilitiesExceptResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
CreateAttendee
data CreateAttendee Source #
See: newCreateAttendee smart constructor.
Constructors
| CreateAttendee' (Maybe AttendeeCapabilities) Text (Sensitive Text) |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> CreateAttendee |
Create a value of CreateAttendee with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateAttendee, createAttendee_capabilities - 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
contentcapabilities toSendReceiveorReceiveunless you also setvideocapabilities toSendReceiveorReceive. If you don't set thevideocapability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set yourvideocapability to receive and you set yourcontentcapability to not receive. - When you change an
audiocapability fromNoneorReceivetoSendorSendReceive, and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants. - When you change a
videoorcontentcapability fromNoneorReceivetoSendorSendReceive, 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, createAttendee_meetingId - The unique ID of the meeting.
CreateAttendee, createAttendee_externalUserId - The Amazon Chime SDK external user ID. An idempotency token. Links the
attendee to an identity managed by a builder application.
data CreateAttendeeResponse Source #
See: newCreateAttendeeResponse smart constructor.
Constructors
| CreateAttendeeResponse' (Maybe Attendee) Int |
Instances
newCreateAttendeeResponse Source #
Create a value of CreateAttendeeResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attendee:CreateAttendeeResponse', createAttendeeResponse_attendee - The attendee information, including attendee ID and join token.
$sel:httpStatus:CreateAttendeeResponse', createAttendeeResponse_httpStatus - The response's http status code.
CreateMeeting
data CreateMeeting Source #
See: newCreateMeeting smart constructor.
Constructors
| CreateMeeting' (Maybe MeetingFeaturesConfiguration) (Maybe (Sensitive Text)) (Maybe NotificationsConfiguration) (Maybe Text) (Maybe [Tag]) (Maybe (NonEmpty Text)) (Sensitive Text) Text (Sensitive Text) |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> CreateMeeting |
Create a value of CreateMeeting with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateMeeting, createMeeting_meetingFeatures - Lists the audio and video features enabled for a meeting, such as echo
reduction.
CreateMeeting, createMeeting_meetingHostId - Reserved.
$sel:notificationsConfiguration:CreateMeeting', createMeeting_notificationsConfiguration - The configuration for resource targets to receive notifications when
meeting and attendee events occur.
CreateMeeting, createMeeting_primaryMeetingId - When specified, replicates the media from the primary meeting to the new
meeting.
$sel:tags:CreateMeeting', createMeeting_tags - 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, createMeeting_tenantIds - A consistent and opaque identifier, created and maintained by the
builder to represent a segment of their users.
$sel:clientRequestToken:CreateMeeting', createMeeting_clientRequestToken - The unique identifier for the client request. Use a different token for
different meetings.
CreateMeeting, createMeeting_mediaRegion - 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.
CreateMeeting, createMeeting_externalMeetingId - The external meeting ID.
data CreateMeetingResponse Source #
See: newCreateMeetingResponse smart constructor.
Constructors
| CreateMeetingResponse' (Maybe Meeting) Int |
Instances
newCreateMeetingResponse Source #
Create a value of CreateMeetingResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:meeting:CreateMeetingResponse', createMeetingResponse_meeting - The meeting information, including the meeting ID and MediaPlacement.
$sel:httpStatus:CreateMeetingResponse', createMeetingResponse_httpStatus - The response's http status code.
CreateMeetingWithAttendees
data CreateMeetingWithAttendees Source #
See: newCreateMeetingWithAttendees smart constructor.
Constructors
Instances
newCreateMeetingWithAttendees Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> NonEmpty CreateAttendeeRequestItem | |
| -> CreateMeetingWithAttendees |
Create a value of CreateMeetingWithAttendees with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateMeetingWithAttendees, createMeetingWithAttendees_meetingFeatures - Lists the audio and video features enabled for a meeting, such as echo
reduction.
CreateMeetingWithAttendees, createMeetingWithAttendees_meetingHostId - Reserved.
$sel:notificationsConfiguration:CreateMeetingWithAttendees', createMeetingWithAttendees_notificationsConfiguration - The configuration for resource targets to receive notifications when
meeting and attendee events occur.
CreateMeetingWithAttendees, createMeetingWithAttendees_primaryMeetingId - When specified, replicates the media from the primary meeting to the new
meeting.
$sel:tags:CreateMeetingWithAttendees', createMeetingWithAttendees_tags - The tags in the request.
CreateMeetingWithAttendees, createMeetingWithAttendees_tenantIds - A consistent and opaque identifier, created and maintained by the
builder to represent a segment of their users.
$sel:clientRequestToken:CreateMeetingWithAttendees', createMeetingWithAttendees_clientRequestToken - The unique identifier for the client request. Use a different token for
different meetings.
CreateMeetingWithAttendees, createMeetingWithAttendees_mediaRegion - 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, createMeetingWithAttendees_externalMeetingId - The external meeting ID.
CreateMeetingWithAttendees, createMeetingWithAttendees_attendees - The attendee information, including attendees' IDs and join tokens.
data CreateMeetingWithAttendeesResponse Source #
See: newCreateMeetingWithAttendeesResponse smart constructor.
Constructors
| CreateMeetingWithAttendeesResponse' (Maybe [Attendee]) (Maybe [CreateAttendeeError]) (Maybe Meeting) Int |
Instances
newCreateMeetingWithAttendeesResponse Source #
Arguments
| :: Int | |
| -> CreateMeetingWithAttendeesResponse |
Create a value of CreateMeetingWithAttendeesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateMeetingWithAttendees, createMeetingWithAttendeesResponse_attendees - The attendee information, including attendees' IDs and join tokens.
$sel:errors:CreateMeetingWithAttendeesResponse', createMeetingWithAttendeesResponse_errors - 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.
$sel:meeting:CreateMeetingWithAttendeesResponse', createMeetingWithAttendeesResponse_meeting - The meeting information, including the meeting ID and MediaPlacement.
$sel:httpStatus:CreateMeetingWithAttendeesResponse', createMeetingWithAttendeesResponse_httpStatus - The response's http status code.
DeleteAttendee
data DeleteAttendee Source #
See: newDeleteAttendee smart constructor.
Constructors
| DeleteAttendee' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> DeleteAttendee |
Create a value of DeleteAttendee with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteAttendee, deleteAttendee_meetingId - The Amazon Chime SDK meeting ID.
DeleteAttendee, deleteAttendee_attendeeId - The Amazon Chime SDK attendee ID.
data DeleteAttendeeResponse Source #
See: newDeleteAttendeeResponse smart constructor.
Constructors
| DeleteAttendeeResponse' | |
Instances
newDeleteAttendeeResponse :: DeleteAttendeeResponse Source #
Create a value of DeleteAttendeeResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteMeeting
data DeleteMeeting Source #
See: newDeleteMeeting smart constructor.
Constructors
| DeleteMeeting' Text |
Instances
Arguments
| :: Text | |
| -> DeleteMeeting |
Create a value of DeleteMeeting with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteMeeting, deleteMeeting_meetingId - The Amazon Chime SDK meeting ID.
data DeleteMeetingResponse Source #
See: newDeleteMeetingResponse smart constructor.
Constructors
| DeleteMeetingResponse' | |
Instances
newDeleteMeetingResponse :: DeleteMeetingResponse Source #
Create a value of DeleteMeetingResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
GetAttendee
data GetAttendee Source #
See: newGetAttendee smart constructor.
Constructors
| GetAttendee' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> GetAttendee |
Create a value of GetAttendee with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetAttendee, getAttendee_meetingId - The Amazon Chime SDK meeting ID.
GetAttendee, getAttendee_attendeeId - The Amazon Chime SDK attendee ID.
data GetAttendeeResponse Source #
See: newGetAttendeeResponse smart constructor.
Constructors
| GetAttendeeResponse' (Maybe Attendee) Int |
Instances
newGetAttendeeResponse Source #
Arguments
| :: Int | |
| -> GetAttendeeResponse |
Create a value of GetAttendeeResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attendee:GetAttendeeResponse', getAttendeeResponse_attendee - The Amazon Chime SDK attendee information.
$sel:httpStatus:GetAttendeeResponse', getAttendeeResponse_httpStatus - The response's http status code.
GetMeeting
data GetMeeting Source #
See: newGetMeeting smart constructor.
Constructors
| GetMeeting' Text |
Instances
Arguments
| :: Text | |
| -> GetMeeting |
Create a value of GetMeeting with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetMeeting, getMeeting_meetingId - The Amazon Chime SDK meeting ID.
data GetMeetingResponse Source #
See: newGetMeetingResponse smart constructor.
Constructors
| GetMeetingResponse' (Maybe Meeting) Int |
Instances
newGetMeetingResponse Source #
Arguments
| :: Int | |
| -> GetMeetingResponse |
Create a value of GetMeetingResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:meeting:GetMeetingResponse', getMeetingResponse_meeting - The Amazon Chime SDK meeting information.
$sel:httpStatus:GetMeetingResponse', getMeetingResponse_httpStatus - The response's http status code.
ListAttendees
data ListAttendees Source #
See: newListAttendees smart constructor.
Instances
Arguments
| :: Text | |
| -> ListAttendees |
Create a value of ListAttendees with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListAttendees', listAttendees_maxResults - The maximum number of results to return in a single call.
ListAttendees, listAttendees_nextToken - The token to use to retrieve the next page of results.
ListAttendees, listAttendees_meetingId - The Amazon Chime SDK meeting ID.
data ListAttendeesResponse Source #
See: newListAttendeesResponse smart constructor.
Instances
newListAttendeesResponse Source #
Create a value of ListAttendeesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attendees:ListAttendeesResponse', listAttendeesResponse_attendees - The Amazon Chime SDK attendee information.
ListAttendees, listAttendeesResponse_nextToken - The token to use to retrieve the next page of results.
$sel:httpStatus:ListAttendeesResponse', listAttendeesResponse_httpStatus - The response's http status code.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource smart constructor.
Constructors
| ListTagsForResource' Text |
Instances
newListTagsForResource Source #
Arguments
| :: Text | |
| -> ListTagsForResource |
Create a value of ListTagsForResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceARN:ListTagsForResource', listTagsForResource_resourceARN - The ARN of the resource.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse smart constructor.
Constructors
| ListTagsForResourceResponse' (Maybe [Tag]) Int |
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tags:ListTagsForResourceResponse', listTagsForResourceResponse_tags - The tags requested for the specified resource.
$sel:httpStatus:ListTagsForResourceResponse', listTagsForResourceResponse_httpStatus - The response's http status code.
StartMeetingTranscription
data StartMeetingTranscription Source #
See: newStartMeetingTranscription smart constructor.
Constructors
| StartMeetingTranscription' Text TranscriptionConfiguration |
Instances
newStartMeetingTranscription Source #
Arguments
| :: Text | |
| -> TranscriptionConfiguration | |
| -> StartMeetingTranscription |
Create a value of StartMeetingTranscription with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
StartMeetingTranscription, startMeetingTranscription_meetingId - The unique ID of the meeting being transcribed.
$sel:transcriptionConfiguration:StartMeetingTranscription', startMeetingTranscription_transcriptionConfiguration - The configuration for the current transcription operation. Must contain
EngineTranscribeSettings or EngineTranscribeMedicalSettings.
data StartMeetingTranscriptionResponse Source #
See: newStartMeetingTranscriptionResponse smart constructor.
Constructors
| StartMeetingTranscriptionResponse' | |
Instances
newStartMeetingTranscriptionResponse :: StartMeetingTranscriptionResponse Source #
Create a value of StartMeetingTranscriptionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
StopMeetingTranscription
data StopMeetingTranscription Source #
See: newStopMeetingTranscription smart constructor.
Constructors
| StopMeetingTranscription' Text |
Instances
newStopMeetingTranscription Source #
Arguments
| :: Text | |
| -> StopMeetingTranscription |
Create a value of StopMeetingTranscription with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
StopMeetingTranscription, stopMeetingTranscription_meetingId - The unique ID of the meeting for which you stop transcription.
data StopMeetingTranscriptionResponse Source #
See: newStopMeetingTranscriptionResponse smart constructor.
Constructors
| StopMeetingTranscriptionResponse' | |
Instances
| Generic StopMeetingTranscriptionResponse Source # | |
Defined in Amazonka.ChimeSdkMeetings.StopMeetingTranscription Associated Types type Rep StopMeetingTranscriptionResponse :: Type -> Type # | |
| Read StopMeetingTranscriptionResponse Source # | |
| Show StopMeetingTranscriptionResponse Source # | |
Defined in Amazonka.ChimeSdkMeetings.StopMeetingTranscription Methods showsPrec :: Int -> StopMeetingTranscriptionResponse -> ShowS # | |
| NFData StopMeetingTranscriptionResponse Source # | |
Defined in Amazonka.ChimeSdkMeetings.StopMeetingTranscription Methods rnf :: StopMeetingTranscriptionResponse -> () # | |
| Eq StopMeetingTranscriptionResponse Source # | |
| type Rep StopMeetingTranscriptionResponse Source # | |
newStopMeetingTranscriptionResponse :: StopMeetingTranscriptionResponse Source #
Create a value of StopMeetingTranscriptionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
TagResource
data TagResource Source #
See: newTagResource smart constructor.
Constructors
| TagResource' Text [Tag] |
Instances
Arguments
| :: Text | |
| -> TagResource |
Create a value of TagResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceARN:TagResource', tagResource_resourceARN - The ARN of the resource.
$sel:tags:TagResource', tagResource_tags - Lists the requested tags.
data TagResourceResponse Source #
See: newTagResourceResponse smart constructor.
Constructors
| TagResourceResponse' Int |
Instances
newTagResourceResponse Source #
Arguments
| :: Int | |
| -> TagResourceResponse |
Create a value of TagResourceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:TagResourceResponse', tagResourceResponse_httpStatus - The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource smart constructor.
Constructors
| UntagResource' Text [Text] |
Instances
Arguments
| :: Text | |
| -> UntagResource |
Create a value of UntagResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceARN:UntagResource', untagResource_resourceARN - The ARN of the resource that you're removing tags from.
$sel:tagKeys:UntagResource', untagResource_tagKeys - The tag keys being removed from the resources.
data UntagResourceResponse Source #
See: newUntagResourceResponse smart constructor.
Constructors
| UntagResourceResponse' Int |
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UntagResourceResponse', untagResourceResponse_httpStatus - The response's http status code.
UpdateAttendeeCapabilities
data UpdateAttendeeCapabilities Source #
See: newUpdateAttendeeCapabilities smart constructor.
Constructors
| UpdateAttendeeCapabilities' Text Text AttendeeCapabilities |
Instances
newUpdateAttendeeCapabilities Source #
Arguments
| :: Text | |
| -> Text | |
| -> AttendeeCapabilities | |
| -> UpdateAttendeeCapabilities |
Create a value of UpdateAttendeeCapabilities with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateAttendeeCapabilities, updateAttendeeCapabilities_meetingId - The ID of the meeting associated with the update request.
UpdateAttendeeCapabilities, updateAttendeeCapabilities_attendeeId - The ID of the attendee associated with the update request.
UpdateAttendeeCapabilities, updateAttendeeCapabilities_capabilities - The capabilties that you want to update.
data UpdateAttendeeCapabilitiesResponse Source #
See: newUpdateAttendeeCapabilitiesResponse smart constructor.
Constructors
| UpdateAttendeeCapabilitiesResponse' (Maybe Attendee) Int |
Instances
newUpdateAttendeeCapabilitiesResponse Source #
Arguments
| :: Int | |
| -> UpdateAttendeeCapabilitiesResponse |
Create a value of UpdateAttendeeCapabilitiesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attendee:UpdateAttendeeCapabilitiesResponse', updateAttendeeCapabilitiesResponse_attendee - The updated attendee data.
$sel:httpStatus:UpdateAttendeeCapabilitiesResponse', updateAttendeeCapabilitiesResponse_httpStatus - The response's http status code.
Types
MediaCapabilities
newtype MediaCapabilities Source #
Constructors
| MediaCapabilities' | |
Fields | |
Bundled Patterns
| pattern MediaCapabilities_None :: MediaCapabilities | |
| pattern MediaCapabilities_Receive :: MediaCapabilities | |
| pattern MediaCapabilities_Send :: MediaCapabilities | |
| pattern MediaCapabilities_SendReceive :: MediaCapabilities |
Instances
MeetingFeatureStatus
newtype MeetingFeatureStatus Source #
Constructors
| MeetingFeatureStatus' | |
Fields | |
Bundled Patterns
| pattern MeetingFeatureStatus_AVAILABLE :: MeetingFeatureStatus | |
| pattern MeetingFeatureStatus_UNAVAILABLE :: MeetingFeatureStatus |
Instances
TranscribeContentIdentificationType
newtype TranscribeContentIdentificationType Source #
Constructors
| TranscribeContentIdentificationType' | |
Bundled Patterns
| pattern TranscribeContentIdentificationType_PII :: TranscribeContentIdentificationType |
Instances
TranscribeContentRedactionType
newtype TranscribeContentRedactionType Source #
Constructors
| TranscribeContentRedactionType' | |
Fields | |
Bundled Patterns
| pattern TranscribeContentRedactionType_PII :: TranscribeContentRedactionType |
Instances
TranscribeLanguageCode
newtype TranscribeLanguageCode Source #
Constructors
| TranscribeLanguageCode' | |
Fields | |
Bundled Patterns
| pattern TranscribeLanguageCode_De_DE :: TranscribeLanguageCode | |
| pattern TranscribeLanguageCode_En_AU :: TranscribeLanguageCode | |
| pattern TranscribeLanguageCode_En_GB :: TranscribeLanguageCode | |
| pattern TranscribeLanguageCode_En_US :: TranscribeLanguageCode | |
| pattern TranscribeLanguageCode_Es_US :: TranscribeLanguageCode | |
| pattern TranscribeLanguageCode_Fr_CA :: TranscribeLanguageCode | |
| pattern TranscribeLanguageCode_Fr_FR :: TranscribeLanguageCode | |
| pattern TranscribeLanguageCode_It_IT :: TranscribeLanguageCode | |
| pattern TranscribeLanguageCode_Ja_JP :: TranscribeLanguageCode | |
| pattern TranscribeLanguageCode_Ko_KR :: TranscribeLanguageCode | |
| pattern TranscribeLanguageCode_Pt_BR :: TranscribeLanguageCode | |
| pattern TranscribeLanguageCode_Zh_CN :: TranscribeLanguageCode |
Instances
TranscribeMedicalContentIdentificationType
newtype TranscribeMedicalContentIdentificationType Source #
Constructors
| TranscribeMedicalContentIdentificationType' | |
Bundled Patterns
| pattern TranscribeMedicalContentIdentificationType_PHI :: TranscribeMedicalContentIdentificationType |
Instances
TranscribeMedicalLanguageCode
newtype TranscribeMedicalLanguageCode Source #
Constructors
| TranscribeMedicalLanguageCode' | |
Fields | |
Bundled Patterns
| pattern TranscribeMedicalLanguageCode_En_US :: TranscribeMedicalLanguageCode |
Instances
TranscribeMedicalRegion
newtype TranscribeMedicalRegion Source #
Constructors
| TranscribeMedicalRegion' | |
Fields | |
Bundled Patterns
Instances
TranscribeMedicalSpecialty
newtype TranscribeMedicalSpecialty Source #
Constructors
| TranscribeMedicalSpecialty' | |
Fields | |
Bundled Patterns
Instances
TranscribeMedicalType
newtype TranscribeMedicalType Source #
Constructors
| TranscribeMedicalType' | |
Fields | |
Bundled Patterns
| pattern TranscribeMedicalType_CONVERSATION :: TranscribeMedicalType | |
| pattern TranscribeMedicalType_DICTATION :: TranscribeMedicalType |
Instances
TranscribePartialResultsStability
newtype TranscribePartialResultsStability Source #
Constructors
| TranscribePartialResultsStability' | |
Bundled Patterns
Instances
TranscribeRegion
newtype TranscribeRegion Source #
Constructors
| TranscribeRegion' | |
Fields | |
Bundled Patterns
| pattern TranscribeRegion_Ap_northeast_1 :: TranscribeRegion | |
| pattern TranscribeRegion_Ap_northeast_2 :: TranscribeRegion | |
| pattern TranscribeRegion_Ap_southeast_2 :: TranscribeRegion | |
| pattern TranscribeRegion_Auto :: TranscribeRegion | |
| pattern TranscribeRegion_Ca_central_1 :: TranscribeRegion | |
| pattern TranscribeRegion_Eu_central_1 :: TranscribeRegion | |
| pattern TranscribeRegion_Eu_west_1 :: TranscribeRegion | |
| pattern TranscribeRegion_Eu_west_2 :: TranscribeRegion | |
| pattern TranscribeRegion_Sa_east_1 :: TranscribeRegion | |
| pattern TranscribeRegion_Us_east_1 :: TranscribeRegion | |
| pattern TranscribeRegion_Us_east_2 :: TranscribeRegion | |
| pattern TranscribeRegion_Us_gov_west_1 :: TranscribeRegion | |
| pattern TranscribeRegion_Us_west_2 :: TranscribeRegion |
Instances
TranscribeVocabularyFilterMethod
newtype TranscribeVocabularyFilterMethod Source #
Constructors
| TranscribeVocabularyFilterMethod' | |
Fields | |
Bundled Patterns
Instances
Attendee
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.
See: newAttendee smart constructor.
Constructors
| Attendee' (Maybe Text) (Maybe AttendeeCapabilities) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) |
Instances
newAttendee :: Attendee Source #
Create a value of Attendee with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attendeeId:Attendee', attendee_attendeeId - The Amazon Chime SDK attendee ID.
$sel:capabilities:Attendee', attendee_capabilities - 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
contentcapabilities toSendReceiveorReceiveunless you also setvideocapabilities toSendReceiveorReceive. If you don't set thevideocapability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set yourvideocapability to receive and you set yourcontentcapability to not receive. - When you change an
audiocapability fromNoneorReceivetoSendorSendReceive, and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants. - When you change a
videoorcontentcapability fromNoneorReceivetoSendorSendReceive, 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.
$sel:externalUserId:Attendee', attendee_externalUserId - The Amazon Chime SDK external user ID. An idempotency token. Links the
attendee to an identity managed by a builder application.
$sel:joinToken:Attendee', attendee_joinToken - The join token used by the Amazon Chime SDK attendee.
AttendeeCapabilities
data AttendeeCapabilities Source #
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
contentcapabilities toSendReceiveorReceiveunless you also setvideocapabilities toSendReceiveorReceive. If you don't set thevideocapability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set yourvideocapability to receive and you set yourcontentcapability to not receive. - When you change an
audiocapability fromNoneorReceivetoSendorSendReceive, and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants. - When you change a
videoorcontentcapability fromNoneorReceivetoSendorSendReceive, 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.
See: newAttendeeCapabilities smart constructor.
Instances
newAttendeeCapabilities Source #
Arguments
| :: MediaCapabilities | |
| -> MediaCapabilities | |
| -> MediaCapabilities | |
| -> AttendeeCapabilities |
Create a value of AttendeeCapabilities with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:audio:AttendeeCapabilities', attendeeCapabilities_audio - The audio capability assigned to an attendee.
$sel:video:AttendeeCapabilities', attendeeCapabilities_video - The video capability assigned to an attendee.
$sel:content:AttendeeCapabilities', attendeeCapabilities_content - The content capability assigned to an attendee.
AttendeeIdItem
data AttendeeIdItem Source #
A structure that contains one or more attendee IDs.
See: newAttendeeIdItem smart constructor.
Constructors
| AttendeeIdItem' Text |
Instances
Arguments
| :: Text | |
| -> AttendeeIdItem |
Create a value of AttendeeIdItem with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attendeeId:AttendeeIdItem', attendeeIdItem_attendeeId - A list of one or more attendee IDs.
AudioFeatures
data AudioFeatures Source #
An optional category of meeting features that contains audio-specific configurations, such as operating parameters for Amazon Voice Focus.
See: newAudioFeatures smart constructor.
Constructors
| AudioFeatures' (Maybe MeetingFeatureStatus) |
Instances
newAudioFeatures :: AudioFeatures Source #
Create a value of AudioFeatures with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:echoReduction:AudioFeatures', audioFeatures_echoReduction - Makes echo reduction available to clients who connect to the meeting.
CreateAttendeeError
data CreateAttendeeError Source #
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.
See: newCreateAttendeeError smart constructor.
Instances
newCreateAttendeeError :: CreateAttendeeError Source #
Create a value of CreateAttendeeError with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:errorCode:CreateAttendeeError', createAttendeeError_errorCode - The error code.
$sel:errorMessage:CreateAttendeeError', createAttendeeError_errorMessage - The error message.
$sel:externalUserId:CreateAttendeeError', createAttendeeError_externalUserId - The Amazon Chime SDK external user ID. An idempotency token. Links the
attendee to an identity managed by a builder application.
CreateAttendeeRequestItem
data CreateAttendeeRequestItem Source #
The Amazon Chime SDK attendee fields to create, used with the BatchCreateAttendee action.
See: newCreateAttendeeRequestItem smart constructor.
Constructors
| CreateAttendeeRequestItem' (Maybe AttendeeCapabilities) (Sensitive Text) |
Instances
newCreateAttendeeRequestItem Source #
Create a value of CreateAttendeeRequestItem with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:capabilities:CreateAttendeeRequestItem', createAttendeeRequestItem_capabilities - A list of one or more capabilities.
$sel:externalUserId:CreateAttendeeRequestItem', createAttendeeRequestItem_externalUserId - The Amazon Chime SDK external user ID. An idempotency token. Links the
attendee to an identity managed by a builder application.
EngineTranscribeMedicalSettings
data EngineTranscribeMedicalSettings Source #
Settings specific to the Amazon Transcribe Medical engine.
See: newEngineTranscribeMedicalSettings smart constructor.
Constructors
Instances
newEngineTranscribeMedicalSettings Source #
Arguments
| :: TranscribeMedicalLanguageCode | |
| -> TranscribeMedicalSpecialty | |
| -> TranscribeMedicalType | |
| -> EngineTranscribeMedicalSettings |
Create a value of EngineTranscribeMedicalSettings with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:contentIdentificationType:EngineTranscribeMedicalSettings', engineTranscribeMedicalSettings_contentIdentificationType - Set this field to PHI to identify personal health information in the
transcription output.
$sel:region:EngineTranscribeMedicalSettings', engineTranscribeMedicalSettings_region - The AWS Region passed to Amazon Transcribe Medical. If you don't
specify a Region, Amazon Chime uses the meeting's Region.
$sel:vocabularyName:EngineTranscribeMedicalSettings', engineTranscribeMedicalSettings_vocabularyName - The name of the vocabulary passed to Amazon Transcribe Medical.
$sel:languageCode:EngineTranscribeMedicalSettings', engineTranscribeMedicalSettings_languageCode - The language code specified for the Amazon Transcribe Medical engine.
$sel:specialty:EngineTranscribeMedicalSettings', engineTranscribeMedicalSettings_specialty - The specialty specified for the Amazon Transcribe Medical engine.
$sel:type':EngineTranscribeMedicalSettings', engineTranscribeMedicalSettings_type - The type of transcription.
EngineTranscribeSettings
data EngineTranscribeSettings Source #
Settings specific to the Amazon Transcribe engine.
See: newEngineTranscribeSettings smart constructor.
Constructors
Instances
newEngineTranscribeSettings :: EngineTranscribeSettings Source #
Create a value of EngineTranscribeSettings with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:contentIdentificationType:EngineTranscribeSettings', engineTranscribeSettings_contentIdentificationType - Set this field to PII to identify personally identifiable information
in the transcription output.
$sel:contentRedactionType:EngineTranscribeSettings', engineTranscribeSettings_contentRedactionType - 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.
$sel:enablePartialResultsStabilization:EngineTranscribeSettings', engineTranscribeSettings_enablePartialResultsStabilization - 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.
$sel:identifyLanguage:EngineTranscribeSettings', engineTranscribeSettings_identifyLanguage - Automatically identifies the language spoken in media files.
$sel:languageCode:EngineTranscribeSettings', engineTranscribeSettings_languageCode - The language code specified for the Amazon Transcribe engine.
$sel:languageModelName:EngineTranscribeSettings', engineTranscribeSettings_languageModelName - The name of the language model used during transcription.
$sel:languageOptions:EngineTranscribeSettings', engineTranscribeSettings_languageOptions - Language codes for the languages that you want to identify. You must
provide at least 2 codes.
$sel:partialResultsStability:EngineTranscribeSettings', engineTranscribeSettings_partialResultsStability - 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.
$sel:piiEntityTypes:EngineTranscribeSettings', engineTranscribeSettings_piiEntityTypes - 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.
$sel:preferredLanguage:EngineTranscribeSettings', engineTranscribeSettings_preferredLanguage - Language code for the preferred language.
$sel:region:EngineTranscribeSettings', engineTranscribeSettings_region - The AWS Region passed to Amazon Transcribe. If you don't specify a
Region, Amazon Chime uses the meeting's Region.
$sel:vocabularyFilterMethod:EngineTranscribeSettings', engineTranscribeSettings_vocabularyFilterMethod - The filtering method passed to Amazon Transcribe.
$sel:vocabularyFilterName:EngineTranscribeSettings', engineTranscribeSettings_vocabularyFilterName - The name of the vocabulary filter passed to Amazon Transcribe.
$sel:vocabularyName:EngineTranscribeSettings', engineTranscribeSettings_vocabularyName - The name of the vocabulary passed to Amazon Transcribe.
MediaPlacement
data MediaPlacement Source #
A set of endpoints used by clients to connect to the media service group for an Amazon Chime SDK meeting.
See: newMediaPlacement smart constructor.
Constructors
| MediaPlacement' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newMediaPlacement :: MediaPlacement Source #
Create a value of MediaPlacement with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:audioFallbackUrl:MediaPlacement', mediaPlacement_audioFallbackUrl - The audio fallback URL.
$sel:audioHostUrl:MediaPlacement', mediaPlacement_audioHostUrl - The audio host URL.
$sel:eventIngestionUrl:MediaPlacement', mediaPlacement_eventIngestionUrl - The event ingestion URL.
$sel:screenDataUrl:MediaPlacement', mediaPlacement_screenDataUrl - The screen data URL.
$sel:screenSharingUrl:MediaPlacement', mediaPlacement_screenSharingUrl - The screen sharing URL.
$sel:screenViewingUrl:MediaPlacement', mediaPlacement_screenViewingUrl - The screen viewing URL.
$sel:signalingUrl:MediaPlacement', mediaPlacement_signalingUrl - The signaling URL.
$sel:turnControlUrl:MediaPlacement', mediaPlacement_turnControlUrl - The turn control URL.
Meeting
A meeting created using the Amazon Chime SDK.
See: newMeeting smart constructor.
Constructors
| Meeting' (Maybe (Sensitive Text)) (Maybe MediaPlacement) (Maybe Text) (Maybe Text) (Maybe MeetingFeaturesConfiguration) (Maybe (Sensitive Text)) (Maybe Text) (Maybe Text) (Maybe (NonEmpty Text)) |
Instances
newMeeting :: Meeting Source #
Create a value of Meeting with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:externalMeetingId:Meeting', meeting_externalMeetingId - The external meeting ID.
$sel:mediaPlacement:Meeting', meeting_mediaPlacement - The media placement for the meeting.
$sel:mediaRegion:Meeting', meeting_mediaRegion - 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.
$sel:meetingArn:Meeting', meeting_meetingArn - The ARN of the meeting.
$sel:meetingFeatures:Meeting', meeting_meetingFeatures - The features available to a meeting, such as Amazon Voice Focus.
$sel:meetingHostId:Meeting', meeting_meetingHostId - Reserved.
$sel:meetingId:Meeting', meeting_meetingId - The Amazon Chime SDK meeting ID.
$sel:primaryMeetingId:Meeting', meeting_primaryMeetingId - When specified, replicates the media from the primary meeting to this
meeting.
$sel:tenantIds:Meeting', meeting_tenantIds - Array of strings.
MeetingFeaturesConfiguration
data MeetingFeaturesConfiguration Source #
The configuration settings of the features available to a meeting.>
See: newMeetingFeaturesConfiguration smart constructor.
Constructors
| MeetingFeaturesConfiguration' (Maybe AudioFeatures) |
Instances
newMeetingFeaturesConfiguration :: MeetingFeaturesConfiguration Source #
Create a value of MeetingFeaturesConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:audio:MeetingFeaturesConfiguration', meetingFeaturesConfiguration_audio - The configuration settings for the audio features available to a
meeting.
NotificationsConfiguration
data NotificationsConfiguration Source #
The configuration for resource targets to receive notifications when meeting and attendee events occur.
See: newNotificationsConfiguration smart constructor.
Constructors
| NotificationsConfiguration' (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) |
Instances
newNotificationsConfiguration :: NotificationsConfiguration Source #
Create a value of NotificationsConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:lambdaFunctionArn:NotificationsConfiguration', notificationsConfiguration_lambdaFunctionArn - The ARN of the AWS Lambda function in the notifications configuration.
$sel:snsTopicArn:NotificationsConfiguration', notificationsConfiguration_snsTopicArn - The ARN of the SNS topic.
$sel:sqsQueueArn:NotificationsConfiguration', notificationsConfiguration_sqsQueueArn - The ARN of the SQS queue.
Tag
A key-value pair that you define.
See: newTag smart constructor.
Instances
| FromJSON Tag Source # | |
| ToJSON Tag Source # | |
Defined in Amazonka.ChimeSdkMeetings.Types.Tag | |
| Generic Tag Source # | |
| Read Tag Source # | |
| Show Tag Source # | |
| NFData Tag Source # | |
Defined in Amazonka.ChimeSdkMeetings.Types.Tag | |
| Eq Tag Source # | |
| Hashable Tag Source # | |
Defined in Amazonka.ChimeSdkMeetings.Types.Tag | |
| type Rep Tag Source # | |
Defined in Amazonka.ChimeSdkMeetings.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.ChimeSdkMeetings.Types.Tag" "amazonka-chime-sdk-meetings-2.0-BH1YehHiRGe8LBGen60xi" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of Tag with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:key:Tag', tag_key - The tag's key.
$sel:value:Tag', tag_value - The tag's value.
TranscriptionConfiguration
data TranscriptionConfiguration Source #
The configuration for the current transcription operation. Must contain
EngineTranscribeSettings or EngineTranscribeMedicalSettings.
See: newTranscriptionConfiguration smart constructor.
Constructors
| TranscriptionConfiguration' (Maybe EngineTranscribeMedicalSettings) (Maybe EngineTranscribeSettings) |
Instances
newTranscriptionConfiguration :: TranscriptionConfiguration Source #
Create a value of TranscriptionConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:engineTranscribeMedicalSettings:TranscriptionConfiguration', transcriptionConfiguration_engineTranscribeMedicalSettings - The transcription configuration settings passed to Amazon Transcribe
Medical.
$sel:engineTranscribeSettings:TranscriptionConfiguration', transcriptionConfiguration_engineTranscribeSettings - The transcription configuration settings passed to Amazon Transcribe.