[ aws . iotanalytics ]
describe-pipeline¶
Description¶
Retrieves information about a pipeline.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
describe-pipeline
--pipeline-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]
Options¶
--pipeline-name (string)
The name of the pipeline whose information is retrieved.
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
See ‘aws help’ for descriptions of global parameters.
Examples¶
To retrieve information about a pipeline
The following describe-pipeline example displays details for the specified pipeline.
aws iotanalytics describe-pipeline \
--pipeline-name mypipeline
Output:
{
"pipeline": {
"activities": [
{
"channel": {
"channelName": "mychannel",
"name": "mychannel_28",
"next": "mydatastore_29"
}
},
{
"datastore": {
"datastoreName": "mydatastore",
"name": "mydatastore_29"
}
}
],
"name": "mypipeline",
"lastUpdateTime": 1561676362.515,
"creationTime": 1557859124.432,
"reprocessingSummaries": [
{
"status": "SUCCEEDED",
"creationTime": 1561676362.189,
"id": "6ad2764f-fb13-4de3-b101-4e74af03b043"
}
],
"arn": "arn:aws:iotanalytics:us-west-2:123456789012:pipeline/mypipeline"
}
}
For more information, see DescribePipeline in the AWS IoT Analytics API Reference.
Output¶
pipeline -> (structure)
A “Pipeline” object that contains information about the pipeline.
name -> (string)
The name of the pipeline.
arn -> (string)
The ARN of the pipeline.
activities -> (list)
The activities that perform transformations on the messages.
(structure)
An activity that performs a transformation on a message.
channel -> (structure)
Determines the source of the messages to be processed.
name -> (string)
The name of the ‘channel’ activity.
channelName -> (string)
The name of the channel from which the messages are processed.
next -> (string)
The next activity in the pipeline.
lambda -> (structure)
Runs a Lambda function to modify the message.
name -> (string)
The name of the ‘lambda’ activity.
lambdaName -> (string)
The name of the Lambda function that is run on the message.
batchSize -> (integer)
The number of messages passed to the Lambda function for processing.
The AWS Lambda function must be able to process all of these messages within five minutes, which is the maximum timeout duration for Lambda functions.
next -> (string)
The next activity in the pipeline.
datastore -> (structure)
Specifies where to store the processed message data.
name -> (string)
The name of the ‘datastore’ activity.
datastoreName -> (string)
The name of the data store where processed messages are stored.
addAttributes -> (structure)
Adds other attributes based on existing attributes in the message.
name -> (string)
The name of the ‘addAttributes’ activity.
attributes -> (map)
A list of 1-50 “AttributeNameMapping” objects that map an existing attribute to a new attribute.
Note
The existing attributes remain in the message, so if you want to remove the originals, use “RemoveAttributeActivity”.
key -> (string)
value -> (string)
next -> (string)
The next activity in the pipeline.
removeAttributes -> (structure)
Removes attributes from a message.
name -> (string)
The name of the ‘removeAttributes’ activity.
attributes -> (list)
A list of 1-50 attributes to remove from the message.
(string)
next -> (string)
The next activity in the pipeline.
selectAttributes -> (structure)
Creates a new message using only the specified attributes from the original message.
name -> (string)
The name of the ‘selectAttributes’ activity.
attributes -> (list)
A list of the attributes to select from the message.
(string)
next -> (string)
The next activity in the pipeline.
filter -> (structure)
Filters a message based on its attributes.
name -> (string)
The name of the ‘filter’ activity.
filter -> (string)
An expression that looks like a SQL WHERE clause that must return a Boolean value.
next -> (string)
The next activity in the pipeline.
math -> (structure)
Computes an arithmetic expression using the message’s attributes and adds it to the message.
name -> (string)
The name of the ‘math’ activity.
attribute -> (string)
The name of the attribute that contains the result of the math operation.
math -> (string)
An expression that uses one or more existing attributes and must return an integer value.
next -> (string)
The next activity in the pipeline.
deviceRegistryEnrich -> (structure)
Adds data from the AWS IoT device registry to your message.
name -> (string)
The name of the ‘deviceRegistryEnrich’ activity.
attribute -> (string)
The name of the attribute that is added to the message.
thingName -> (string)
The name of the IoT device whose registry information is added to the message.
roleArn -> (string)
The ARN of the role that allows access to the device’s registry information.
next -> (string)
The next activity in the pipeline.
deviceShadowEnrich -> (structure)
Adds information from the AWS IoT Device Shadows service to a message.
name -> (string)
The name of the ‘deviceShadowEnrich’ activity.
attribute -> (string)
The name of the attribute that is added to the message.
thingName -> (string)
The name of the IoT device whose shadow information is added to the message.
roleArn -> (string)
The ARN of the role that allows access to the device’s shadow.
next -> (string)
The next activity in the pipeline.
reprocessingSummaries -> (list)
A summary of information about the pipeline reprocessing.
(structure)
Information about pipeline reprocessing.
id -> (string)
The ‘reprocessingId’ returned by “StartPipelineReprocessing”.
status -> (string)
The status of the pipeline reprocessing.
creationTime -> (timestamp)
The time the pipeline reprocessing was created.
creationTime -> (timestamp)
When the pipeline was created.
lastUpdateTime -> (timestamp)
The last time the pipeline was updated.