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

Contents

Service Configuration
Errors
Waiters
Operations
Types
- Identity

Description

Derived from API version 2018-11-29 of the AWS service descriptions, licensed under Apache 2.0.

The Amazon API Gateway Management API allows you to directly manage runtime aspects of your deployed APIs. To use it, you must explicitly set the SDK's endpoint to point to the endpoint of your deployed API. The endpoint will be of the form https://{api-id}.execute-api.{region}.amazonaws.com/{stage}, or will be the endpoint corresponding to your API's custom domain and base path, if applicable.

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 DeleteConnection = DeleteConnection' Text
newDeleteConnection :: Text -> DeleteConnection
data DeleteConnectionResponse = DeleteConnectionResponse' {
}
newDeleteConnectionResponse :: DeleteConnectionResponse
data GetConnection = GetConnection' Text
newGetConnection :: Text -> GetConnection
data GetConnectionResponse = GetConnectionResponse' (Maybe POSIX) (Maybe POSIX) (Maybe Identity) Int
newGetConnectionResponse :: Int -> GetConnectionResponse
data PostToConnection = PostToConnection' Text ByteString
newPostToConnection :: Text -> ByteString -> PostToConnection
data PostToConnectionResponse = PostToConnectionResponse' {
}
newPostToConnectionResponse :: PostToConnectionResponse
data Identity = Identity' Text Text
newIdentity :: Text -> Text -> Identity

Service Configuration

defaultService :: Service Source #

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

Errors

Error matchers are designed for use with the functions provided by Control.Exception.Lens. This allows catching (and rethrowing) service specific errors returned by APIGatewayManagementAPI.

PayloadTooLargeException

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

The data has exceeded the maximum size allowed.

ForbiddenException

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

The caller is not authorized to invoke this operation.

GoneException

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

The connection with the provided id no longer exists.

LimitExceededException

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

Waiters

Waiters poll by repeatedly sending a request until some remote success condition configured by the Wait specification is fulfilled. The Wait specification determines how many attempts should be made, in addition to delay and retry strategies.

Operations

Some AWS operations return results that are incomplete and require subsequent requests in order to obtain the entire result set. The process of sending subsequent requests to continue where a previous request left off is called pagination. For example, the ListObjects operation of Amazon S3 returns up to 1000 objects at a time, and you must send subsequent requests with the appropriate Marker in order to retrieve the next page of results.

Operations that have an AWSPager instance can transparently perform subsequent requests, correctly setting Markers and other request facets to iterate through the entire result set of a truncated API operation. Operations which support this have an additional note in the documentation.

Many operations have the ability to filter results on the server side. See the individual operation parameters for details.

DeleteConnection

data DeleteConnection Source #

See: newDeleteConnection smart constructor.

Constructors

DeleteConnection' Text

Instances

Instances details

Eq DeleteConnection Source #
Instance details Defined in Amazonka.APIGatewayManagementAPI.DeleteConnection Methods (==) :: DeleteConnection -> DeleteConnection -> Bool # (/=) :: DeleteConnection -> DeleteConnection -> Bool #
Read DeleteConnection Source #
Instance details Defined in Amazonka.APIGatewayManagementAPI.DeleteConnection Methods readsPrec :: Int -> ReadS DeleteConnection # readList :: ReadS [DeleteConnection] # readPrec :: ReadPrec DeleteConnection # readListPrec :: ReadPrec [DeleteConnection] #
Show DeleteConnection Source #
Instance details Defined in Amazonka.APIGatewayManagementAPI.DeleteConnection Methods showsPrec :: Int -> DeleteConnection -> ShowS # show :: DeleteConnection -> String # showList :: [DeleteConnection] -> ShowS #
Generic DeleteConnection Source #
Instance details Defined in Amazonka.APIGatewayManagementAPI.DeleteConnection Associated Types type Rep DeleteConnection :: Type -> Type # Methods from :: DeleteConnection -> Rep DeleteConnection x # to :: Rep DeleteConnection x -> DeleteConnection #
NFData DeleteConnection Source #
Instance details Defined in Amazonka.APIGatewayManagementAPI.DeleteConnection Methods rnf :: DeleteConnection -> () #
Hashable DeleteConnection Source #
Instance details Defined in Amazonka.APIGatewayManagementAPI.DeleteConnection Methods hashWithSalt :: Int -> DeleteConnection -> Int # hash :: DeleteConnection -> Int #
AWSRequest DeleteConnection Source #
Instance details Defined in Amazonka.APIGatewayManagementAPI.DeleteConnection Associated Types type AWSResponse DeleteConnection # Methods request :: DeleteConnection -> Request DeleteConnection # response :: MonadResource m => Logger -> Service -> Proxy DeleteConnection -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteConnection))) #
ToHeaders DeleteConnection Source #
Instance details Defined in Amazonka.APIGatewayManagementAPI.DeleteConnection Methods toHeaders :: DeleteConnection -> [Header] #
ToPath DeleteConnection Source #
Instance details Defined in Amazonka.APIGatewayManagementAPI.DeleteConnection Methods toPath :: DeleteConnection -> ByteString #
ToQuery DeleteConnection Source #
Instance details Defined in Amazonka.APIGatewayManagementAPI.DeleteConnection Methods toQuery :: DeleteConnection -> QueryString #
type Rep DeleteConnection Source #
Instance details Defined in Amazonka.APIGatewayManagementAPI.DeleteConnection type Rep DeleteConnection = D1 ('MetaData "DeleteConnection" "Amazonka.APIGatewayManagementAPI.DeleteConnection" "libZSservicesZSamazonka-apigatewaymanagementapiZSamazonka-apigatewaymanagementapi" 'False) (C1 ('MetaCons "DeleteConnection'" 'PrefixI 'True) (S1 ('MetaSel ('Just "connectionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DeleteConnection Source #
Instance details Defined in Amazonka.APIGatewayManagementAPI.DeleteConnection type AWSResponse DeleteConnection = DeleteConnectionResponse

newDeleteConnection Source #

Arguments

:: Text	`$sel:connectionId:DeleteConnection'`
-> DeleteConnection

Create a value of DeleteConnection 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:connectionId:DeleteConnection', deleteConnection_connectionId - Undocumented member.

data DeleteConnectionResponse Source #

See: newDeleteConnectionResponse smart constructor.

Constructors

DeleteConnectionResponse'

Instances

Instances details

Eq DeleteConnectionResponse Source #
Instance details Defined in Amazonka.APIGatewayManagementAPI.DeleteConnection Methods (==) :: DeleteConnectionResponse -> DeleteConnectionResponse -> Bool # (/=) :: DeleteConnectionResponse -> DeleteConnectionResponse -> Bool #
Read DeleteConnectionResponse Source #
Instance details Defined in Amazonka.APIGatewayManagementAPI.DeleteConnection Methods readsPrec :: Int -> ReadS DeleteConnectionResponse # readList :: ReadS [DeleteConnectionResponse] # readPrec :: ReadPrec DeleteConnectionResponse # readListPrec :: ReadPrec [DeleteConnectionResponse] #
Show DeleteConnectionResponse Source #
Instance details Defined in Amazonka.APIGatewayManagementAPI.DeleteConnection Methods showsPrec :: Int -> DeleteConnectionResponse -> ShowS # show :: DeleteConnectionResponse -> String # showList :: [DeleteConnectionResponse] -> ShowS #
Generic DeleteConnectionResponse Source #
Instance details Defined in Amazonka.APIGatewayManagementAPI.DeleteConnection Associated Types type Rep DeleteConnectionResponse :: Type -> Type # Methods from :: DeleteConnectionResponse -> Rep DeleteConnectionResponse x # to :: Rep DeleteConnectionResponse x -> DeleteConnectionResponse #
NFData DeleteConnectionResponse Source #
Instance details Defined in Amazonka.APIGatewayManagementAPI.DeleteConnection Methods rnf :: DeleteConnectionResponse -> () #
type Rep DeleteConnectionResponse Source #
Instance details Defined in Amazonka.APIGatewayManagementAPI.DeleteConnection type Rep DeleteConnectionResponse = D1 ('MetaData "DeleteConnectionResponse" "Amazonka.APIGatewayManagementAPI.DeleteConnection" "libZSservicesZSamazonka-apigatewaymanagementapiZSamazonka-apigatewaymanagementapi" 'False) (C1 ('MetaCons "DeleteConnectionResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteConnectionResponse :: DeleteConnectionResponse Source #

Create a value of DeleteConnectionResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

GetConnection

data GetConnection Source #

See: newGetConnection smart constructor.

Constructors

GetConnection' Text

Instances

Instances details

Eq GetConnection Source #
Instance details Defined in Amazonka.APIGatewayManagementAPI.GetConnection Methods (==) :: GetConnection -> GetConnection -> Bool # (/=) :: GetConnection -> GetConnection -> Bool #
Read GetConnection Source #
Instance details Defined in Amazonka.APIGatewayManagementAPI.GetConnection Methods readsPrec :: Int -> ReadS GetConnection # readList :: ReadS [GetConnection] # readPrec :: ReadPrec GetConnection # readListPrec :: ReadPrec [GetConnection] #
Show GetConnection Source #
Instance details Defined in Amazonka.APIGatewayManagementAPI.GetConnection Methods showsPrec :: Int -> GetConnection -> ShowS # show :: GetConnection -> String # showList :: [GetConnection] -> ShowS #
Generic GetConnection Source #
Instance details Defined in Amazonka.APIGatewayManagementAPI.GetConnection Associated Types type Rep GetConnection :: Type -> Type # Methods from :: GetConnection -> Rep GetConnection x # to :: Rep GetConnection x -> GetConnection #
NFData GetConnection Source #
Instance details Defined in Amazonka.APIGatewayManagementAPI.GetConnection Methods rnf :: GetConnection -> () #
Hashable GetConnection Source #
Instance details Defined in Amazonka.APIGatewayManagementAPI.GetConnection Methods hashWithSalt :: Int -> GetConnection -> Int # hash :: GetConnection -> Int #
AWSRequest GetConnection Source #
Instance details Defined in Amazonka.APIGatewayManagementAPI.GetConnection Associated Types type AWSResponse GetConnection # Methods request :: GetConnection -> Request GetConnection # response :: MonadResource m => Logger -> Service -> Proxy GetConnection -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetConnection))) #
ToHeaders GetConnection Source #
Instance details Defined in Amazonka.APIGatewayManagementAPI.GetConnection Methods toHeaders :: GetConnection -> [Header] #
ToPath GetConnection Source #
Instance details Defined in Amazonka.APIGatewayManagementAPI.GetConnection Methods toPath :: GetConnection -> ByteString #
ToQuery GetConnection Source #
Instance details Defined in Amazonka.APIGatewayManagementAPI.GetConnection Methods toQuery :: GetConnection -> QueryString #
type Rep GetConnection Source #
Instance details Defined in Amazonka.APIGatewayManagementAPI.GetConnection type Rep GetConnection = D1 ('MetaData "GetConnection" "Amazonka.APIGatewayManagementAPI.GetConnection" "libZSservicesZSamazonka-apigatewaymanagementapiZSamazonka-apigatewaymanagementapi" 'False) (C1 ('MetaCons "GetConnection'" 'PrefixI 'True) (S1 ('MetaSel ('Just "connectionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse GetConnection Source #
Instance details Defined in Amazonka.APIGatewayManagementAPI.GetConnection type AWSResponse GetConnection = GetConnectionResponse

newGetConnection Source #

Arguments

:: Text	`$sel:connectionId:GetConnection'`
-> GetConnection

Create a value of GetConnection 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:connectionId:GetConnection', getConnection_connectionId - Undocumented member.

data GetConnectionResponse Source #

See: newGetConnectionResponse smart constructor.

Constructors

GetConnectionResponse' (Maybe POSIX) (Maybe POSIX) (Maybe Identity) Int

Instances

Instances details

Eq GetConnectionResponse Source #
Instance details Defined in Amazonka.APIGatewayManagementAPI.GetConnection Methods (==) :: GetConnectionResponse -> GetConnectionResponse -> Bool # (/=) :: GetConnectionResponse -> GetConnectionResponse -> Bool #
Read GetConnectionResponse Source #
Instance details Defined in Amazonka.APIGatewayManagementAPI.GetConnection Methods readsPrec :: Int -> ReadS GetConnectionResponse # readList :: ReadS [GetConnectionResponse] # readPrec :: ReadPrec GetConnectionResponse # readListPrec :: ReadPrec [GetConnectionResponse] #
Show GetConnectionResponse Source #
Instance details Defined in Amazonka.APIGatewayManagementAPI.GetConnection Methods showsPrec :: Int -> GetConnectionResponse -> ShowS # show :: GetConnectionResponse -> String # showList :: [GetConnectionResponse] -> ShowS #
Generic GetConnectionResponse Source #
Instance details Defined in Amazonka.APIGatewayManagementAPI.GetConnection Associated Types type Rep GetConnectionResponse :: Type -> Type # Methods from :: GetConnectionResponse -> Rep GetConnectionResponse x # to :: Rep GetConnectionResponse x -> GetConnectionResponse #
NFData GetConnectionResponse Source #
Instance details Defined in Amazonka.APIGatewayManagementAPI.GetConnection Methods rnf :: GetConnectionResponse -> () #
type Rep GetConnectionResponse Source #
Instance details Defined in Amazonka.APIGatewayManagementAPI.GetConnection type Rep GetConnectionResponse = D1 ('MetaData "GetConnectionResponse" "Amazonka.APIGatewayManagementAPI.GetConnection" "libZSservicesZSamazonka-apigatewaymanagementapiZSamazonka-apigatewaymanagementapi" 'False) (C1 ('MetaCons "GetConnectionResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "connectedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "lastActiveAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "identity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Identity)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetConnectionResponse Source #

Arguments

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

Create a value of GetConnectionResponse 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:connectedAt:GetConnectionResponse', getConnectionResponse_connectedAt - The time in ISO 8601 format for when the connection was established.

$sel:lastActiveAt:GetConnectionResponse', getConnectionResponse_lastActiveAt - The time in ISO 8601 format for when the connection was last active.

$sel:identity:GetConnectionResponse', getConnectionResponse_identity - Undocumented member.

$sel:httpStatus:GetConnectionResponse', getConnectionResponse_httpStatus - The response's http status code.

PostToConnection

data PostToConnection Source #

See: newPostToConnection smart constructor.

Constructors

PostToConnection' Text ByteString

Instances

Instances details

Eq PostToConnection Source #
Instance details Defined in Amazonka.APIGatewayManagementAPI.PostToConnection Methods (==) :: PostToConnection -> PostToConnection -> Bool # (/=) :: PostToConnection -> PostToConnection -> Bool #
Read PostToConnection Source #
Instance details Defined in Amazonka.APIGatewayManagementAPI.PostToConnection Methods readsPrec :: Int -> ReadS PostToConnection # readList :: ReadS [PostToConnection] # readPrec :: ReadPrec PostToConnection # readListPrec :: ReadPrec [PostToConnection] #
Show PostToConnection Source #
Instance details Defined in Amazonka.APIGatewayManagementAPI.PostToConnection Methods showsPrec :: Int -> PostToConnection -> ShowS # show :: PostToConnection -> String # showList :: [PostToConnection] -> ShowS #
Generic PostToConnection Source #
Instance details Defined in Amazonka.APIGatewayManagementAPI.PostToConnection Associated Types type Rep PostToConnection :: Type -> Type # Methods from :: PostToConnection -> Rep PostToConnection x # to :: Rep PostToConnection x -> PostToConnection #
NFData PostToConnection Source #
Instance details Defined in Amazonka.APIGatewayManagementAPI.PostToConnection Methods rnf :: PostToConnection -> () #
Hashable PostToConnection Source #
Instance details Defined in Amazonka.APIGatewayManagementAPI.PostToConnection Methods hashWithSalt :: Int -> PostToConnection -> Int # hash :: PostToConnection -> Int #
AWSRequest PostToConnection Source #
Instance details Defined in Amazonka.APIGatewayManagementAPI.PostToConnection Associated Types type AWSResponse PostToConnection # Methods request :: PostToConnection -> Request PostToConnection # response :: MonadResource m => Logger -> Service -> Proxy PostToConnection -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse PostToConnection))) #
ToBody PostToConnection Source #
Instance details Defined in Amazonka.APIGatewayManagementAPI.PostToConnection Methods toBody :: PostToConnection -> RequestBody #
ToHeaders PostToConnection Source #
Instance details Defined in Amazonka.APIGatewayManagementAPI.PostToConnection Methods toHeaders :: PostToConnection -> [Header] #
ToPath PostToConnection Source #
Instance details Defined in Amazonka.APIGatewayManagementAPI.PostToConnection Methods toPath :: PostToConnection -> ByteString #
ToQuery PostToConnection Source #
Instance details Defined in Amazonka.APIGatewayManagementAPI.PostToConnection Methods toQuery :: PostToConnection -> QueryString #
type Rep PostToConnection Source #
Instance details Defined in Amazonka.APIGatewayManagementAPI.PostToConnection type Rep PostToConnection = D1 ('MetaData "PostToConnection" "Amazonka.APIGatewayManagementAPI.PostToConnection" "libZSservicesZSamazonka-apigatewaymanagementapiZSamazonka-apigatewaymanagementapi" 'False) (C1 ('MetaCons "PostToConnection'" 'PrefixI 'True) (S1 ('MetaSel ('Just "connectionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "data'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ByteString)))
type AWSResponse PostToConnection Source #
Instance details Defined in Amazonka.APIGatewayManagementAPI.PostToConnection type AWSResponse PostToConnection = PostToConnectionResponse

newPostToConnection Source #

Arguments

:: Text	`$sel:connectionId:PostToConnection'`
-> ByteString	`$sel:data':PostToConnection'`
-> PostToConnection

Create a value of PostToConnection 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:connectionId:PostToConnection', postToConnection_connectionId - The identifier of the connection that a specific client is using.

$sel:data':PostToConnection', postToConnection_data - The data to be sent to the client specified by its connection id.

data PostToConnectionResponse Source #

See: newPostToConnectionResponse smart constructor.

Constructors

PostToConnectionResponse'

Instances

Instances details

Eq PostToConnectionResponse Source #
Instance details Defined in Amazonka.APIGatewayManagementAPI.PostToConnection Methods (==) :: PostToConnectionResponse -> PostToConnectionResponse -> Bool # (/=) :: PostToConnectionResponse -> PostToConnectionResponse -> Bool #
Read PostToConnectionResponse Source #
Instance details Defined in Amazonka.APIGatewayManagementAPI.PostToConnection Methods readsPrec :: Int -> ReadS PostToConnectionResponse # readList :: ReadS [PostToConnectionResponse] # readPrec :: ReadPrec PostToConnectionResponse # readListPrec :: ReadPrec [PostToConnectionResponse] #
Show PostToConnectionResponse Source #
Instance details Defined in Amazonka.APIGatewayManagementAPI.PostToConnection Methods showsPrec :: Int -> PostToConnectionResponse -> ShowS # show :: PostToConnectionResponse -> String # showList :: [PostToConnectionResponse] -> ShowS #
Generic PostToConnectionResponse Source #
Instance details Defined in Amazonka.APIGatewayManagementAPI.PostToConnection Associated Types type Rep PostToConnectionResponse :: Type -> Type # Methods from :: PostToConnectionResponse -> Rep PostToConnectionResponse x # to :: Rep PostToConnectionResponse x -> PostToConnectionResponse #
NFData PostToConnectionResponse Source #
Instance details Defined in Amazonka.APIGatewayManagementAPI.PostToConnection Methods rnf :: PostToConnectionResponse -> () #
type Rep PostToConnectionResponse Source #
Instance details Defined in Amazonka.APIGatewayManagementAPI.PostToConnection type Rep PostToConnectionResponse = D1 ('MetaData "PostToConnectionResponse" "Amazonka.APIGatewayManagementAPI.PostToConnection" "libZSservicesZSamazonka-apigatewaymanagementapiZSamazonka-apigatewaymanagementapi" 'False) (C1 ('MetaCons "PostToConnectionResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newPostToConnectionResponse :: PostToConnectionResponse Source #

Create a value of PostToConnectionResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

Types

Identity

data Identity Source #

See: newIdentity smart constructor.

Constructors

Identity' Text Text

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.