Struct aws_sdk_datapipeline::client::fluent_builders::PutPipelineDefinition

pub struct PutPipelineDefinition<C = DynConnector, M = AwsMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to PutPipelineDefinition.

Adds tasks, schedules, and preconditions to the specified pipeline. You can use PutPipelineDefinition to populate a new pipeline.

PutPipelineDefinition also validates the configuration as it adds it to the pipeline. Changes to the pipeline are saved unless one of the following three validation errors exists in the pipeline.

1. An object is missing a name or identifier field.
2. A string or reference field is empty.
3. The number of objects in the pipeline exceeds the maximum allowed objects.
4. The pipeline is in a FINISHED state.

Pipeline object definitions are passed to the PutPipelineDefinition action and returned by the GetPipelineDefinition action.

Example 1 This example sets an valid pipeline configuration and returns success.

POST / HTTP/1.1 Content-Type: application/x-amz-json-1.1 X-Amz-Target: DataPipeline.PutPipelineDefinition Content-Length: 914 Host: datapipeline.us-east-1.amazonaws.com X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT Authorization: AuthParams

{“pipelineId”: “df-0937003356ZJEXAMPLE”, “pipelineObjects”: [ {“id”: “Default”, “name”: “Default”, “fields”: [ {“key”: “workerGroup”, “stringValue”: “workerGroup”} ] }, {“id”: “Schedule”, “name”: “Schedule”, “fields”: [ {“key”: “startDateTime”, “stringValue”: “2012-12-12T00:00:00”}, {“key”: “type”, “stringValue”: “Schedule”}, {“key”: “period”, “stringValue”: “1 hour”}, {“key”: “endDateTime”, “stringValue”: “2012-12-21T18:00:00”} ] }, {“id”: “SayHello”, “name”: “SayHello”, “fields”: [ {“key”: “type”, “stringValue”: “ShellCommandActivity”}, {“key”: “command”, “stringValue”: “echo hello”}, {“key”: “parent”, “refValue”: “Default”}, {“key”: “schedule”, “refValue”: “Schedule”} ] } ] }

HTTP/1.1 200 x-amzn-RequestId: f74afc14-0754-11e2-af6f-6bc7a6be60d9 Content-Type: application/x-amz-json-1.1 Content-Length: 18 Date: Mon, 12 Nov 2012 17:50:53 GMT

{“errored”: false}

Example 2 This example sets an invalid pipeline configuration (the value for workerGroup is an empty string) and returns an error message.

POST / HTTP/1.1 Content-Type: application/x-amz-json-1.1 X-Amz-Target: DataPipeline.PutPipelineDefinition Content-Length: 903 Host: datapipeline.us-east-1.amazonaws.com X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT Authorization: AuthParams

{“pipelineId”: “df-06372391ZG65EXAMPLE”, “pipelineObjects”: [ {“id”: “Default”, “name”: “Default”, “fields”: [ {“key”: “workerGroup”, “stringValue”: “”} ] }, {“id”: “Schedule”, “name”: “Schedule”, “fields”: [ {“key”: “startDateTime”, “stringValue”: “2012-09-25T17:00:00”}, {“key”: “type”, “stringValue”: “Schedule”}, {“key”: “period”, “stringValue”: “1 hour”}, {“key”: “endDateTime”, “stringValue”: “2012-09-25T18:00:00”} ] }, {“id”: “SayHello”, “name”: “SayHello”, “fields”: [ {“key”: “type”, “stringValue”: “ShellCommandActivity”}, {“key”: “command”, “stringValue”: “echo hello”}, {“key”: “parent”, “refValue”: “Default”}, {“key”: “schedule”, “refValue”: “Schedule”}

] } ] }

HTTP/1.1 200 x-amzn-RequestId: f74afc14-0754-11e2-af6f-6bc7a6be60d9 Content-Type: application/x-amz-json-1.1 Content-Length: 18 Date: Mon, 12 Nov 2012 17:50:53 GMT

{“__type”: “com.amazon.setl.webservice#InvalidRequestException”, “message”: “Pipeline definition has errors: Could not save the pipeline definition due to FATAL errors: [com.amazon.setl.webservice.ValidationError@108d7ea9] Please call Validate to validate your pipeline”}

Implementations

impl<C, M, R> PutPipelineDefinition<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<PutPipelineDefinitionOutput, SdkError<PutPipelineDefinitionError>> where
    R::Policy: SmithyRetryPolicy<PutPipelineDefinitionInputOperationOutputAlias, PutPipelineDefinitionOutput, PutPipelineDefinitionError, PutPipelineDefinitionInputOperationRetryAlias>, 

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn pipeline_id(self, inp: impl Into<String>) -> Self

The ID of the pipeline.

pub fn set_pipeline_id(self, input: Option<String>) -> Self

The ID of the pipeline.

pub fn pipeline_objects(self, inp: impl Into<PipelineObject>) -> Self

Appends an item to pipelineObjects.

To override the contents of this collection use set_pipeline_objects.

The objects that define the pipeline. These objects overwrite the existing pipeline definition.

pub fn set_pipeline_objects(self, input: Option<Vec<PipelineObject>>) -> Self

The objects that define the pipeline. These objects overwrite the existing pipeline definition.

pub fn parameter_objects(self, inp: impl Into<ParameterObject>) -> Self

Appends an item to parameterObjects.

To override the contents of this collection use set_parameter_objects.

The parameter objects used with the pipeline.

pub fn set_parameter_objects(self, input: Option<Vec<ParameterObject>>) -> Self

The parameter objects used with the pipeline.

pub fn parameter_values(self, inp: impl Into<ParameterValue>) -> Self

Appends an item to parameterValues.

To override the contents of this collection use set_parameter_values.

The parameter values used with the pipeline.

pub fn set_parameter_values(self, input: Option<Vec<ParameterValue>>) -> Self

The parameter values used with the pipeline.

Trait Implementations

impl<C: Debug, M: Debug, R: Debug> Debug for PutPipelineDefinition<C, M, R>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.