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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Create a pipe. Amazon EventBridge Pipes connect event sources to targets and reduces the need for specialized knowledge and integration code.

Synopsis

data CreatePipe = CreatePipe' {
- description :: Maybe (Sensitive Text)
- desiredState :: Maybe RequestedPipeState
- enrichment :: Maybe Text
- enrichmentParameters :: Maybe PipeEnrichmentParameters
- sourceParameters :: Maybe PipeSourceParameters
- tags :: Maybe (HashMap Text (Sensitive Text))
- targetParameters :: Maybe PipeTargetParameters
- name :: Text
- roleArn :: Text
- source :: Text
- target :: Text
}
newCreatePipe :: Text -> Text -> Text -> Text -> CreatePipe
createPipe_description :: Lens' CreatePipe (Maybe Text)
createPipe_desiredState :: Lens' CreatePipe (Maybe RequestedPipeState)
createPipe_enrichment :: Lens' CreatePipe (Maybe Text)
createPipe_enrichmentParameters :: Lens' CreatePipe (Maybe PipeEnrichmentParameters)
createPipe_sourceParameters :: Lens' CreatePipe (Maybe PipeSourceParameters)
createPipe_tags :: Lens' CreatePipe (Maybe (HashMap Text Text))
createPipe_targetParameters :: Lens' CreatePipe (Maybe PipeTargetParameters)
createPipe_name :: Lens' CreatePipe Text
createPipe_roleArn :: Lens' CreatePipe Text
createPipe_source :: Lens' CreatePipe Text
createPipe_target :: Lens' CreatePipe Text
data CreatePipeResponse = CreatePipeResponse' {
- arn :: Maybe Text
- creationTime :: Maybe POSIX
- currentState :: Maybe PipeState
- desiredState :: Maybe RequestedPipeState
- lastModifiedTime :: Maybe POSIX
- name :: Maybe Text
- httpStatus :: Int
}
newCreatePipeResponse :: Int -> CreatePipeResponse
createPipeResponse_arn :: Lens' CreatePipeResponse (Maybe Text)
createPipeResponse_creationTime :: Lens' CreatePipeResponse (Maybe UTCTime)
createPipeResponse_currentState :: Lens' CreatePipeResponse (Maybe PipeState)
createPipeResponse_desiredState :: Lens' CreatePipeResponse (Maybe RequestedPipeState)
createPipeResponse_lastModifiedTime :: Lens' CreatePipeResponse (Maybe UTCTime)
createPipeResponse_name :: Lens' CreatePipeResponse (Maybe Text)
createPipeResponse_httpStatus :: Lens' CreatePipeResponse Int

Creating a Request

data CreatePipe Source #

See: newCreatePipe smart constructor.

Constructors

CreatePipe'

Fields

description :: Maybe (Sensitive Text)
A description of the pipe.
desiredState :: Maybe RequestedPipeState
The state the pipe should be in.
enrichment :: Maybe Text
The ARN of the enrichment resource.
enrichmentParameters :: Maybe PipeEnrichmentParameters
The parameters required to set up enrichment on your pipe.
sourceParameters :: Maybe PipeSourceParameters
The parameters required to set up a source for your pipe.
tags :: Maybe (HashMap Text (Sensitive Text))
The list of key-value pairs to associate with the pipe.
targetParameters :: Maybe PipeTargetParameters
The parameters required to set up a target for your pipe.
name :: Text
The name of the pipe.
roleArn :: Text
The ARN of the role that allows the pipe to send data to the target.
source :: Text
The ARN of the source resource.
target :: Text
The ARN of the target resource.

Instances

Instances details

ToJSON CreatePipe Source #
Instance details Defined in Amazonka.Pipes.CreatePipe Methods toJSON :: CreatePipe -> Value # toEncoding :: CreatePipe -> Encoding # toJSONList :: [CreatePipe] -> Value # toEncodingList :: [CreatePipe] -> Encoding #
ToHeaders CreatePipe Source #
Instance details Defined in Amazonka.Pipes.CreatePipe Methods toHeaders :: CreatePipe -> [Header] #
ToPath CreatePipe Source #
Instance details Defined in Amazonka.Pipes.CreatePipe Methods toPath :: CreatePipe -> ByteString #
ToQuery CreatePipe Source #
Instance details Defined in Amazonka.Pipes.CreatePipe Methods toQuery :: CreatePipe -> QueryString #
AWSRequest CreatePipe Source #
Instance details Defined in Amazonka.Pipes.CreatePipe Associated Types type AWSResponse CreatePipe # Methods request :: (Service -> Service) -> CreatePipe -> Request CreatePipe # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreatePipe -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreatePipe))) #
Generic CreatePipe Source #
Instance details Defined in Amazonka.Pipes.CreatePipe Associated Types type Rep CreatePipe :: Type -> Type # Methods from :: CreatePipe -> Rep CreatePipe x # to :: Rep CreatePipe x -> CreatePipe #
Show CreatePipe Source #
Instance details Defined in Amazonka.Pipes.CreatePipe Methods showsPrec :: Int -> CreatePipe -> ShowS # show :: CreatePipe -> String # showList :: [CreatePipe] -> ShowS #
NFData CreatePipe Source #
Instance details Defined in Amazonka.Pipes.CreatePipe Methods rnf :: CreatePipe -> () #
Eq CreatePipe Source #
Instance details Defined in Amazonka.Pipes.CreatePipe Methods (==) :: CreatePipe -> CreatePipe -> Bool # (/=) :: CreatePipe -> CreatePipe -> Bool #
Hashable CreatePipe Source #
Instance details Defined in Amazonka.Pipes.CreatePipe Methods hashWithSalt :: Int -> CreatePipe -> Int # hash :: CreatePipe -> Int #
type AWSResponse CreatePipe Source #
Instance details Defined in Amazonka.Pipes.CreatePipe type AWSResponse CreatePipe = CreatePipeResponse
type Rep CreatePipe Source #
Instance details Defined in Amazonka.Pipes.CreatePipe type Rep CreatePipe = D1 ('MetaData "CreatePipe" "Amazonka.Pipes.CreatePipe" "amazonka-pipes-2.0-DDuNjbjVfgsJFLlibzr06i" 'False) (C1 ('MetaCons "CreatePipe'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 ('MetaSel ('Just "desiredState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RequestedPipeState))) :: (S1 ('MetaSel ('Just "enrichment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "enrichmentParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PipeEnrichmentParameters)) :: S1 ('MetaSel ('Just "sourceParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PipeSourceParameters))))) :: ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text (Sensitive Text)))) :: (S1 ('MetaSel ('Just "targetParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PipeTargetParameters)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :: (S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "source") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "target") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newCreatePipe Source #

Arguments

:: Text	`CreatePipe`
-> Text	`$sel:roleArn:CreatePipe'`
-> Text	`CreatePipe`
-> Text	`CreatePipe`
-> CreatePipe

Create a value of CreatePipe 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:description:CreatePipe', createPipe_description - A description of the pipe.

CreatePipe, createPipe_desiredState - The state the pipe should be in.

CreatePipe, createPipe_enrichment - The ARN of the enrichment resource.

$sel:enrichmentParameters:CreatePipe', createPipe_enrichmentParameters - The parameters required to set up enrichment on your pipe.

$sel:sourceParameters:CreatePipe', createPipe_sourceParameters - The parameters required to set up a source for your pipe.

CreatePipe, createPipe_tags - The list of key-value pairs to associate with the pipe.

$sel:targetParameters:CreatePipe', createPipe_targetParameters - The parameters required to set up a target for your pipe.

CreatePipe, createPipe_name - The name of the pipe.

$sel:roleArn:CreatePipe', createPipe_roleArn - The ARN of the role that allows the pipe to send data to the target.

CreatePipe, createPipe_source - The ARN of the source resource.

CreatePipe, createPipe_target - The ARN of the target resource.

Request Lenses

createPipe_description :: Lens' CreatePipe (Maybe Text) Source #

A description of the pipe.

createPipe_desiredState :: Lens' CreatePipe (Maybe RequestedPipeState) Source #

The state the pipe should be in.

createPipe_enrichment :: Lens' CreatePipe (Maybe Text) Source #

The ARN of the enrichment resource.

createPipe_enrichmentParameters :: Lens' CreatePipe (Maybe PipeEnrichmentParameters) Source #

The parameters required to set up enrichment on your pipe.

createPipe_sourceParameters :: Lens' CreatePipe (Maybe PipeSourceParameters) Source #

The parameters required to set up a source for your pipe.

createPipe_tags :: Lens' CreatePipe (Maybe (HashMap Text Text)) Source #

The list of key-value pairs to associate with the pipe.

createPipe_targetParameters :: Lens' CreatePipe (Maybe PipeTargetParameters) Source #

The parameters required to set up a target for your pipe.

createPipe_name :: Lens' CreatePipe Text Source #

The name of the pipe.

createPipe_roleArn :: Lens' CreatePipe Text Source #

The ARN of the role that allows the pipe to send data to the target.

createPipe_source :: Lens' CreatePipe Text Source #

The ARN of the source resource.

createPipe_target :: Lens' CreatePipe Text Source #

The ARN of the target resource.

Destructuring the Response

data CreatePipeResponse Source #

See: newCreatePipeResponse smart constructor.

Constructors

CreatePipeResponse'

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

newCreatePipeResponse Source #

Arguments

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

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

CreatePipeResponse, createPipeResponse_arn - The ARN of the pipe.

CreatePipeResponse, createPipeResponse_creationTime - The time the pipe was created.

CreatePipeResponse, createPipeResponse_currentState - The state the pipe is in.

CreatePipe, createPipeResponse_desiredState - The state the pipe should be in.

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

CreatePipe, createPipeResponse_name - The name of the pipe.

$sel:httpStatus:CreatePipeResponse', createPipeResponse_httpStatus - The response's http status code.

Response Lenses

createPipeResponse_arn :: Lens' CreatePipeResponse (Maybe Text) Source #

The ARN of the pipe.

createPipeResponse_creationTime :: Lens' CreatePipeResponse (Maybe UTCTime) Source #

The time the pipe was created.

createPipeResponse_currentState :: Lens' CreatePipeResponse (Maybe PipeState) Source #

The state the pipe is in.

createPipeResponse_desiredState :: Lens' CreatePipeResponse (Maybe RequestedPipeState) Source #

The state the pipe should be in.

createPipeResponse_lastModifiedTime :: Lens' CreatePipeResponse (Maybe UTCTime) Source #

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

createPipeResponse_name :: Lens' CreatePipeResponse (Maybe Text) Source #

The name of the pipe.

createPipeResponse_httpStatus :: Lens' CreatePipeResponse Int Source #

The response's http status code.