Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.SageMaker.UpdateWorkforce

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Use this operation to update your workforce. You can use this operation to require that workers use specific IP addresses to work on tasks and to update your OpenID Connect (OIDC) Identity Provider (IdP) workforce configuration.

Use SourceIpConfig to restrict worker access to tasks to a specific range of IP addresses. You specify allowed IP addresses by creating a list of up to ten CIDRs. By default, a workforce isn't restricted to specific IP addresses. If you specify a range of IP addresses, workers who attempt to access tasks using any IP address outside the specified range are denied and get a Not Found error message on the worker portal.

Use OidcConfig to update the configuration of a workforce created using your own OIDC IdP.

You can only update your OIDC IdP configuration when there are no work teams associated with your workforce. You can delete work teams using the operation.

After restricting access to a range of IP addresses or updating your OIDC IdP configuration with this operation, you can view details about your update workforce using the operation.

This operation only applies to private workforces.

Creating a Request

data UpdateWorkforce Source #

See: newUpdateWorkforce smart constructor.

Constructors

UpdateWorkforce'

Fields

sourceIpConfig :: Maybe SourceIpConfig
A list of one to ten worker IP address ranges (CIDRs) that can be used to access tasks assigned to this workforce.
Maximum: Ten CIDR values
oidcConfig :: Maybe OidcConfig
Use this parameter to update your OIDC Identity Provider (IdP) configuration for a workforce made using your own IdP.
workforceName :: Text
The name of the private workforce that you want to update. You can find your workforce name by using the operation.

Instances

Instances details

Eq UpdateWorkforce Source #
Instance details Defined in Amazonka.SageMaker.UpdateWorkforce Methods (==) :: UpdateWorkforce -> UpdateWorkforce -> Bool # (/=) :: UpdateWorkforce -> UpdateWorkforce -> Bool #
Show UpdateWorkforce Source #
Instance details Defined in Amazonka.SageMaker.UpdateWorkforce Methods showsPrec :: Int -> UpdateWorkforce -> ShowS # show :: UpdateWorkforce -> String # showList :: [UpdateWorkforce] -> ShowS #
Generic UpdateWorkforce Source #
Instance details Defined in Amazonka.SageMaker.UpdateWorkforce Associated Types type Rep UpdateWorkforce :: Type -> Type # Methods from :: UpdateWorkforce -> Rep UpdateWorkforce x # to :: Rep UpdateWorkforce x -> UpdateWorkforce #
NFData UpdateWorkforce Source #
Instance details Defined in Amazonka.SageMaker.UpdateWorkforce Methods rnf :: UpdateWorkforce -> () #
Hashable UpdateWorkforce Source #
Instance details Defined in Amazonka.SageMaker.UpdateWorkforce Methods hashWithSalt :: Int -> UpdateWorkforce -> Int # hash :: UpdateWorkforce -> Int #
ToJSON UpdateWorkforce Source #
Instance details Defined in Amazonka.SageMaker.UpdateWorkforce Methods toJSON :: UpdateWorkforce -> Value # toEncoding :: UpdateWorkforce -> Encoding # toJSONList :: [UpdateWorkforce] -> Value # toEncodingList :: [UpdateWorkforce] -> Encoding #
AWSRequest UpdateWorkforce Source #
Instance details Defined in Amazonka.SageMaker.UpdateWorkforce Associated Types type AWSResponse UpdateWorkforce # Methods request :: UpdateWorkforce -> Request UpdateWorkforce # response :: MonadResource m => Logger -> Service -> Proxy UpdateWorkforce -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateWorkforce))) #
ToHeaders UpdateWorkforce Source #
Instance details Defined in Amazonka.SageMaker.UpdateWorkforce Methods toHeaders :: UpdateWorkforce -> [Header] #
ToPath UpdateWorkforce Source #
Instance details Defined in Amazonka.SageMaker.UpdateWorkforce Methods toPath :: UpdateWorkforce -> ByteString #
ToQuery UpdateWorkforce Source #
Instance details Defined in Amazonka.SageMaker.UpdateWorkforce Methods toQuery :: UpdateWorkforce -> QueryString #
type Rep UpdateWorkforce Source #
Instance details Defined in Amazonka.SageMaker.UpdateWorkforce type Rep UpdateWorkforce = D1 ('MetaData "UpdateWorkforce" "Amazonka.SageMaker.UpdateWorkforce" "libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker" 'False) (C1 ('MetaCons "UpdateWorkforce'" 'PrefixI 'True) (S1 ('MetaSel ('Just "sourceIpConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SourceIpConfig)) :: (S1 ('MetaSel ('Just "oidcConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OidcConfig)) :: S1 ('MetaSel ('Just "workforceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse UpdateWorkforce Source #
Instance details Defined in Amazonka.SageMaker.UpdateWorkforce type AWSResponse UpdateWorkforce = UpdateWorkforceResponse

newUpdateWorkforce Source #

Arguments

:: Text	`$sel:workforceName:UpdateWorkforce'`
-> UpdateWorkforce

Create a value of UpdateWorkforce 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:sourceIpConfig:UpdateWorkforce', updateWorkforce_sourceIpConfig - A list of one to ten worker IP address ranges (CIDRs) that can be used to access tasks assigned to this workforce.

Maximum: Ten CIDR values

$sel:oidcConfig:UpdateWorkforce', updateWorkforce_oidcConfig - Use this parameter to update your OIDC Identity Provider (IdP) configuration for a workforce made using your own IdP.

$sel:workforceName:UpdateWorkforce', updateWorkforce_workforceName - The name of the private workforce that you want to update. You can find your workforce name by using the operation.

Request Lenses

updateWorkforce_sourceIpConfig :: Lens' UpdateWorkforce (Maybe SourceIpConfig) Source #

A list of one to ten worker IP address ranges (CIDRs) that can be used to access tasks assigned to this workforce.

Maximum: Ten CIDR values

updateWorkforce_oidcConfig :: Lens' UpdateWorkforce (Maybe OidcConfig) Source #

Use this parameter to update your OIDC Identity Provider (IdP) configuration for a workforce made using your own IdP.

updateWorkforce_workforceName :: Lens' UpdateWorkforce Text Source #

The name of the private workforce that you want to update. You can find your workforce name by using the operation.

Destructuring the Response

data UpdateWorkforceResponse Source #

See: newUpdateWorkforceResponse smart constructor.

Constructors

UpdateWorkforceResponse'
Fields httpStatus :: Int The response's http status code. workforce :: Workforce A single private workforce. 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.

Instances

Instances details

Eq UpdateWorkforceResponse Source #
Instance details Defined in Amazonka.SageMaker.UpdateWorkforce Methods (==) :: UpdateWorkforceResponse -> UpdateWorkforceResponse -> Bool # (/=) :: UpdateWorkforceResponse -> UpdateWorkforceResponse -> Bool #
Read UpdateWorkforceResponse Source #
Instance details Defined in Amazonka.SageMaker.UpdateWorkforce Methods readsPrec :: Int -> ReadS UpdateWorkforceResponse # readList :: ReadS [UpdateWorkforceResponse] # readPrec :: ReadPrec UpdateWorkforceResponse # readListPrec :: ReadPrec [UpdateWorkforceResponse] #
Show UpdateWorkforceResponse Source #
Instance details Defined in Amazonka.SageMaker.UpdateWorkforce Methods showsPrec :: Int -> UpdateWorkforceResponse -> ShowS # show :: UpdateWorkforceResponse -> String # showList :: [UpdateWorkforceResponse] -> ShowS #
Generic UpdateWorkforceResponse Source #
Instance details Defined in Amazonka.SageMaker.UpdateWorkforce Associated Types type Rep UpdateWorkforceResponse :: Type -> Type # Methods from :: UpdateWorkforceResponse -> Rep UpdateWorkforceResponse x # to :: Rep UpdateWorkforceResponse x -> UpdateWorkforceResponse #
NFData UpdateWorkforceResponse Source #
Instance details Defined in Amazonka.SageMaker.UpdateWorkforce Methods rnf :: UpdateWorkforceResponse -> () #
type Rep UpdateWorkforceResponse Source #
Instance details Defined in Amazonka.SageMaker.UpdateWorkforce type Rep UpdateWorkforceResponse = D1 ('MetaData "UpdateWorkforceResponse" "Amazonka.SageMaker.UpdateWorkforce" "libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker" 'False) (C1 ('MetaCons "UpdateWorkforceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "workforce") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Workforce)))

newUpdateWorkforceResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateWorkforceResponse'`
-> Workforce	`$sel:workforce:UpdateWorkforceResponse'`
-> UpdateWorkforceResponse

Create a value of UpdateWorkforceResponse 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:httpStatus:UpdateWorkforceResponse', updateWorkforceResponse_httpStatus - The response's http status code.

$sel:workforce:UpdateWorkforceResponse', updateWorkforceResponse_workforce - A single private workforce. 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.

Response Lenses

updateWorkforceResponse_httpStatus :: Lens' UpdateWorkforceResponse Int Source #

The response's http status code.

updateWorkforceResponse_workforce :: Lens' UpdateWorkforceResponse Workforce Source #

A single private workforce. 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.