Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . sagemaker ]

update-workforce

Description

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

Warning

This operation applies only to private workforces.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  update-workforce
--workforce-name <value>
[--source-ip-config <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--workforce-name (string)

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.

--source-ip-config (structure)

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

Shorthand Syntax:

Cidrs=string,string

JSON Syntax:

{
  "Cidrs": ["string", ...]
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

Workforce -> (structure)

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 .

WorkforceName -> (string)

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.

WorkforceArn -> (string)

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

LastUpdatedDate -> (timestamp)

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

SourceIpConfig -> (structure)

A list of one to four IP address ranges (CIDRs ) to be added to the workforce allow list.

Cidrs -> (list)

A list of one to four Classless Inter-Domain Routing (CIDR) values.

Maximum: Four CIDR values

Note

The following Length Constraints apply to individual CIDR values in the CIDR value list.

(string)