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 |
Registers an endpoint under an Amazon Chime AppInstanceUser
. The
endpoint receives messages for a user. For push notifications, the
endpoint is a mobile device used to receive mobile push notifications
for a user.
Synopsis
- data RegisterAppInstanceUserEndpoint = RegisterAppInstanceUserEndpoint' {}
- newRegisterAppInstanceUserEndpoint :: Text -> AppInstanceUserEndpointType -> Text -> EndpointAttributes -> Text -> RegisterAppInstanceUserEndpoint
- 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
- data RegisterAppInstanceUserEndpointResponse = RegisterAppInstanceUserEndpointResponse' {
- appInstanceUserArn :: Maybe (Sensitive Text)
- endpointId :: Maybe (Sensitive Text)
- httpStatus :: Int
- newRegisterAppInstanceUserEndpointResponse :: Int -> RegisterAppInstanceUserEndpointResponse
- registerAppInstanceUserEndpointResponse_appInstanceUserArn :: Lens' RegisterAppInstanceUserEndpointResponse (Maybe Text)
- registerAppInstanceUserEndpointResponse_endpointId :: Lens' RegisterAppInstanceUserEndpointResponse (Maybe Text)
- registerAppInstanceUserEndpointResponse_httpStatus :: Lens' RegisterAppInstanceUserEndpointResponse Int
Creating a Request
data RegisterAppInstanceUserEndpoint Source #
See: newRegisterAppInstanceUserEndpoint
smart constructor.
RegisterAppInstanceUserEndpoint' | |
|
Instances
newRegisterAppInstanceUserEndpoint Source #
:: Text | |
-> AppInstanceUserEndpointType | |
-> Text | |
-> EndpointAttributes | |
-> Text | |
-> RegisterAppInstanceUserEndpoint |
Create a value of RegisterAppInstanceUserEndpoint
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:
RegisterAppInstanceUserEndpoint
, registerAppInstanceUserEndpoint_allowMessages
- 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
, registerAppInstanceUserEndpoint_name
- The name of the AppInstanceUserEndpoint
.
RegisterAppInstanceUserEndpoint
, registerAppInstanceUserEndpoint_appInstanceUserArn
- The ARN of the AppInstanceUser
.
RegisterAppInstanceUserEndpoint
, registerAppInstanceUserEndpoint_type
- 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
, registerAppInstanceUserEndpoint_resourceArn
- The ARN of the resource to which the endpoint belongs.
RegisterAppInstanceUserEndpoint
, registerAppInstanceUserEndpoint_endpointAttributes
- The attributes of an Endpoint
.
$sel:clientRequestToken:RegisterAppInstanceUserEndpoint'
, registerAppInstanceUserEndpoint_clientRequestToken
- The idempotency token for each client request.
Request Lenses
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.
Destructuring the Response
data RegisterAppInstanceUserEndpointResponse Source #
See: newRegisterAppInstanceUserEndpointResponse
smart constructor.
RegisterAppInstanceUserEndpointResponse' | |
|
Instances
newRegisterAppInstanceUserEndpointResponse Source #
Create a value of RegisterAppInstanceUserEndpointResponse
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:
RegisterAppInstanceUserEndpoint
, registerAppInstanceUserEndpointResponse_appInstanceUserArn
- The ARN of the AppInstanceUser
.
RegisterAppInstanceUserEndpointResponse
, registerAppInstanceUserEndpointResponse_endpointId
- The unique identifier of the AppInstanceUserEndpoint
.
$sel:httpStatus:RegisterAppInstanceUserEndpointResponse'
, registerAppInstanceUserEndpointResponse_httpStatus
- The response's http status code.
Response Lenses
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.