libZSservicesZSamazonka-iotsitewiseZSamazonka-iotsitewise
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.IoTSiteWise.DeletePortal

Description

Deletes a portal from IoT SiteWise Monitor.

Synopsis

Creating a Request

data DeletePortal Source #

See: newDeletePortal smart constructor.

Constructors

DeletePortal' 

Fields

  • clientToken :: Maybe Text

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

  • portalId :: Text

    The ID of the portal to delete.

Instances

Instances details
Eq DeletePortal Source # 
Instance details

Defined in Amazonka.IoTSiteWise.DeletePortal

Methods

(==) :: DeletePortal -> DeletePortal -> Bool #

(/=) :: DeletePortal -> DeletePortal -> Bool #

Read DeletePortal Source # 
Instance details

Defined in Amazonka.IoTSiteWise.DeletePortal

Methods

readsPrec :: Int -> ReadS DeletePortal #

readList :: ReadS [DeletePortal] #

readPrec :: ReadPrec DeletePortal #

readListPrec :: ReadPrec [DeletePortal] #

Show DeletePortal Source # 
Instance details

Defined in Amazonka.IoTSiteWise.DeletePortal

Methods

showsPrec :: Int -> DeletePortal -> ShowS #

show :: DeletePortal -> String #

showList :: [DeletePortal] -> ShowS #

Generic DeletePortal Source # 
Instance details

Defined in Amazonka.IoTSiteWise.DeletePortal

Associated Types

type Rep DeletePortal :: Type -> Type #

Methods

from :: DeletePortal -> Rep DeletePortal x #

to :: Rep DeletePortal x -> DeletePortal #

NFData DeletePortal Source # 
Instance details

Defined in Amazonka.IoTSiteWise.DeletePortal

Methods

rnf :: DeletePortal -> () #

Hashable DeletePortal Source # 
Instance details

Defined in Amazonka.IoTSiteWise.DeletePortal

Methods

hashWithSalt :: Int -> DeletePortal -> Int #

hash :: DeletePortal -> Int #

AWSRequest DeletePortal Source # 
Instance details

Defined in Amazonka.IoTSiteWise.DeletePortal

Associated Types

type AWSResponse DeletePortal #

Methods

request :: DeletePortal -> Request DeletePortal #

response :: MonadResource m => Logger -> Service -> Proxy DeletePortal -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeletePortal))) #

ToHeaders DeletePortal Source # 
Instance details

Defined in Amazonka.IoTSiteWise.DeletePortal

Methods

toHeaders :: DeletePortal -> [Header] #

ToPath DeletePortal Source # 
Instance details

Defined in Amazonka.IoTSiteWise.DeletePortal

Methods

toPath :: DeletePortal -> ByteString #

ToQuery DeletePortal Source # 
Instance details

Defined in Amazonka.IoTSiteWise.DeletePortal

Methods

toQuery :: DeletePortal -> QueryString #

type Rep DeletePortal Source # 
Instance details

Defined in Amazonka.IoTSiteWise.DeletePortal

type Rep DeletePortal = D1 ('MetaData "DeletePortal" "Amazonka.IoTSiteWise.DeletePortal" "libZSservicesZSamazonka-iotsitewiseZSamazonka-iotsitewise" 'False) (C1 ('MetaCons "DeletePortal'" 'PrefixI 'True) (S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "portalId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DeletePortal Source # 
Instance details

Defined in Amazonka.IoTSiteWise.DeletePortal

type AWSResponse DeletePortal = DeletePortalResponse

newDeletePortal Source #

Arguments

:: Text

$sel:portalId:DeletePortal'

-> DeletePortal 

Create a value of DeletePortal 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:clientToken:DeletePortal', deletePortal_clientToken - A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

$sel:portalId:DeletePortal', deletePortal_portalId - The ID of the portal to delete.

Request Lenses

deletePortal_clientToken :: Lens' DeletePortal (Maybe Text) Source #

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

deletePortal_portalId :: Lens' DeletePortal Text Source #

The ID of the portal to delete.

Destructuring the Response

data DeletePortalResponse Source #

See: newDeletePortalResponse smart constructor.

Constructors

DeletePortalResponse' 

Fields

  • httpStatus :: Int

    The response's http status code.

  • portalStatus :: PortalStatus

    The status of the portal, which contains a state (DELETING after successfully calling this operation) and any error message.

Instances

Instances details
Eq DeletePortalResponse Source # 
Instance details

Defined in Amazonka.IoTSiteWise.DeletePortal

Methods

(==) :: DeletePortalResponse -> DeletePortalResponse -> Bool #

(/=) :: DeletePortalResponse -> DeletePortalResponse -> Bool #

Read DeletePortalResponse Source # 
Instance details

Defined in Amazonka.IoTSiteWise.DeletePortal

Methods

readsPrec :: Int -> ReadS DeletePortalResponse #

readList :: ReadS [DeletePortalResponse] #

readPrec :: ReadPrec DeletePortalResponse #

readListPrec :: ReadPrec [DeletePortalResponse] #

Show DeletePortalResponse Source # 
Instance details

Defined in Amazonka.IoTSiteWise.DeletePortal

Methods

showsPrec :: Int -> DeletePortalResponse -> ShowS #

show :: DeletePortalResponse -> String #

showList :: [DeletePortalResponse] -> ShowS #

Generic DeletePortalResponse Source # 
Instance details

Defined in Amazonka.IoTSiteWise.DeletePortal

Associated Types

type Rep DeletePortalResponse :: Type -> Type #

Methods

from :: DeletePortalResponse -> Rep DeletePortalResponse x #

to :: Rep DeletePortalResponse x -> DeletePortalResponse #

NFData DeletePortalResponse Source # 
Instance details

Defined in Amazonka.IoTSiteWise.DeletePortal

Methods

rnf :: DeletePortalResponse -> () #

type Rep DeletePortalResponse Source # 
Instance details

Defined in Amazonka.IoTSiteWise.DeletePortal

type Rep DeletePortalResponse = D1 ('MetaData "DeletePortalResponse" "Amazonka.IoTSiteWise.DeletePortal" "libZSservicesZSamazonka-iotsitewiseZSamazonka-iotsitewise" 'False) (C1 ('MetaCons "DeletePortalResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "portalStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PortalStatus)))

newDeletePortalResponse Source #

Arguments

:: Int

$sel:httpStatus:DeletePortalResponse'

-> PortalStatus

$sel:portalStatus:DeletePortalResponse'

-> DeletePortalResponse 

Create a value of DeletePortalResponse 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:httpStatus:DeletePortalResponse', deletePortalResponse_httpStatus - The response's http status code.

$sel:portalStatus:DeletePortalResponse', deletePortalResponse_portalStatus - The status of the portal, which contains a state (DELETING after successfully calling this operation) and any error message.

Response Lenses

deletePortalResponse_httpStatus :: Lens' DeletePortalResponse Int Source #

The response's http status code.

deletePortalResponse_portalStatus :: Lens' DeletePortalResponse PortalStatus Source #

The status of the portal, which contains a state (DELETING after successfully calling this operation) and any error message.