UpdateWorkforce - Amazon SageMaker Service


Restricts access to tasks assigned to workers in the specified workforce to those within specific ranges of IP addresses. You specify allowed IP addresses by creating a list of up to four 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 access and get a Not Found error message on the worker portal. After restricting access with this operation, you can see the allowed IP values for a private workforce with the DescribeWorkforce operation.


This operation applies only to private workforces.

Request Syntax

{ "SourceIpConfig": { "Cidrs": [ "string" ] }, "WorkforceName": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.


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

Maximum: Four CIDR values

Type: SourceIpConfig object

Required: No


The name of the private workforce whose access you want to restrict. WorkforceName is automatically set to default when a workforce is created and cannot be modified.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Pattern: ^[a-zA-Z0-9]([a-zA-Z0-9\-])*$

Required: Yes

Response Syntax

{ "Workforce": { "LastUpdatedDate": number, "SourceIpConfig": { "Cidrs": [ "string" ] }, "WorkforceArn": "string", "WorkforceName": "string" } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.


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 AWS 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.

Type: Workforce object


For information about the errors that are common to all actions, see Common Errors.

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: