aws_sdk_sagemaker/client/

describe_workforce.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeWorkforce`](crate::operation::describe_workforce::builders::DescribeWorkforceFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`workforce_name(impl Into<String>)`](crate::operation::describe_workforce::builders::DescribeWorkforceFluentBuilder::workforce_name) / [`set_workforce_name(Option<String>)`](crate::operation::describe_workforce::builders::DescribeWorkforceFluentBuilder::set_workforce_name):<br>required: **true**<br><p>The name of the private workforce whose access you want to restrict. <code>WorkforceName</code> is automatically set to <code>default</code> when a workforce is created and cannot be modified.</p><br>
    /// - On success, responds with [`DescribeWorkforceOutput`](crate::operation::describe_workforce::DescribeWorkforceOutput) with field(s):
    ///   - [`workforce(Option<Workforce>)`](crate::operation::describe_workforce::DescribeWorkforceOutput::workforce): <p>A single private workforce, which is automatically created when you create your first private work team. 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>
    /// - On failure, responds with [`SdkError<DescribeWorkforceError>`](crate::operation::describe_workforce::DescribeWorkforceError)
    pub fn describe_workforce(&self) -> crate::operation::describe_workforce::builders::DescribeWorkforceFluentBuilder {
        crate::operation::describe_workforce::builders::DescribeWorkforceFluentBuilder::new(self.handle.clone())
    }
}