Locale - Amazon Mechanical Turk

WARNING

You are browsing the documentation for a deprecated version ('2014-08-15') of the Amazon Mechanical Turk Requester API. This version of the API will be deprecated and will be rendered unusable as of June 1st, 2019.

If you request against a legacy API version (https://docs.aws.amazon.com/AWSMechTurk/latest/AWSMturkAPI-legacy/Welcome.html) on or after June 1, 2019, you will receive the following response:

This Requester API is no longer supported. Please use the latest API using the official AWS SDK. https://aws.amazon.com/getting-started/tools-sdks

The latest version of our API ('2017-01-17') provides you with additional tool choices and enables you to select from nine AWS Software Development Kits (SDKs) that have been widely adopted across the AWS community. This API can be accessed using the following AWS SDKs: Python/Boto (Boto3), Javascript (NodeJS or Browser), Java, .NET, Go, Ruby, PHP or C++. This version also makes it easier for customers to connect MTurk with other AWS services like S3, Lambda, Step Functions, Lex, Polly, Rekognition, Amazon SageMaker, AWS Batch, EC2, and more.

This version also updates naming conventions used in the API and adopts the AWS standard of Signature Version 4 to authenticate requests securely. The API uses REST requests and no longer requires that developers be familiar with SOAP protocol. These changes make the MTurk API consistent with AWS APIs, simplifying the on-boarding process for both new and existing AWS developers. The legacy MTurk Command Line Tools and .NET, Java, Ruby, and Perl SDKs were marked as deprecated in January 2018. We will be deprecating the legacy APIs as of June 1, 2019.

If you are on a legacy API, you must migrate to the latest version of our API. You can find documentation for the latest API here and the AWS SDKs here. Please check whether you need to migrate and review the technical migration guide.

For support, contact requestor-apilegacydeprecation-support@amazon.com.

 

Locale

Description

The Locale data structure represents a geographical region or location.

The Locale data structure is used as part of the QualificationRequirement data structure when you specify a requirement based on the locale Qualification, and as part of the Qualification data structure that describes the value of a locale Qualification.

When used in a QualificationRequirement, the Locale data structure only needs to contain as much of the locale as the Worker needs to match to meet the requirement. For example, a requirement that the Worker be living anywhere in the United States would have only the Country field.

Note

Currently, a Locale data structure only supports the Country field and Subdivision field. Please note that subdivisions or states are only available for the United States of America.

Elements

The Locale structure can contain the elements described in the following table. When the structure is used in a request, elements described as Required must be included for the request to succeed.

Name Description Required

Country

The country of the locale.

Type: A valid ISO 3166 country code. For example, the code US refers to the United States of America.

Default: none

Yes

Subdivision

The state or subdivision of the locale.

Type: Type: A valid ISO 3166-2 subdivision code. For example, the code CA refers to the state of California

Default: none

Yes

Example

The following code sample indicates a locale in the United States.

<LocaleValue> <Country>US</Country> </LocaleValue>

Example

The following code sample indicates a locale in the state of California in the United States of America.

<LocaleValue> <Country>US</Country> <Subdivision>CA</Subdivision> </LocaleValue>