Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
SPDX-License-Identifier: CC-BY-SA-4.0

Gets a list of labeling jobs assigned to a specified work team.

{
   "[CreationTimeAfter](#SageMaker-ListLabelingJobsForWorkteam-request-CreationTimeAfter)": number,
   "[CreationTimeBefore](#SageMaker-ListLabelingJobsForWorkteam-request-CreationTimeBefore)": number,
   "[JobReferenceCodeContains](#SageMaker-ListLabelingJobsForWorkteam-request-JobReferenceCodeContains)": "string",
   "[MaxResults](#SageMaker-ListLabelingJobsForWorkteam-request-MaxResults)": number,
   "[NextToken](#SageMaker-ListLabelingJobsForWorkteam-request-NextToken)": "string",
   "[SortBy](#SageMaker-ListLabelingJobsForWorkteam-request-SortBy)": "string",
   "[SortOrder](#SageMaker-ListLabelingJobsForWorkteam-request-SortOrder)": "string",
   "[WorkteamArn](#SageMaker-ListLabelingJobsForWorkteam-request-WorkteamArn)": "string"
}

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

The request accepts the following data in JSON format.

** CreationTimeAfter ** A filter that returns only labeling jobs created after the specified time (timestamp).
Type: Timestamp
Required: No

** CreationTimeBefore ** A filter that returns only labeling jobs created before the specified time (timestamp).
Type: Timestamp
Required: No

** JobReferenceCodeContains ** A filter the limits jobs to only the ones whose job reference code contains the specified string.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: .+
Required: No

** MaxResults ** The maximum number of labeling jobs to return in each page of the response.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No

** NextToken ** If the result of the previous ListLabelingJobsForWorkteam request was truncated, the response includes a NextToken. To retrieve the next set of labeling jobs, use the token in the next request.
Type: String
Length Constraints: Maximum length of 8192.
Pattern: .*
Required: No

** SortBy ** The field to sort results by. The default is CreationTime.
Type: String
Valid Values:CreationTime
Required: No

** SortOrder ** The sort order for results. The default is Ascending.
Type: String
Valid Values:Ascending | Descending
Required: No

** WorkteamArn ** The Amazon Resource Name (ARN) of the work team for which you want to see labeling jobs for.
Type: String
Length Constraints: Maximum length of 256.
Pattern: arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:workteam/.*
Required: Yes

{
   "[LabelingJobSummaryList](#SageMaker-ListLabelingJobsForWorkteam-response-LabelingJobSummaryList)": [ 
      { 
         "[CreationTime](API_LabelingJobForWorkteamSummary.md#SageMaker-Type-LabelingJobForWorkteamSummary-CreationTime)": number,
         "[JobReferenceCode](API_LabelingJobForWorkteamSummary.md#SageMaker-Type-LabelingJobForWorkteamSummary-JobReferenceCode)": "string",
         "[LabelCounters](API_LabelingJobForWorkteamSummary.md#SageMaker-Type-LabelingJobForWorkteamSummary-LabelCounters)": { 
            "[HumanLabeled](API_LabelCountersForWorkteam.md#SageMaker-Type-LabelCountersForWorkteam-HumanLabeled)": number,
            "[PendingHuman](API_LabelCountersForWorkteam.md#SageMaker-Type-LabelCountersForWorkteam-PendingHuman)": number,
            "[Total](API_LabelCountersForWorkteam.md#SageMaker-Type-LabelCountersForWorkteam-Total)": number
         },
         "[LabelingJobName](API_LabelingJobForWorkteamSummary.md#SageMaker-Type-LabelingJobForWorkteamSummary-LabelingJobName)": "string",
         "[NumberOfHumanWorkersPerDataObject](API_LabelingJobForWorkteamSummary.md#SageMaker-Type-LabelingJobForWorkteamSummary-NumberOfHumanWorkersPerDataObject)": number,
         "[WorkRequesterAccountId](API_LabelingJobForWorkteamSummary.md#SageMaker-Type-LabelingJobForWorkteamSummary-WorkRequesterAccountId)": "string"
      }
   ],
   "[NextToken](#SageMaker-ListLabelingJobsForWorkteam-response-NextToken)": "string"
}

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

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

** LabelingJobSummaryList ** An array of LabelingJobSummary objects, each describing a labeling job.
Type: Array of LabelingJobForWorkteamSummary objects

** NextToken ** If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of labeling jobs, use it in the subsequent request.
Type: String
Length Constraints: Maximum length of 8192.
Pattern: .*

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

ResourceNotFound
Resource being access is not found.
HTTP Status Code: 400

For more information about using this API in one of the language-specific AWS SDKs, see the following: + AWS Command Line Interface + AWS SDK for .NET + AWS SDK for C++ + AWS SDK for Go + AWS SDK for Go - Pilot + AWS SDK for Java + AWS SDK for JavaScript + AWS SDK for PHP V3 + AWS SDK for Python + AWS SDK for Ruby V2