Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.SageMaker.Types.Workforce

Description

Synopsis

data Workforce = Workforce' {
- cognitoConfig :: Maybe CognitoConfig
- createDate :: Maybe POSIX
- failureReason :: Maybe Text
- lastUpdatedDate :: Maybe POSIX
- oidcConfig :: Maybe OidcConfigForResponse
- sourceIpConfig :: Maybe SourceIpConfig
- status :: Maybe WorkforceStatus
- subDomain :: Maybe Text
- workforceVpcConfig :: Maybe WorkforceVpcConfigResponse
- workforceName :: Text
- workforceArn :: Text
}
newWorkforce :: Text -> Text -> Workforce
workforce_cognitoConfig :: Lens' Workforce (Maybe CognitoConfig)
workforce_createDate :: Lens' Workforce (Maybe UTCTime)
workforce_failureReason :: Lens' Workforce (Maybe Text)
workforce_lastUpdatedDate :: Lens' Workforce (Maybe UTCTime)
workforce_oidcConfig :: Lens' Workforce (Maybe OidcConfigForResponse)
workforce_sourceIpConfig :: Lens' Workforce (Maybe SourceIpConfig)
workforce_status :: Lens' Workforce (Maybe WorkforceStatus)
workforce_subDomain :: Lens' Workforce (Maybe Text)
workforce_workforceVpcConfig :: Lens' Workforce (Maybe WorkforceVpcConfigResponse)
workforce_workforceName :: Lens' Workforce Text
workforce_workforceArn :: Lens' Workforce Text

Documentation

data Workforce Source #

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: newWorkforce smart constructor.

Constructors

Workforce'

Fields

cognitoConfig :: Maybe CognitoConfig
The configuration of an Amazon Cognito workforce. A single Cognito workforce is created using and corresponds to a single Amazon Cognito user pool.
createDate :: Maybe POSIX
The date that the workforce is created.
failureReason :: Maybe Text
The reason your workforce failed.
lastUpdatedDate :: Maybe POSIX
The most recent date that was used to successfully add one or more IP address ranges (CIDRs) to a private workforce's allow list.
oidcConfig :: Maybe OidcConfigForResponse
The configuration of an OIDC Identity Provider (IdP) private workforce.
sourceIpConfig :: Maybe 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.
status :: Maybe WorkforceStatus
The status of your workforce.
subDomain :: Maybe Text
The subdomain for your OIDC Identity Provider.
workforceVpcConfig :: Maybe WorkforceVpcConfigResponse
The configuration of a VPC workforce.
workforceName :: Text
The name of the private workforce.
workforceArn :: Text
The Amazon Resource Name (ARN) of the private workforce.

Instances

Instances details

FromJSON Workforce Source #
Instance details Defined in Amazonka.SageMaker.Types.Workforce Methods parseJSON :: Value -> Parser Workforce # parseJSONList :: Value -> Parser [Workforce] #
Generic Workforce Source #
Instance details Defined in Amazonka.SageMaker.Types.Workforce Associated Types type Rep Workforce :: Type -> Type # Methods from :: Workforce -> Rep Workforce x # to :: Rep Workforce x -> Workforce #
Read Workforce Source #
Instance details Defined in Amazonka.SageMaker.Types.Workforce Methods readsPrec :: Int -> ReadS Workforce # readList :: ReadS [Workforce] # readPrec :: ReadPrec Workforce # readListPrec :: ReadPrec [Workforce] #
Show Workforce Source #
Instance details Defined in Amazonka.SageMaker.Types.Workforce Methods showsPrec :: Int -> Workforce -> ShowS # show :: Workforce -> String # showList :: [Workforce] -> ShowS #
NFData Workforce Source #
Instance details Defined in Amazonka.SageMaker.Types.Workforce Methods rnf :: Workforce -> () #
Eq Workforce Source #
Instance details Defined in Amazonka.SageMaker.Types.Workforce Methods (==) :: Workforce -> Workforce -> Bool # (/=) :: Workforce -> Workforce -> Bool #
Hashable Workforce Source #
Instance details Defined in Amazonka.SageMaker.Types.Workforce Methods hashWithSalt :: Int -> Workforce -> Int # hash :: Workforce -> Int #
type Rep Workforce Source #
Instance details Defined in Amazonka.SageMaker.Types.Workforce type Rep Workforce = D1 ('MetaData "Workforce" "Amazonka.SageMaker.Types.Workforce" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "Workforce'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "cognitoConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CognitoConfig)) :: S1 ('MetaSel ('Just "createDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "failureReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "lastUpdatedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "oidcConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OidcConfigForResponse))))) :: ((S1 ('MetaSel ('Just "sourceIpConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SourceIpConfig)) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WorkforceStatus)) :: S1 ('MetaSel ('Just "subDomain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "workforceVpcConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WorkforceVpcConfigResponse)) :: (S1 ('MetaSel ('Just "workforceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "workforceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newWorkforce Source #

Arguments

:: Text	`$sel:workforceName:Workforce'`
-> Text	`$sel:workforceArn:Workforce'`
-> Workforce

Create a value of Workforce with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:cognitoConfig:Workforce', workforce_cognitoConfig - The configuration of an Amazon Cognito workforce. A single Cognito workforce is created using and corresponds to a single Amazon Cognito user pool.

$sel:createDate:Workforce', workforce_createDate - The date that the workforce is created.

$sel:failureReason:Workforce', workforce_failureReason - The reason your workforce failed.

$sel:lastUpdatedDate:Workforce', workforce_lastUpdatedDate - The most recent date that was used to successfully add one or more IP address ranges (CIDRs) to a private workforce's allow list.

$sel:oidcConfig:Workforce', workforce_oidcConfig - The configuration of an OIDC Identity Provider (IdP) private workforce.

$sel:sourceIpConfig:Workforce', workforce_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.

$sel:status:Workforce', workforce_status - The status of your workforce.

$sel:subDomain:Workforce', workforce_subDomain - The subdomain for your OIDC Identity Provider.

$sel:workforceVpcConfig:Workforce', workforce_workforceVpcConfig - The configuration of a VPC workforce.

$sel:workforceName:Workforce', workforce_workforceName - The name of the private workforce.

$sel:workforceArn:Workforce', workforce_workforceArn - The Amazon Resource Name (ARN) of the private workforce.

workforce_cognitoConfig :: Lens' Workforce (Maybe CognitoConfig) Source #

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

workforce_createDate :: Lens' Workforce (Maybe UTCTime) Source #

The date that the workforce is created.

workforce_failureReason :: Lens' Workforce (Maybe Text) Source #

The reason your workforce failed.

workforce_lastUpdatedDate :: Lens' Workforce (Maybe UTCTime) Source #

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

workforce_oidcConfig :: Lens' Workforce (Maybe OidcConfigForResponse) Source #

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

workforce_sourceIpConfig :: Lens' Workforce (Maybe SourceIpConfig) Source #

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.

workforce_status :: Lens' Workforce (Maybe WorkforceStatus) Source #

The status of your workforce.

workforce_subDomain :: Lens' Workforce (Maybe Text) Source #

The subdomain for your OIDC Identity Provider.

workforce_workforceVpcConfig :: Lens' Workforce (Maybe WorkforceVpcConfigResponse) Source #

The configuration of a VPC workforce.

workforce_workforceName :: Lens' Workforce Text Source #

The name of the private workforce.

workforce_workforceArn :: Lens' Workforce Text Source #

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