Amazonka.Pipes.DescribePipe

Get the information about an existing pipe. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.

Creating a Request

data DescribePipe

See: newDescribePipe smart constructor.

Constructors

DescribePipe'

Fields

• name :: Text

  The name of the pipe.

Instances

ToHeaders DescribePipe

Defined in Amazonka.Pipes.DescribePipe

Methods

toHeaders :: DescribePipe -> [Header]

ToPath DescribePipe

Defined in Amazonka.Pipes.DescribePipe

Methods

toPath :: DescribePipe -> ByteString

ToQuery DescribePipe

Defined in Amazonka.Pipes.DescribePipe

Methods

toQuery :: DescribePipe -> QueryString

AWSRequest DescribePipe

Defined in Amazonka.Pipes.DescribePipe

Associated Types

type AWSResponse DescribePipe

Methods

request :: (Service -> Service) -> DescribePipe -> Request DescribePipe

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribePipe -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribePipe)))

Generic DescribePipe

Defined in Amazonka.Pipes.DescribePipe

Associated Types

type Rep DescribePipe :: Type -> Type

Methods

from :: DescribePipe -> Rep DescribePipe x

to :: Rep DescribePipe x -> DescribePipe

Read DescribePipe

Defined in Amazonka.Pipes.DescribePipe

Methods

readsPrec :: Int -> ReadS DescribePipe

readList :: ReadS [DescribePipe]

readPrec :: ReadPrec DescribePipe

readListPrec :: ReadPrec [DescribePipe]

Show DescribePipe

Defined in Amazonka.Pipes.DescribePipe

Methods

showsPrec :: Int -> DescribePipe -> ShowS

show :: DescribePipe -> String

showList :: [DescribePipe] -> ShowS

NFData DescribePipe

Defined in Amazonka.Pipes.DescribePipe

Methods

rnf :: DescribePipe -> ()

Eq DescribePipe

Defined in Amazonka.Pipes.DescribePipe

Methods

(==) :: DescribePipe -> DescribePipe -> Bool

(/=) :: DescribePipe -> DescribePipe -> Bool

Hashable DescribePipe

Defined in Amazonka.Pipes.DescribePipe

Methods

hashWithSalt :: Int -> DescribePipe -> Int

hash :: DescribePipe -> Int

type AWSResponse DescribePipe

Defined in Amazonka.Pipes.DescribePipe

type AWSResponse DescribePipe = DescribePipeResponse

type Rep DescribePipe

Defined in Amazonka.Pipes.DescribePipe

type Rep DescribePipe = D1 ('MetaData "DescribePipe" "Amazonka.Pipes.DescribePipe" "amazonka-pipes-2.0-DDuNjbjVfgsJFLlibzr06i" 'False) (C1 ('MetaCons "DescribePipe'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribePipe

Arguments

:: Text

DescribePipe

-> DescribePipe

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

The name of the pipe.

Destructuring the Response

data DescribePipeResponse

See: newDescribePipeResponse smart constructor.

Constructors

DescribePipeResponse'

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.

• description :: Maybe (Sensitive Text)

  A description of the pipe.

• desiredState :: Maybe RequestedPipeStateDescribeResponse

  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.

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

• roleArn :: Maybe Text

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

• source :: Maybe Text

  The ARN of the source resource.

• sourceParameters :: Maybe PipeSourceParameters

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

• stateReason :: Maybe Text

  The reason the pipe is in its current state.

• tags :: Maybe (HashMap Text (Sensitive Text))

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

• target :: Maybe Text

  The ARN of the target resource.

• targetParameters :: Maybe PipeTargetParameters

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

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribePipeResponse

Defined in Amazonka.Pipes.DescribePipe

Associated Types

type Rep DescribePipeResponse :: Type -> Type

Methods

from :: DescribePipeResponse -> Rep DescribePipeResponse x

to :: Rep DescribePipeResponse x -> DescribePipeResponse

Show DescribePipeResponse

Defined in Amazonka.Pipes.DescribePipe

Methods

showsPrec :: Int -> DescribePipeResponse -> ShowS

show :: DescribePipeResponse -> String

showList :: [DescribePipeResponse] -> ShowS

NFData DescribePipeResponse

Defined in Amazonka.Pipes.DescribePipe

Methods

rnf :: DescribePipeResponse -> ()

Eq DescribePipeResponse

Defined in Amazonka.Pipes.DescribePipe

Methods

(==) :: DescribePipeResponse -> DescribePipeResponse -> Bool

(/=) :: DescribePipeResponse -> DescribePipeResponse -> Bool

type Rep DescribePipeResponse

Defined in Amazonka.Pipes.DescribePipe

type Rep DescribePipeResponse = D1 ('MetaData "DescribePipeResponse" "Amazonka.Pipes.DescribePipe" "amazonka-pipes-2.0-DDuNjbjVfgsJFLlibzr06i" 'False) (C1 ('MetaCons "DescribePipeResponse'" '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 "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))))) :*: ((S1 ('MetaSel ('Just "desiredState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RequestedPipeStateDescribeResponse)) :*: S1 ('MetaSel ('Just "enrichment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "enrichmentParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PipeEnrichmentParameters)) :*: S1 ('MetaSel ('Just "lastModifiedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))) :*: (((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "source") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "sourceParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PipeSourceParameters)))) :*: ((S1 ('MetaSel ('Just "stateReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text (Sensitive Text))))) :*: (S1 ('MetaSel ('Just "target") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "targetParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PipeTargetParameters)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))))

newDescribePipeResponse

Arguments

:: Int

$sel:httpStatus:DescribePipeResponse'

-> DescribePipeResponse

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)

The ARN of the pipe.

describePipeResponse_creationTime :: Lens' DescribePipeResponse (Maybe UTCTime)

The time the pipe was created.

describePipeResponse_currentState :: Lens' DescribePipeResponse (Maybe PipeState)

The state the pipe is in.

describePipeResponse_description :: Lens' DescribePipeResponse (Maybe Text)

A description of the pipe.

describePipeResponse_desiredState :: Lens' DescribePipeResponse (Maybe RequestedPipeStateDescribeResponse)

The state the pipe should be in.

describePipeResponse_enrichment :: Lens' DescribePipeResponse (Maybe Text)

The ARN of the enrichment resource.

describePipeResponse_enrichmentParameters :: Lens' DescribePipeResponse (Maybe PipeEnrichmentParameters)

The parameters required to set up enrichment on your pipe.

describePipeResponse_lastModifiedTime :: Lens' DescribePipeResponse (Maybe UTCTime)

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

describePipeResponse_name :: Lens' DescribePipeResponse (Maybe Text)

The name of the pipe.

describePipeResponse_roleArn :: Lens' DescribePipeResponse (Maybe Text)

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

describePipeResponse_source :: Lens' DescribePipeResponse (Maybe Text)

The ARN of the source resource.

describePipeResponse_sourceParameters :: Lens' DescribePipeResponse (Maybe PipeSourceParameters)

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

describePipeResponse_stateReason :: Lens' DescribePipeResponse (Maybe Text)

The reason the pipe is in its current state.

describePipeResponse_tags :: Lens' DescribePipeResponse (Maybe (HashMap Text Text))

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

describePipeResponse_target :: Lens' DescribePipeResponse (Maybe Text)

The ARN of the target resource.

describePipeResponse_targetParameters :: Lens' DescribePipeResponse (Maybe PipeTargetParameters)

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

describePipeResponse_httpStatus :: Lens' DescribePipeResponse Int

The response's http status code.