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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Update an existing pipe. When you call UpdatePipe, only the fields that are included in the request are changed, the rest are unchanged. The exception to this is if you modify any Amazon Web Services-service specific fields in the SourceParameters, EnrichmentParameters, or TargetParameters objects. The fields in these objects are updated atomically as one and override existing values. This is by design and means that if you don't specify an optional field in one of these Parameters objects, that field will be set to its system-default value after the update.

 <p>For more information about pipes, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html"> Amazon EventBridge Pipes</a> in the Amazon EventBridge User Guide.</p>

Synopsis

data UpdatePipe = UpdatePipe' {
- description :: Maybe (Sensitive Text)
- desiredState :: Maybe RequestedPipeState
- enrichment :: Maybe Text
- enrichmentParameters :: Maybe PipeEnrichmentParameters
- sourceParameters :: Maybe UpdatePipeSourceParameters
- target :: Maybe Text
- targetParameters :: Maybe PipeTargetParameters
- name :: Text
- roleArn :: Text
}
newUpdatePipe :: Text -> Text -> UpdatePipe
updatePipe_description :: Lens' UpdatePipe (Maybe Text)
updatePipe_desiredState :: Lens' UpdatePipe (Maybe RequestedPipeState)
updatePipe_enrichment :: Lens' UpdatePipe (Maybe Text)
updatePipe_enrichmentParameters :: Lens' UpdatePipe (Maybe PipeEnrichmentParameters)
updatePipe_sourceParameters :: Lens' UpdatePipe (Maybe UpdatePipeSourceParameters)
updatePipe_target :: Lens' UpdatePipe (Maybe Text)
updatePipe_targetParameters :: Lens' UpdatePipe (Maybe PipeTargetParameters)
updatePipe_name :: Lens' UpdatePipe Text
updatePipe_roleArn :: Lens' UpdatePipe Text
data UpdatePipeResponse = UpdatePipeResponse' {
- arn :: Maybe Text
- creationTime :: Maybe POSIX
- currentState :: Maybe PipeState
- desiredState :: Maybe RequestedPipeState
- lastModifiedTime :: Maybe POSIX
- name :: Maybe Text
- httpStatus :: Int
}
newUpdatePipeResponse :: Int -> UpdatePipeResponse
updatePipeResponse_arn :: Lens' UpdatePipeResponse (Maybe Text)
updatePipeResponse_creationTime :: Lens' UpdatePipeResponse (Maybe UTCTime)
updatePipeResponse_currentState :: Lens' UpdatePipeResponse (Maybe PipeState)
updatePipeResponse_desiredState :: Lens' UpdatePipeResponse (Maybe RequestedPipeState)
updatePipeResponse_lastModifiedTime :: Lens' UpdatePipeResponse (Maybe UTCTime)
updatePipeResponse_name :: Lens' UpdatePipeResponse (Maybe Text)
updatePipeResponse_httpStatus :: Lens' UpdatePipeResponse Int

Creating a Request

data UpdatePipe Source #

See: newUpdatePipe smart constructor.

Constructors

UpdatePipe'

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 UpdatePipeSourceParameters
The parameters required to set up a source for your pipe.
target :: Maybe Text
The ARN of the target resource.
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.

Instances

Instances details

ToJSON UpdatePipe Source #
Instance details Defined in Amazonka.Pipes.UpdatePipe Methods toJSON :: UpdatePipe -> Value # toEncoding :: UpdatePipe -> Encoding # toJSONList :: [UpdatePipe] -> Value # toEncodingList :: [UpdatePipe] -> Encoding #
ToHeaders UpdatePipe Source #
Instance details Defined in Amazonka.Pipes.UpdatePipe Methods toHeaders :: UpdatePipe -> [Header] #
ToPath UpdatePipe Source #
Instance details Defined in Amazonka.Pipes.UpdatePipe Methods toPath :: UpdatePipe -> ByteString #
ToQuery UpdatePipe Source #
Instance details Defined in Amazonka.Pipes.UpdatePipe Methods toQuery :: UpdatePipe -> QueryString #
AWSRequest UpdatePipe Source #
Instance details Defined in Amazonka.Pipes.UpdatePipe Associated Types type AWSResponse UpdatePipe # Methods request :: (Service -> Service) -> UpdatePipe -> Request UpdatePipe # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdatePipe -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdatePipe))) #
Generic UpdatePipe Source #
Instance details Defined in Amazonka.Pipes.UpdatePipe Associated Types type Rep UpdatePipe :: Type -> Type # Methods from :: UpdatePipe -> Rep UpdatePipe x # to :: Rep UpdatePipe x -> UpdatePipe #
Show UpdatePipe Source #
Instance details Defined in Amazonka.Pipes.UpdatePipe Methods showsPrec :: Int -> UpdatePipe -> ShowS # show :: UpdatePipe -> String # showList :: [UpdatePipe] -> ShowS #
NFData UpdatePipe Source #
Instance details Defined in Amazonka.Pipes.UpdatePipe Methods rnf :: UpdatePipe -> () #
Eq UpdatePipe Source #
Instance details Defined in Amazonka.Pipes.UpdatePipe Methods (==) :: UpdatePipe -> UpdatePipe -> Bool # (/=) :: UpdatePipe -> UpdatePipe -> Bool #
Hashable UpdatePipe Source #
Instance details Defined in Amazonka.Pipes.UpdatePipe Methods hashWithSalt :: Int -> UpdatePipe -> Int # hash :: UpdatePipe -> Int #
type AWSResponse UpdatePipe Source #
Instance details Defined in Amazonka.Pipes.UpdatePipe type AWSResponse UpdatePipe = UpdatePipeResponse
type Rep UpdatePipe Source #
Instance details Defined in Amazonka.Pipes.UpdatePipe type Rep UpdatePipe = D1 ('MetaData "UpdatePipe" "Amazonka.Pipes.UpdatePipe" "amazonka-pipes-2.0-DDuNjbjVfgsJFLlibzr06i" 'False) (C1 ('MetaCons "UpdatePipe'" '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 UpdatePipeSourceParameters)) :: S1 ('MetaSel ('Just "target") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe 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))))))

newUpdatePipe Source #

Arguments

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

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

UpdatePipe, updatePipe_desiredState - The state the pipe should be in.

UpdatePipe, updatePipe_enrichment - The ARN of the enrichment resource.

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

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

UpdatePipe, updatePipe_target - The ARN of the target resource.

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

UpdatePipe, updatePipe_name - The name of the pipe.

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

Request Lenses

updatePipe_description :: Lens' UpdatePipe (Maybe Text) Source #

A description of the pipe.

updatePipe_desiredState :: Lens' UpdatePipe (Maybe RequestedPipeState) Source #

The state the pipe should be in.

updatePipe_enrichment :: Lens' UpdatePipe (Maybe Text) Source #

The ARN of the enrichment resource.

updatePipe_enrichmentParameters :: Lens' UpdatePipe (Maybe PipeEnrichmentParameters) Source #

The parameters required to set up enrichment on your pipe.

updatePipe_sourceParameters :: Lens' UpdatePipe (Maybe UpdatePipeSourceParameters) Source #

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

updatePipe_target :: Lens' UpdatePipe (Maybe Text) Source #

The ARN of the target resource.

updatePipe_targetParameters :: Lens' UpdatePipe (Maybe PipeTargetParameters) Source #

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

updatePipe_name :: Lens' UpdatePipe Text Source #

The name of the pipe.

updatePipe_roleArn :: Lens' UpdatePipe Text Source #

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

Destructuring the Response

data UpdatePipeResponse Source #

See: newUpdatePipeResponse smart constructor.

Constructors

UpdatePipeResponse'

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

newUpdatePipeResponse Source #

Arguments

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

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

UpdatePipeResponse, updatePipeResponse_arn - The ARN of the pipe.

UpdatePipeResponse, updatePipeResponse_creationTime - The time the pipe was created.

UpdatePipeResponse, updatePipeResponse_currentState - The state the pipe is in.

UpdatePipe, updatePipeResponse_desiredState - The state the pipe should be in.

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

UpdatePipe, updatePipeResponse_name - The name of the pipe.

$sel:httpStatus:UpdatePipeResponse', updatePipeResponse_httpStatus - The response's http status code.

Response Lenses

updatePipeResponse_arn :: Lens' UpdatePipeResponse (Maybe Text) Source #

The ARN of the pipe.

updatePipeResponse_creationTime :: Lens' UpdatePipeResponse (Maybe UTCTime) Source #

The time the pipe was created.

updatePipeResponse_currentState :: Lens' UpdatePipeResponse (Maybe PipeState) Source #

The state the pipe is in.

updatePipeResponse_desiredState :: Lens' UpdatePipeResponse (Maybe RequestedPipeState) Source #

The state the pipe should be in.

updatePipeResponse_lastModifiedTime :: Lens' UpdatePipeResponse (Maybe UTCTime) Source #

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

updatePipeResponse_name :: Lens' UpdatePipeResponse (Maybe Text) Source #

The name of the pipe.

updatePipeResponse_httpStatus :: Lens' UpdatePipeResponse Int Source #

The response's http status code.