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.APIGatewayManagementAPI.Types

Contents

Service Configuration
Errors
Identity

Description

Synopsis

defaultService :: Service
_PayloadTooLargeException :: AsError a => Getting (First ServiceError) a ServiceError
_ForbiddenException :: AsError a => Getting (First ServiceError) a ServiceError
_GoneException :: AsError a => Getting (First ServiceError) a ServiceError
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
data Identity = Identity' {
- sourceIp :: Text
- userAgent :: Text
}
newIdentity :: Text -> Text -> Identity
identity_sourceIp :: Lens' Identity Text
identity_userAgent :: Lens' Identity Text

Service Configuration

defaultService :: Service Source #

API version 2018-11-29 of the Amazon ApiGatewayManagementApi SDK configuration.

Errors

_PayloadTooLargeException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The data has exceeded the maximum size allowed.

_ForbiddenException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The caller is not authorized to invoke this operation.

_GoneException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The connection with the provided id no longer exists.

_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The client is sending more than the allowed number of requests per unit of time or the WebSocket client side buffer is full.

Identity

data Identity Source #

See: newIdentity smart constructor.

Constructors

Identity'
Fields sourceIp :: Text The source IP address of the TCP connection making the request to API Gateway. userAgent :: Text The User Agent of the API caller.

Instances

Instances details

Eq Identity Source #
Instance details Defined in Amazonka.APIGatewayManagementAPI.Types.Identity Methods (==) :: Identity -> Identity -> Bool # (/=) :: Identity -> Identity -> Bool #
Read Identity Source #
Instance details Defined in Amazonka.APIGatewayManagementAPI.Types.Identity Methods readsPrec :: Int -> ReadS Identity # readList :: ReadS [Identity] # readPrec :: ReadPrec Identity # readListPrec :: ReadPrec [Identity] #
Show Identity Source #
Instance details Defined in Amazonka.APIGatewayManagementAPI.Types.Identity Methods showsPrec :: Int -> Identity -> ShowS # show :: Identity -> String # showList :: [Identity] -> ShowS #
Generic Identity Source #
Instance details Defined in Amazonka.APIGatewayManagementAPI.Types.Identity Associated Types type Rep Identity :: Type -> Type # Methods from :: Identity -> Rep Identity x # to :: Rep Identity x -> Identity #
NFData Identity Source #
Instance details Defined in Amazonka.APIGatewayManagementAPI.Types.Identity Methods rnf :: Identity -> () #
Hashable Identity Source #
Instance details Defined in Amazonka.APIGatewayManagementAPI.Types.Identity Methods hashWithSalt :: Int -> Identity -> Int # hash :: Identity -> Int #
FromJSON Identity Source #
Instance details Defined in Amazonka.APIGatewayManagementAPI.Types.Identity Methods parseJSON :: Value -> Parser Identity # parseJSONList :: Value -> Parser [Identity] #
type Rep Identity Source #
Instance details Defined in Amazonka.APIGatewayManagementAPI.Types.Identity type Rep Identity = D1 ('MetaData "Identity" "Amazonka.APIGatewayManagementAPI.Types.Identity" "libZSservicesZSamazonka-apigatewaymanagementapiZSamazonka-apigatewaymanagementapi" 'False) (C1 ('MetaCons "Identity'" 'PrefixI 'True) (S1 ('MetaSel ('Just "sourceIp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "userAgent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newIdentity Source #

Arguments

:: Text	`$sel:sourceIp:Identity'`
-> Text	`$sel:userAgent:Identity'`
-> Identity

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:sourceIp:Identity', identity_sourceIp - The source IP address of the TCP connection making the request to API Gateway.

$sel:userAgent:Identity', identity_userAgent - The User Agent of the API caller.

identity_sourceIp :: Lens' Identity Text Source #

The source IP address of the TCP connection making the request to API Gateway.

identity_userAgent :: Lens' Identity Text Source #

The User Agent of the API caller.