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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Start an existing pipe.

Synopsis

data StartPipe = StartPipe' {
- name :: Text
}
newStartPipe :: Text -> StartPipe
startPipe_name :: Lens' StartPipe Text
data StartPipeResponse = StartPipeResponse' {
- arn :: Maybe Text
- creationTime :: Maybe POSIX
- currentState :: Maybe PipeState
- desiredState :: Maybe RequestedPipeState
- lastModifiedTime :: Maybe POSIX
- name :: Maybe Text
- httpStatus :: Int
}
newStartPipeResponse :: Int -> StartPipeResponse
startPipeResponse_arn :: Lens' StartPipeResponse (Maybe Text)
startPipeResponse_creationTime :: Lens' StartPipeResponse (Maybe UTCTime)
startPipeResponse_currentState :: Lens' StartPipeResponse (Maybe PipeState)
startPipeResponse_desiredState :: Lens' StartPipeResponse (Maybe RequestedPipeState)
startPipeResponse_lastModifiedTime :: Lens' StartPipeResponse (Maybe UTCTime)
startPipeResponse_name :: Lens' StartPipeResponse (Maybe Text)
startPipeResponse_httpStatus :: Lens' StartPipeResponse Int

Creating a Request

data StartPipe Source #

See: newStartPipe smart constructor.

Constructors

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

Instances

Instances details

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

newStartPipe Source #

Arguments

:: Text	`StartPipe`
-> StartPipe

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

StartPipe, startPipe_name - The name of the pipe.

Request Lenses

startPipe_name :: Lens' StartPipe Text Source #

The name of the pipe.

Destructuring the Response

data StartPipeResponse Source #

See: newStartPipeResponse smart constructor.

Constructors

StartPipeResponse'

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 StartPipeResponse Source #
Instance details Defined in Amazonka.Pipes.StartPipe Associated Types type Rep StartPipeResponse :: Type -> Type # Methods from :: StartPipeResponse -> Rep StartPipeResponse x # to :: Rep StartPipeResponse x -> StartPipeResponse #
Read StartPipeResponse Source #
Instance details Defined in Amazonka.Pipes.StartPipe Methods readsPrec :: Int -> ReadS StartPipeResponse # readList :: ReadS [StartPipeResponse] # readPrec :: ReadPrec StartPipeResponse # readListPrec :: ReadPrec [StartPipeResponse] #
Show StartPipeResponse Source #
Instance details Defined in Amazonka.Pipes.StartPipe Methods showsPrec :: Int -> StartPipeResponse -> ShowS # show :: StartPipeResponse -> String # showList :: [StartPipeResponse] -> ShowS #
NFData StartPipeResponse Source #
Instance details Defined in Amazonka.Pipes.StartPipe Methods rnf :: StartPipeResponse -> () #
Eq StartPipeResponse Source #
Instance details Defined in Amazonka.Pipes.StartPipe Methods (==) :: StartPipeResponse -> StartPipeResponse -> Bool # (/=) :: StartPipeResponse -> StartPipeResponse -> Bool #
type Rep StartPipeResponse Source #
Instance details Defined in Amazonka.Pipes.StartPipe type Rep StartPipeResponse = D1 ('MetaData "StartPipeResponse" "Amazonka.Pipes.StartPipe" "amazonka-pipes-2.0-DDuNjbjVfgsJFLlibzr06i" 'False) (C1 ('MetaCons "StartPipeResponse'" '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)))))

newStartPipeResponse Source #

Arguments

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

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

StartPipeResponse, startPipeResponse_arn - The ARN of the pipe.

StartPipeResponse, startPipeResponse_creationTime - The time the pipe was created.

StartPipeResponse, startPipeResponse_currentState - The state the pipe is in.

StartPipeResponse, startPipeResponse_desiredState - The state the pipe should be in.

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

StartPipe, startPipeResponse_name - The name of the pipe.

$sel:httpStatus:StartPipeResponse', startPipeResponse_httpStatus - The response's http status code.

Response Lenses

startPipeResponse_arn :: Lens' StartPipeResponse (Maybe Text) Source #

The ARN of the pipe.

startPipeResponse_creationTime :: Lens' StartPipeResponse (Maybe UTCTime) Source #

The time the pipe was created.

startPipeResponse_currentState :: Lens' StartPipeResponse (Maybe PipeState) Source #

The state the pipe is in.

startPipeResponse_desiredState :: Lens' StartPipeResponse (Maybe RequestedPipeState) Source #

The state the pipe should be in.

startPipeResponse_lastModifiedTime :: Lens' StartPipeResponse (Maybe UTCTime) Source #

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

startPipeResponse_name :: Lens' StartPipeResponse (Maybe Text) Source #

The name of the pipe.

startPipeResponse_httpStatus :: Lens' StartPipeResponse Int Source #

The response's http status code.