| 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.Types
Description
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 AppInstance = AppInstance' {}
- newAppInstance :: AppInstance
- appInstance_name :: Lens' AppInstance (Maybe Text)
- appInstance_metadata :: Lens' AppInstance (Maybe Text)
- appInstance_appInstanceArn :: Lens' AppInstance (Maybe Text)
- appInstance_createdTimestamp :: Lens' AppInstance (Maybe UTCTime)
- appInstance_lastUpdatedTimestamp :: Lens' AppInstance (Maybe UTCTime)
- data AppInstanceAdmin = AppInstanceAdmin' {}
- newAppInstanceAdmin :: AppInstanceAdmin
- appInstanceAdmin_admin :: Lens' AppInstanceAdmin (Maybe Identity)
- appInstanceAdmin_appInstanceArn :: Lens' AppInstanceAdmin (Maybe Text)
- appInstanceAdmin_createdTimestamp :: Lens' AppInstanceAdmin (Maybe UTCTime)
- data AppInstanceAdminSummary = AppInstanceAdminSummary' {}
- newAppInstanceAdminSummary :: AppInstanceAdminSummary
- appInstanceAdminSummary_admin :: Lens' AppInstanceAdminSummary (Maybe Identity)
- data AppInstanceRetentionSettings = AppInstanceRetentionSettings' {}
- newAppInstanceRetentionSettings :: AppInstanceRetentionSettings
- appInstanceRetentionSettings_channelRetentionSettings :: Lens' AppInstanceRetentionSettings (Maybe ChannelRetentionSettings)
- data AppInstanceSummary = AppInstanceSummary' {}
- newAppInstanceSummary :: AppInstanceSummary
- appInstanceSummary_name :: Lens' AppInstanceSummary (Maybe Text)
- appInstanceSummary_metadata :: Lens' AppInstanceSummary (Maybe Text)
- appInstanceSummary_appInstanceArn :: Lens' AppInstanceSummary (Maybe Text)
- data AppInstanceUser = AppInstanceUser' {}
- newAppInstanceUser :: AppInstanceUser
- appInstanceUser_appInstanceUserArn :: Lens' AppInstanceUser (Maybe Text)
- appInstanceUser_name :: Lens' AppInstanceUser (Maybe Text)
- appInstanceUser_metadata :: Lens' AppInstanceUser (Maybe Text)
- appInstanceUser_createdTimestamp :: Lens' AppInstanceUser (Maybe UTCTime)
- appInstanceUser_lastUpdatedTimestamp :: Lens' AppInstanceUser (Maybe UTCTime)
- data AppInstanceUserSummary = AppInstanceUserSummary' {}
- newAppInstanceUserSummary :: AppInstanceUserSummary
- appInstanceUserSummary_appInstanceUserArn :: Lens' AppInstanceUserSummary (Maybe Text)
- appInstanceUserSummary_name :: Lens' AppInstanceUserSummary (Maybe Text)
- appInstanceUserSummary_metadata :: Lens' AppInstanceUserSummary (Maybe Text)
- data ChannelRetentionSettings = ChannelRetentionSettings' {}
- newChannelRetentionSettings :: ChannelRetentionSettings
- channelRetentionSettings_retentionDays :: Lens' ChannelRetentionSettings (Maybe Natural)
- data Identity = Identity' {}
- newIdentity :: Identity
- identity_arn :: Lens' Identity (Maybe Text)
- identity_name :: Lens' Identity (Maybe Text)
- data Tag = Tag' {}
- newTag :: Text -> Text -> Tag
- tag_key :: Lens' Tag Text
- tag_value :: Lens' Tag Text
Service Configuration
defaultService :: Service Source #
API version 2021-04-20 of the Amazon Chime SDK Identity SDK configuration.
Errors
_ThrottledClientException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The client exceeded its request rate limit.
_ResourceLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request exceeds the resource limit.
_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 :: AsError a => Getting (First ServiceError) a ServiceError Source #
The client is permanently forbidden from making the request.
_ServiceFailureException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The service encountered an unexpected error.
_UnauthorizedClientException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The client is not currently authorized to make the request.
_ServiceUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The service is currently unavailable.
_BadRequestException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The input parameters don't match the service's restrictions.
AppInstance
data AppInstance Source #
The details of an AppInstance, an instance of an Amazon Chime SDK
messaging application.
See: newAppInstance smart constructor.
Constructors
| AppInstance' | |
Fields
| |
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.
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
data AppInstanceAdmin Source #
The details of an AppInstanceAdmin.
See: newAppInstanceAdmin smart constructor.
Constructors
| AppInstanceAdmin' | |
Fields
| |
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.
appInstanceAdmin_admin :: Lens' AppInstanceAdmin (Maybe Identity) Source #
The AppInstanceAdmin data.
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
data AppInstanceAdminSummary Source #
Summary of the details of an AppInstanceAdmin.
See: newAppInstanceAdminSummary smart constructor.
Constructors
| AppInstanceAdminSummary' | |
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.
appInstanceAdminSummary_admin :: Lens' AppInstanceAdminSummary (Maybe Identity) Source #
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' | |
Fields
| |
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.
appInstanceRetentionSettings_channelRetentionSettings :: Lens' AppInstanceRetentionSettings (Maybe ChannelRetentionSettings) Source #
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.
Constructors
| AppInstanceSummary' | |
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.
appInstanceSummary_name :: Lens' AppInstanceSummary (Maybe Text) Source #
The name of the AppInstance.
appInstanceSummary_metadata :: Lens' AppInstanceSummary (Maybe Text) Source #
The metadata of the AppInstance.
appInstanceSummary_appInstanceArn :: Lens' AppInstanceSummary (Maybe Text) Source #
The AppInstance ARN.
AppInstanceUser
data AppInstanceUser Source #
The details of an AppInstanceUser.
See: newAppInstanceUser smart constructor.
Constructors
| AppInstanceUser' | |
Fields
| |
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.
appInstanceUser_appInstanceUserArn :: Lens' AppInstanceUser (Maybe Text) Source #
The ARN of the 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
data AppInstanceUserSummary Source #
Summary of the details of an AppInstanceUser.
See: newAppInstanceUserSummary smart constructor.
Constructors
| AppInstanceUserSummary' | |
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.
appInstanceUserSummary_appInstanceUserArn :: Lens' AppInstanceUserSummary (Maybe Text) Source #
The ARN of the AppInstanceUser.
appInstanceUserSummary_name :: Lens' AppInstanceUserSummary (Maybe Text) Source #
The name of an AppInstanceUser.
appInstanceUserSummary_metadata :: Lens' AppInstanceUserSummary (Maybe Text) Source #
The metadata of the AppInstanceUser.
ChannelRetentionSettings
data ChannelRetentionSettings Source #
The details of the retention settings for a channel.
See: newChannelRetentionSettings smart constructor.
Constructors
| ChannelRetentionSettings' | |
Fields
| |
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.
channelRetentionSettings_retentionDays :: Lens' ChannelRetentionSettings (Maybe Natural) Source #
The time in days to retain the messages in a channel.
Identity
The details of a user.
See: newIdentity smart constructor.
Constructors
| Identity' | |
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.
Constructors
| Tag' | |
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.