{-# LANGUAGE DeriveGeneric #-} {-# LANGUAGE DuplicateRecordFields #-} {-# LANGUAGE NamedFieldPuns #-} {-# LANGUAGE OverloadedStrings #-} {-# LANGUAGE RecordWildCards #-} {-# LANGUAGE StrictData #-} {-# LANGUAGE TypeFamilies #-} {-# LANGUAGE NoImplicitPrelude #-} {-# OPTIONS_GHC -fno-warn-unused-binds #-} {-# OPTIONS_GHC -fno-warn-unused-imports #-} {-# OPTIONS_GHC -fno-warn-unused-matches #-} -- Derived from AWS service descriptions, licensed under Apache 2.0. -- | -- Module : Amazonka.SageMaker.ListLabelingJobsForWorkteam -- Copyright : (c) 2013-2023 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- -- Gets a list of labeling jobs assigned to a specified work team. -- -- This operation returns paginated results. module Amazonka.SageMaker.ListLabelingJobsForWorkteam ( -- * Creating a Request ListLabelingJobsForWorkteam (..), newListLabelingJobsForWorkteam, -- * Request Lenses listLabelingJobsForWorkteam_creationTimeAfter, listLabelingJobsForWorkteam_creationTimeBefore, listLabelingJobsForWorkteam_jobReferenceCodeContains, listLabelingJobsForWorkteam_maxResults, listLabelingJobsForWorkteam_nextToken, listLabelingJobsForWorkteam_sortBy, listLabelingJobsForWorkteam_sortOrder, listLabelingJobsForWorkteam_workteamArn, -- * Destructuring the Response ListLabelingJobsForWorkteamResponse (..), newListLabelingJobsForWorkteamResponse, -- * Response Lenses listLabelingJobsForWorkteamResponse_nextToken, listLabelingJobsForWorkteamResponse_httpStatus, listLabelingJobsForWorkteamResponse_labelingJobSummaryList, ) where import qualified Amazonka.Core as Core import qualified Amazonka.Core.Lens.Internal as Lens import qualified Amazonka.Data as Data import qualified Amazonka.Prelude as Prelude import qualified Amazonka.Request as Request import qualified Amazonka.Response as Response import Amazonka.SageMaker.Types -- | /See:/ 'newListLabelingJobsForWorkteam' smart constructor. data ListLabelingJobsForWorkteam = ListLabelingJobsForWorkteam' { -- | A filter that returns only labeling jobs created after the specified -- time (timestamp). creationTimeAfter :: Prelude.Maybe Data.POSIX, -- | A filter that returns only labeling jobs created before the specified -- time (timestamp). creationTimeBefore :: Prelude.Maybe Data.POSIX, -- | A filter the limits jobs to only the ones whose job reference code -- contains the specified string. jobReferenceCodeContains :: Prelude.Maybe Prelude.Text, -- | The maximum number of labeling jobs to return in each page of the -- response. maxResults :: Prelude.Maybe Prelude.Natural, -- | 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. nextToken :: Prelude.Maybe Prelude.Text, -- | The field to sort results by. The default is @CreationTime@. sortBy :: Prelude.Maybe ListLabelingJobsForWorkteamSortByOptions, -- | The sort order for results. The default is @Ascending@. sortOrder :: Prelude.Maybe SortOrder, -- | The Amazon Resource Name (ARN) of the work team for which you want to -- see labeling jobs for. workteamArn :: Prelude.Text } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'ListLabelingJobsForWorkteam' with all optional fields omitted. -- -- Use or to modify other optional fields. -- -- The following record fields are available, with the corresponding lenses provided -- for backwards compatibility: -- -- 'creationTimeAfter', 'listLabelingJobsForWorkteam_creationTimeAfter' - A filter that returns only labeling jobs created after the specified -- time (timestamp). -- -- 'creationTimeBefore', 'listLabelingJobsForWorkteam_creationTimeBefore' - A filter that returns only labeling jobs created before the specified -- time (timestamp). -- -- 'jobReferenceCodeContains', 'listLabelingJobsForWorkteam_jobReferenceCodeContains' - A filter the limits jobs to only the ones whose job reference code -- contains the specified string. -- -- 'maxResults', 'listLabelingJobsForWorkteam_maxResults' - The maximum number of labeling jobs to return in each page of the -- response. -- -- 'nextToken', 'listLabelingJobsForWorkteam_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. -- -- 'sortBy', 'listLabelingJobsForWorkteam_sortBy' - The field to sort results by. The default is @CreationTime@. -- -- 'sortOrder', 'listLabelingJobsForWorkteam_sortOrder' - The sort order for results. The default is @Ascending@. -- -- 'workteamArn', 'listLabelingJobsForWorkteam_workteamArn' - The Amazon Resource Name (ARN) of the work team for which you want to -- see labeling jobs for. newListLabelingJobsForWorkteam :: -- | 'workteamArn' Prelude.Text -> ListLabelingJobsForWorkteam newListLabelingJobsForWorkteam pWorkteamArn_ = ListLabelingJobsForWorkteam' { creationTimeAfter = Prelude.Nothing, creationTimeBefore = Prelude.Nothing, jobReferenceCodeContains = Prelude.Nothing, maxResults = Prelude.Nothing, nextToken = Prelude.Nothing, sortBy = Prelude.Nothing, sortOrder = Prelude.Nothing, workteamArn = pWorkteamArn_ } -- | A filter that returns only labeling jobs created after the specified -- time (timestamp). listLabelingJobsForWorkteam_creationTimeAfter :: Lens.Lens' ListLabelingJobsForWorkteam (Prelude.Maybe Prelude.UTCTime) listLabelingJobsForWorkteam_creationTimeAfter = Lens.lens (\ListLabelingJobsForWorkteam' {creationTimeAfter} -> creationTimeAfter) (\s@ListLabelingJobsForWorkteam' {} a -> s {creationTimeAfter = a} :: ListLabelingJobsForWorkteam) Prelude.. Lens.mapping Data._Time -- | A filter that returns only labeling jobs created before the specified -- time (timestamp). listLabelingJobsForWorkteam_creationTimeBefore :: Lens.Lens' ListLabelingJobsForWorkteam (Prelude.Maybe Prelude.UTCTime) listLabelingJobsForWorkteam_creationTimeBefore = Lens.lens (\ListLabelingJobsForWorkteam' {creationTimeBefore} -> creationTimeBefore) (\s@ListLabelingJobsForWorkteam' {} a -> s {creationTimeBefore = a} :: ListLabelingJobsForWorkteam) Prelude.. Lens.mapping Data._Time -- | A filter the limits jobs to only the ones whose job reference code -- contains the specified string. listLabelingJobsForWorkteam_jobReferenceCodeContains :: Lens.Lens' ListLabelingJobsForWorkteam (Prelude.Maybe Prelude.Text) listLabelingJobsForWorkteam_jobReferenceCodeContains = Lens.lens (\ListLabelingJobsForWorkteam' {jobReferenceCodeContains} -> jobReferenceCodeContains) (\s@ListLabelingJobsForWorkteam' {} a -> s {jobReferenceCodeContains = a} :: ListLabelingJobsForWorkteam) -- | The maximum number of labeling jobs to return in each page of the -- response. listLabelingJobsForWorkteam_maxResults :: Lens.Lens' ListLabelingJobsForWorkteam (Prelude.Maybe Prelude.Natural) listLabelingJobsForWorkteam_maxResults = Lens.lens (\ListLabelingJobsForWorkteam' {maxResults} -> maxResults) (\s@ListLabelingJobsForWorkteam' {} a -> s {maxResults = a} :: ListLabelingJobsForWorkteam) -- | 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. listLabelingJobsForWorkteam_nextToken :: Lens.Lens' ListLabelingJobsForWorkteam (Prelude.Maybe Prelude.Text) listLabelingJobsForWorkteam_nextToken = Lens.lens (\ListLabelingJobsForWorkteam' {nextToken} -> nextToken) (\s@ListLabelingJobsForWorkteam' {} a -> s {nextToken = a} :: ListLabelingJobsForWorkteam) -- | The field to sort results by. The default is @CreationTime@. listLabelingJobsForWorkteam_sortBy :: Lens.Lens' ListLabelingJobsForWorkteam (Prelude.Maybe ListLabelingJobsForWorkteamSortByOptions) listLabelingJobsForWorkteam_sortBy = Lens.lens (\ListLabelingJobsForWorkteam' {sortBy} -> sortBy) (\s@ListLabelingJobsForWorkteam' {} a -> s {sortBy = a} :: ListLabelingJobsForWorkteam) -- | The sort order for results. The default is @Ascending@. listLabelingJobsForWorkteam_sortOrder :: Lens.Lens' ListLabelingJobsForWorkteam (Prelude.Maybe SortOrder) listLabelingJobsForWorkteam_sortOrder = Lens.lens (\ListLabelingJobsForWorkteam' {sortOrder} -> sortOrder) (\s@ListLabelingJobsForWorkteam' {} a -> s {sortOrder = a} :: ListLabelingJobsForWorkteam) -- | The Amazon Resource Name (ARN) of the work team for which you want to -- see labeling jobs for. listLabelingJobsForWorkteam_workteamArn :: Lens.Lens' ListLabelingJobsForWorkteam Prelude.Text listLabelingJobsForWorkteam_workteamArn = Lens.lens (\ListLabelingJobsForWorkteam' {workteamArn} -> workteamArn) (\s@ListLabelingJobsForWorkteam' {} a -> s {workteamArn = a} :: ListLabelingJobsForWorkteam) instance Core.AWSPager ListLabelingJobsForWorkteam where page rq rs | Core.stop ( rs Lens.^? listLabelingJobsForWorkteamResponse_nextToken Prelude.. Lens._Just ) = Prelude.Nothing | Core.stop ( rs Lens.^. listLabelingJobsForWorkteamResponse_labelingJobSummaryList ) = Prelude.Nothing | Prelude.otherwise = Prelude.Just Prelude.$ rq Prelude.& listLabelingJobsForWorkteam_nextToken Lens..~ rs Lens.^? listLabelingJobsForWorkteamResponse_nextToken Prelude.. Lens._Just instance Core.AWSRequest ListLabelingJobsForWorkteam where type AWSResponse ListLabelingJobsForWorkteam = ListLabelingJobsForWorkteamResponse request overrides = Request.postJSON (overrides defaultService) response = Response.receiveJSON ( \s h x -> ListLabelingJobsForWorkteamResponse' Prelude.<$> (x Data..?> "NextToken") Prelude.<*> (Prelude.pure (Prelude.fromEnum s)) Prelude.<*> ( x Data..?> "LabelingJobSummaryList" Core..!@ Prelude.mempty ) ) instance Prelude.Hashable ListLabelingJobsForWorkteam where hashWithSalt _salt ListLabelingJobsForWorkteam' {..} = _salt `Prelude.hashWithSalt` creationTimeAfter `Prelude.hashWithSalt` creationTimeBefore `Prelude.hashWithSalt` jobReferenceCodeContains `Prelude.hashWithSalt` maxResults `Prelude.hashWithSalt` nextToken `Prelude.hashWithSalt` sortBy `Prelude.hashWithSalt` sortOrder `Prelude.hashWithSalt` workteamArn instance Prelude.NFData ListLabelingJobsForWorkteam where rnf ListLabelingJobsForWorkteam' {..} = Prelude.rnf creationTimeAfter `Prelude.seq` Prelude.rnf creationTimeBefore `Prelude.seq` Prelude.rnf jobReferenceCodeContains `Prelude.seq` Prelude.rnf maxResults `Prelude.seq` Prelude.rnf nextToken `Prelude.seq` Prelude.rnf sortBy `Prelude.seq` Prelude.rnf sortOrder `Prelude.seq` Prelude.rnf workteamArn instance Data.ToHeaders ListLabelingJobsForWorkteam where toHeaders = Prelude.const ( Prelude.mconcat [ "X-Amz-Target" Data.=# ( "SageMaker.ListLabelingJobsForWorkteam" :: Prelude.ByteString ), "Content-Type" Data.=# ( "application/x-amz-json-1.1" :: Prelude.ByteString ) ] ) instance Data.ToJSON ListLabelingJobsForWorkteam where toJSON ListLabelingJobsForWorkteam' {..} = Data.object ( Prelude.catMaybes [ ("CreationTimeAfter" Data..=) Prelude.<$> creationTimeAfter, ("CreationTimeBefore" Data..=) Prelude.<$> creationTimeBefore, ("JobReferenceCodeContains" Data..=) Prelude.<$> jobReferenceCodeContains, ("MaxResults" Data..=) Prelude.<$> maxResults, ("NextToken" Data..=) Prelude.<$> nextToken, ("SortBy" Data..=) Prelude.<$> sortBy, ("SortOrder" Data..=) Prelude.<$> sortOrder, Prelude.Just ("WorkteamArn" Data..= workteamArn) ] ) instance Data.ToPath ListLabelingJobsForWorkteam where toPath = Prelude.const "/" instance Data.ToQuery ListLabelingJobsForWorkteam where toQuery = Prelude.const Prelude.mempty -- | /See:/ 'newListLabelingJobsForWorkteamResponse' smart constructor. data ListLabelingJobsForWorkteamResponse = ListLabelingJobsForWorkteamResponse' { -- | If the response is truncated, SageMaker returns this token. To retrieve -- the next set of labeling jobs, use it in the subsequent request. nextToken :: Prelude.Maybe Prelude.Text, -- | The response's http status code. httpStatus :: Prelude.Int, -- | An array of @LabelingJobSummary@ objects, each describing a labeling -- job. labelingJobSummaryList :: [LabelingJobForWorkteamSummary] } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'ListLabelingJobsForWorkteamResponse' with all optional fields omitted. -- -- Use or to modify other optional fields. -- -- The following record fields are available, with the corresponding lenses provided -- for backwards compatibility: -- -- 'nextToken', 'listLabelingJobsForWorkteamResponse_nextToken' - If the response is truncated, SageMaker returns this token. To retrieve -- the next set of labeling jobs, use it in the subsequent request. -- -- 'httpStatus', 'listLabelingJobsForWorkteamResponse_httpStatus' - The response's http status code. -- -- 'labelingJobSummaryList', 'listLabelingJobsForWorkteamResponse_labelingJobSummaryList' - An array of @LabelingJobSummary@ objects, each describing a labeling -- job. newListLabelingJobsForWorkteamResponse :: -- | 'httpStatus' Prelude.Int -> ListLabelingJobsForWorkteamResponse newListLabelingJobsForWorkteamResponse pHttpStatus_ = ListLabelingJobsForWorkteamResponse' { nextToken = Prelude.Nothing, httpStatus = pHttpStatus_, labelingJobSummaryList = Prelude.mempty } -- | If the response is truncated, SageMaker returns this token. To retrieve -- the next set of labeling jobs, use it in the subsequent request. listLabelingJobsForWorkteamResponse_nextToken :: Lens.Lens' ListLabelingJobsForWorkteamResponse (Prelude.Maybe Prelude.Text) listLabelingJobsForWorkteamResponse_nextToken = Lens.lens (\ListLabelingJobsForWorkteamResponse' {nextToken} -> nextToken) (\s@ListLabelingJobsForWorkteamResponse' {} a -> s {nextToken = a} :: ListLabelingJobsForWorkteamResponse) -- | The response's http status code. listLabelingJobsForWorkteamResponse_httpStatus :: Lens.Lens' ListLabelingJobsForWorkteamResponse Prelude.Int listLabelingJobsForWorkteamResponse_httpStatus = Lens.lens (\ListLabelingJobsForWorkteamResponse' {httpStatus} -> httpStatus) (\s@ListLabelingJobsForWorkteamResponse' {} a -> s {httpStatus = a} :: ListLabelingJobsForWorkteamResponse) -- | An array of @LabelingJobSummary@ objects, each describing a labeling -- job. listLabelingJobsForWorkteamResponse_labelingJobSummaryList :: Lens.Lens' ListLabelingJobsForWorkteamResponse [LabelingJobForWorkteamSummary] listLabelingJobsForWorkteamResponse_labelingJobSummaryList = Lens.lens (\ListLabelingJobsForWorkteamResponse' {labelingJobSummaryList} -> labelingJobSummaryList) (\s@ListLabelingJobsForWorkteamResponse' {} a -> s {labelingJobSummaryList = a} :: ListLabelingJobsForWorkteamResponse) Prelude.. Lens.coerced instance Prelude.NFData ListLabelingJobsForWorkteamResponse where rnf ListLabelingJobsForWorkteamResponse' {..} = Prelude.rnf nextToken `Prelude.seq` Prelude.rnf httpStatus `Prelude.seq` Prelude.rnf labelingJobSummaryList