Amazonka.APIGatewayManagementAPI

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.

Service Configuration

defaultService :: Service

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.

ForbiddenException

_ForbiddenException :: AsError a => Fold a ServiceError

The caller is not authorized to invoke this operation.

GoneException

_GoneException :: AsError a => Fold a ServiceError

The connection with the provided id no longer exists.

LimitExceededException

_LimitExceededException :: AsError a => Fold a ServiceError

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

PayloadTooLargeException

_PayloadTooLargeException :: AsError a => Fold a ServiceError

The data has exceeded the maximum size allowed.

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

See: newDeleteConnection smart constructor.

Constructors

DeleteConnection' Text

Instances

ToHeaders DeleteConnection

Defined in Amazonka.APIGatewayManagementAPI.DeleteConnection

Methods

toHeaders :: DeleteConnection -> [Header]

ToPath DeleteConnection

Defined in Amazonka.APIGatewayManagementAPI.DeleteConnection

Methods

toPath :: DeleteConnection -> ByteString

ToQuery DeleteConnection

Defined in Amazonka.APIGatewayManagementAPI.DeleteConnection

Methods

toQuery :: DeleteConnection -> QueryString

AWSRequest DeleteConnection

Defined in Amazonka.APIGatewayManagementAPI.DeleteConnection

Associated Types

type AWSResponse DeleteConnection

Methods

request :: (Service -> Service) -> DeleteConnection -> Request DeleteConnection

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DeleteConnection -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteConnection)))

Generic DeleteConnection

Defined in Amazonka.APIGatewayManagementAPI.DeleteConnection

Associated Types

type Rep DeleteConnection :: Type -> Type

Methods

from :: DeleteConnection -> Rep DeleteConnection x

to :: Rep DeleteConnection x -> DeleteConnection

Read DeleteConnection

Defined in Amazonka.APIGatewayManagementAPI.DeleteConnection

Methods

readsPrec :: Int -> ReadS DeleteConnection

readList :: ReadS [DeleteConnection]

readPrec :: ReadPrec DeleteConnection

readListPrec :: ReadPrec [DeleteConnection]

Show DeleteConnection

Defined in Amazonka.APIGatewayManagementAPI.DeleteConnection

Methods

showsPrec :: Int -> DeleteConnection -> ShowS

show :: DeleteConnection -> String

showList :: [DeleteConnection] -> ShowS

NFData DeleteConnection

Defined in Amazonka.APIGatewayManagementAPI.DeleteConnection

Methods

rnf :: DeleteConnection -> ()

Eq DeleteConnection

Defined in Amazonka.APIGatewayManagementAPI.DeleteConnection

Methods

(==) :: DeleteConnection -> DeleteConnection -> Bool

(/=) :: DeleteConnection -> DeleteConnection -> Bool

Hashable DeleteConnection

Defined in Amazonka.APIGatewayManagementAPI.DeleteConnection

Methods

hashWithSalt :: Int -> DeleteConnection -> Int

hash :: DeleteConnection -> Int

type AWSResponse DeleteConnection

Defined in Amazonka.APIGatewayManagementAPI.DeleteConnection

type AWSResponse DeleteConnection = DeleteConnectionResponse

type Rep DeleteConnection

Defined in Amazonka.APIGatewayManagementAPI.DeleteConnection

type Rep DeleteConnection = D1 ('MetaData "DeleteConnection" "Amazonka.APIGatewayManagementAPI.DeleteConnection" "amazonka-apigatewaymanagementapi-2.0-HxSVILnkEh6Hs18CaFx2Dr" 'False) (C1 ('MetaCons "DeleteConnection'" 'PrefixI 'True) (S1 ('MetaSel ('Just "connectionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeleteConnection

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

See: newDeleteConnectionResponse smart constructor.

Constructors

DeleteConnectionResponse'

Instances

Generic DeleteConnectionResponse

Defined in Amazonka.APIGatewayManagementAPI.DeleteConnection

Associated Types

type Rep DeleteConnectionResponse :: Type -> Type

Methods

from :: DeleteConnectionResponse -> Rep DeleteConnectionResponse x

to :: Rep DeleteConnectionResponse x -> DeleteConnectionResponse

Read DeleteConnectionResponse

Defined in Amazonka.APIGatewayManagementAPI.DeleteConnection

Methods

readsPrec :: Int -> ReadS DeleteConnectionResponse

readList :: ReadS [DeleteConnectionResponse]

readPrec :: ReadPrec DeleteConnectionResponse

readListPrec :: ReadPrec [DeleteConnectionResponse]

Show DeleteConnectionResponse

Defined in Amazonka.APIGatewayManagementAPI.DeleteConnection

Methods

showsPrec :: Int -> DeleteConnectionResponse -> ShowS

show :: DeleteConnectionResponse -> String

showList :: [DeleteConnectionResponse] -> ShowS

NFData DeleteConnectionResponse

Defined in Amazonka.APIGatewayManagementAPI.DeleteConnection

Methods

rnf :: DeleteConnectionResponse -> ()

Eq DeleteConnectionResponse

Defined in Amazonka.APIGatewayManagementAPI.DeleteConnection

Methods

(==) :: DeleteConnectionResponse -> DeleteConnectionResponse -> Bool

(/=) :: DeleteConnectionResponse -> DeleteConnectionResponse -> Bool

type Rep DeleteConnectionResponse

Defined in Amazonka.APIGatewayManagementAPI.DeleteConnection

type Rep DeleteConnectionResponse = D1 ('MetaData "DeleteConnectionResponse" "Amazonka.APIGatewayManagementAPI.DeleteConnection" "amazonka-apigatewaymanagementapi-2.0-HxSVILnkEh6Hs18CaFx2Dr" 'False) (C1 ('MetaCons "DeleteConnectionResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteConnectionResponse :: DeleteConnectionResponse

Create a value of DeleteConnectionResponse with all optional fields omitted.

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

GetConnection

data GetConnection

See: newGetConnection smart constructor.

Constructors

GetConnection' Text

Instances

ToHeaders GetConnection

Defined in Amazonka.APIGatewayManagementAPI.GetConnection

Methods

toHeaders :: GetConnection -> [Header]

ToPath GetConnection

Defined in Amazonka.APIGatewayManagementAPI.GetConnection

Methods

toPath :: GetConnection -> ByteString

ToQuery GetConnection

Defined in Amazonka.APIGatewayManagementAPI.GetConnection

Methods

toQuery :: GetConnection -> QueryString

AWSRequest GetConnection

Defined in Amazonka.APIGatewayManagementAPI.GetConnection

Associated Types

type AWSResponse GetConnection

Methods

request :: (Service -> Service) -> GetConnection -> Request GetConnection

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetConnection -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetConnection)))

Generic GetConnection

Defined in Amazonka.APIGatewayManagementAPI.GetConnection

Associated Types

type Rep GetConnection :: Type -> Type

Methods

from :: GetConnection -> Rep GetConnection x

to :: Rep GetConnection x -> GetConnection

Read GetConnection

Defined in Amazonka.APIGatewayManagementAPI.GetConnection

Methods

readsPrec :: Int -> ReadS GetConnection

readList :: ReadS [GetConnection]

readPrec :: ReadPrec GetConnection

readListPrec :: ReadPrec [GetConnection]

Show GetConnection

Defined in Amazonka.APIGatewayManagementAPI.GetConnection

Methods

showsPrec :: Int -> GetConnection -> ShowS

show :: GetConnection -> String

showList :: [GetConnection] -> ShowS

NFData GetConnection

Defined in Amazonka.APIGatewayManagementAPI.GetConnection

Methods

rnf :: GetConnection -> ()

Eq GetConnection

Defined in Amazonka.APIGatewayManagementAPI.GetConnection

Methods

(==) :: GetConnection -> GetConnection -> Bool

(/=) :: GetConnection -> GetConnection -> Bool

Hashable GetConnection

Defined in Amazonka.APIGatewayManagementAPI.GetConnection

Methods

hashWithSalt :: Int -> GetConnection -> Int

hash :: GetConnection -> Int

type AWSResponse GetConnection

Defined in Amazonka.APIGatewayManagementAPI.GetConnection

type AWSResponse GetConnection = GetConnectionResponse

type Rep GetConnection

Defined in Amazonka.APIGatewayManagementAPI.GetConnection

type Rep GetConnection = D1 ('MetaData "GetConnection" "Amazonka.APIGatewayManagementAPI.GetConnection" "amazonka-apigatewaymanagementapi-2.0-HxSVILnkEh6Hs18CaFx2Dr" 'False) (C1 ('MetaCons "GetConnection'" 'PrefixI 'True) (S1 ('MetaSel ('Just "connectionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetConnection

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

See: newGetConnectionResponse smart constructor.

Constructors

GetConnectionResponse' (Maybe ISO8601) (Maybe Identity) (Maybe ISO8601) Int

Instances

Generic GetConnectionResponse

Defined in Amazonka.APIGatewayManagementAPI.GetConnection

Associated Types

type Rep GetConnectionResponse :: Type -> Type

Methods

from :: GetConnectionResponse -> Rep GetConnectionResponse x

to :: Rep GetConnectionResponse x -> GetConnectionResponse

Read GetConnectionResponse

Defined in Amazonka.APIGatewayManagementAPI.GetConnection

Methods

readsPrec :: Int -> ReadS GetConnectionResponse

readList :: ReadS [GetConnectionResponse]

readPrec :: ReadPrec GetConnectionResponse

readListPrec :: ReadPrec [GetConnectionResponse]

Show GetConnectionResponse

Defined in Amazonka.APIGatewayManagementAPI.GetConnection

Methods

showsPrec :: Int -> GetConnectionResponse -> ShowS

show :: GetConnectionResponse -> String

showList :: [GetConnectionResponse] -> ShowS

NFData GetConnectionResponse

Defined in Amazonka.APIGatewayManagementAPI.GetConnection

Methods

rnf :: GetConnectionResponse -> ()

Eq GetConnectionResponse

Defined in Amazonka.APIGatewayManagementAPI.GetConnection

Methods

(==) :: GetConnectionResponse -> GetConnectionResponse -> Bool

(/=) :: GetConnectionResponse -> GetConnectionResponse -> Bool

type Rep GetConnectionResponse

Defined in Amazonka.APIGatewayManagementAPI.GetConnection

type Rep GetConnectionResponse = D1 ('MetaData "GetConnectionResponse" "Amazonka.APIGatewayManagementAPI.GetConnection" "amazonka-apigatewaymanagementapi-2.0-HxSVILnkEh6Hs18CaFx2Dr" 'False) (C1 ('MetaCons "GetConnectionResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "connectedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: S1 ('MetaSel ('Just "identity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Identity))) :*: (S1 ('MetaSel ('Just "lastActiveAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetConnectionResponse

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:identity:GetConnectionResponse', getConnectionResponse_identity - Undocumented member.

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

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

PostToConnection

data PostToConnection

See: newPostToConnection smart constructor.

Constructors

PostToConnection' Text ByteString

Instances

ToBody PostToConnection

Defined in Amazonka.APIGatewayManagementAPI.PostToConnection

Methods

toBody :: PostToConnection -> RequestBody

ToHeaders PostToConnection

Defined in Amazonka.APIGatewayManagementAPI.PostToConnection

Methods

toHeaders :: PostToConnection -> [Header]

ToPath PostToConnection

Defined in Amazonka.APIGatewayManagementAPI.PostToConnection

Methods

toPath :: PostToConnection -> ByteString

ToQuery PostToConnection

Defined in Amazonka.APIGatewayManagementAPI.PostToConnection

Methods

toQuery :: PostToConnection -> QueryString

AWSRequest PostToConnection

Defined in Amazonka.APIGatewayManagementAPI.PostToConnection

Associated Types

type AWSResponse PostToConnection

Methods

request :: (Service -> Service) -> PostToConnection -> Request PostToConnection

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy PostToConnection -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse PostToConnection)))

Generic PostToConnection

Defined in Amazonka.APIGatewayManagementAPI.PostToConnection

Associated Types

type Rep PostToConnection :: Type -> Type

Methods

from :: PostToConnection -> Rep PostToConnection x

to :: Rep PostToConnection x -> PostToConnection

Read PostToConnection

Defined in Amazonka.APIGatewayManagementAPI.PostToConnection

Methods

readsPrec :: Int -> ReadS PostToConnection

readList :: ReadS [PostToConnection]

readPrec :: ReadPrec PostToConnection

readListPrec :: ReadPrec [PostToConnection]

Show PostToConnection

Defined in Amazonka.APIGatewayManagementAPI.PostToConnection

Methods

showsPrec :: Int -> PostToConnection -> ShowS

show :: PostToConnection -> String

showList :: [PostToConnection] -> ShowS

NFData PostToConnection

Defined in Amazonka.APIGatewayManagementAPI.PostToConnection

Methods

rnf :: PostToConnection -> ()

Eq PostToConnection

Defined in Amazonka.APIGatewayManagementAPI.PostToConnection

Methods

(==) :: PostToConnection -> PostToConnection -> Bool

(/=) :: PostToConnection -> PostToConnection -> Bool

Hashable PostToConnection

Defined in Amazonka.APIGatewayManagementAPI.PostToConnection

Methods

hashWithSalt :: Int -> PostToConnection -> Int

hash :: PostToConnection -> Int

type AWSResponse PostToConnection

Defined in Amazonka.APIGatewayManagementAPI.PostToConnection

type AWSResponse PostToConnection = PostToConnectionResponse

type Rep PostToConnection

Defined in Amazonka.APIGatewayManagementAPI.PostToConnection

type Rep PostToConnection = D1 ('MetaData "PostToConnection" "Amazonka.APIGatewayManagementAPI.PostToConnection" "amazonka-apigatewaymanagementapi-2.0-HxSVILnkEh6Hs18CaFx2Dr" 'False) (C1 ('MetaCons "PostToConnection'" 'PrefixI 'True) (S1 ('MetaSel ('Just "connectionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "data'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ByteString)))

newPostToConnection

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

See: newPostToConnectionResponse smart constructor.

Constructors

PostToConnectionResponse'

Instances

Generic PostToConnectionResponse

Defined in Amazonka.APIGatewayManagementAPI.PostToConnection

Associated Types

type Rep PostToConnectionResponse :: Type -> Type

Methods

from :: PostToConnectionResponse -> Rep PostToConnectionResponse x

to :: Rep PostToConnectionResponse x -> PostToConnectionResponse

Read PostToConnectionResponse

Defined in Amazonka.APIGatewayManagementAPI.PostToConnection

Methods

readsPrec :: Int -> ReadS PostToConnectionResponse

readList :: ReadS [PostToConnectionResponse]

readPrec :: ReadPrec PostToConnectionResponse

readListPrec :: ReadPrec [PostToConnectionResponse]

Show PostToConnectionResponse

Defined in Amazonka.APIGatewayManagementAPI.PostToConnection

Methods

showsPrec :: Int -> PostToConnectionResponse -> ShowS

show :: PostToConnectionResponse -> String

showList :: [PostToConnectionResponse] -> ShowS

NFData PostToConnectionResponse

Defined in Amazonka.APIGatewayManagementAPI.PostToConnection

Methods

rnf :: PostToConnectionResponse -> ()

Eq PostToConnectionResponse

Defined in Amazonka.APIGatewayManagementAPI.PostToConnection

Methods

(==) :: PostToConnectionResponse -> PostToConnectionResponse -> Bool

(/=) :: PostToConnectionResponse -> PostToConnectionResponse -> Bool

type Rep PostToConnectionResponse

Defined in Amazonka.APIGatewayManagementAPI.PostToConnection

type Rep PostToConnectionResponse = D1 ('MetaData "PostToConnectionResponse" "Amazonka.APIGatewayManagementAPI.PostToConnection" "amazonka-apigatewaymanagementapi-2.0-HxSVILnkEh6Hs18CaFx2Dr" 'False) (C1 ('MetaCons "PostToConnectionResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newPostToConnectionResponse :: PostToConnectionResponse

Create a value of PostToConnectionResponse with all optional fields omitted.

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

Types

Identity

data Identity

See: newIdentity smart constructor.

Constructors

Identity' Text Text

Instances

FromJSON Identity

Defined in Amazonka.APIGatewayManagementAPI.Types.Identity

Methods

parseJSON :: Value -> Parser Identity

parseJSONList :: Value -> Parser [Identity]

Generic Identity

Defined in Amazonka.APIGatewayManagementAPI.Types.Identity

Associated Types

type Rep Identity :: Type -> Type

Methods

from :: Identity -> Rep Identity x

to :: Rep Identity x -> Identity

Read Identity

Defined in Amazonka.APIGatewayManagementAPI.Types.Identity

Methods

readsPrec :: Int -> ReadS Identity

readList :: ReadS [Identity]

readPrec :: ReadPrec Identity

readListPrec :: ReadPrec [Identity]

Show Identity

Defined in Amazonka.APIGatewayManagementAPI.Types.Identity

Methods

showsPrec :: Int -> Identity -> ShowS

show :: Identity -> String

showList :: [Identity] -> ShowS

NFData Identity

Defined in Amazonka.APIGatewayManagementAPI.Types.Identity

Methods

rnf :: Identity -> ()

Eq Identity

Defined in Amazonka.APIGatewayManagementAPI.Types.Identity

Methods

(==) :: Identity -> Identity -> Bool

(/=) :: Identity -> Identity -> Bool

Hashable Identity

Defined in Amazonka.APIGatewayManagementAPI.Types.Identity

Methods

hashWithSalt :: Int -> Identity -> Int

hash :: Identity -> Int

type Rep Identity

Defined in Amazonka.APIGatewayManagementAPI.Types.Identity

type Rep Identity = D1 ('MetaData "Identity" "Amazonka.APIGatewayManagementAPI.Types.Identity" "amazonka-apigatewaymanagementapi-2.0-HxSVILnkEh6Hs18CaFx2Dr" '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

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.