aws_sdk_sagemaker/client/

create_workforce.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`CreateWorkforce`](crate::operation::create_workforce::builders::CreateWorkforceFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`cognito_config(CognitoConfig)`](crate::operation::create_workforce::builders::CreateWorkforceFluentBuilder::cognito_config) / [`set_cognito_config(Option<CognitoConfig>)`](crate::operation::create_workforce::builders::CreateWorkforceFluentBuilder::set_cognito_config):<br>required: **false**<br><p>Use this parameter to configure an Amazon Cognito private workforce. A single Cognito workforce is created using and corresponds to a single <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools.html"> Amazon Cognito user pool</a>.</p> <p>Do not use <code>OidcConfig</code> if you specify values for <code>CognitoConfig</code>.</p><br>
    ///   - [`oidc_config(OidcConfig)`](crate::operation::create_workforce::builders::CreateWorkforceFluentBuilder::oidc_config) / [`set_oidc_config(Option<OidcConfig>)`](crate::operation::create_workforce::builders::CreateWorkforceFluentBuilder::set_oidc_config):<br>required: **false**<br><p>Use this parameter to configure a private workforce using your own OIDC Identity Provider.</p> <p>Do not use <code>CognitoConfig</code> if you specify values for <code>OidcConfig</code>.</p><br>
    ///   - [`source_ip_config(SourceIpConfig)`](crate::operation::create_workforce::builders::CreateWorkforceFluentBuilder::source_ip_config) / [`set_source_ip_config(Option<SourceIpConfig>)`](crate::operation::create_workforce::builders::CreateWorkforceFluentBuilder::set_source_ip_config):<br>required: **false**<br><p>A list of IP address ranges (<a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html">CIDRs</a>). Used to create an allow list of IP addresses for a private workforce. Workers will only be able to log in to their worker portal from an IP address within this range. By default, a workforce isn't restricted to specific IP addresses.</p><br>
    ///   - [`workforce_name(impl Into<String>)`](crate::operation::create_workforce::builders::CreateWorkforceFluentBuilder::workforce_name) / [`set_workforce_name(Option<String>)`](crate::operation::create_workforce::builders::CreateWorkforceFluentBuilder::set_workforce_name):<br>required: **true**<br><p>The name of the private workforce.</p><br>
    ///   - [`tags(Tag)`](crate::operation::create_workforce::builders::CreateWorkforceFluentBuilder::tags) / [`set_tags(Option<Vec::<Tag>>)`](crate::operation::create_workforce::builders::CreateWorkforceFluentBuilder::set_tags):<br>required: **false**<br><p>An array of key-value pairs that contain metadata to help you categorize and organize our workforce. Each tag consists of a key and a value, both of which you define.</p><br>
    ///   - [`workforce_vpc_config(WorkforceVpcConfigRequest)`](crate::operation::create_workforce::builders::CreateWorkforceFluentBuilder::workforce_vpc_config) / [`set_workforce_vpc_config(Option<WorkforceVpcConfigRequest>)`](crate::operation::create_workforce::builders::CreateWorkforceFluentBuilder::set_workforce_vpc_config):<br>required: **false**<br><p>Use this parameter to configure a workforce using VPC.</p><br>
    /// - On success, responds with [`CreateWorkforceOutput`](crate::operation::create_workforce::CreateWorkforceOutput) with field(s):
    ///   - [`workforce_arn(Option<String>)`](crate::operation::create_workforce::CreateWorkforceOutput::workforce_arn): <p>The Amazon Resource Name (ARN) of the workforce.</p>
    /// - On failure, responds with [`SdkError<CreateWorkforceError>`](crate::operation::create_workforce::CreateWorkforceError)
    pub fn create_workforce(&self) -> crate::operation::create_workforce::builders::CreateWorkforceFluentBuilder {
        crate::operation::create_workforce::builders::CreateWorkforceFluentBuilder::new(self.handle.clone())
    }
}