| 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.CreateMeeting
Description
Creates a new Amazon Chime SDK meeting in the specified media Region with no initial attendees. For more information about specifying media Regions, see Amazon Chime SDK Media Regions in the Amazon Chime Developer Guide. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
Synopsis
- data CreateMeeting = CreateMeeting' {
- 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
- newCreateMeeting :: Text -> Text -> Text -> CreateMeeting
- createMeeting_meetingFeatures :: Lens' CreateMeeting (Maybe MeetingFeaturesConfiguration)
- createMeeting_meetingHostId :: Lens' CreateMeeting (Maybe Text)
- createMeeting_notificationsConfiguration :: Lens' CreateMeeting (Maybe NotificationsConfiguration)
- createMeeting_primaryMeetingId :: Lens' CreateMeeting (Maybe Text)
- createMeeting_tags :: Lens' CreateMeeting (Maybe [Tag])
- createMeeting_tenantIds :: Lens' CreateMeeting (Maybe (NonEmpty Text))
- createMeeting_clientRequestToken :: Lens' CreateMeeting Text
- createMeeting_mediaRegion :: Lens' CreateMeeting Text
- createMeeting_externalMeetingId :: Lens' CreateMeeting Text
- data CreateMeetingResponse = CreateMeetingResponse' {
- meeting :: Maybe Meeting
- httpStatus :: Int
- newCreateMeetingResponse :: Int -> CreateMeetingResponse
- createMeetingResponse_meeting :: Lens' CreateMeetingResponse (Maybe Meeting)
- createMeetingResponse_httpStatus :: Lens' CreateMeetingResponse Int
Creating a Request
data CreateMeeting Source #
See: newCreateMeeting smart constructor.
Constructors
| CreateMeeting' | |
Fields
| |
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.
Request Lenses
createMeeting_meetingFeatures :: Lens' CreateMeeting (Maybe MeetingFeaturesConfiguration) Source #
Lists the audio and video features enabled for a meeting, such as echo reduction.
createMeeting_meetingHostId :: Lens' CreateMeeting (Maybe Text) Source #
Reserved.
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.
createMeeting_externalMeetingId :: Lens' CreateMeeting Text Source #
The external meeting ID.
Destructuring the Response
data CreateMeetingResponse Source #
See: newCreateMeetingResponse smart constructor.
Constructors
| CreateMeetingResponse' | |
Fields
| |
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.
Response Lenses
createMeetingResponse_meeting :: Lens' CreateMeetingResponse (Maybe Meeting) Source #
The meeting information, including the meeting ID and MediaPlacement.
createMeetingResponse_httpStatus :: Lens' CreateMeetingResponse Int Source #
The response's http status code.