| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.ChimeSDKIdentity
Contents
- Service Configuration
- Errors
- Waiters
- Operations
- CreateAppInstance
- GetAppInstanceRetentionSettings
- DescribeAppInstanceAdmin
- CreateAppInstanceUser
- PutAppInstanceRetentionSettings
- CreateAppInstanceAdmin
- ListAppInstanceAdmins
- ListAppInstances
- DescribeAppInstanceUser
- DescribeAppInstance
- ListAppInstanceUsers
- DeleteAppInstanceUser
- UpdateAppInstanceUser
- DeleteAppInstanceAdmin
- DeleteAppInstance
- UpdateAppInstance
- Types
Description
Derived from API version 2021-04-20 of the AWS service descriptions, licensed under Apache 2.0.
The Amazon Chime SDK Identity APIs in this section allow software developers to create and manage unique instances of their messaging applications. These APIs provide the overarching framework for creating and sending messages. For more information about the identity APIs, refer to Amazon Chime SDK identity.
Synopsis
- defaultService :: Service
- _ThrottledClientException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _ConflictException :: AsError a => Getting (First ServiceError) a ServiceError
- _ForbiddenException :: AsError a => Getting (First ServiceError) a ServiceError
- _ServiceFailureException :: AsError a => Getting (First ServiceError) a ServiceError
- _UnauthorizedClientException :: AsError a => Getting (First ServiceError) a ServiceError
- _ServiceUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError
- _BadRequestException :: AsError a => Getting (First ServiceError) a ServiceError
- data CreateAppInstance = CreateAppInstance' (Maybe (Sensitive Text)) (Maybe (NonEmpty Tag)) (Sensitive Text) (Sensitive Text)
- newCreateAppInstance :: Text -> Text -> CreateAppInstance
- data CreateAppInstanceResponse = CreateAppInstanceResponse' (Maybe Text) Int
- newCreateAppInstanceResponse :: Int -> CreateAppInstanceResponse
- data GetAppInstanceRetentionSettings = GetAppInstanceRetentionSettings' Text
- newGetAppInstanceRetentionSettings :: Text -> GetAppInstanceRetentionSettings
- data GetAppInstanceRetentionSettingsResponse = GetAppInstanceRetentionSettingsResponse' (Maybe AppInstanceRetentionSettings) (Maybe POSIX) Int
- newGetAppInstanceRetentionSettingsResponse :: Int -> GetAppInstanceRetentionSettingsResponse
- data DescribeAppInstanceAdmin = DescribeAppInstanceAdmin' Text Text
- newDescribeAppInstanceAdmin :: Text -> Text -> DescribeAppInstanceAdmin
- data DescribeAppInstanceAdminResponse = DescribeAppInstanceAdminResponse' (Maybe AppInstanceAdmin) Int
- newDescribeAppInstanceAdminResponse :: Int -> DescribeAppInstanceAdminResponse
- data CreateAppInstanceUser = CreateAppInstanceUser' (Maybe (Sensitive Text)) (Maybe (NonEmpty Tag)) Text (Sensitive Text) (Sensitive Text) (Sensitive Text)
- newCreateAppInstanceUser :: Text -> Text -> Text -> Text -> CreateAppInstanceUser
- data CreateAppInstanceUserResponse = CreateAppInstanceUserResponse' (Maybe Text) Int
- newCreateAppInstanceUserResponse :: Int -> CreateAppInstanceUserResponse
- data PutAppInstanceRetentionSettings = PutAppInstanceRetentionSettings' Text AppInstanceRetentionSettings
- newPutAppInstanceRetentionSettings :: Text -> AppInstanceRetentionSettings -> PutAppInstanceRetentionSettings
- data PutAppInstanceRetentionSettingsResponse = PutAppInstanceRetentionSettingsResponse' (Maybe AppInstanceRetentionSettings) (Maybe POSIX) Int
- newPutAppInstanceRetentionSettingsResponse :: Int -> PutAppInstanceRetentionSettingsResponse
- data CreateAppInstanceAdmin = CreateAppInstanceAdmin' Text Text
- newCreateAppInstanceAdmin :: Text -> Text -> CreateAppInstanceAdmin
- data CreateAppInstanceAdminResponse = CreateAppInstanceAdminResponse' (Maybe Identity) (Maybe Text) Int
- newCreateAppInstanceAdminResponse :: Int -> CreateAppInstanceAdminResponse
- data ListAppInstanceAdmins = ListAppInstanceAdmins' (Maybe (Sensitive Text)) (Maybe Natural) Text
- newListAppInstanceAdmins :: Text -> ListAppInstanceAdmins
- data ListAppInstanceAdminsResponse = ListAppInstanceAdminsResponse' (Maybe (Sensitive Text)) (Maybe [AppInstanceAdminSummary]) (Maybe Text) Int
- newListAppInstanceAdminsResponse :: Int -> ListAppInstanceAdminsResponse
- data ListAppInstances = ListAppInstances' (Maybe (Sensitive Text)) (Maybe Natural)
- newListAppInstances :: ListAppInstances
- data ListAppInstancesResponse = ListAppInstancesResponse' (Maybe [AppInstanceSummary]) (Maybe (Sensitive Text)) Int
- newListAppInstancesResponse :: Int -> ListAppInstancesResponse
- data DescribeAppInstanceUser = DescribeAppInstanceUser' Text
- newDescribeAppInstanceUser :: Text -> DescribeAppInstanceUser
- data DescribeAppInstanceUserResponse = DescribeAppInstanceUserResponse' (Maybe AppInstanceUser) Int
- newDescribeAppInstanceUserResponse :: Int -> DescribeAppInstanceUserResponse
- data DescribeAppInstance = DescribeAppInstance' Text
- newDescribeAppInstance :: Text -> DescribeAppInstance
- data DescribeAppInstanceResponse = DescribeAppInstanceResponse' (Maybe AppInstance) Int
- newDescribeAppInstanceResponse :: Int -> DescribeAppInstanceResponse
- data ListAppInstanceUsers = ListAppInstanceUsers' (Maybe (Sensitive Text)) (Maybe Natural) Text
- newListAppInstanceUsers :: Text -> ListAppInstanceUsers
- data ListAppInstanceUsersResponse = ListAppInstanceUsersResponse' (Maybe (Sensitive Text)) (Maybe [AppInstanceUserSummary]) (Maybe Text) Int
- newListAppInstanceUsersResponse :: Int -> ListAppInstanceUsersResponse
- data DeleteAppInstanceUser = DeleteAppInstanceUser' Text
- newDeleteAppInstanceUser :: Text -> DeleteAppInstanceUser
- data DeleteAppInstanceUserResponse = DeleteAppInstanceUserResponse' {
- newDeleteAppInstanceUserResponse :: DeleteAppInstanceUserResponse
- data UpdateAppInstanceUser = UpdateAppInstanceUser' Text (Sensitive Text) (Sensitive Text)
- newUpdateAppInstanceUser :: Text -> Text -> Text -> UpdateAppInstanceUser
- data UpdateAppInstanceUserResponse = UpdateAppInstanceUserResponse' (Maybe Text) Int
- newUpdateAppInstanceUserResponse :: Int -> UpdateAppInstanceUserResponse
- data DeleteAppInstanceAdmin = DeleteAppInstanceAdmin' Text Text
- newDeleteAppInstanceAdmin :: Text -> Text -> DeleteAppInstanceAdmin
- data DeleteAppInstanceAdminResponse = DeleteAppInstanceAdminResponse' {
- newDeleteAppInstanceAdminResponse :: DeleteAppInstanceAdminResponse
- data DeleteAppInstance = DeleteAppInstance' Text
- newDeleteAppInstance :: Text -> DeleteAppInstance
- data DeleteAppInstanceResponse = DeleteAppInstanceResponse' {
- newDeleteAppInstanceResponse :: DeleteAppInstanceResponse
- data UpdateAppInstance = UpdateAppInstance' Text (Sensitive Text) (Sensitive Text)
- newUpdateAppInstance :: Text -> Text -> Text -> UpdateAppInstance
- data UpdateAppInstanceResponse = UpdateAppInstanceResponse' (Maybe Text) Int
- newUpdateAppInstanceResponse :: Int -> UpdateAppInstanceResponse
- data AppInstance = AppInstance' (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe Text) (Maybe POSIX) (Maybe POSIX)
- newAppInstance :: AppInstance
- data AppInstanceAdmin = AppInstanceAdmin' (Maybe Identity) (Maybe Text) (Maybe POSIX)
- newAppInstanceAdmin :: AppInstanceAdmin
- data AppInstanceAdminSummary = AppInstanceAdminSummary' (Maybe Identity)
- newAppInstanceAdminSummary :: AppInstanceAdminSummary
- data AppInstanceRetentionSettings = AppInstanceRetentionSettings' (Maybe ChannelRetentionSettings)
- newAppInstanceRetentionSettings :: AppInstanceRetentionSettings
- data AppInstanceSummary = AppInstanceSummary' (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe Text)
- newAppInstanceSummary :: AppInstanceSummary
- data AppInstanceUser = AppInstanceUser' (Maybe Text) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe POSIX) (Maybe POSIX)
- newAppInstanceUser :: AppInstanceUser
- data AppInstanceUserSummary = AppInstanceUserSummary' (Maybe Text) (Maybe (Sensitive Text)) (Maybe (Sensitive Text))
- newAppInstanceUserSummary :: AppInstanceUserSummary
- data ChannelRetentionSettings = ChannelRetentionSettings' (Maybe Natural)
- newChannelRetentionSettings :: ChannelRetentionSettings
- data Identity = Identity' (Maybe Text) (Maybe (Sensitive Text))
- newIdentity :: Identity
- data Tag = Tag' (Sensitive Text) (Sensitive Text)
- newTag :: Text -> Text -> Tag
Service Configuration
defaultService :: Service Source #
API version 2021-04-20 of the Amazon Chime SDK Identity 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 ChimeSDKIdentity.
ThrottledClientException
_ThrottledClientException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The client exceeded its request rate limit.
ResourceLimitExceededException
_ResourceLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request exceeds the resource limit.
ConflictException
_ConflictException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request could not be processed because of conflict in the current state of the resource.
ForbiddenException
_ForbiddenException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The client is permanently forbidden from making the request.
ServiceFailureException
_ServiceFailureException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The service encountered an unexpected error.
UnauthorizedClientException
_UnauthorizedClientException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The client is not currently authorized to make the request.
ServiceUnavailableException
_ServiceUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The service is currently unavailable.
BadRequestException
_BadRequestException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The input parameters don't match the service's restrictions.
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.
CreateAppInstance
data CreateAppInstance Source #
See: newCreateAppInstance smart constructor.
Constructors
| CreateAppInstance' (Maybe (Sensitive Text)) (Maybe (NonEmpty Tag)) (Sensitive Text) (Sensitive Text) |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> CreateAppInstance |
Create a value of CreateAppInstance 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:metadata:CreateAppInstance', createAppInstance_metadata - The metadata of the AppInstance. Limited to a 1KB string in UTF-8.
$sel:tags:CreateAppInstance', createAppInstance_tags - Tags assigned to the AppInstanceUser.
$sel:name:CreateAppInstance', createAppInstance_name - The name of the AppInstance.
$sel:clientRequestToken:CreateAppInstance', createAppInstance_clientRequestToken - The ClientRequestToken of the AppInstance.
data CreateAppInstanceResponse Source #
See: newCreateAppInstanceResponse smart constructor.
Constructors
| CreateAppInstanceResponse' (Maybe Text) Int |
Instances
newCreateAppInstanceResponse Source #
Create a value of CreateAppInstanceResponse 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:appInstanceArn:CreateAppInstanceResponse', createAppInstanceResponse_appInstanceArn - The Amazon Resource Number (ARN) of the AppInstance.
$sel:httpStatus:CreateAppInstanceResponse', createAppInstanceResponse_httpStatus - The response's http status code.
GetAppInstanceRetentionSettings
data GetAppInstanceRetentionSettings Source #
See: newGetAppInstanceRetentionSettings smart constructor.
Constructors
| GetAppInstanceRetentionSettings' Text |
Instances
newGetAppInstanceRetentionSettings Source #
Arguments
| :: Text | |
| -> GetAppInstanceRetentionSettings |
Create a value of GetAppInstanceRetentionSettings 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:appInstanceArn:GetAppInstanceRetentionSettings', getAppInstanceRetentionSettings_appInstanceArn - The ARN of the AppInstance.
data GetAppInstanceRetentionSettingsResponse Source #
See: newGetAppInstanceRetentionSettingsResponse smart constructor.
Constructors
| GetAppInstanceRetentionSettingsResponse' (Maybe AppInstanceRetentionSettings) (Maybe POSIX) Int |
Instances
newGetAppInstanceRetentionSettingsResponse Source #
Arguments
| :: Int | |
| -> GetAppInstanceRetentionSettingsResponse |
Create a value of GetAppInstanceRetentionSettingsResponse 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:appInstanceRetentionSettings:GetAppInstanceRetentionSettingsResponse', getAppInstanceRetentionSettingsResponse_appInstanceRetentionSettings - The retention settings for the AppInstance.
$sel:initiateDeletionTimestamp:GetAppInstanceRetentionSettingsResponse', getAppInstanceRetentionSettingsResponse_initiateDeletionTimestamp - The timestamp representing the time at which the specified items are
retained, in Epoch Seconds.
$sel:httpStatus:GetAppInstanceRetentionSettingsResponse', getAppInstanceRetentionSettingsResponse_httpStatus - The response's http status code.
DescribeAppInstanceAdmin
data DescribeAppInstanceAdmin Source #
See: newDescribeAppInstanceAdmin smart constructor.
Constructors
| DescribeAppInstanceAdmin' Text Text |
Instances
newDescribeAppInstanceAdmin Source #
Arguments
| :: Text | |
| -> Text | |
| -> DescribeAppInstanceAdmin |
Create a value of DescribeAppInstanceAdmin 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:appInstanceAdminArn:DescribeAppInstanceAdmin', describeAppInstanceAdmin_appInstanceAdminArn - The ARN of the AppInstanceAdmin.
$sel:appInstanceArn:DescribeAppInstanceAdmin', describeAppInstanceAdmin_appInstanceArn - The ARN of the AppInstance.
data DescribeAppInstanceAdminResponse Source #
See: newDescribeAppInstanceAdminResponse smart constructor.
Constructors
| DescribeAppInstanceAdminResponse' (Maybe AppInstanceAdmin) Int |
Instances
newDescribeAppInstanceAdminResponse Source #
Create a value of DescribeAppInstanceAdminResponse 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:appInstanceAdmin:DescribeAppInstanceAdminResponse', describeAppInstanceAdminResponse_appInstanceAdmin - The ARN and name of the AppInstanceUser, the ARN of the AppInstance,
and the created and last-updated timestamps. All timestamps use epoch
milliseconds.
$sel:httpStatus:DescribeAppInstanceAdminResponse', describeAppInstanceAdminResponse_httpStatus - The response's http status code.
CreateAppInstanceUser
data CreateAppInstanceUser Source #
See: newCreateAppInstanceUser smart constructor.
Constructors
| CreateAppInstanceUser' (Maybe (Sensitive Text)) (Maybe (NonEmpty Tag)) Text (Sensitive Text) (Sensitive Text) (Sensitive Text) |
Instances
newCreateAppInstanceUser Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> CreateAppInstanceUser |
Create a value of CreateAppInstanceUser 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:metadata:CreateAppInstanceUser', createAppInstanceUser_metadata - The request's metadata. Limited to a 1KB string in UTF-8.
$sel:tags:CreateAppInstanceUser', createAppInstanceUser_tags - Tags assigned to the AppInstanceUser.
$sel:appInstanceArn:CreateAppInstanceUser', createAppInstanceUser_appInstanceArn - The ARN of the AppInstance request.
$sel:appInstanceUserId:CreateAppInstanceUser', createAppInstanceUser_appInstanceUserId - The user ID of the AppInstance.
$sel:name:CreateAppInstanceUser', createAppInstanceUser_name - The user's name.
$sel:clientRequestToken:CreateAppInstanceUser', createAppInstanceUser_clientRequestToken - The token assigned to the user requesting an AppInstance.
data CreateAppInstanceUserResponse Source #
See: newCreateAppInstanceUserResponse smart constructor.
Constructors
| CreateAppInstanceUserResponse' (Maybe Text) Int |
Instances
newCreateAppInstanceUserResponse Source #
Create a value of CreateAppInstanceUserResponse 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:appInstanceUserArn:CreateAppInstanceUserResponse', createAppInstanceUserResponse_appInstanceUserArn - The user's ARN.
$sel:httpStatus:CreateAppInstanceUserResponse', createAppInstanceUserResponse_httpStatus - The response's http status code.
PutAppInstanceRetentionSettings
data PutAppInstanceRetentionSettings Source #
See: newPutAppInstanceRetentionSettings smart constructor.
Instances
newPutAppInstanceRetentionSettings Source #
Arguments
| :: Text | |
| -> AppInstanceRetentionSettings |
|
| -> PutAppInstanceRetentionSettings |
Create a value of PutAppInstanceRetentionSettings 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:appInstanceArn:PutAppInstanceRetentionSettings', putAppInstanceRetentionSettings_appInstanceArn - The ARN of the AppInstance.
$sel:appInstanceRetentionSettings:PutAppInstanceRetentionSettings', putAppInstanceRetentionSettings_appInstanceRetentionSettings - The time in days to retain data. Data type: number.
data PutAppInstanceRetentionSettingsResponse Source #
See: newPutAppInstanceRetentionSettingsResponse smart constructor.
Constructors
| PutAppInstanceRetentionSettingsResponse' (Maybe AppInstanceRetentionSettings) (Maybe POSIX) Int |
Instances
newPutAppInstanceRetentionSettingsResponse Source #
Arguments
| :: Int | |
| -> PutAppInstanceRetentionSettingsResponse |
Create a value of PutAppInstanceRetentionSettingsResponse 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:appInstanceRetentionSettings:PutAppInstanceRetentionSettings', putAppInstanceRetentionSettingsResponse_appInstanceRetentionSettings - The time in days to retain data. Data type: number.
$sel:initiateDeletionTimestamp:PutAppInstanceRetentionSettingsResponse', putAppInstanceRetentionSettingsResponse_initiateDeletionTimestamp - The time at which the API deletes data.
$sel:httpStatus:PutAppInstanceRetentionSettingsResponse', putAppInstanceRetentionSettingsResponse_httpStatus - The response's http status code.
CreateAppInstanceAdmin
data CreateAppInstanceAdmin Source #
See: newCreateAppInstanceAdmin smart constructor.
Constructors
| CreateAppInstanceAdmin' Text Text |
Instances
newCreateAppInstanceAdmin Source #
Arguments
| :: Text | |
| -> Text | |
| -> CreateAppInstanceAdmin |
Create a value of CreateAppInstanceAdmin 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:appInstanceAdminArn:CreateAppInstanceAdmin', createAppInstanceAdmin_appInstanceAdminArn - The ARN of the administrator of the current AppInstance.
$sel:appInstanceArn:CreateAppInstanceAdmin', createAppInstanceAdmin_appInstanceArn - The ARN of the AppInstance.
data CreateAppInstanceAdminResponse Source #
See: newCreateAppInstanceAdminResponse smart constructor.
Instances
newCreateAppInstanceAdminResponse Source #
Create a value of CreateAppInstanceAdminResponse 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:appInstanceAdmin:CreateAppInstanceAdminResponse', createAppInstanceAdminResponse_appInstanceAdmin - The name and ARN of the admin for the AppInstance.
$sel:appInstanceArn:CreateAppInstanceAdmin', createAppInstanceAdminResponse_appInstanceArn - The ARN of the of the admin for the AppInstance.
$sel:httpStatus:CreateAppInstanceAdminResponse', createAppInstanceAdminResponse_httpStatus - The response's http status code.
ListAppInstanceAdmins
data ListAppInstanceAdmins Source #
See: newListAppInstanceAdmins smart constructor.
Instances
newListAppInstanceAdmins Source #
Create a value of ListAppInstanceAdmins 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:nextToken:ListAppInstanceAdmins', listAppInstanceAdmins_nextToken - The token returned from previous API requests until the number of
administrators is reached.
$sel:maxResults:ListAppInstanceAdmins', listAppInstanceAdmins_maxResults - The maximum number of administrators that you want to return.
$sel:appInstanceArn:ListAppInstanceAdmins', listAppInstanceAdmins_appInstanceArn - The ARN of the AppInstance.
data ListAppInstanceAdminsResponse Source #
See: newListAppInstanceAdminsResponse smart constructor.
Constructors
| ListAppInstanceAdminsResponse' (Maybe (Sensitive Text)) (Maybe [AppInstanceAdminSummary]) (Maybe Text) Int |
Instances
newListAppInstanceAdminsResponse Source #
Create a value of ListAppInstanceAdminsResponse 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:nextToken:ListAppInstanceAdmins', listAppInstanceAdminsResponse_nextToken - The token returned from previous API requests until the number of
administrators is reached.
$sel:appInstanceAdmins:ListAppInstanceAdminsResponse', listAppInstanceAdminsResponse_appInstanceAdmins - The information for each administrator.
$sel:appInstanceArn:ListAppInstanceAdmins', listAppInstanceAdminsResponse_appInstanceArn - The ARN of the AppInstance.
$sel:httpStatus:ListAppInstanceAdminsResponse', listAppInstanceAdminsResponse_httpStatus - The response's http status code.
ListAppInstances
data ListAppInstances Source #
See: newListAppInstances smart constructor.
Instances
newListAppInstances :: ListAppInstances Source #
Create a value of ListAppInstances 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:nextToken:ListAppInstances', listAppInstances_nextToken - The token passed by previous API requests until you reach the maximum
number of AppInstances.
$sel:maxResults:ListAppInstances', listAppInstances_maxResults - The maximum number of AppInstances that you want to return.
data ListAppInstancesResponse Source #
See: newListAppInstancesResponse smart constructor.
Constructors
| ListAppInstancesResponse' (Maybe [AppInstanceSummary]) (Maybe (Sensitive Text)) Int |
Instances
newListAppInstancesResponse Source #
Create a value of ListAppInstancesResponse 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:appInstances:ListAppInstancesResponse', listAppInstancesResponse_appInstances - The information for each AppInstance.
$sel:nextToken:ListAppInstances', listAppInstancesResponse_nextToken - The token passed by previous API requests until the maximum number of
AppInstances is reached.
$sel:httpStatus:ListAppInstancesResponse', listAppInstancesResponse_httpStatus - The response's http status code.
DescribeAppInstanceUser
data DescribeAppInstanceUser Source #
See: newDescribeAppInstanceUser smart constructor.
Constructors
| DescribeAppInstanceUser' Text |
Instances
newDescribeAppInstanceUser Source #
Create a value of DescribeAppInstanceUser 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:appInstanceUserArn:DescribeAppInstanceUser', describeAppInstanceUser_appInstanceUserArn - The ARN of the AppInstanceUser.
data DescribeAppInstanceUserResponse Source #
See: newDescribeAppInstanceUserResponse smart constructor.
Constructors
| DescribeAppInstanceUserResponse' (Maybe AppInstanceUser) Int |
Instances
newDescribeAppInstanceUserResponse Source #
Create a value of DescribeAppInstanceUserResponse 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:appInstanceUser:DescribeAppInstanceUserResponse', describeAppInstanceUserResponse_appInstanceUser - The name of the AppInstanceUser.
$sel:httpStatus:DescribeAppInstanceUserResponse', describeAppInstanceUserResponse_httpStatus - The response's http status code.
DescribeAppInstance
data DescribeAppInstance Source #
See: newDescribeAppInstance smart constructor.
Constructors
| DescribeAppInstance' Text |
Instances
newDescribeAppInstance Source #
Create a value of DescribeAppInstance 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:appInstanceArn:DescribeAppInstance', describeAppInstance_appInstanceArn - The ARN of the AppInstance.
data DescribeAppInstanceResponse Source #
See: newDescribeAppInstanceResponse smart constructor.
Constructors
| DescribeAppInstanceResponse' (Maybe AppInstance) Int |
Instances
newDescribeAppInstanceResponse Source #
Create a value of DescribeAppInstanceResponse 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:appInstance:DescribeAppInstanceResponse', describeAppInstanceResponse_appInstance - The ARN, metadata, created and last-updated timestamps, and the name of
the AppInstance. All timestamps use epoch milliseconds.
$sel:httpStatus:DescribeAppInstanceResponse', describeAppInstanceResponse_httpStatus - The response's http status code.
ListAppInstanceUsers
data ListAppInstanceUsers Source #
See: newListAppInstanceUsers smart constructor.
Instances
newListAppInstanceUsers Source #
Create a value of ListAppInstanceUsers 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:nextToken:ListAppInstanceUsers', listAppInstanceUsers_nextToken - The token passed by previous API calls until all requested users are
returned.
$sel:maxResults:ListAppInstanceUsers', listAppInstanceUsers_maxResults - The maximum number of requests that you want returned.
$sel:appInstanceArn:ListAppInstanceUsers', listAppInstanceUsers_appInstanceArn - The ARN of the AppInstance.
data ListAppInstanceUsersResponse Source #
See: newListAppInstanceUsersResponse smart constructor.
Constructors
| ListAppInstanceUsersResponse' (Maybe (Sensitive Text)) (Maybe [AppInstanceUserSummary]) (Maybe Text) Int |
Instances
newListAppInstanceUsersResponse Source #
Create a value of ListAppInstanceUsersResponse 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:nextToken:ListAppInstanceUsers', listAppInstanceUsersResponse_nextToken - The token passed by previous API calls until all requested users are
returned.
$sel:appInstanceUsers:ListAppInstanceUsersResponse', listAppInstanceUsersResponse_appInstanceUsers - The information for each requested AppInstanceUser.
$sel:appInstanceArn:ListAppInstanceUsers', listAppInstanceUsersResponse_appInstanceArn - The ARN of the AppInstance.
$sel:httpStatus:ListAppInstanceUsersResponse', listAppInstanceUsersResponse_httpStatus - The response's http status code.
DeleteAppInstanceUser
data DeleteAppInstanceUser Source #
See: newDeleteAppInstanceUser smart constructor.
Constructors
| DeleteAppInstanceUser' Text |
Instances
newDeleteAppInstanceUser Source #
Create a value of DeleteAppInstanceUser 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:appInstanceUserArn:DeleteAppInstanceUser', deleteAppInstanceUser_appInstanceUserArn - The ARN of the user request being deleted.
data DeleteAppInstanceUserResponse Source #
See: newDeleteAppInstanceUserResponse smart constructor.
Constructors
| DeleteAppInstanceUserResponse' | |
Instances
newDeleteAppInstanceUserResponse :: DeleteAppInstanceUserResponse Source #
Create a value of DeleteAppInstanceUserResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
UpdateAppInstanceUser
data UpdateAppInstanceUser Source #
See: newUpdateAppInstanceUser smart constructor.
Instances
newUpdateAppInstanceUser Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> UpdateAppInstanceUser |
Create a value of UpdateAppInstanceUser 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:appInstanceUserArn:UpdateAppInstanceUser', updateAppInstanceUser_appInstanceUserArn - The ARN of the AppInstanceUser.
$sel:name:UpdateAppInstanceUser', updateAppInstanceUser_name - The name of the AppInstanceUser.
$sel:metadata:UpdateAppInstanceUser', updateAppInstanceUser_metadata - The metadata of the AppInstanceUser.
data UpdateAppInstanceUserResponse Source #
See: newUpdateAppInstanceUserResponse smart constructor.
Constructors
| UpdateAppInstanceUserResponse' (Maybe Text) Int |
Instances
newUpdateAppInstanceUserResponse Source #
Create a value of UpdateAppInstanceUserResponse 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:appInstanceUserArn:UpdateAppInstanceUser', updateAppInstanceUserResponse_appInstanceUserArn - The ARN of the AppInstanceUser.
$sel:httpStatus:UpdateAppInstanceUserResponse', updateAppInstanceUserResponse_httpStatus - The response's http status code.
DeleteAppInstanceAdmin
data DeleteAppInstanceAdmin Source #
See: newDeleteAppInstanceAdmin smart constructor.
Constructors
| DeleteAppInstanceAdmin' Text Text |
Instances
newDeleteAppInstanceAdmin Source #
Arguments
| :: Text | |
| -> Text | |
| -> DeleteAppInstanceAdmin |
Create a value of DeleteAppInstanceAdmin 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:appInstanceAdminArn:DeleteAppInstanceAdmin', deleteAppInstanceAdmin_appInstanceAdminArn - The ARN of the AppInstance's administrator.
$sel:appInstanceArn:DeleteAppInstanceAdmin', deleteAppInstanceAdmin_appInstanceArn - The ARN of the AppInstance.
data DeleteAppInstanceAdminResponse Source #
See: newDeleteAppInstanceAdminResponse smart constructor.
Constructors
| DeleteAppInstanceAdminResponse' | |
Instances
newDeleteAppInstanceAdminResponse :: DeleteAppInstanceAdminResponse Source #
Create a value of DeleteAppInstanceAdminResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteAppInstance
data DeleteAppInstance Source #
See: newDeleteAppInstance smart constructor.
Constructors
| DeleteAppInstance' Text |
Instances
Arguments
| :: Text | |
| -> DeleteAppInstance |
Create a value of DeleteAppInstance 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:appInstanceArn:DeleteAppInstance', deleteAppInstance_appInstanceArn - The ARN of the AppInstance.
data DeleteAppInstanceResponse Source #
See: newDeleteAppInstanceResponse smart constructor.
Constructors
| DeleteAppInstanceResponse' | |
Instances
newDeleteAppInstanceResponse :: DeleteAppInstanceResponse Source #
Create a value of DeleteAppInstanceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
UpdateAppInstance
data UpdateAppInstance Source #
See: newUpdateAppInstance smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> UpdateAppInstance |
Create a value of UpdateAppInstance 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:appInstanceArn:UpdateAppInstance', updateAppInstance_appInstanceArn - The ARN of the AppInstance.
$sel:name:UpdateAppInstance', updateAppInstance_name - The name that you want to change.
$sel:metadata:UpdateAppInstance', updateAppInstance_metadata - The metadata that you want to change.
data UpdateAppInstanceResponse Source #
See: newUpdateAppInstanceResponse smart constructor.
Constructors
| UpdateAppInstanceResponse' (Maybe Text) Int |
Instances
newUpdateAppInstanceResponse Source #
Create a value of UpdateAppInstanceResponse 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:appInstanceArn:UpdateAppInstance', updateAppInstanceResponse_appInstanceArn - The ARN of the AppInstance.
$sel:httpStatus:UpdateAppInstanceResponse', updateAppInstanceResponse_httpStatus - The response's http status code.
Types
AppInstance
data AppInstance Source #
The details of an AppInstance, an instance of an Amazon Chime SDK
messaging application.
See: newAppInstance smart constructor.
Constructors
| AppInstance' (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe Text) (Maybe POSIX) (Maybe POSIX) |
Instances
newAppInstance :: AppInstance Source #
Create a value of AppInstance 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:name:AppInstance', appInstance_name - The name of an AppInstance.
$sel:metadata:AppInstance', appInstance_metadata - The metadata of an AppInstance.
$sel:appInstanceArn:AppInstance', appInstance_appInstanceArn - The ARN of the messaging instance.
$sel:createdTimestamp:AppInstance', appInstance_createdTimestamp - The time at which an AppInstance was created. In epoch milliseconds.
$sel:lastUpdatedTimestamp:AppInstance', appInstance_lastUpdatedTimestamp - The time an AppInstance was last updated. In epoch milliseconds.
AppInstanceAdmin
data AppInstanceAdmin Source #
The details of an AppInstanceAdmin.
See: newAppInstanceAdmin smart constructor.
Instances
newAppInstanceAdmin :: AppInstanceAdmin Source #
Create a value of AppInstanceAdmin 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:admin:AppInstanceAdmin', appInstanceAdmin_admin - The AppInstanceAdmin data.
$sel:appInstanceArn:AppInstanceAdmin', appInstanceAdmin_appInstanceArn - The ARN of the AppInstance for which the user is an administrator.
$sel:createdTimestamp:AppInstanceAdmin', appInstanceAdmin_createdTimestamp - The time at which an administrator was created.
AppInstanceAdminSummary
data AppInstanceAdminSummary Source #
Summary of the details of an AppInstanceAdmin.
See: newAppInstanceAdminSummary smart constructor.
Constructors
| AppInstanceAdminSummary' (Maybe Identity) |
Instances
newAppInstanceAdminSummary :: AppInstanceAdminSummary Source #
Create a value of AppInstanceAdminSummary 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:admin:AppInstanceAdminSummary', appInstanceAdminSummary_admin - The details of the AppInstanceAdmin.
AppInstanceRetentionSettings
data AppInstanceRetentionSettings Source #
The details of the data-retention settings for an AppInstance.
See: newAppInstanceRetentionSettings smart constructor.
Constructors
| AppInstanceRetentionSettings' (Maybe ChannelRetentionSettings) |
Instances
newAppInstanceRetentionSettings :: AppInstanceRetentionSettings Source #
Create a value of AppInstanceRetentionSettings 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:channelRetentionSettings:AppInstanceRetentionSettings', appInstanceRetentionSettings_channelRetentionSettings - The length of time in days to retain the messages in a channel.
AppInstanceSummary
data AppInstanceSummary Source #
Summary of the data for an AppInstance.
See: newAppInstanceSummary smart constructor.
Instances
newAppInstanceSummary :: AppInstanceSummary Source #
Create a value of AppInstanceSummary 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:name:AppInstanceSummary', appInstanceSummary_name - The name of the AppInstance.
$sel:metadata:AppInstanceSummary', appInstanceSummary_metadata - The metadata of the AppInstance.
$sel:appInstanceArn:AppInstanceSummary', appInstanceSummary_appInstanceArn - The AppInstance ARN.
AppInstanceUser
data AppInstanceUser Source #
The details of an AppInstanceUser.
See: newAppInstanceUser smart constructor.
Constructors
| AppInstanceUser' (Maybe Text) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe POSIX) (Maybe POSIX) |
Instances
newAppInstanceUser :: AppInstanceUser Source #
Create a value of AppInstanceUser 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:appInstanceUserArn:AppInstanceUser', appInstanceUser_appInstanceUserArn - The ARN of the AppInstanceUser.
$sel:name:AppInstanceUser', appInstanceUser_name - The name of the AppInstanceUser.
$sel:metadata:AppInstanceUser', appInstanceUser_metadata - The metadata of the AppInstanceUser.
$sel:createdTimestamp:AppInstanceUser', appInstanceUser_createdTimestamp - The time at which the AppInstanceUser was created.
$sel:lastUpdatedTimestamp:AppInstanceUser', appInstanceUser_lastUpdatedTimestamp - The time at which the AppInstanceUser was last updated.
AppInstanceUserSummary
data AppInstanceUserSummary Source #
Summary of the details of an AppInstanceUser.
See: newAppInstanceUserSummary smart constructor.
Instances
newAppInstanceUserSummary :: AppInstanceUserSummary Source #
Create a value of AppInstanceUserSummary 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:appInstanceUserArn:AppInstanceUserSummary', appInstanceUserSummary_appInstanceUserArn - The ARN of the AppInstanceUser.
$sel:name:AppInstanceUserSummary', appInstanceUserSummary_name - The name of an AppInstanceUser.
$sel:metadata:AppInstanceUserSummary', appInstanceUserSummary_metadata - The metadata of the AppInstanceUser.
ChannelRetentionSettings
data ChannelRetentionSettings Source #
The details of the retention settings for a channel.
See: newChannelRetentionSettings smart constructor.
Constructors
| ChannelRetentionSettings' (Maybe Natural) |
Instances
newChannelRetentionSettings :: ChannelRetentionSettings Source #
Create a value of ChannelRetentionSettings 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:retentionDays:ChannelRetentionSettings', channelRetentionSettings_retentionDays - The time in days to retain the messages in a channel.
Identity
The details of a user.
See: newIdentity smart constructor.
Instances
| Eq Identity Source # | |
| Show Identity Source # | |
| Generic Identity Source # | |
| NFData Identity Source # | |
Defined in Amazonka.ChimeSDKIdentity.Types.Identity | |
| Hashable Identity Source # | |
Defined in Amazonka.ChimeSDKIdentity.Types.Identity | |
| FromJSON Identity Source # | |
| type Rep Identity Source # | |
Defined in Amazonka.ChimeSDKIdentity.Types.Identity type Rep Identity = D1 ('MetaData "Identity" "Amazonka.ChimeSDKIdentity.Types.Identity" "libZSservicesZSamazonka-chime-sdk-identityZSamazonka-chime-sdk-identity" 'False) (C1 ('MetaCons "Identity'" 'PrefixI 'True) (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))))) | |
newIdentity :: Identity Source #
Create a value of Identity 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:arn:Identity', identity_arn - The ARN in an Identity.
$sel:name:Identity', identity_name - The name in an Identity.
Tag
Describes a tag applied to a resource.
See: newTag smart constructor.
Instances
| Eq Tag Source # | |
| Show Tag Source # | |
| Generic Tag Source # | |
| NFData Tag Source # | |
Defined in Amazonka.ChimeSDKIdentity.Types.Tag | |
| Hashable Tag Source # | |
Defined in Amazonka.ChimeSDKIdentity.Types.Tag | |
| ToJSON Tag Source # | |
Defined in Amazonka.ChimeSDKIdentity.Types.Tag | |
| type Rep Tag Source # | |
Defined in Amazonka.ChimeSDKIdentity.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.ChimeSDKIdentity.Types.Tag" "libZSservicesZSamazonka-chime-sdk-identityZSamazonka-chime-sdk-identity" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive 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 key of the tag.
$sel:value:Tag', tag_value - The value of the tag.