Amazonka.IoTSiteWise.DeletePortal

Deletes a portal from IoT SiteWise Monitor.

Creating a Request

data DeletePortal

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

ToHeaders DeletePortal

Defined in Amazonka.IoTSiteWise.DeletePortal

Methods

toHeaders :: DeletePortal -> [Header]

ToPath DeletePortal

Defined in Amazonka.IoTSiteWise.DeletePortal

Methods

toPath :: DeletePortal -> ByteString

ToQuery DeletePortal

Defined in Amazonka.IoTSiteWise.DeletePortal

Methods

toQuery :: DeletePortal -> QueryString

AWSRequest DeletePortal

Defined in Amazonka.IoTSiteWise.DeletePortal

Associated Types

type AWSResponse DeletePortal

Methods

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

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

Generic DeletePortal

Defined in Amazonka.IoTSiteWise.DeletePortal

Associated Types

type Rep DeletePortal :: Type -> Type

Methods

from :: DeletePortal -> Rep DeletePortal x

to :: Rep DeletePortal x -> DeletePortal

Read DeletePortal

Defined in Amazonka.IoTSiteWise.DeletePortal

Methods

readsPrec :: Int -> ReadS DeletePortal

readList :: ReadS [DeletePortal]

readPrec :: ReadPrec DeletePortal

readListPrec :: ReadPrec [DeletePortal]

Show DeletePortal

Defined in Amazonka.IoTSiteWise.DeletePortal

Methods

showsPrec :: Int -> DeletePortal -> ShowS

show :: DeletePortal -> String

showList :: [DeletePortal] -> ShowS

NFData DeletePortal

Defined in Amazonka.IoTSiteWise.DeletePortal

Methods

rnf :: DeletePortal -> ()

Eq DeletePortal

Defined in Amazonka.IoTSiteWise.DeletePortal

Methods

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

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

Hashable DeletePortal

Defined in Amazonka.IoTSiteWise.DeletePortal

Methods

hashWithSalt :: Int -> DeletePortal -> Int

hash :: DeletePortal -> Int

type AWSResponse DeletePortal

Defined in Amazonka.IoTSiteWise.DeletePortal

type AWSResponse DeletePortal = DeletePortalResponse

type Rep DeletePortal

Defined in Amazonka.IoTSiteWise.DeletePortal

type Rep DeletePortal = D1 ('MetaData "DeletePortal" "Amazonka.IoTSiteWise.DeletePortal" "amazonka-iotsitewise-2.0-AK8rDlpQ5oPJsrLUUxJgY" '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)))

newDeletePortal

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)

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

The ID of the portal to delete.

Destructuring the Response

data DeletePortalResponse

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

Generic DeletePortalResponse

Defined in Amazonka.IoTSiteWise.DeletePortal

Associated Types

type Rep DeletePortalResponse :: Type -> Type

Methods

from :: DeletePortalResponse -> Rep DeletePortalResponse x

to :: Rep DeletePortalResponse x -> DeletePortalResponse

Read DeletePortalResponse

Defined in Amazonka.IoTSiteWise.DeletePortal

Methods

readsPrec :: Int -> ReadS DeletePortalResponse

readList :: ReadS [DeletePortalResponse]

readPrec :: ReadPrec DeletePortalResponse

readListPrec :: ReadPrec [DeletePortalResponse]

Show DeletePortalResponse

Defined in Amazonka.IoTSiteWise.DeletePortal

Methods

showsPrec :: Int -> DeletePortalResponse -> ShowS

show :: DeletePortalResponse -> String

showList :: [DeletePortalResponse] -> ShowS

NFData DeletePortalResponse

Defined in Amazonka.IoTSiteWise.DeletePortal

Methods

rnf :: DeletePortalResponse -> ()

Eq DeletePortalResponse

Defined in Amazonka.IoTSiteWise.DeletePortal

Methods

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

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

type Rep DeletePortalResponse

Defined in Amazonka.IoTSiteWise.DeletePortal

type Rep DeletePortalResponse = D1 ('MetaData "DeletePortalResponse" "Amazonka.IoTSiteWise.DeletePortal" "amazonka-iotsitewise-2.0-AK8rDlpQ5oPJsrLUUxJgY" '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

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

The response's http status code.

deletePortalResponse_portalStatus :: Lens' DeletePortalResponse PortalStatus

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