| 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.CreateMeetingWithAttendees
Description
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.
Synopsis
- data CreateMeetingWithAttendees = CreateMeetingWithAttendees' {
- meetingFeatures :: Maybe MeetingFeaturesConfiguration
- meetingHostId :: Maybe (Sensitive Text)
- notificationsConfiguration :: Maybe NotificationsConfiguration
- primaryMeetingId :: Maybe Text
- tags :: Maybe [Tag]
- tenantIds :: Maybe (NonEmpty Text)
- clientRequestToken :: Sensitive Text
- mediaRegion :: Text
- externalMeetingId :: Sensitive Text
- attendees :: NonEmpty CreateAttendeeRequestItem
- newCreateMeetingWithAttendees :: Text -> Text -> Text -> NonEmpty CreateAttendeeRequestItem -> CreateMeetingWithAttendees
- createMeetingWithAttendees_meetingFeatures :: Lens' CreateMeetingWithAttendees (Maybe MeetingFeaturesConfiguration)
- createMeetingWithAttendees_meetingHostId :: Lens' CreateMeetingWithAttendees (Maybe Text)
- createMeetingWithAttendees_notificationsConfiguration :: Lens' CreateMeetingWithAttendees (Maybe NotificationsConfiguration)
- createMeetingWithAttendees_primaryMeetingId :: Lens' CreateMeetingWithAttendees (Maybe Text)
- createMeetingWithAttendees_tags :: Lens' CreateMeetingWithAttendees (Maybe [Tag])
- createMeetingWithAttendees_tenantIds :: Lens' CreateMeetingWithAttendees (Maybe (NonEmpty Text))
- createMeetingWithAttendees_clientRequestToken :: Lens' CreateMeetingWithAttendees Text
- createMeetingWithAttendees_mediaRegion :: Lens' CreateMeetingWithAttendees Text
- createMeetingWithAttendees_externalMeetingId :: Lens' CreateMeetingWithAttendees Text
- createMeetingWithAttendees_attendees :: Lens' CreateMeetingWithAttendees (NonEmpty CreateAttendeeRequestItem)
- data CreateMeetingWithAttendeesResponse = CreateMeetingWithAttendeesResponse' {}
- newCreateMeetingWithAttendeesResponse :: Int -> CreateMeetingWithAttendeesResponse
- createMeetingWithAttendeesResponse_attendees :: Lens' CreateMeetingWithAttendeesResponse (Maybe [Attendee])
- createMeetingWithAttendeesResponse_errors :: Lens' CreateMeetingWithAttendeesResponse (Maybe [CreateAttendeeError])
- createMeetingWithAttendeesResponse_meeting :: Lens' CreateMeetingWithAttendeesResponse (Maybe Meeting)
- createMeetingWithAttendeesResponse_httpStatus :: Lens' CreateMeetingWithAttendeesResponse Int
Creating a Request
data CreateMeetingWithAttendees Source #
See: newCreateMeetingWithAttendees smart constructor.
Constructors
| CreateMeetingWithAttendees' | |
Fields
| |
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.
Request Lenses
createMeetingWithAttendees_meetingFeatures :: Lens' CreateMeetingWithAttendees (Maybe MeetingFeaturesConfiguration) Source #
Lists the audio and video features enabled for a meeting, such as echo reduction.
createMeetingWithAttendees_meetingHostId :: Lens' CreateMeetingWithAttendees (Maybe Text) Source #
Reserved.
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_tags :: Lens' CreateMeetingWithAttendees (Maybe [Tag]) Source #
The tags in the request.
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_externalMeetingId :: Lens' CreateMeetingWithAttendees Text Source #
The external meeting ID.
createMeetingWithAttendees_attendees :: Lens' CreateMeetingWithAttendees (NonEmpty CreateAttendeeRequestItem) Source #
The attendee information, including attendees' IDs and join tokens.
Destructuring the Response
data CreateMeetingWithAttendeesResponse Source #
See: newCreateMeetingWithAttendeesResponse smart constructor.
Constructors
| CreateMeetingWithAttendeesResponse' | |
Fields
| |
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.
Response Lenses
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.
createMeetingWithAttendeesResponse_httpStatus :: Lens' CreateMeetingWithAttendeesResponse Int Source #
The response's http status code.