Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Pipes.StopPipe

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Stop an existing pipe.

Synopsis

data StopPipe = StopPipe' {
- name :: Text
}
newStopPipe :: Text -> StopPipe
stopPipe_name :: Lens' StopPipe Text
data StopPipeResponse = StopPipeResponse' {
- arn :: Maybe Text
- creationTime :: Maybe POSIX
- currentState :: Maybe PipeState
- desiredState :: Maybe RequestedPipeState
- lastModifiedTime :: Maybe POSIX
- name :: Maybe Text
- httpStatus :: Int
}
newStopPipeResponse :: Int -> StopPipeResponse
stopPipeResponse_arn :: Lens' StopPipeResponse (Maybe Text)
stopPipeResponse_creationTime :: Lens' StopPipeResponse (Maybe UTCTime)
stopPipeResponse_currentState :: Lens' StopPipeResponse (Maybe PipeState)
stopPipeResponse_desiredState :: Lens' StopPipeResponse (Maybe RequestedPipeState)
stopPipeResponse_lastModifiedTime :: Lens' StopPipeResponse (Maybe UTCTime)
stopPipeResponse_name :: Lens' StopPipeResponse (Maybe Text)
stopPipeResponse_httpStatus :: Lens' StopPipeResponse Int

Creating a Request

data StopPipe Source #

See: newStopPipe smart constructor.

Constructors

StopPipe'
Fields name :: Text The name of the pipe.

Instances

Instances details

ToJSON StopPipe Source #
Instance details Defined in Amazonka.Pipes.StopPipe Methods toJSON :: StopPipe -> Value # toEncoding :: StopPipe -> Encoding # toJSONList :: [StopPipe] -> Value # toEncodingList :: [StopPipe] -> Encoding #
ToHeaders StopPipe Source #
Instance details Defined in Amazonka.Pipes.StopPipe Methods toHeaders :: StopPipe -> [Header] #
ToPath StopPipe Source #
Instance details Defined in Amazonka.Pipes.StopPipe Methods toPath :: StopPipe -> ByteString #
ToQuery StopPipe Source #
Instance details Defined in Amazonka.Pipes.StopPipe Methods toQuery :: StopPipe -> QueryString #
AWSRequest StopPipe Source #
Instance details Defined in Amazonka.Pipes.StopPipe Associated Types type AWSResponse StopPipe # Methods request :: (Service -> Service) -> StopPipe -> Request StopPipe # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy StopPipe -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StopPipe))) #
Generic StopPipe Source #
Instance details Defined in Amazonka.Pipes.StopPipe Associated Types type Rep StopPipe :: Type -> Type # Methods from :: StopPipe -> Rep StopPipe x # to :: Rep StopPipe x -> StopPipe #
Read StopPipe Source #
Instance details Defined in Amazonka.Pipes.StopPipe Methods readsPrec :: Int -> ReadS StopPipe # readList :: ReadS [StopPipe] # readPrec :: ReadPrec StopPipe # readListPrec :: ReadPrec [StopPipe] #
Show StopPipe Source #
Instance details Defined in Amazonka.Pipes.StopPipe Methods showsPrec :: Int -> StopPipe -> ShowS # show :: StopPipe -> String # showList :: [StopPipe] -> ShowS #
NFData StopPipe Source #
Instance details Defined in Amazonka.Pipes.StopPipe Methods rnf :: StopPipe -> () #
Eq StopPipe Source #
Instance details Defined in Amazonka.Pipes.StopPipe Methods (==) :: StopPipe -> StopPipe -> Bool # (/=) :: StopPipe -> StopPipe -> Bool #
Hashable StopPipe Source #
Instance details Defined in Amazonka.Pipes.StopPipe Methods hashWithSalt :: Int -> StopPipe -> Int # hash :: StopPipe -> Int #
type AWSResponse StopPipe Source #
Instance details Defined in Amazonka.Pipes.StopPipe type AWSResponse StopPipe = StopPipeResponse
type Rep StopPipe Source #
Instance details Defined in Amazonka.Pipes.StopPipe type Rep StopPipe = D1 ('MetaData "StopPipe" "Amazonka.Pipes.StopPipe" "amazonka-pipes-2.0-DDuNjbjVfgsJFLlibzr06i" 'False) (C1 ('MetaCons "StopPipe'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newStopPipe Source #

Arguments

:: Text	`StopPipe`
-> StopPipe

Create a value of StopPipe 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:

StopPipe, stopPipe_name - The name of the pipe.

Request Lenses

stopPipe_name :: Lens' StopPipe Text Source #

The name of the pipe.

Destructuring the Response

data StopPipeResponse Source #

See: newStopPipeResponse smart constructor.

Constructors

StopPipeResponse'

Fields

arn :: Maybe Text
The ARN of the pipe.
creationTime :: Maybe POSIX
The time the pipe was created.
currentState :: Maybe PipeState
The state the pipe is in.
desiredState :: Maybe RequestedPipeState
The state the pipe should be in.
lastModifiedTime :: Maybe POSIX
When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
name :: Maybe Text
The name of the pipe.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic StopPipeResponse Source #
Instance details Defined in Amazonka.Pipes.StopPipe Associated Types type Rep StopPipeResponse :: Type -> Type # Methods from :: StopPipeResponse -> Rep StopPipeResponse x # to :: Rep StopPipeResponse x -> StopPipeResponse #
Read StopPipeResponse Source #
Instance details Defined in Amazonka.Pipes.StopPipe Methods readsPrec :: Int -> ReadS StopPipeResponse # readList :: ReadS [StopPipeResponse] # readPrec :: ReadPrec StopPipeResponse # readListPrec :: ReadPrec [StopPipeResponse] #
Show StopPipeResponse Source #
Instance details Defined in Amazonka.Pipes.StopPipe Methods showsPrec :: Int -> StopPipeResponse -> ShowS # show :: StopPipeResponse -> String # showList :: [StopPipeResponse] -> ShowS #
NFData StopPipeResponse Source #
Instance details Defined in Amazonka.Pipes.StopPipe Methods rnf :: StopPipeResponse -> () #
Eq StopPipeResponse Source #
Instance details Defined in Amazonka.Pipes.StopPipe Methods (==) :: StopPipeResponse -> StopPipeResponse -> Bool # (/=) :: StopPipeResponse -> StopPipeResponse -> Bool #
type Rep StopPipeResponse Source #
Instance details Defined in Amazonka.Pipes.StopPipe type Rep StopPipeResponse = D1 ('MetaData "StopPipeResponse" "Amazonka.Pipes.StopPipe" "amazonka-pipes-2.0-DDuNjbjVfgsJFLlibzr06i" 'False) (C1 ('MetaCons "StopPipeResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "currentState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PipeState)))) :: ((S1 ('MetaSel ('Just "desiredState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RequestedPipeState)) :: S1 ('MetaSel ('Just "lastModifiedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newStopPipeResponse Source #

Arguments

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

Create a value of StopPipeResponse 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:

StopPipeResponse, stopPipeResponse_arn - The ARN of the pipe.

StopPipeResponse, stopPipeResponse_creationTime - The time the pipe was created.

StopPipeResponse, stopPipeResponse_currentState - The state the pipe is in.

StopPipeResponse, stopPipeResponse_desiredState - The state the pipe should be in.

StopPipeResponse, stopPipeResponse_lastModifiedTime - When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

StopPipe, stopPipeResponse_name - The name of the pipe.

$sel:httpStatus:StopPipeResponse', stopPipeResponse_httpStatus - The response's http status code.

Response Lenses

stopPipeResponse_arn :: Lens' StopPipeResponse (Maybe Text) Source #

The ARN of the pipe.

stopPipeResponse_creationTime :: Lens' StopPipeResponse (Maybe UTCTime) Source #

The time the pipe was created.

stopPipeResponse_currentState :: Lens' StopPipeResponse (Maybe PipeState) Source #

The state the pipe is in.

stopPipeResponse_desiredState :: Lens' StopPipeResponse (Maybe RequestedPipeState) Source #

The state the pipe should be in.

stopPipeResponse_lastModifiedTime :: Lens' StopPipeResponse (Maybe UTCTime) Source #

When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

stopPipeResponse_name :: Lens' StopPipeResponse (Maybe Text) Source #

The name of the pipe.

stopPipeResponse_httpStatus :: Lens' StopPipeResponse Int Source #

The response's http status code.