Struct aws_sdk_datapipeline::client::fluent_builders::SetStatus

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

Fluent builder constructing a request to SetStatus.

Requests that the status of the specified physical or logical pipeline objects be updated in the specified pipeline. This update might not occur immediately, but is eventually consistent. The status that can be set depends on the type of object (for example, DataNode or Activity). You cannot perform this operation on FINISHED pipelines and attempting to do so returns InvalidRequestException.

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

{“pipelineId”: “df-0634701J7KEXAMPLE”, “objectIds”: [“o-08600941GHJWMBR9E2”], “status”: “pause”}

x-amzn-RequestId: e83b8ab7-076a-11e2-af6f-6bc7a6be60d9 Content-Type: application/x-amz-json-1.1 Content-Length: 0 Date: Mon, 12 Nov 2012 17:50:53 GMT

Unexpected response: 200, OK, undefined

Implementations

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

pub async fn send(self) -> Result<SetStatusOutput, SdkError<SetStatusError>> where
    R::Policy: SmithyRetryPolicy<SetStatusInputOperationOutputAlias, SetStatusOutput, SetStatusError, SetStatusInputOperationRetryAlias>, 

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 that contains the objects.

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

The ID of the pipeline that contains the objects.

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

Appends an item to objectIds.

To override the contents of this collection use set_object_ids.

The IDs of the objects. The corresponding objects can be either physical or components, but not a mix of both types.

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

The IDs of the objects. The corresponding objects can be either physical or components, but not a mix of both types.

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

The status to be set on all the objects specified in objectIds. For components, use PAUSE or RESUME. For instances, use TRY_CANCEL, RERUN, or MARK_FINISHED.

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

The status to be set on all the objects specified in objectIds. For components, use PAUSE or RESUME. For instances, use TRY_CANCEL, RERUN, or MARK_FINISHED.

Trait Implementations

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

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

Formats the value using the given formatter.