libZSservicesZSamazonka-chime-sdk-identityZSamazonka-chime-sdk-identity
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.ChimeSDKIdentity.Lens

Description

 
Synopsis

Operations

CreateAppInstance

createAppInstance_metadata :: Lens' CreateAppInstance (Maybe Text) Source #

The metadata of the AppInstance. Limited to a 1KB string in UTF-8.

createAppInstance_tags :: Lens' CreateAppInstance (Maybe (NonEmpty Tag)) Source #

Tags assigned to the AppInstanceUser.

createAppInstance_clientRequestToken :: Lens' CreateAppInstance Text Source #

The ClientRequestToken of the AppInstance.

createAppInstanceResponse_appInstanceArn :: Lens' CreateAppInstanceResponse (Maybe Text) Source #

The Amazon Resource Number (ARN) of the AppInstance.

GetAppInstanceRetentionSettings

getAppInstanceRetentionSettingsResponse_initiateDeletionTimestamp :: Lens' GetAppInstanceRetentionSettingsResponse (Maybe UTCTime) Source #

The timestamp representing the time at which the specified items are retained, in Epoch Seconds.

DescribeAppInstanceAdmin

describeAppInstanceAdminResponse_appInstanceAdmin :: Lens' DescribeAppInstanceAdminResponse (Maybe AppInstanceAdmin) Source #

The ARN and name of the AppInstanceUser, the ARN of the AppInstance, and the created and last-updated timestamps. All timestamps use epoch milliseconds.

CreateAppInstanceUser

createAppInstanceUser_metadata :: Lens' CreateAppInstanceUser (Maybe Text) Source #

The request's metadata. Limited to a 1KB string in UTF-8.

createAppInstanceUser_tags :: Lens' CreateAppInstanceUser (Maybe (NonEmpty Tag)) Source #

Tags assigned to the AppInstanceUser.

createAppInstanceUser_clientRequestToken :: Lens' CreateAppInstanceUser Text Source #

The token assigned to the user requesting an AppInstance.

PutAppInstanceRetentionSettings

CreateAppInstanceAdmin

createAppInstanceAdmin_appInstanceAdminArn :: Lens' CreateAppInstanceAdmin Text Source #

The ARN of the administrator of the current AppInstance.

ListAppInstanceAdmins

listAppInstanceAdmins_nextToken :: Lens' ListAppInstanceAdmins (Maybe Text) Source #

The token returned from previous API requests until the number of administrators is reached.

listAppInstanceAdmins_maxResults :: Lens' ListAppInstanceAdmins (Maybe Natural) Source #

The maximum number of administrators that you want to return.

listAppInstanceAdminsResponse_nextToken :: Lens' ListAppInstanceAdminsResponse (Maybe Text) Source #

The token returned from previous API requests until the number of administrators is reached.

ListAppInstances

listAppInstances_nextToken :: Lens' ListAppInstances (Maybe Text) Source #

The token passed by previous API requests until you reach the maximum number of AppInstances.

listAppInstances_maxResults :: Lens' ListAppInstances (Maybe Natural) Source #

The maximum number of AppInstances that you want to return.

listAppInstancesResponse_nextToken :: Lens' ListAppInstancesResponse (Maybe Text) Source #

The token passed by previous API requests until the maximum number of AppInstances is reached.

DescribeAppInstanceUser

DescribeAppInstance

describeAppInstanceResponse_appInstance :: Lens' DescribeAppInstanceResponse (Maybe AppInstance) Source #

The ARN, metadata, created and last-updated timestamps, and the name of the AppInstance. All timestamps use epoch milliseconds.

ListAppInstanceUsers

listAppInstanceUsers_nextToken :: Lens' ListAppInstanceUsers (Maybe Text) Source #

The token passed by previous API calls until all requested users are returned.

listAppInstanceUsers_maxResults :: Lens' ListAppInstanceUsers (Maybe Natural) Source #

The maximum number of requests that you want returned.

listAppInstanceUsersResponse_nextToken :: Lens' ListAppInstanceUsersResponse (Maybe Text) Source #

The token passed by previous API calls until all requested users are returned.

DeleteAppInstanceUser

UpdateAppInstanceUser

DeleteAppInstanceAdmin

DeleteAppInstance

UpdateAppInstance

updateAppInstance_name :: Lens' UpdateAppInstance Text Source #

The name that you want to change.

updateAppInstance_metadata :: Lens' UpdateAppInstance Text Source #

The metadata that you want to change.

Types

AppInstance

appInstance_name :: Lens' AppInstance (Maybe Text) Source #

The name of an AppInstance.

appInstance_metadata :: Lens' AppInstance (Maybe Text) Source #

The metadata of an AppInstance.

appInstance_appInstanceArn :: Lens' AppInstance (Maybe Text) Source #

The ARN of the messaging instance.

appInstance_createdTimestamp :: Lens' AppInstance (Maybe UTCTime) Source #

The time at which an AppInstance was created. In epoch milliseconds.

appInstance_lastUpdatedTimestamp :: Lens' AppInstance (Maybe UTCTime) Source #

The time an AppInstance was last updated. In epoch milliseconds.

AppInstanceAdmin

appInstanceAdmin_appInstanceArn :: Lens' AppInstanceAdmin (Maybe Text) Source #

The ARN of the AppInstance for which the user is an administrator.

appInstanceAdmin_createdTimestamp :: Lens' AppInstanceAdmin (Maybe UTCTime) Source #

The time at which an administrator was created.

AppInstanceAdminSummary

AppInstanceRetentionSettings

AppInstanceSummary

AppInstanceUser

appInstanceUser_name :: Lens' AppInstanceUser (Maybe Text) Source #

The name of the AppInstanceUser.

appInstanceUser_metadata :: Lens' AppInstanceUser (Maybe Text) Source #

The metadata of the AppInstanceUser.

appInstanceUser_createdTimestamp :: Lens' AppInstanceUser (Maybe UTCTime) Source #

The time at which the AppInstanceUser was created.

appInstanceUser_lastUpdatedTimestamp :: Lens' AppInstanceUser (Maybe UTCTime) Source #

The time at which the AppInstanceUser was last updated.

AppInstanceUserSummary

ChannelRetentionSettings

channelRetentionSettings_retentionDays :: Lens' ChannelRetentionSettings (Maybe Natural) Source #

The time in days to retain the messages in a channel.

Identity

identity_arn :: Lens' Identity (Maybe Text) Source #

The ARN in an Identity.

identity_name :: Lens' Identity (Maybe Text) Source #

The name in an Identity.

Tag

tag_key :: Lens' Tag Text Source #

The key of the tag.

tag_value :: Lens' Tag Text Source #

The value of the tag.