aws_sdk_sagemaker/client/

create_workteam.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`CreateWorkteam`](crate::operation::create_workteam::builders::CreateWorkteamFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`workteam_name(impl Into<String>)`](crate::operation::create_workteam::builders::CreateWorkteamFluentBuilder::workteam_name) / [`set_workteam_name(Option<String>)`](crate::operation::create_workteam::builders::CreateWorkteamFluentBuilder::set_workteam_name):<br>required: **true**<br><p>The name of the work team. Use this name to identify the work team.</p><br>
    ///   - [`workforce_name(impl Into<String>)`](crate::operation::create_workteam::builders::CreateWorkteamFluentBuilder::workforce_name) / [`set_workforce_name(Option<String>)`](crate::operation::create_workteam::builders::CreateWorkteamFluentBuilder::set_workforce_name):<br>required: **false**<br><p>The name of the workforce.</p><br>
    ///   - [`member_definitions(MemberDefinition)`](crate::operation::create_workteam::builders::CreateWorkteamFluentBuilder::member_definitions) / [`set_member_definitions(Option<Vec::<MemberDefinition>>)`](crate::operation::create_workteam::builders::CreateWorkteamFluentBuilder::set_member_definitions):<br>required: **true**<br><p>A list of <code>MemberDefinition</code> objects that contains objects that identify the workers that make up the work team.</p> <p>Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). For private workforces created using Amazon Cognito use <code>CognitoMemberDefinition</code>. For workforces created using your own OIDC identity provider (IdP) use <code>OidcMemberDefinition</code>. Do not provide input for both of these parameters in a single request.</p> <p>For workforces created using Amazon Cognito, private work teams correspond to Amazon Cognito <i>user groups</i> within the user pool used to create a workforce. All of the <code>CognitoMemberDefinition</code> objects that make up the member definition must have the same <code>ClientId</code> and <code>UserPool</code> values. To add a Amazon Cognito user group to an existing worker pool, see <code>Adding groups to a User Pool</code>. For more information about user pools, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools.html">Amazon Cognito User Pools</a>.</p> <p>For workforces created using your own OIDC IdP, specify the user groups that you want to include in your private work team in <code>OidcMemberDefinition</code> by listing those groups in <code>Groups</code>.</p><br>
    ///   - [`description(impl Into<String>)`](crate::operation::create_workteam::builders::CreateWorkteamFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::create_workteam::builders::CreateWorkteamFluentBuilder::set_description):<br>required: **true**<br><p>A description of the work team.</p><br>
    ///   - [`notification_configuration(NotificationConfiguration)`](crate::operation::create_workteam::builders::CreateWorkteamFluentBuilder::notification_configuration) / [`set_notification_configuration(Option<NotificationConfiguration>)`](crate::operation::create_workteam::builders::CreateWorkteamFluentBuilder::set_notification_configuration):<br>required: **false**<br><p>Configures notification of workers regarding available or expiring work items.</p><br>
    ///   - [`worker_access_configuration(WorkerAccessConfiguration)`](crate::operation::create_workteam::builders::CreateWorkteamFluentBuilder::worker_access_configuration) / [`set_worker_access_configuration(Option<WorkerAccessConfiguration>)`](crate::operation::create_workteam::builders::CreateWorkteamFluentBuilder::set_worker_access_configuration):<br>required: **false**<br><p>Use this optional parameter to constrain access to an Amazon S3 resource based on the IP address using supported IAM global condition keys. The Amazon S3 resource is accessed in the worker portal using a Amazon S3 presigned URL.</p><br>
    ///   - [`tags(Tag)`](crate::operation::create_workteam::builders::CreateWorkteamFluentBuilder::tags) / [`set_tags(Option<Vec::<Tag>>)`](crate::operation::create_workteam::builders::CreateWorkteamFluentBuilder::set_tags):<br>required: **false**<br><p>An array of key-value pairs.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html">Resource Tag</a> and <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what">Using Cost Allocation Tags</a> in the <i> Amazon Web Services Billing and Cost Management User Guide</i>.</p><br>
    /// - On success, responds with [`CreateWorkteamOutput`](crate::operation::create_workteam::CreateWorkteamOutput) with field(s):
    ///   - [`workteam_arn(Option<String>)`](crate::operation::create_workteam::CreateWorkteamOutput::workteam_arn): <p>The Amazon Resource Name (ARN) of the work team. You can use this ARN to identify the work team.</p>
    /// - On failure, responds with [`SdkError<CreateWorkteamError>`](crate::operation::create_workteam::CreateWorkteamError)
    pub fn create_workteam(&self) -> crate::operation::create_workteam::builders::CreateWorkteamFluentBuilder {
        crate::operation::create_workteam::builders::CreateWorkteamFluentBuilder::new(self.handle.clone())
    }
}