AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the UpdateWorkforce operation. 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.

The worker portal is now supported in VPC and public internet.

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.

To restrict public internet access for all workers, configure the SourceIpConfig CIDR value. For example, when using SourceIpConfig with an IpAddressType of IPv4, you can restrict access to the IPv4 CIDR block "10.0.0.0/16". When using an IpAddressType of dualstack, you can specify both the IPv4 and IPv6 CIDR blocks, such as "10.0.0.0/16" for IPv4 only, "2001:db8:1234:1a00::/56" for IPv6 only, or "10.0.0.0/16" and "2001:db8:1234:1a00::/56" for dual stack.

Amazon SageMaker does not support Source Ip restriction for worker portals in VPC.

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 DeleteWorkteam 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 DescribeWorkforce operation.

This operation only applies to private workforces.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.SageMaker.AmazonSageMakerRequest
      Amazon.SageMaker.Model.UpdateWorkforceRequest

Namespace: Amazon.SageMaker.Model
Assembly: AWSSDK.SageMaker.dll
Version: 3.x.y.z

Syntax

C#
public class UpdateWorkforceRequest : AmazonSageMakerRequest
         IAmazonWebServiceRequest

The UpdateWorkforceRequest type exposes the following members

Constructors

NameDescription
Public Method UpdateWorkforceRequest()

Properties

NameTypeDescription
Public Property IpAddressType Amazon.SageMaker.WorkforceIpAddressType

Gets and sets the property IpAddressType.

Use this parameter to specify whether you want IPv4 only or dualstack (IPv4 and IPv6) to support your labeling workforce.

Public Property OidcConfig Amazon.SageMaker.Model.OidcConfig

Gets and sets the property OidcConfig.

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

Public Property SourceIpConfig Amazon.SageMaker.Model.SourceIpConfig

Gets and sets the property 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

Public Property WorkforceName System.String

Gets and sets the property WorkforceName.

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

Public Property WorkforceVpcConfig Amazon.SageMaker.Model.WorkforceVpcConfigRequest

Gets and sets the property WorkforceVpcConfig.

Use this parameter to update your VPC configuration for a workforce.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5