amazonka-chime-sdk-identity-2.0: Amazon Chime SDK Identity SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

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.

CreateAppInstanceAdmin

createAppInstanceAdmin_appInstanceAdminArn :: Lens' CreateAppInstanceAdmin Text Source #

The ARN of the administrator of the current AppInstance.

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.

DeleteAppInstance

DeleteAppInstanceAdmin

DeleteAppInstanceUser

DeregisterAppInstanceUserEndpoint

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.

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.

DescribeAppInstanceUser

DescribeAppInstanceUserEndpoint

describeAppInstanceUserEndpoint_endpointId :: Lens' DescribeAppInstanceUserEndpoint Text Source #

The unique identifier of the AppInstanceUserEndpoint.

describeAppInstanceUserEndpointResponse_appInstanceUserEndpoint :: Lens' DescribeAppInstanceUserEndpointResponse (Maybe AppInstanceUserEndpoint) Source #

The full details of an AppInstanceUserEndpoint: the AppInstanceUserArn, ID, name, type, resource ARN, attributes, allow messages, state, and created and last updated timestamps. All timestamps use epoch milliseconds.

GetAppInstanceRetentionSettings

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

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

ListAppInstanceAdmins

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

The maximum number of administrators that you want to return.

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

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

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

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

ListAppInstanceUserEndpoints

listAppInstanceUserEndpoints_maxResults :: Lens' ListAppInstanceUserEndpoints (Maybe Natural) Source #

The maximum number of endpoints that you want to return.

listAppInstanceUserEndpoints_nextToken :: Lens' ListAppInstanceUserEndpoints (Maybe Text) Source #

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

listAppInstanceUserEndpointsResponse_nextToken :: Lens' ListAppInstanceUserEndpointsResponse (Maybe Text) Source #

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

ListAppInstanceUsers

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

The maximum number of requests that you want returned.

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

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

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

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

ListAppInstances

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

The maximum number of AppInstances that you want to return.

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

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

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

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

ListTagsForResource

PutAppInstanceRetentionSettings

RegisterAppInstanceUserEndpoint

registerAppInstanceUserEndpoint_allowMessages :: Lens' RegisterAppInstanceUserEndpoint (Maybe AllowMessages) Source #

Boolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages. ALL indicates the endpoint receives all messages. NONE indicates the endpoint receives no messages.

registerAppInstanceUserEndpoint_type :: Lens' RegisterAppInstanceUserEndpoint AppInstanceUserEndpointType Source #

The type of the AppInstanceUserEndpoint. Supported types:

  • APNS: The mobile notification service for an Apple device.
  • APNS_SANDBOX: The sandbox environment of the mobile notification service for an Apple device.
  • GCM: The mobile notification service for an Android device.

Populate the ResourceArn value of each type as PinpointAppArn.

registerAppInstanceUserEndpoint_resourceArn :: Lens' RegisterAppInstanceUserEndpoint Text Source #

The ARN of the resource to which the endpoint belongs.

TagResource

tagResource_tags :: Lens' TagResource (NonEmpty Tag) Source #

The tag key-value pairs.

UntagResource

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.

UpdateAppInstanceUser

UpdateAppInstanceUserEndpoint

updateAppInstanceUserEndpoint_allowMessages :: Lens' UpdateAppInstanceUserEndpoint (Maybe AllowMessages) Source #

Boolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages. ALL indicates the endpoint will receive all messages. NONE indicates the endpoint will receive no messages.

updateAppInstanceUserEndpoint_endpointId :: Lens' UpdateAppInstanceUserEndpoint Text Source #

The unique identifier of the AppInstanceUserEndpoint.

Types

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.

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

The metadata of an AppInstance.

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

The name of an AppInstance.

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_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.

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

The metadata of the AppInstanceUser.

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

The name of the AppInstanceUser.

AppInstanceUserEndpoint

appInstanceUserEndpoint_allowMessages :: Lens' AppInstanceUserEndpoint (Maybe AllowMessages) Source #

Boolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages. ALL indicates the endpoint will receive all messages. NONE indicates the endpoint will receive no messages.

appInstanceUserEndpoint_createdTimestamp :: Lens' AppInstanceUserEndpoint (Maybe UTCTime) Source #

The time at which an AppInstanceUserEndpoint was created.

appInstanceUserEndpoint_endpointId :: Lens' AppInstanceUserEndpoint (Maybe Text) Source #

The unique identifier of the AppInstanceUserEndpoint.

appInstanceUserEndpoint_endpointState :: Lens' AppInstanceUserEndpoint (Maybe EndpointState) Source #

A read-only field that represents the state of an AppInstanceUserEndpoint. Supported values:

  • ACTIVE: The AppInstanceUserEndpoint is active and able to receive messages. When ACTIVE, the EndpointStatusReason remains empty.
  • INACTIVE: The AppInstanceUserEndpoint is inactive and can't receive message. When INACTIVE, the corresponding reason will be conveyed through EndpointStatusReason.
  • INVALID_DEVICE_TOKEN indicates that an AppInstanceUserEndpoint is INACTIVE due to invalid device token
  • INVALID_PINPOINT_ARN indicates that an AppInstanceUserEndpoint is INACTIVE due to an invalid pinpoint ARN that was input through the ResourceArn field.

appInstanceUserEndpoint_lastUpdatedTimestamp :: Lens' AppInstanceUserEndpoint (Maybe UTCTime) Source #

The time at which an AppInstanceUserEndpoint was last updated.

appInstanceUserEndpoint_name :: Lens' AppInstanceUserEndpoint (Maybe Text) Source #

The name of the AppInstanceUserEndpoint.

appInstanceUserEndpoint_resourceArn :: Lens' AppInstanceUserEndpoint (Maybe Text) Source #

The ARN of the resource to which the endpoint belongs.

AppInstanceUserEndpointSummary

appInstanceUserEndpointSummary_allowMessages :: Lens' AppInstanceUserEndpointSummary (Maybe AllowMessages) Source #

BBoolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages. ALL indicates the endpoint will receive all messages. NONE indicates the endpoint will receive no messages.

appInstanceUserEndpointSummary_endpointId :: Lens' AppInstanceUserEndpointSummary (Maybe Text) Source #

The unique identifier of the AppInstanceUserEndpoint.

appInstanceUserEndpointSummary_endpointState :: Lens' AppInstanceUserEndpointSummary (Maybe EndpointState) Source #

A read-only field that represent the state of an AppInstanceUserEndpoint.

AppInstanceUserSummary

ChannelRetentionSettings

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

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

EndpointAttributes

endpointAttributes_voipDeviceToken :: Lens' EndpointAttributes (Maybe Text) Source #

The VOIP device token for the APNS and APNS_SANDBOX endpoint types.

endpointAttributes_deviceToken :: Lens' EndpointAttributes Text Source #

The device token for the GCM, APNS, and APNS_SANDBOX endpoint types.

EndpointState

endpointState_status :: Lens' EndpointState EndpointStatus Source #

Enum that indicates the Status of an AppInstanceUserEndpoint.

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 in a tag.

tag_value :: Lens' Tag Text Source #

The value in a tag.