libZSservicesZSamazonka-iot-analyticsZSamazonka-iot-analytics
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.IoTAnalytics.CreatePipeline

Description

Creates a pipeline. A pipeline consumes messages from a channel and allows you to process the messages before storing them in a data store. You must specify both a channel and a datastore activity and, optionally, as many as 23 additional activities in the pipelineActivities array.

Synopsis

Creating a Request

data CreatePipeline Source #

See: newCreatePipeline smart constructor.

Constructors

CreatePipeline' 

Fields

  • tags :: Maybe (NonEmpty Tag)

    Metadata which can be used to manage the pipeline.

  • pipelineName :: Text

    The name of the pipeline.

  • pipelineActivities :: NonEmpty PipelineActivity

    A list of PipelineActivity objects. Activities perform transformations on your messages, such as removing, renaming or adding message attributes; filtering messages based on attribute values; invoking your Lambda unctions on messages for advanced processing; or performing mathematical transformations to normalize device data.

    The list can be 2-25 PipelineActivity objects and must contain both a channel and a datastore activity. Each entry in the list must contain only one activity. For example:

    pipelineActivities = [ { "channel": { ... } }, { "lambda": { ... } }, ... ]

Instances

Instances details
Eq CreatePipeline Source # 
Instance details

Defined in Amazonka.IoTAnalytics.CreatePipeline

Methods

(==) :: CreatePipeline -> CreatePipeline -> Bool #

(/=) :: CreatePipeline -> CreatePipeline -> Bool #

Read CreatePipeline Source # 
Instance details

Defined in Amazonka.IoTAnalytics.CreatePipeline

Methods

readsPrec :: Int -> ReadS CreatePipeline #

readList :: ReadS [CreatePipeline] #

readPrec :: ReadPrec CreatePipeline #

readListPrec :: ReadPrec [CreatePipeline] #

Show CreatePipeline Source # 
Instance details

Defined in Amazonka.IoTAnalytics.CreatePipeline

Methods

showsPrec :: Int -> CreatePipeline -> ShowS #

show :: CreatePipeline -> String #

showList :: [CreatePipeline] -> ShowS #

Generic CreatePipeline Source # 
Instance details

Defined in Amazonka.IoTAnalytics.CreatePipeline

Associated Types

type Rep CreatePipeline :: Type -> Type #

Methods

from :: CreatePipeline -> Rep CreatePipeline x #

to :: Rep CreatePipeline x -> CreatePipeline #

NFData CreatePipeline Source # 
Instance details

Defined in Amazonka.IoTAnalytics.CreatePipeline

Methods

rnf :: CreatePipeline -> () #

Hashable CreatePipeline Source # 
Instance details

Defined in Amazonka.IoTAnalytics.CreatePipeline

Methods

hashWithSalt :: Int -> CreatePipeline -> Int #

hash :: CreatePipeline -> Int #

ToJSON CreatePipeline Source # 
Instance details

Defined in Amazonka.IoTAnalytics.CreatePipeline

Methods

toJSON :: CreatePipeline -> Value #

toEncoding :: CreatePipeline -> Encoding #

toJSONList :: [CreatePipeline] -> Value #

toEncodingList :: [CreatePipeline] -> Encoding #

AWSRequest CreatePipeline Source # 
Instance details

Defined in Amazonka.IoTAnalytics.CreatePipeline

Associated Types

type AWSResponse CreatePipeline #

Methods

request :: CreatePipeline -> Request CreatePipeline #

response :: MonadResource m => Logger -> Service -> Proxy CreatePipeline -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreatePipeline))) #

ToHeaders CreatePipeline Source # 
Instance details

Defined in Amazonka.IoTAnalytics.CreatePipeline

Methods

toHeaders :: CreatePipeline -> [Header] #

ToPath CreatePipeline Source # 
Instance details

Defined in Amazonka.IoTAnalytics.CreatePipeline

Methods

toPath :: CreatePipeline -> ByteString #

ToQuery CreatePipeline Source # 
Instance details

Defined in Amazonka.IoTAnalytics.CreatePipeline

Methods

toQuery :: CreatePipeline -> QueryString #

type Rep CreatePipeline Source # 
Instance details

Defined in Amazonka.IoTAnalytics.CreatePipeline

type Rep CreatePipeline = D1 ('MetaData "CreatePipeline" "Amazonka.IoTAnalytics.CreatePipeline" "libZSservicesZSamazonka-iot-analyticsZSamazonka-iot-analytics" 'False) (C1 ('MetaCons "CreatePipeline'" 'PrefixI 'True) (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag))) :*: (S1 ('MetaSel ('Just "pipelineName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "pipelineActivities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty PipelineActivity)))))
type AWSResponse CreatePipeline Source # 
Instance details

Defined in Amazonka.IoTAnalytics.CreatePipeline

type AWSResponse CreatePipeline = CreatePipelineResponse

newCreatePipeline Source #

Arguments

:: Text

$sel:pipelineName:CreatePipeline'

-> NonEmpty PipelineActivity

$sel:pipelineActivities:CreatePipeline'

-> CreatePipeline 

Create a value of CreatePipeline 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:tags:CreatePipeline', createPipeline_tags - Metadata which can be used to manage the pipeline.

$sel:pipelineName:CreatePipeline', createPipeline_pipelineName - The name of the pipeline.

$sel:pipelineActivities:CreatePipeline', createPipeline_pipelineActivities - A list of PipelineActivity objects. Activities perform transformations on your messages, such as removing, renaming or adding message attributes; filtering messages based on attribute values; invoking your Lambda unctions on messages for advanced processing; or performing mathematical transformations to normalize device data.

The list can be 2-25 PipelineActivity objects and must contain both a channel and a datastore activity. Each entry in the list must contain only one activity. For example:

pipelineActivities = [ { "channel": { ... } }, { "lambda": { ... } }, ... ]

Request Lenses

createPipeline_tags :: Lens' CreatePipeline (Maybe (NonEmpty Tag)) Source #

Metadata which can be used to manage the pipeline.

createPipeline_pipelineName :: Lens' CreatePipeline Text Source #

The name of the pipeline.

createPipeline_pipelineActivities :: Lens' CreatePipeline (NonEmpty PipelineActivity) Source #

A list of PipelineActivity objects. Activities perform transformations on your messages, such as removing, renaming or adding message attributes; filtering messages based on attribute values; invoking your Lambda unctions on messages for advanced processing; or performing mathematical transformations to normalize device data.

The list can be 2-25 PipelineActivity objects and must contain both a channel and a datastore activity. Each entry in the list must contain only one activity. For example:

pipelineActivities = [ { "channel": { ... } }, { "lambda": { ... } }, ... ]

Destructuring the Response

data CreatePipelineResponse Source #

See: newCreatePipelineResponse smart constructor.

Constructors

CreatePipelineResponse' 

Fields

Instances

Instances details
Eq CreatePipelineResponse Source # 
Instance details

Defined in Amazonka.IoTAnalytics.CreatePipeline

Methods

(==) :: CreatePipelineResponse -> CreatePipelineResponse -> Bool #

(/=) :: CreatePipelineResponse -> CreatePipelineResponse -> Bool #

Read CreatePipelineResponse Source # 
Instance details

Defined in Amazonka.IoTAnalytics.CreatePipeline

Methods

readsPrec :: Int -> ReadS CreatePipelineResponse #

readList :: ReadS [CreatePipelineResponse] #

readPrec :: ReadPrec CreatePipelineResponse #

readListPrec :: ReadPrec [CreatePipelineResponse] #

Show CreatePipelineResponse Source # 
Instance details

Defined in Amazonka.IoTAnalytics.CreatePipeline

Methods

showsPrec :: Int -> CreatePipelineResponse -> ShowS #

show :: CreatePipelineResponse -> String #

showList :: [CreatePipelineResponse] -> ShowS #

Generic CreatePipelineResponse Source # 
Instance details

Defined in Amazonka.IoTAnalytics.CreatePipeline

Associated Types

type Rep CreatePipelineResponse :: Type -> Type #

Methods

from :: CreatePipelineResponse -> Rep CreatePipelineResponse x #

to :: Rep CreatePipelineResponse x -> CreatePipelineResponse #

NFData CreatePipelineResponse Source # 
Instance details

Defined in Amazonka.IoTAnalytics.CreatePipeline

Methods

rnf :: CreatePipelineResponse -> () #

type Rep CreatePipelineResponse Source # 
Instance details

Defined in Amazonka.IoTAnalytics.CreatePipeline

type Rep CreatePipelineResponse = D1 ('MetaData "CreatePipelineResponse" "Amazonka.IoTAnalytics.CreatePipeline" "libZSservicesZSamazonka-iot-analyticsZSamazonka-iot-analytics" 'False) (C1 ('MetaCons "CreatePipelineResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "pipelineName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "pipelineArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreatePipelineResponse Source #

Arguments

:: Int

$sel:httpStatus:CreatePipelineResponse'

-> CreatePipelineResponse 

Create a value of CreatePipelineResponse 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:pipelineName:CreatePipeline', createPipelineResponse_pipelineName - The name of the pipeline.

$sel:pipelineArn:CreatePipelineResponse', createPipelineResponse_pipelineArn - The ARN of the pipeline.

$sel:httpStatus:CreatePipelineResponse', createPipelineResponse_httpStatus - The response's http status code.

Response Lenses

createPipelineResponse_pipelineName :: Lens' CreatePipelineResponse (Maybe Text) Source #

The name of the pipeline.

createPipelineResponse_pipelineArn :: Lens' CreatePipelineResponse (Maybe Text) Source #

The ARN of the pipeline.

createPipelineResponse_httpStatus :: Lens' CreatePipelineResponse Int Source #

The response's http status code.