aws-sdk-sagemakerjobruntime 1.0.0

AWS SDK for Sagemaker Job Runtime Service
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::complete_rollout::_complete_rollout_input::CompleteRolloutInputBuilder;

pub use crate::operation::complete_rollout::_complete_rollout_output::CompleteRolloutOutputBuilder;

impl crate::operation::complete_rollout::builders::CompleteRolloutInputBuilder {
    /// Sends a request with this input using the given client.
    pub async fn send_with(
        self,
        client: &crate::Client,
    ) -> ::std::result::Result<
        crate::operation::complete_rollout::CompleteRolloutOutput,
        ::aws_smithy_runtime_api::client::result::SdkError<
            crate::operation::complete_rollout::CompleteRolloutError,
            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
        >,
    > {
        let mut fluent_builder = client.complete_rollout();
        fluent_builder.inner = self;
        fluent_builder.send().await
    }
}
/// Fluent builder constructing a request to `CompleteRollout`.
///
/// Marks a rollout as complete, indicating that no further turns will be appended to the trajectory. After calling this operation, the trajectory is sealed and eligible for reward submission via the UpdateReward operation.
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct CompleteRolloutFluentBuilder {
    handle: ::std::sync::Arc<crate::client::Handle>,
    inner: crate::operation::complete_rollout::builders::CompleteRolloutInputBuilder,
    config_override: ::std::option::Option<crate::config::Builder>,
}
impl
    crate::client::customize::internal::CustomizableSend<
        crate::operation::complete_rollout::CompleteRolloutOutput,
        crate::operation::complete_rollout::CompleteRolloutError,
    > for CompleteRolloutFluentBuilder
{
    fn send(
        self,
        config_override: crate::config::Builder,
    ) -> crate::client::customize::internal::BoxFuture<
        crate::client::customize::internal::SendResult<
            crate::operation::complete_rollout::CompleteRolloutOutput,
            crate::operation::complete_rollout::CompleteRolloutError,
        >,
    > {
        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
    }
}
impl CompleteRolloutFluentBuilder {
    /// Creates a new `CompleteRolloutFluentBuilder`.
    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
        Self {
            handle,
            inner: ::std::default::Default::default(),
            config_override: ::std::option::Option::None,
        }
    }
    /// Access the CompleteRollout as a reference.
    pub fn as_input(&self) -> &crate::operation::complete_rollout::builders::CompleteRolloutInputBuilder {
        &self.inner
    }
    /// 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](aws_smithy_types::retry::RetryConfig), which can be
    /// set when configuring the client.
    pub async fn send(
        self,
    ) -> ::std::result::Result<
        crate::operation::complete_rollout::CompleteRolloutOutput,
        ::aws_smithy_runtime_api::client::result::SdkError<
            crate::operation::complete_rollout::CompleteRolloutError,
            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
        >,
    > {
        let input = self
            .inner
            .build()
            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
        let runtime_plugins = crate::operation::complete_rollout::CompleteRollout::operation_runtime_plugins(
            self.handle.runtime_plugins.clone(),
            &self.handle.conf,
            self.config_override,
        );
        crate::operation::complete_rollout::CompleteRollout::orchestrate(&runtime_plugins, input).await
    }

    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
    pub fn customize(
        self,
    ) -> crate::client::customize::CustomizableOperation<
        crate::operation::complete_rollout::CompleteRolloutOutput,
        crate::operation::complete_rollout::CompleteRolloutError,
        Self,
    > {
        crate::client::customize::CustomizableOperation::new(self)
    }
    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
        self.set_config_override(::std::option::Option::Some(config_override.into()));
        self
    }

    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
        self.config_override = config_override;
        self
    }
    /// The job ARN.
    pub fn job_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.job_arn(input.into());
        self
    }
    /// The job ARN.
    pub fn set_job_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_job_arn(input);
        self
    }
    /// The job ARN.
    pub fn get_job_arn(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_job_arn()
    }
    /// The trajectory ID to mark as complete.
    pub fn trajectory_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.trajectory_id(input.into());
        self
    }
    /// The trajectory ID to mark as complete.
    pub fn set_trajectory_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_trajectory_id(input);
        self
    }
    /// The trajectory ID to mark as complete.
    pub fn get_trajectory_id(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_trajectory_id()
    }
    /// The target status for the trajectory. Defaults to READY if not specified. Set to FAILED if the rollout encountered an error and the trajectory should not be used for processing.
    pub fn status(mut self, input: crate::types::CompletionStatus) -> Self {
        self.inner = self.inner.status(input);
        self
    }
    /// The target status for the trajectory. Defaults to READY if not specified. Set to FAILED if the rollout encountered an error and the trajectory should not be used for processing.
    pub fn set_status(mut self, input: ::std::option::Option<crate::types::CompletionStatus>) -> Self {
        self.inner = self.inner.set_status(input);
        self
    }
    /// The target status for the trajectory. Defaults to READY if not specified. Set to FAILED if the rollout encountered an error and the trajectory should not be used for processing.
    pub fn get_status(&self) -> &::std::option::Option<crate::types::CompletionStatus> {
        self.inner.get_status()
    }
    /// A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
    pub fn client_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.client_token(input.into());
        self
    }
    /// A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
    pub fn set_client_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_client_token(input);
        self
    }
    /// A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
    pub fn get_client_token(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_client_token()
    }
}