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 |
- Operations
- CreateAppInstance
- CreateAppInstanceAdmin
- CreateAppInstanceUser
- DeleteAppInstance
- DeleteAppInstanceAdmin
- DeleteAppInstanceUser
- DeregisterAppInstanceUserEndpoint
- DescribeAppInstance
- DescribeAppInstanceAdmin
- DescribeAppInstanceUser
- DescribeAppInstanceUserEndpoint
- GetAppInstanceRetentionSettings
- ListAppInstanceAdmins
- ListAppInstanceUserEndpoints
- ListAppInstanceUsers
- ListAppInstances
- ListTagsForResource
- PutAppInstanceRetentionSettings
- RegisterAppInstanceUserEndpoint
- TagResource
- UntagResource
- UpdateAppInstance
- UpdateAppInstanceUser
- UpdateAppInstanceUserEndpoint
- Types
Synopsis
- createAppInstance_metadata :: Lens' CreateAppInstance (Maybe Text)
- createAppInstance_tags :: Lens' CreateAppInstance (Maybe (NonEmpty Tag))
- createAppInstance_name :: Lens' CreateAppInstance Text
- createAppInstance_clientRequestToken :: Lens' CreateAppInstance Text
- createAppInstanceResponse_appInstanceArn :: Lens' CreateAppInstanceResponse (Maybe Text)
- createAppInstanceResponse_httpStatus :: Lens' CreateAppInstanceResponse Int
- createAppInstanceAdmin_appInstanceAdminArn :: Lens' CreateAppInstanceAdmin Text
- createAppInstanceAdmin_appInstanceArn :: Lens' CreateAppInstanceAdmin Text
- createAppInstanceAdminResponse_appInstanceAdmin :: Lens' CreateAppInstanceAdminResponse (Maybe Identity)
- createAppInstanceAdminResponse_appInstanceArn :: Lens' CreateAppInstanceAdminResponse (Maybe Text)
- createAppInstanceAdminResponse_httpStatus :: Lens' CreateAppInstanceAdminResponse Int
- createAppInstanceUser_metadata :: Lens' CreateAppInstanceUser (Maybe Text)
- createAppInstanceUser_tags :: Lens' CreateAppInstanceUser (Maybe (NonEmpty Tag))
- createAppInstanceUser_appInstanceArn :: Lens' CreateAppInstanceUser Text
- createAppInstanceUser_appInstanceUserId :: Lens' CreateAppInstanceUser Text
- createAppInstanceUser_name :: Lens' CreateAppInstanceUser Text
- createAppInstanceUser_clientRequestToken :: Lens' CreateAppInstanceUser Text
- createAppInstanceUserResponse_appInstanceUserArn :: Lens' CreateAppInstanceUserResponse (Maybe Text)
- createAppInstanceUserResponse_httpStatus :: Lens' CreateAppInstanceUserResponse Int
- deleteAppInstance_appInstanceArn :: Lens' DeleteAppInstance Text
- deleteAppInstanceAdmin_appInstanceAdminArn :: Lens' DeleteAppInstanceAdmin Text
- deleteAppInstanceAdmin_appInstanceArn :: Lens' DeleteAppInstanceAdmin Text
- deleteAppInstanceUser_appInstanceUserArn :: Lens' DeleteAppInstanceUser Text
- deregisterAppInstanceUserEndpoint_appInstanceUserArn :: Lens' DeregisterAppInstanceUserEndpoint Text
- deregisterAppInstanceUserEndpoint_endpointId :: Lens' DeregisterAppInstanceUserEndpoint Text
- describeAppInstance_appInstanceArn :: Lens' DescribeAppInstance Text
- describeAppInstanceResponse_appInstance :: Lens' DescribeAppInstanceResponse (Maybe AppInstance)
- describeAppInstanceResponse_httpStatus :: Lens' DescribeAppInstanceResponse Int
- describeAppInstanceAdmin_appInstanceAdminArn :: Lens' DescribeAppInstanceAdmin Text
- describeAppInstanceAdmin_appInstanceArn :: Lens' DescribeAppInstanceAdmin Text
- describeAppInstanceAdminResponse_appInstanceAdmin :: Lens' DescribeAppInstanceAdminResponse (Maybe AppInstanceAdmin)
- describeAppInstanceAdminResponse_httpStatus :: Lens' DescribeAppInstanceAdminResponse Int
- describeAppInstanceUser_appInstanceUserArn :: Lens' DescribeAppInstanceUser Text
- describeAppInstanceUserResponse_appInstanceUser :: Lens' DescribeAppInstanceUserResponse (Maybe AppInstanceUser)
- describeAppInstanceUserResponse_httpStatus :: Lens' DescribeAppInstanceUserResponse Int
- describeAppInstanceUserEndpoint_appInstanceUserArn :: Lens' DescribeAppInstanceUserEndpoint Text
- describeAppInstanceUserEndpoint_endpointId :: Lens' DescribeAppInstanceUserEndpoint Text
- describeAppInstanceUserEndpointResponse_appInstanceUserEndpoint :: Lens' DescribeAppInstanceUserEndpointResponse (Maybe AppInstanceUserEndpoint)
- describeAppInstanceUserEndpointResponse_httpStatus :: Lens' DescribeAppInstanceUserEndpointResponse Int
- getAppInstanceRetentionSettings_appInstanceArn :: Lens' GetAppInstanceRetentionSettings Text
- getAppInstanceRetentionSettingsResponse_appInstanceRetentionSettings :: Lens' GetAppInstanceRetentionSettingsResponse (Maybe AppInstanceRetentionSettings)
- getAppInstanceRetentionSettingsResponse_initiateDeletionTimestamp :: Lens' GetAppInstanceRetentionSettingsResponse (Maybe UTCTime)
- getAppInstanceRetentionSettingsResponse_httpStatus :: Lens' GetAppInstanceRetentionSettingsResponse Int
- listAppInstanceAdmins_maxResults :: Lens' ListAppInstanceAdmins (Maybe Natural)
- listAppInstanceAdmins_nextToken :: Lens' ListAppInstanceAdmins (Maybe Text)
- listAppInstanceAdmins_appInstanceArn :: Lens' ListAppInstanceAdmins Text
- listAppInstanceAdminsResponse_appInstanceAdmins :: Lens' ListAppInstanceAdminsResponse (Maybe [AppInstanceAdminSummary])
- listAppInstanceAdminsResponse_appInstanceArn :: Lens' ListAppInstanceAdminsResponse (Maybe Text)
- listAppInstanceAdminsResponse_nextToken :: Lens' ListAppInstanceAdminsResponse (Maybe Text)
- listAppInstanceAdminsResponse_httpStatus :: Lens' ListAppInstanceAdminsResponse Int
- listAppInstanceUserEndpoints_maxResults :: Lens' ListAppInstanceUserEndpoints (Maybe Natural)
- listAppInstanceUserEndpoints_nextToken :: Lens' ListAppInstanceUserEndpoints (Maybe Text)
- listAppInstanceUserEndpoints_appInstanceUserArn :: Lens' ListAppInstanceUserEndpoints Text
- listAppInstanceUserEndpointsResponse_appInstanceUserEndpoints :: Lens' ListAppInstanceUserEndpointsResponse (Maybe [AppInstanceUserEndpointSummary])
- listAppInstanceUserEndpointsResponse_nextToken :: Lens' ListAppInstanceUserEndpointsResponse (Maybe Text)
- listAppInstanceUserEndpointsResponse_httpStatus :: Lens' ListAppInstanceUserEndpointsResponse Int
- listAppInstanceUsers_maxResults :: Lens' ListAppInstanceUsers (Maybe Natural)
- listAppInstanceUsers_nextToken :: Lens' ListAppInstanceUsers (Maybe Text)
- listAppInstanceUsers_appInstanceArn :: Lens' ListAppInstanceUsers Text
- listAppInstanceUsersResponse_appInstanceArn :: Lens' ListAppInstanceUsersResponse (Maybe Text)
- listAppInstanceUsersResponse_appInstanceUsers :: Lens' ListAppInstanceUsersResponse (Maybe [AppInstanceUserSummary])
- listAppInstanceUsersResponse_nextToken :: Lens' ListAppInstanceUsersResponse (Maybe Text)
- listAppInstanceUsersResponse_httpStatus :: Lens' ListAppInstanceUsersResponse Int
- listAppInstances_maxResults :: Lens' ListAppInstances (Maybe Natural)
- listAppInstances_nextToken :: Lens' ListAppInstances (Maybe Text)
- listAppInstancesResponse_appInstances :: Lens' ListAppInstancesResponse (Maybe [AppInstanceSummary])
- listAppInstancesResponse_nextToken :: Lens' ListAppInstancesResponse (Maybe Text)
- listAppInstancesResponse_httpStatus :: Lens' ListAppInstancesResponse Int
- listTagsForResource_resourceARN :: Lens' ListTagsForResource Text
- listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (NonEmpty Tag))
- listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int
- putAppInstanceRetentionSettings_appInstanceArn :: Lens' PutAppInstanceRetentionSettings Text
- putAppInstanceRetentionSettings_appInstanceRetentionSettings :: Lens' PutAppInstanceRetentionSettings AppInstanceRetentionSettings
- putAppInstanceRetentionSettingsResponse_appInstanceRetentionSettings :: Lens' PutAppInstanceRetentionSettingsResponse (Maybe AppInstanceRetentionSettings)
- putAppInstanceRetentionSettingsResponse_initiateDeletionTimestamp :: Lens' PutAppInstanceRetentionSettingsResponse (Maybe UTCTime)
- putAppInstanceRetentionSettingsResponse_httpStatus :: Lens' PutAppInstanceRetentionSettingsResponse Int
- registerAppInstanceUserEndpoint_allowMessages :: Lens' RegisterAppInstanceUserEndpoint (Maybe AllowMessages)
- registerAppInstanceUserEndpoint_name :: Lens' RegisterAppInstanceUserEndpoint (Maybe Text)
- registerAppInstanceUserEndpoint_appInstanceUserArn :: Lens' RegisterAppInstanceUserEndpoint Text
- registerAppInstanceUserEndpoint_type :: Lens' RegisterAppInstanceUserEndpoint AppInstanceUserEndpointType
- registerAppInstanceUserEndpoint_resourceArn :: Lens' RegisterAppInstanceUserEndpoint Text
- registerAppInstanceUserEndpoint_endpointAttributes :: Lens' RegisterAppInstanceUserEndpoint EndpointAttributes
- registerAppInstanceUserEndpoint_clientRequestToken :: Lens' RegisterAppInstanceUserEndpoint Text
- registerAppInstanceUserEndpointResponse_appInstanceUserArn :: Lens' RegisterAppInstanceUserEndpointResponse (Maybe Text)
- registerAppInstanceUserEndpointResponse_endpointId :: Lens' RegisterAppInstanceUserEndpointResponse (Maybe Text)
- registerAppInstanceUserEndpointResponse_httpStatus :: Lens' RegisterAppInstanceUserEndpointResponse Int
- tagResource_resourceARN :: Lens' TagResource Text
- tagResource_tags :: Lens' TagResource (NonEmpty Tag)
- untagResource_resourceARN :: Lens' UntagResource Text
- untagResource_tagKeys :: Lens' UntagResource (NonEmpty Text)
- updateAppInstance_appInstanceArn :: Lens' UpdateAppInstance Text
- updateAppInstance_name :: Lens' UpdateAppInstance Text
- updateAppInstance_metadata :: Lens' UpdateAppInstance Text
- updateAppInstanceResponse_appInstanceArn :: Lens' UpdateAppInstanceResponse (Maybe Text)
- updateAppInstanceResponse_httpStatus :: Lens' UpdateAppInstanceResponse Int
- updateAppInstanceUser_appInstanceUserArn :: Lens' UpdateAppInstanceUser Text
- updateAppInstanceUser_name :: Lens' UpdateAppInstanceUser Text
- updateAppInstanceUser_metadata :: Lens' UpdateAppInstanceUser Text
- updateAppInstanceUserResponse_appInstanceUserArn :: Lens' UpdateAppInstanceUserResponse (Maybe Text)
- updateAppInstanceUserResponse_httpStatus :: Lens' UpdateAppInstanceUserResponse Int
- updateAppInstanceUserEndpoint_allowMessages :: Lens' UpdateAppInstanceUserEndpoint (Maybe AllowMessages)
- updateAppInstanceUserEndpoint_name :: Lens' UpdateAppInstanceUserEndpoint (Maybe Text)
- updateAppInstanceUserEndpoint_appInstanceUserArn :: Lens' UpdateAppInstanceUserEndpoint Text
- updateAppInstanceUserEndpoint_endpointId :: Lens' UpdateAppInstanceUserEndpoint Text
- updateAppInstanceUserEndpointResponse_appInstanceUserArn :: Lens' UpdateAppInstanceUserEndpointResponse (Maybe Text)
- updateAppInstanceUserEndpointResponse_endpointId :: Lens' UpdateAppInstanceUserEndpointResponse (Maybe Text)
- updateAppInstanceUserEndpointResponse_httpStatus :: Lens' UpdateAppInstanceUserEndpointResponse Int
- appInstance_appInstanceArn :: Lens' AppInstance (Maybe Text)
- appInstance_createdTimestamp :: Lens' AppInstance (Maybe UTCTime)
- appInstance_lastUpdatedTimestamp :: Lens' AppInstance (Maybe UTCTime)
- appInstance_metadata :: Lens' AppInstance (Maybe Text)
- appInstance_name :: Lens' AppInstance (Maybe Text)
- appInstanceAdmin_admin :: Lens' AppInstanceAdmin (Maybe Identity)
- appInstanceAdmin_appInstanceArn :: Lens' AppInstanceAdmin (Maybe Text)
- appInstanceAdmin_createdTimestamp :: Lens' AppInstanceAdmin (Maybe UTCTime)
- appInstanceAdminSummary_admin :: Lens' AppInstanceAdminSummary (Maybe Identity)
- appInstanceRetentionSettings_channelRetentionSettings :: Lens' AppInstanceRetentionSettings (Maybe ChannelRetentionSettings)
- appInstanceSummary_appInstanceArn :: Lens' AppInstanceSummary (Maybe Text)
- appInstanceSummary_metadata :: Lens' AppInstanceSummary (Maybe Text)
- appInstanceSummary_name :: Lens' AppInstanceSummary (Maybe Text)
- appInstanceUser_appInstanceUserArn :: Lens' AppInstanceUser (Maybe Text)
- appInstanceUser_createdTimestamp :: Lens' AppInstanceUser (Maybe UTCTime)
- appInstanceUser_lastUpdatedTimestamp :: Lens' AppInstanceUser (Maybe UTCTime)
- appInstanceUser_metadata :: Lens' AppInstanceUser (Maybe Text)
- appInstanceUser_name :: Lens' AppInstanceUser (Maybe Text)
- appInstanceUserEndpoint_allowMessages :: Lens' AppInstanceUserEndpoint (Maybe AllowMessages)
- appInstanceUserEndpoint_appInstanceUserArn :: Lens' AppInstanceUserEndpoint (Maybe Text)
- appInstanceUserEndpoint_createdTimestamp :: Lens' AppInstanceUserEndpoint (Maybe UTCTime)
- appInstanceUserEndpoint_endpointAttributes :: Lens' AppInstanceUserEndpoint (Maybe EndpointAttributes)
- appInstanceUserEndpoint_endpointId :: Lens' AppInstanceUserEndpoint (Maybe Text)
- appInstanceUserEndpoint_endpointState :: Lens' AppInstanceUserEndpoint (Maybe EndpointState)
- appInstanceUserEndpoint_lastUpdatedTimestamp :: Lens' AppInstanceUserEndpoint (Maybe UTCTime)
- appInstanceUserEndpoint_name :: Lens' AppInstanceUserEndpoint (Maybe Text)
- appInstanceUserEndpoint_resourceArn :: Lens' AppInstanceUserEndpoint (Maybe Text)
- appInstanceUserEndpoint_type :: Lens' AppInstanceUserEndpoint (Maybe AppInstanceUserEndpointType)
- appInstanceUserEndpointSummary_allowMessages :: Lens' AppInstanceUserEndpointSummary (Maybe AllowMessages)
- appInstanceUserEndpointSummary_appInstanceUserArn :: Lens' AppInstanceUserEndpointSummary (Maybe Text)
- appInstanceUserEndpointSummary_endpointId :: Lens' AppInstanceUserEndpointSummary (Maybe Text)
- appInstanceUserEndpointSummary_endpointState :: Lens' AppInstanceUserEndpointSummary (Maybe EndpointState)
- appInstanceUserEndpointSummary_name :: Lens' AppInstanceUserEndpointSummary (Maybe Text)
- appInstanceUserEndpointSummary_type :: Lens' AppInstanceUserEndpointSummary (Maybe AppInstanceUserEndpointType)
- appInstanceUserSummary_appInstanceUserArn :: Lens' AppInstanceUserSummary (Maybe Text)
- appInstanceUserSummary_metadata :: Lens' AppInstanceUserSummary (Maybe Text)
- appInstanceUserSummary_name :: Lens' AppInstanceUserSummary (Maybe Text)
- channelRetentionSettings_retentionDays :: Lens' ChannelRetentionSettings (Maybe Natural)
- endpointAttributes_voipDeviceToken :: Lens' EndpointAttributes (Maybe Text)
- endpointAttributes_deviceToken :: Lens' EndpointAttributes Text
- endpointState_statusReason :: Lens' EndpointState (Maybe EndpointStatusReason)
- endpointState_status :: Lens' EndpointState EndpointStatus
- identity_arn :: Lens' Identity (Maybe Text)
- identity_name :: Lens' Identity (Maybe Text)
- tag_key :: Lens' Tag Text
- tag_value :: Lens' Tag Text
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_name :: Lens' CreateAppInstance Text Source #
The name of the AppInstance
.
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
.
createAppInstanceResponse_httpStatus :: Lens' CreateAppInstanceResponse Int Source #
The response's http status code.
CreateAppInstanceAdmin
createAppInstanceAdmin_appInstanceAdminArn :: Lens' CreateAppInstanceAdmin Text Source #
The ARN of the administrator of the current AppInstance
.
createAppInstanceAdmin_appInstanceArn :: Lens' CreateAppInstanceAdmin Text Source #
The ARN of the AppInstance
.
createAppInstanceAdminResponse_appInstanceAdmin :: Lens' CreateAppInstanceAdminResponse (Maybe Identity) Source #
The name and ARN of the admin for the AppInstance
.
createAppInstanceAdminResponse_appInstanceArn :: Lens' CreateAppInstanceAdminResponse (Maybe Text) Source #
The ARN of the of the admin for the AppInstance
.
createAppInstanceAdminResponse_httpStatus :: Lens' CreateAppInstanceAdminResponse Int Source #
The response's http status code.
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_appInstanceArn :: Lens' CreateAppInstanceUser Text Source #
The ARN of the AppInstance
request.
createAppInstanceUser_appInstanceUserId :: Lens' CreateAppInstanceUser Text Source #
The user ID of the AppInstance
.
createAppInstanceUser_name :: Lens' CreateAppInstanceUser Text Source #
The user's name.
createAppInstanceUser_clientRequestToken :: Lens' CreateAppInstanceUser Text Source #
The token assigned to the user requesting an AppInstance
.
createAppInstanceUserResponse_appInstanceUserArn :: Lens' CreateAppInstanceUserResponse (Maybe Text) Source #
The user's ARN.
createAppInstanceUserResponse_httpStatus :: Lens' CreateAppInstanceUserResponse Int Source #
The response's http status code.
DeleteAppInstance
deleteAppInstance_appInstanceArn :: Lens' DeleteAppInstance Text Source #
The ARN of the AppInstance
.
DeleteAppInstanceAdmin
deleteAppInstanceAdmin_appInstanceAdminArn :: Lens' DeleteAppInstanceAdmin Text Source #
The ARN of the AppInstance
's administrator.
deleteAppInstanceAdmin_appInstanceArn :: Lens' DeleteAppInstanceAdmin Text Source #
The ARN of the AppInstance
.
DeleteAppInstanceUser
deleteAppInstanceUser_appInstanceUserArn :: Lens' DeleteAppInstanceUser Text Source #
The ARN of the user request being deleted.
DeregisterAppInstanceUserEndpoint
deregisterAppInstanceUserEndpoint_appInstanceUserArn :: Lens' DeregisterAppInstanceUserEndpoint Text Source #
The ARN of the AppInstanceUser
.
deregisterAppInstanceUserEndpoint_endpointId :: Lens' DeregisterAppInstanceUserEndpoint Text Source #
The unique identifier of the AppInstanceUserEndpoint
.
DescribeAppInstance
describeAppInstance_appInstanceArn :: Lens' DescribeAppInstance Text Source #
The ARN of the AppInstance
.
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.
describeAppInstanceResponse_httpStatus :: Lens' DescribeAppInstanceResponse Int Source #
The response's http status code.
DescribeAppInstanceAdmin
describeAppInstanceAdmin_appInstanceAdminArn :: Lens' DescribeAppInstanceAdmin Text Source #
The ARN of the AppInstanceAdmin
.
describeAppInstanceAdmin_appInstanceArn :: Lens' DescribeAppInstanceAdmin Text Source #
The ARN of the AppInstance
.
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.
describeAppInstanceAdminResponse_httpStatus :: Lens' DescribeAppInstanceAdminResponse Int Source #
The response's http status code.
DescribeAppInstanceUser
describeAppInstanceUser_appInstanceUserArn :: Lens' DescribeAppInstanceUser Text Source #
The ARN of the AppInstanceUser
.
describeAppInstanceUserResponse_appInstanceUser :: Lens' DescribeAppInstanceUserResponse (Maybe AppInstanceUser) Source #
The name of the AppInstanceUser
.
describeAppInstanceUserResponse_httpStatus :: Lens' DescribeAppInstanceUserResponse Int Source #
The response's http status code.
DescribeAppInstanceUserEndpoint
describeAppInstanceUserEndpoint_appInstanceUserArn :: Lens' DescribeAppInstanceUserEndpoint Text Source #
The ARN of the AppInstanceUser
.
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.
describeAppInstanceUserEndpointResponse_httpStatus :: Lens' DescribeAppInstanceUserEndpointResponse Int Source #
The response's http status code.
GetAppInstanceRetentionSettings
getAppInstanceRetentionSettings_appInstanceArn :: Lens' GetAppInstanceRetentionSettings Text Source #
The ARN of the AppInstance
.
getAppInstanceRetentionSettingsResponse_appInstanceRetentionSettings :: Lens' GetAppInstanceRetentionSettingsResponse (Maybe AppInstanceRetentionSettings) Source #
The retention settings for the AppInstance
.
getAppInstanceRetentionSettingsResponse_initiateDeletionTimestamp :: Lens' GetAppInstanceRetentionSettingsResponse (Maybe UTCTime) Source #
The timestamp representing the time at which the specified items are retained, in Epoch Seconds.
getAppInstanceRetentionSettingsResponse_httpStatus :: Lens' GetAppInstanceRetentionSettingsResponse Int Source #
The response's http status code.
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.
listAppInstanceAdmins_appInstanceArn :: Lens' ListAppInstanceAdmins Text Source #
The ARN of the AppInstance
.
listAppInstanceAdminsResponse_appInstanceAdmins :: Lens' ListAppInstanceAdminsResponse (Maybe [AppInstanceAdminSummary]) Source #
The information for each administrator.
listAppInstanceAdminsResponse_appInstanceArn :: Lens' ListAppInstanceAdminsResponse (Maybe Text) Source #
The ARN of the AppInstance
.
listAppInstanceAdminsResponse_nextToken :: Lens' ListAppInstanceAdminsResponse (Maybe Text) Source #
The token returned from previous API requests until the number of administrators is reached.
listAppInstanceAdminsResponse_httpStatus :: Lens' ListAppInstanceAdminsResponse Int Source #
The response's http status code.
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.
listAppInstanceUserEndpoints_appInstanceUserArn :: Lens' ListAppInstanceUserEndpoints Text Source #
The ARN of the AppInstanceUser
.
listAppInstanceUserEndpointsResponse_appInstanceUserEndpoints :: Lens' ListAppInstanceUserEndpointsResponse (Maybe [AppInstanceUserEndpointSummary]) Source #
The information for each requested AppInstanceUserEndpoint
.
listAppInstanceUserEndpointsResponse_nextToken :: Lens' ListAppInstanceUserEndpointsResponse (Maybe Text) Source #
The token passed by previous API calls until all requested endpoints are returned.
listAppInstanceUserEndpointsResponse_httpStatus :: Lens' ListAppInstanceUserEndpointsResponse Int Source #
The response's http status code.
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.
listAppInstanceUsers_appInstanceArn :: Lens' ListAppInstanceUsers Text Source #
The ARN of the AppInstance
.
listAppInstanceUsersResponse_appInstanceArn :: Lens' ListAppInstanceUsersResponse (Maybe Text) Source #
The ARN of the AppInstance
.
listAppInstanceUsersResponse_appInstanceUsers :: Lens' ListAppInstanceUsersResponse (Maybe [AppInstanceUserSummary]) Source #
The information for each requested AppInstanceUser
.
listAppInstanceUsersResponse_nextToken :: Lens' ListAppInstanceUsersResponse (Maybe Text) Source #
The token passed by previous API calls until all requested users are returned.
listAppInstanceUsersResponse_httpStatus :: Lens' ListAppInstanceUsersResponse Int Source #
The response's http status code.
ListAppInstances
listAppInstances_maxResults :: Lens' ListAppInstances (Maybe Natural) Source #
The maximum number of AppInstance
s 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_appInstances :: Lens' ListAppInstancesResponse (Maybe [AppInstanceSummary]) Source #
The information for each AppInstance
.
listAppInstancesResponse_nextToken :: Lens' ListAppInstancesResponse (Maybe Text) Source #
The token passed by previous API requests until the maximum number of
AppInstance
s is reached.
listAppInstancesResponse_httpStatus :: Lens' ListAppInstancesResponse Int Source #
The response's http status code.
ListTagsForResource
listTagsForResource_resourceARN :: Lens' ListTagsForResource Text Source #
The ARN of the resource.
listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (NonEmpty Tag)) Source #
The tag key-value pairs.
listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int Source #
The response's http status code.
PutAppInstanceRetentionSettings
putAppInstanceRetentionSettings_appInstanceArn :: Lens' PutAppInstanceRetentionSettings Text Source #
The ARN of the AppInstance
.
putAppInstanceRetentionSettings_appInstanceRetentionSettings :: Lens' PutAppInstanceRetentionSettings AppInstanceRetentionSettings Source #
The time in days to retain data. Data type: number.
putAppInstanceRetentionSettingsResponse_appInstanceRetentionSettings :: Lens' PutAppInstanceRetentionSettingsResponse (Maybe AppInstanceRetentionSettings) Source #
The time in days to retain data. Data type: number.
putAppInstanceRetentionSettingsResponse_initiateDeletionTimestamp :: Lens' PutAppInstanceRetentionSettingsResponse (Maybe UTCTime) Source #
The time at which the API deletes data.
putAppInstanceRetentionSettingsResponse_httpStatus :: Lens' PutAppInstanceRetentionSettingsResponse Int Source #
The response's http status code.
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_name :: Lens' RegisterAppInstanceUserEndpoint (Maybe Text) Source #
The name of the AppInstanceUserEndpoint
.
registerAppInstanceUserEndpoint_appInstanceUserArn :: Lens' RegisterAppInstanceUserEndpoint Text Source #
The ARN of the AppInstanceUser
.
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.
registerAppInstanceUserEndpoint_endpointAttributes :: Lens' RegisterAppInstanceUserEndpoint EndpointAttributes Source #
The attributes of an Endpoint
.
registerAppInstanceUserEndpoint_clientRequestToken :: Lens' RegisterAppInstanceUserEndpoint Text Source #
The idempotency token for each client request.
registerAppInstanceUserEndpointResponse_appInstanceUserArn :: Lens' RegisterAppInstanceUserEndpointResponse (Maybe Text) Source #
The ARN of the AppInstanceUser
.
registerAppInstanceUserEndpointResponse_endpointId :: Lens' RegisterAppInstanceUserEndpointResponse (Maybe Text) Source #
The unique identifier of the AppInstanceUserEndpoint
.
registerAppInstanceUserEndpointResponse_httpStatus :: Lens' RegisterAppInstanceUserEndpointResponse Int Source #
The response's http status code.
TagResource
tagResource_resourceARN :: Lens' TagResource Text Source #
The resource ARN.
tagResource_tags :: Lens' TagResource (NonEmpty Tag) Source #
The tag key-value pairs.
UntagResource
untagResource_resourceARN :: Lens' UntagResource Text Source #
The resource ARN.
untagResource_tagKeys :: Lens' UntagResource (NonEmpty Text) Source #
The tag keys.
UpdateAppInstance
updateAppInstance_appInstanceArn :: Lens' UpdateAppInstance Text Source #
The ARN of the AppInstance
.
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.
updateAppInstanceResponse_appInstanceArn :: Lens' UpdateAppInstanceResponse (Maybe Text) Source #
The ARN of the AppInstance
.
updateAppInstanceResponse_httpStatus :: Lens' UpdateAppInstanceResponse Int Source #
The response's http status code.
UpdateAppInstanceUser
updateAppInstanceUser_appInstanceUserArn :: Lens' UpdateAppInstanceUser Text Source #
The ARN of the AppInstanceUser
.
updateAppInstanceUser_name :: Lens' UpdateAppInstanceUser Text Source #
The name of the AppInstanceUser
.
updateAppInstanceUser_metadata :: Lens' UpdateAppInstanceUser Text Source #
The metadata of the AppInstanceUser
.
updateAppInstanceUserResponse_appInstanceUserArn :: Lens' UpdateAppInstanceUserResponse (Maybe Text) Source #
The ARN of the AppInstanceUser
.
updateAppInstanceUserResponse_httpStatus :: Lens' UpdateAppInstanceUserResponse Int Source #
The response's http status code.
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_name :: Lens' UpdateAppInstanceUserEndpoint (Maybe Text) Source #
The name of the AppInstanceUserEndpoint
.
updateAppInstanceUserEndpoint_appInstanceUserArn :: Lens' UpdateAppInstanceUserEndpoint Text Source #
The ARN of the AppInstanceUser
.
updateAppInstanceUserEndpoint_endpointId :: Lens' UpdateAppInstanceUserEndpoint Text Source #
The unique identifier of the AppInstanceUserEndpoint
.
updateAppInstanceUserEndpointResponse_appInstanceUserArn :: Lens' UpdateAppInstanceUserEndpointResponse (Maybe Text) Source #
The ARN of the AppInstanceUser
.
updateAppInstanceUserEndpointResponse_endpointId :: Lens' UpdateAppInstanceUserEndpointResponse (Maybe Text) Source #
The unique identifier of the AppInstanceUserEndpoint
.
updateAppInstanceUserEndpointResponse_httpStatus :: Lens' UpdateAppInstanceUserEndpointResponse Int Source #
The response's http status code.
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_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
appInstanceAdminSummary_admin :: Lens' AppInstanceAdminSummary (Maybe Identity) Source #
The details of the AppInstanceAdmin
.
AppInstanceRetentionSettings
appInstanceRetentionSettings_channelRetentionSettings :: Lens' AppInstanceRetentionSettings (Maybe ChannelRetentionSettings) Source #
The length of time in days to retain the messages in a channel.
AppInstanceSummary
appInstanceSummary_appInstanceArn :: Lens' AppInstanceSummary (Maybe Text) Source #
The AppInstance
ARN.
appInstanceSummary_metadata :: Lens' AppInstanceSummary (Maybe Text) Source #
The metadata of the AppInstance
.
appInstanceSummary_name :: Lens' AppInstanceSummary (Maybe Text) Source #
The name of the AppInstance
.
AppInstanceUser
appInstanceUser_appInstanceUserArn :: Lens' AppInstanceUser (Maybe Text) Source #
The ARN 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.
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_appInstanceUserArn :: Lens' AppInstanceUserEndpoint (Maybe Text) Source #
The ARN of the AppInstanceUser
.
appInstanceUserEndpoint_createdTimestamp :: Lens' AppInstanceUserEndpoint (Maybe UTCTime) Source #
The time at which an AppInstanceUserEndpoint
was created.
appInstanceUserEndpoint_endpointAttributes :: Lens' AppInstanceUserEndpoint (Maybe EndpointAttributes) Source #
The attributes of an Endpoint
.
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
: TheAppInstanceUserEndpoint
is active and able to receive messages. WhenACTIVE
, theEndpointStatusReason
remains empty.INACTIVE
: TheAppInstanceUserEndpoint
is inactive and can't receive message. WhenINACTIVE
, the corresponding reason will be conveyed throughEndpointStatusReason
.INVALID_DEVICE_TOKEN
indicates that anAppInstanceUserEndpoint
isINACTIVE
due to invalid device tokenINVALID_PINPOINT_ARN
indicates that anAppInstanceUserEndpoint
isINACTIVE
due to an invalid pinpoint ARN that was input through theResourceArn
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.
appInstanceUserEndpoint_type :: Lens' AppInstanceUserEndpoint (Maybe AppInstanceUserEndpointType) Source #
The type of the AppInstanceUserEndpoint
.
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_appInstanceUserArn :: Lens' AppInstanceUserEndpointSummary (Maybe Text) Source #
The ARN of the AppInstanceUser
.
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
.
appInstanceUserEndpointSummary_name :: Lens' AppInstanceUserEndpointSummary (Maybe Text) Source #
The name of the AppInstanceUserEndpoint
.
appInstanceUserEndpointSummary_type :: Lens' AppInstanceUserEndpointSummary (Maybe AppInstanceUserEndpointType) Source #
The type of the AppInstanceUserEndpoint
.
AppInstanceUserSummary
appInstanceUserSummary_appInstanceUserArn :: Lens' AppInstanceUserSummary (Maybe Text) Source #
The ARN of the AppInstanceUser
.
appInstanceUserSummary_metadata :: Lens' AppInstanceUserSummary (Maybe Text) Source #
The metadata of the AppInstanceUser
.
appInstanceUserSummary_name :: Lens' AppInstanceUserSummary (Maybe Text) Source #
The name of an AppInstanceUser
.
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_statusReason :: Lens' EndpointState (Maybe EndpointStatusReason) Source #
The reason for the EndpointStatus
.
endpointState_status :: Lens' EndpointState EndpointStatus Source #
Enum that indicates the Status of an AppInstanceUserEndpoint
.