Struct CreateWorkteamInput

#[non_exhaustive]
pub struct CreateWorkteamInput {
    pub workteam_name: Option<String>,
    pub workforce_name: Option<String>,
    pub member_definitions: Option<Vec<MemberDefinition>>,
    pub description: Option<String>,
    pub notification_configuration: Option<NotificationConfiguration>,
    pub worker_access_configuration: Option<WorkerAccessConfiguration>,
    pub tags: Option<Vec<Tag>>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

workteam_name: Option<String>

The name of the work team. Use this name to identify the work team.

workforce_name: Option<String>

The name of the workforce.

member_definitions: Option<Vec<MemberDefinition>>

A list of MemberDefinition objects that contains objects that identify the workers that make up the work team.

Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). For private workforces created using Amazon Cognito use CognitoMemberDefinition. For workforces created using your own OIDC identity provider (IdP) use OidcMemberDefinition. Do not provide input for both of these parameters in a single request.

For workforces created using Amazon Cognito, private work teams correspond to Amazon Cognito user groups within the user pool used to create a workforce. All of the CognitoMemberDefinition objects that make up the member definition must have the same ClientId and UserPool values. To add a Amazon Cognito user group to an existing worker pool, see Adding groups to a User Pool. For more information about user pools, see Amazon Cognito User Pools.

For workforces created using your own OIDC IdP, specify the user groups that you want to include in your private work team in OidcMemberDefinition by listing those groups in Groups.

description: Option<String>

A description of the work team.

notification_configuration: Option<NotificationConfiguration>

Configures notification of workers regarding available or expiring work items.

worker_access_configuration: Option<WorkerAccessConfiguration>

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.

tags: Option<Vec<Tag>>

An array of key-value pairs.

For more information, see Resource Tag and Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

Implementations

impl CreateWorkteamInput

pub fn workteam_name(&self) -> Option<&str>

The name of the work team. Use this name to identify the work team.

pub fn workforce_name(&self) -> Option<&str>

The name of the workforce.

pub fn member_definitions(&self) -> &[MemberDefinition]

A list of MemberDefinition objects that contains objects that identify the workers that make up the work team.

Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). For private workforces created using Amazon Cognito use CognitoMemberDefinition. For workforces created using your own OIDC identity provider (IdP) use OidcMemberDefinition. Do not provide input for both of these parameters in a single request.

For workforces created using Amazon Cognito, private work teams correspond to Amazon Cognito user groups within the user pool used to create a workforce. All of the CognitoMemberDefinition objects that make up the member definition must have the same ClientId and UserPool values. To add a Amazon Cognito user group to an existing worker pool, see Adding groups to a User Pool. For more information about user pools, see Amazon Cognito User Pools.

For workforces created using your own OIDC IdP, specify the user groups that you want to include in your private work team in OidcMemberDefinition by listing those groups in Groups.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .member_definitions.is_none().

pub fn description(&self) -> Option<&str>

A description of the work team.

pub fn notification_configuration(&self) -> Option<&NotificationConfiguration>

Configures notification of workers regarding available or expiring work items.

pub fn worker_access_configuration(&self) -> Option<&WorkerAccessConfiguration>

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.

pub fn tags(&self) -> &[Tag]

An array of key-value pairs.

For more information, see Resource Tag and Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none().

impl CreateWorkteamInput

pub fn builder() -> CreateWorkteamInputBuilder

Creates a new builder-style object to manufacture CreateWorkteamInput.

Trait Implementations

impl Clone for CreateWorkteamInput

fn clone(&self) -> CreateWorkteamInput

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateWorkteamInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for CreateWorkteamInput

fn eq(&self, other: &CreateWorkteamInput) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CreateWorkteamInput