Package software.amazon.awssdk.services.sagemaker.model

Class Workforce

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.Workforce

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Workforce.Builder,Workforce>

@Generated("software.amazon.awssdk:codegen")
public final class Workforce
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Workforce.Builder,Workforce>

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 Create a Private Workforce.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Workforce.Builder

Method Summary

Modifier and Type	Method	Description
static Workforce.Builder	builder()
CognitoConfig	cognitoConfig()	The configuration of an Amazon Cognito workforce.
Instant	createDate()	The date that the workforce is created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	failureReason()	The reason your workforce failed.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Instant	lastUpdatedDate()	The most recent date that UpdateWorkforce was used to successfully add one or more IP address ranges (CIDRs) to a private workforce's allow list.
OidcConfigForResponse	oidcConfig()	The configuration of an OIDC Identity Provider (IdP) private workforce.
List<SdkField<?>>	sdkFields()
static Class<? extends Workforce.Builder>	serializableBuilderClass()
SourceIpConfig	sourceIpConfig()	A list of one to ten IP address ranges (CIDRs) to be added to the workforce allow list.
WorkforceStatus	status()	The status of your workforce.
String	statusAsString()	The status of your workforce.
String	subDomain()	The subdomain for your OIDC Identity Provider.
Workforce.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	workforceArn()	The Amazon Resource Name (ARN) of the private workforce.
String	workforceName()	The name of the private workforce.
WorkforceVpcConfigResponse	workforceVpcConfig()	The configuration of a VPC workforce.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

workforceName

public final String workforceName()

The name of the private workforce.

Returns:

The name of the private workforce.

workforceArn

public final String workforceArn()

The Amazon Resource Name (ARN) of the private workforce.

Returns:

The Amazon Resource Name (ARN) of the private workforce.

lastUpdatedDate

public final Instant lastUpdatedDate()

The most recent date that UpdateWorkforce was used to successfully add one or more IP address ranges (CIDRs) to a private workforce's allow list.

Returns:

The most recent date that UpdateWorkforce was used to successfully add one or more IP address ranges (CIDRs) to a private workforce's allow list.

sourceIpConfig

public final SourceIpConfig sourceIpConfig()

A list of one to ten IP address ranges (CIDRs) to be added to the workforce allow list. By default, a workforce isn't restricted to specific IP addresses.

Returns:

A list of one to ten IP address ranges (CIDRs) to be added to the workforce allow list. By default, a workforce isn't restricted to specific IP addresses.

subDomain

public final String subDomain()

The subdomain for your OIDC Identity Provider.

Returns:

The subdomain for your OIDC Identity Provider.

cognitoConfig

public final CognitoConfig cognitoConfig()

The configuration of an Amazon Cognito workforce. A single Cognito workforce is created using and corresponds to a single Amazon Cognito user pool.

Returns:

The configuration of an Amazon Cognito workforce. A single Cognito workforce is created using and corresponds to a single Amazon Cognito user pool.

oidcConfig

public final OidcConfigForResponse oidcConfig()

The configuration of an OIDC Identity Provider (IdP) private workforce.

Returns:

The configuration of an OIDC Identity Provider (IdP) private workforce.

createDate

public final Instant createDate()

The date that the workforce is created.

Returns:

The date that the workforce is created.

workforceVpcConfig

public final WorkforceVpcConfigResponse workforceVpcConfig()

The configuration of a VPC workforce.

Returns:

The configuration of a VPC workforce.

status

public final WorkforceStatus status()

The status of your workforce.

If the service returns an enum value that is not available in the current SDK version, status will return WorkforceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The status of your workforce.

See Also:

WorkforceStatus

statusAsString

public final String statusAsString()

The status of your workforce.

If the service returns an enum value that is not available in the current SDK version, status will return WorkforceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The status of your workforce.

See Also:

WorkforceStatus

failureReason

public final String failureReason()

The reason your workforce failed.

Returns:

The reason your workforce failed.

toBuilder

public Workforce.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Workforce.Builder,Workforce>

builder

public static Workforce.Builder builder()

serializableBuilderClass

public static Class<? extends Workforce.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo