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

Amazonka.ChimeSDKIdentity.RegisterAppInstanceUserEndpoint

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Creating a Request

data RegisterAppInstanceUserEndpoint Source #

See: newRegisterAppInstanceUserEndpoint smart constructor.

Constructors

RegisterAppInstanceUserEndpoint'

Fields

allowMessages :: Maybe 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.
name :: Maybe (Sensitive Text)
The name of the AppInstanceUserEndpoint.
appInstanceUserArn :: Sensitive Text
The ARN of the AppInstanceUser.
type' :: AppInstanceUserEndpointType
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.
resourceArn :: Sensitive Text
The ARN of the resource to which the endpoint belongs.
endpointAttributes :: EndpointAttributes
The attributes of an Endpoint.
clientRequestToken :: Sensitive Text
The idempotency token for each client request.

Instances

Instances details

ToJSON RegisterAppInstanceUserEndpoint Source #
Instance details Defined in Amazonka.ChimeSDKIdentity.RegisterAppInstanceUserEndpoint Methods toJSON :: RegisterAppInstanceUserEndpoint -> Value # toEncoding :: RegisterAppInstanceUserEndpoint -> Encoding # toJSONList :: [RegisterAppInstanceUserEndpoint] -> Value # toEncodingList :: [RegisterAppInstanceUserEndpoint] -> Encoding #
ToHeaders RegisterAppInstanceUserEndpoint Source #
Instance details Defined in Amazonka.ChimeSDKIdentity.RegisterAppInstanceUserEndpoint Methods toHeaders :: RegisterAppInstanceUserEndpoint -> [Header] #
ToPath RegisterAppInstanceUserEndpoint Source #
Instance details Defined in Amazonka.ChimeSDKIdentity.RegisterAppInstanceUserEndpoint Methods toPath :: RegisterAppInstanceUserEndpoint -> ByteString #
ToQuery RegisterAppInstanceUserEndpoint Source #
Instance details Defined in Amazonka.ChimeSDKIdentity.RegisterAppInstanceUserEndpoint Methods toQuery :: RegisterAppInstanceUserEndpoint -> QueryString #
AWSRequest RegisterAppInstanceUserEndpoint Source #
Instance details Defined in Amazonka.ChimeSDKIdentity.RegisterAppInstanceUserEndpoint Associated Types type AWSResponse RegisterAppInstanceUserEndpoint # Methods request :: (Service -> Service) -> RegisterAppInstanceUserEndpoint -> Request RegisterAppInstanceUserEndpoint # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy RegisterAppInstanceUserEndpoint -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse RegisterAppInstanceUserEndpoint))) #
Generic RegisterAppInstanceUserEndpoint Source #
Instance details Defined in Amazonka.ChimeSDKIdentity.RegisterAppInstanceUserEndpoint Associated Types type Rep RegisterAppInstanceUserEndpoint :: Type -> Type # Methods from :: RegisterAppInstanceUserEndpoint -> Rep RegisterAppInstanceUserEndpoint x # to :: Rep RegisterAppInstanceUserEndpoint x -> RegisterAppInstanceUserEndpoint #
Show RegisterAppInstanceUserEndpoint Source #
Instance details Defined in Amazonka.ChimeSDKIdentity.RegisterAppInstanceUserEndpoint Methods showsPrec :: Int -> RegisterAppInstanceUserEndpoint -> ShowS # show :: RegisterAppInstanceUserEndpoint -> String # showList :: [RegisterAppInstanceUserEndpoint] -> ShowS #
NFData RegisterAppInstanceUserEndpoint Source #
Instance details Defined in Amazonka.ChimeSDKIdentity.RegisterAppInstanceUserEndpoint Methods rnf :: RegisterAppInstanceUserEndpoint -> () #
Eq RegisterAppInstanceUserEndpoint Source #
Instance details Defined in Amazonka.ChimeSDKIdentity.RegisterAppInstanceUserEndpoint Methods (==) :: RegisterAppInstanceUserEndpoint -> RegisterAppInstanceUserEndpoint -> Bool # (/=) :: RegisterAppInstanceUserEndpoint -> RegisterAppInstanceUserEndpoint -> Bool #
Hashable RegisterAppInstanceUserEndpoint Source #
Instance details Defined in Amazonka.ChimeSDKIdentity.RegisterAppInstanceUserEndpoint Methods hashWithSalt :: Int -> RegisterAppInstanceUserEndpoint -> Int # hash :: RegisterAppInstanceUserEndpoint -> Int #
type AWSResponse RegisterAppInstanceUserEndpoint Source #
Instance details Defined in Amazonka.ChimeSDKIdentity.RegisterAppInstanceUserEndpoint type AWSResponse RegisterAppInstanceUserEndpoint = RegisterAppInstanceUserEndpointResponse
type Rep RegisterAppInstanceUserEndpoint Source #
Instance details Defined in Amazonka.ChimeSDKIdentity.RegisterAppInstanceUserEndpoint type Rep RegisterAppInstanceUserEndpoint = D1 ('MetaData "RegisterAppInstanceUserEndpoint" "Amazonka.ChimeSDKIdentity.RegisterAppInstanceUserEndpoint" "amazonka-chime-sdk-identity-2.0-4Oyp0DV6v8255OObqkKpjC" 'False) (C1 ('MetaCons "RegisterAppInstanceUserEndpoint'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "allowMessages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AllowMessages)) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 ('MetaSel ('Just "appInstanceUserArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)))) :: ((S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AppInstanceUserEndpointType) :: S1 ('MetaSel ('Just "resourceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text))) :: (S1 ('MetaSel ('Just "endpointAttributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 EndpointAttributes) :: S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text))))))

newRegisterAppInstanceUserEndpoint Source #

Arguments

:: Text	`RegisterAppInstanceUserEndpoint`
-> AppInstanceUserEndpointType	`RegisterAppInstanceUserEndpoint`
-> Text	`RegisterAppInstanceUserEndpoint`
-> EndpointAttributes	`RegisterAppInstanceUserEndpoint`
-> Text	`$sel:clientRequestToken:RegisterAppInstanceUserEndpoint'`
-> 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.

Constructors

RegisterAppInstanceUserEndpointResponse'
Fields appInstanceUserArn :: Maybe (Sensitive Text) The ARN of the `AppInstanceUser`. endpointId :: Maybe (Sensitive Text) The unique identifier of the `AppInstanceUserEndpoint`. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic RegisterAppInstanceUserEndpointResponse Source #
Instance details Defined in Amazonka.ChimeSDKIdentity.RegisterAppInstanceUserEndpoint Associated Types type Rep RegisterAppInstanceUserEndpointResponse :: Type -> Type # Methods from :: RegisterAppInstanceUserEndpointResponse -> Rep RegisterAppInstanceUserEndpointResponse x # to :: Rep RegisterAppInstanceUserEndpointResponse x -> RegisterAppInstanceUserEndpointResponse #
Show RegisterAppInstanceUserEndpointResponse Source #
Instance details Defined in Amazonka.ChimeSDKIdentity.RegisterAppInstanceUserEndpoint Methods showsPrec :: Int -> RegisterAppInstanceUserEndpointResponse -> ShowS # show :: RegisterAppInstanceUserEndpointResponse -> String # showList :: [RegisterAppInstanceUserEndpointResponse] -> ShowS #
NFData RegisterAppInstanceUserEndpointResponse Source #
Instance details Defined in Amazonka.ChimeSDKIdentity.RegisterAppInstanceUserEndpoint Methods rnf :: RegisterAppInstanceUserEndpointResponse -> () #
Eq RegisterAppInstanceUserEndpointResponse Source #
Instance details Defined in Amazonka.ChimeSDKIdentity.RegisterAppInstanceUserEndpoint Methods (==) :: RegisterAppInstanceUserEndpointResponse -> RegisterAppInstanceUserEndpointResponse -> Bool # (/=) :: RegisterAppInstanceUserEndpointResponse -> RegisterAppInstanceUserEndpointResponse -> Bool #
type Rep RegisterAppInstanceUserEndpointResponse Source #
Instance details Defined in Amazonka.ChimeSDKIdentity.RegisterAppInstanceUserEndpoint type Rep RegisterAppInstanceUserEndpointResponse = D1 ('MetaData "RegisterAppInstanceUserEndpointResponse" "Amazonka.ChimeSDKIdentity.RegisterAppInstanceUserEndpoint" "amazonka-chime-sdk-identity-2.0-4Oyp0DV6v8255OObqkKpjC" 'False) (C1 ('MetaCons "RegisterAppInstanceUserEndpointResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "appInstanceUserArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: (S1 ('MetaSel ('Just "endpointId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newRegisterAppInstanceUserEndpointResponse Source #

Arguments

:: Int	`$sel:httpStatus:RegisterAppInstanceUserEndpointResponse'`
-> RegisterAppInstanceUserEndpointResponse

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.