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 |
Get the information about an existing pipe. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.
Synopsis
- data DescribePipe = DescribePipe' {}
- newDescribePipe :: Text -> DescribePipe
- describePipe_name :: Lens' DescribePipe Text
- data DescribePipeResponse = DescribePipeResponse' {
- arn :: Maybe Text
- creationTime :: Maybe POSIX
- currentState :: Maybe PipeState
- description :: Maybe (Sensitive Text)
- desiredState :: Maybe RequestedPipeStateDescribeResponse
- enrichment :: Maybe Text
- enrichmentParameters :: Maybe PipeEnrichmentParameters
- lastModifiedTime :: Maybe POSIX
- name :: Maybe Text
- roleArn :: Maybe Text
- source :: Maybe Text
- sourceParameters :: Maybe PipeSourceParameters
- stateReason :: Maybe Text
- tags :: Maybe (HashMap Text (Sensitive Text))
- target :: Maybe Text
- targetParameters :: Maybe PipeTargetParameters
- httpStatus :: Int
- newDescribePipeResponse :: Int -> DescribePipeResponse
- describePipeResponse_arn :: Lens' DescribePipeResponse (Maybe Text)
- describePipeResponse_creationTime :: Lens' DescribePipeResponse (Maybe UTCTime)
- describePipeResponse_currentState :: Lens' DescribePipeResponse (Maybe PipeState)
- describePipeResponse_description :: Lens' DescribePipeResponse (Maybe Text)
- describePipeResponse_desiredState :: Lens' DescribePipeResponse (Maybe RequestedPipeStateDescribeResponse)
- describePipeResponse_enrichment :: Lens' DescribePipeResponse (Maybe Text)
- describePipeResponse_enrichmentParameters :: Lens' DescribePipeResponse (Maybe PipeEnrichmentParameters)
- describePipeResponse_lastModifiedTime :: Lens' DescribePipeResponse (Maybe UTCTime)
- describePipeResponse_name :: Lens' DescribePipeResponse (Maybe Text)
- describePipeResponse_roleArn :: Lens' DescribePipeResponse (Maybe Text)
- describePipeResponse_source :: Lens' DescribePipeResponse (Maybe Text)
- describePipeResponse_sourceParameters :: Lens' DescribePipeResponse (Maybe PipeSourceParameters)
- describePipeResponse_stateReason :: Lens' DescribePipeResponse (Maybe Text)
- describePipeResponse_tags :: Lens' DescribePipeResponse (Maybe (HashMap Text Text))
- describePipeResponse_target :: Lens' DescribePipeResponse (Maybe Text)
- describePipeResponse_targetParameters :: Lens' DescribePipeResponse (Maybe PipeTargetParameters)
- describePipeResponse_httpStatus :: Lens' DescribePipeResponse Int
Creating a Request
data DescribePipe Source #
See: newDescribePipe
smart constructor.
Instances
Create a value of DescribePipe
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:
DescribePipe
, describePipe_name
- The name of the pipe.
Request Lenses
describePipe_name :: Lens' DescribePipe Text Source #
The name of the pipe.
Destructuring the Response
data DescribePipeResponse Source #
See: newDescribePipeResponse
smart constructor.
DescribePipeResponse' | |
|
Instances
newDescribePipeResponse Source #
Create a value of DescribePipeResponse
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:
DescribePipeResponse
, describePipeResponse_arn
- The ARN of the pipe.
DescribePipeResponse
, describePipeResponse_creationTime
- The time the pipe was created.
DescribePipeResponse
, describePipeResponse_currentState
- The state the pipe is in.
$sel:description:DescribePipeResponse'
, describePipeResponse_description
- A description of the pipe.
DescribePipeResponse
, describePipeResponse_desiredState
- The state the pipe should be in.
DescribePipeResponse
, describePipeResponse_enrichment
- The ARN of the enrichment resource.
$sel:enrichmentParameters:DescribePipeResponse'
, describePipeResponse_enrichmentParameters
- The parameters required to set up enrichment on your pipe.
DescribePipeResponse
, describePipeResponse_lastModifiedTime
- When the pipe was last updated, in
ISO-8601 format
(YYYY-MM-DDThh:mm:ss.sTZD).
DescribePipe
, describePipeResponse_name
- The name of the pipe.
$sel:roleArn:DescribePipeResponse'
, describePipeResponse_roleArn
- The ARN of the role that allows the pipe to send data to the target.
DescribePipeResponse
, describePipeResponse_source
- The ARN of the source resource.
$sel:sourceParameters:DescribePipeResponse'
, describePipeResponse_sourceParameters
- The parameters required to set up a source for your pipe.
DescribePipeResponse
, describePipeResponse_stateReason
- The reason the pipe is in its current state.
DescribePipeResponse
, describePipeResponse_tags
- The list of key-value pairs to associate with the pipe.
DescribePipeResponse
, describePipeResponse_target
- The ARN of the target resource.
$sel:targetParameters:DescribePipeResponse'
, describePipeResponse_targetParameters
- The parameters required to set up a target for your pipe.
$sel:httpStatus:DescribePipeResponse'
, describePipeResponse_httpStatus
- The response's http status code.
Response Lenses
describePipeResponse_arn :: Lens' DescribePipeResponse (Maybe Text) Source #
The ARN of the pipe.
describePipeResponse_creationTime :: Lens' DescribePipeResponse (Maybe UTCTime) Source #
The time the pipe was created.
describePipeResponse_currentState :: Lens' DescribePipeResponse (Maybe PipeState) Source #
The state the pipe is in.
describePipeResponse_description :: Lens' DescribePipeResponse (Maybe Text) Source #
A description of the pipe.
describePipeResponse_desiredState :: Lens' DescribePipeResponse (Maybe RequestedPipeStateDescribeResponse) Source #
The state the pipe should be in.
describePipeResponse_enrichment :: Lens' DescribePipeResponse (Maybe Text) Source #
The ARN of the enrichment resource.
describePipeResponse_enrichmentParameters :: Lens' DescribePipeResponse (Maybe PipeEnrichmentParameters) Source #
The parameters required to set up enrichment on your pipe.
describePipeResponse_lastModifiedTime :: Lens' DescribePipeResponse (Maybe UTCTime) Source #
When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
describePipeResponse_name :: Lens' DescribePipeResponse (Maybe Text) Source #
The name of the pipe.
describePipeResponse_roleArn :: Lens' DescribePipeResponse (Maybe Text) Source #
The ARN of the role that allows the pipe to send data to the target.
describePipeResponse_source :: Lens' DescribePipeResponse (Maybe Text) Source #
The ARN of the source resource.
describePipeResponse_sourceParameters :: Lens' DescribePipeResponse (Maybe PipeSourceParameters) Source #
The parameters required to set up a source for your pipe.
describePipeResponse_stateReason :: Lens' DescribePipeResponse (Maybe Text) Source #
The reason the pipe is in its current state.
describePipeResponse_tags :: Lens' DescribePipeResponse (Maybe (HashMap Text Text)) Source #
The list of key-value pairs to associate with the pipe.
describePipeResponse_target :: Lens' DescribePipeResponse (Maybe Text) Source #
The ARN of the target resource.
describePipeResponse_targetParameters :: Lens' DescribePipeResponse (Maybe PipeTargetParameters) Source #
The parameters required to set up a target for your pipe.
describePipeResponse_httpStatus :: Lens' DescribePipeResponse Int Source #
The response's http status code.