aws_sdk_sagemaker/client/
update_workforce.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`UpdateWorkforce`](crate::operation::update_workforce::builders::UpdateWorkforceFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`workforce_name(impl Into<String>)`](crate::operation::update_workforce::builders::UpdateWorkforceFluentBuilder::workforce_name) / [`set_workforce_name(Option<String>)`](crate::operation::update_workforce::builders::UpdateWorkforceFluentBuilder::set_workforce_name):<br>required: **true**<br><p>The name of the private workforce that you want to update. You can find your workforce name by using the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListWorkforces.html">ListWorkforces</a> operation.</p><br>
7    ///   - [`source_ip_config(SourceIpConfig)`](crate::operation::update_workforce::builders::UpdateWorkforceFluentBuilder::source_ip_config) / [`set_source_ip_config(Option<SourceIpConfig>)`](crate::operation::update_workforce::builders::UpdateWorkforceFluentBuilder::set_source_ip_config):<br>required: **false**<br><p>A list of one to ten worker IP address ranges (<a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html">CIDRs</a>) that can be used to access tasks assigned to this workforce.</p> <p>Maximum: Ten CIDR values</p><br>
8    ///   - [`oidc_config(OidcConfig)`](crate::operation::update_workforce::builders::UpdateWorkforceFluentBuilder::oidc_config) / [`set_oidc_config(Option<OidcConfig>)`](crate::operation::update_workforce::builders::UpdateWorkforceFluentBuilder::set_oidc_config):<br>required: **false**<br><p>Use this parameter to update your OIDC Identity Provider (IdP) configuration for a workforce made using your own IdP.</p><br>
9    ///   - [`workforce_vpc_config(WorkforceVpcConfigRequest)`](crate::operation::update_workforce::builders::UpdateWorkforceFluentBuilder::workforce_vpc_config) / [`set_workforce_vpc_config(Option<WorkforceVpcConfigRequest>)`](crate::operation::update_workforce::builders::UpdateWorkforceFluentBuilder::set_workforce_vpc_config):<br>required: **false**<br><p>Use this parameter to update your VPC configuration for a workforce.</p><br>
10    /// - On success, responds with [`UpdateWorkforceOutput`](crate::operation::update_workforce::UpdateWorkforceOutput) with field(s):
11    ///   - [`workforce(Option<Workforce>)`](crate::operation::update_workforce::UpdateWorkforceOutput::workforce): <p>A single private workforce. You can create one private work force in each Amazon Web Services Region. By default, any workforce-related API operation used in a specific region will apply to the workforce created in that region. To learn how to create a private workforce, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sms-workforce-create-private.html">Create a Private Workforce</a>.</p>
12    /// - On failure, responds with [`SdkError<UpdateWorkforceError>`](crate::operation::update_workforce::UpdateWorkforceError)
13    pub fn update_workforce(&self) -> crate::operation::update_workforce::builders::UpdateWorkforceFluentBuilder {
14        crate::operation::update_workforce::builders::UpdateWorkforceFluentBuilder::new(self.handle.clone())
15    }
16}