Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.SageMaker.ListWorkteams

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets a list of private work teams that you have defined in a region. The list may be empty if no work team satisfies the filter specified in the NameContains parameter.

This operation returns paginated results.

Synopsis

data ListWorkteams = ListWorkteams' {
- nameContains :: Maybe Text
- nextToken :: Maybe Text
- sortOrder :: Maybe SortOrder
- maxResults :: Maybe Natural
- sortBy :: Maybe ListWorkteamsSortByOptions
}
newListWorkteams :: ListWorkteams
listWorkteams_nameContains :: Lens' ListWorkteams (Maybe Text)
listWorkteams_nextToken :: Lens' ListWorkteams (Maybe Text)
listWorkteams_sortOrder :: Lens' ListWorkteams (Maybe SortOrder)
listWorkteams_maxResults :: Lens' ListWorkteams (Maybe Natural)
listWorkteams_sortBy :: Lens' ListWorkteams (Maybe ListWorkteamsSortByOptions)
data ListWorkteamsResponse = ListWorkteamsResponse' {
- nextToken :: Maybe Text
- httpStatus :: Int
- workteams :: [Workteam]
}
newListWorkteamsResponse :: Int -> ListWorkteamsResponse
listWorkteamsResponse_nextToken :: Lens' ListWorkteamsResponse (Maybe Text)
listWorkteamsResponse_httpStatus :: Lens' ListWorkteamsResponse Int
listWorkteamsResponse_workteams :: Lens' ListWorkteamsResponse [Workteam]

Creating a Request

data ListWorkteams Source #

See: newListWorkteams smart constructor.

Constructors

ListWorkteams'

Fields

nameContains :: Maybe Text
A string in the work team's name. This filter returns only work teams whose name contains the specified string.
nextToken :: Maybe Text
If the result of the previous ListWorkteams request was truncated, the response includes a NextToken. To retrieve the next set of labeling jobs, use the token in the next request.
sortOrder :: Maybe SortOrder
The sort order for results. The default is Ascending.
maxResults :: Maybe Natural
The maximum number of work teams to return in each page of the response.
sortBy :: Maybe ListWorkteamsSortByOptions
The field to sort results by. The default is CreationTime.

Instances

Instances details

Eq ListWorkteams Source #
Instance details Defined in Amazonka.SageMaker.ListWorkteams Methods (==) :: ListWorkteams -> ListWorkteams -> Bool # (/=) :: ListWorkteams -> ListWorkteams -> Bool #
Read ListWorkteams Source #
Instance details Defined in Amazonka.SageMaker.ListWorkteams Methods readsPrec :: Int -> ReadS ListWorkteams # readList :: ReadS [ListWorkteams] # readPrec :: ReadPrec ListWorkteams # readListPrec :: ReadPrec [ListWorkteams] #
Show ListWorkteams Source #
Instance details Defined in Amazonka.SageMaker.ListWorkteams Methods showsPrec :: Int -> ListWorkteams -> ShowS # show :: ListWorkteams -> String # showList :: [ListWorkteams] -> ShowS #
Generic ListWorkteams Source #
Instance details Defined in Amazonka.SageMaker.ListWorkteams Associated Types type Rep ListWorkteams :: Type -> Type # Methods from :: ListWorkteams -> Rep ListWorkteams x # to :: Rep ListWorkteams x -> ListWorkteams #
NFData ListWorkteams Source #
Instance details Defined in Amazonka.SageMaker.ListWorkteams Methods rnf :: ListWorkteams -> () #
Hashable ListWorkteams Source #
Instance details Defined in Amazonka.SageMaker.ListWorkteams Methods hashWithSalt :: Int -> ListWorkteams -> Int # hash :: ListWorkteams -> Int #
ToJSON ListWorkteams Source #
Instance details Defined in Amazonka.SageMaker.ListWorkteams Methods toJSON :: ListWorkteams -> Value # toEncoding :: ListWorkteams -> Encoding # toJSONList :: [ListWorkteams] -> Value # toEncodingList :: [ListWorkteams] -> Encoding #
AWSPager ListWorkteams Source #
Instance details Defined in Amazonka.SageMaker.ListWorkteams Methods page :: ListWorkteams -> AWSResponse ListWorkteams -> Maybe ListWorkteams #
AWSRequest ListWorkteams Source #
Instance details Defined in Amazonka.SageMaker.ListWorkteams Associated Types type AWSResponse ListWorkteams # Methods request :: ListWorkteams -> Request ListWorkteams # response :: MonadResource m => Logger -> Service -> Proxy ListWorkteams -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListWorkteams))) #
ToHeaders ListWorkteams Source #
Instance details Defined in Amazonka.SageMaker.ListWorkteams Methods toHeaders :: ListWorkteams -> [Header] #
ToPath ListWorkteams Source #
Instance details Defined in Amazonka.SageMaker.ListWorkteams Methods toPath :: ListWorkteams -> ByteString #
ToQuery ListWorkteams Source #
Instance details Defined in Amazonka.SageMaker.ListWorkteams Methods toQuery :: ListWorkteams -> QueryString #
type Rep ListWorkteams Source #
Instance details Defined in Amazonka.SageMaker.ListWorkteams type Rep ListWorkteams = D1 ('MetaData "ListWorkteams" "Amazonka.SageMaker.ListWorkteams" "libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker" 'False) (C1 ('MetaCons "ListWorkteams'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nameContains") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "sortOrder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SortOrder)) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "sortBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ListWorkteamsSortByOptions))))))
type AWSResponse ListWorkteams Source #
Instance details Defined in Amazonka.SageMaker.ListWorkteams type AWSResponse ListWorkteams = ListWorkteamsResponse

newListWorkteams :: ListWorkteams Source #

Create a value of ListWorkteams with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:nameContains:ListWorkteams', listWorkteams_nameContains - A string in the work team's name. This filter returns only work teams whose name contains the specified string.

$sel:nextToken:ListWorkteams', listWorkteams_nextToken - If the result of the previous ListWorkteams request was truncated, the response includes a NextToken. To retrieve the next set of labeling jobs, use the token in the next request.

$sel:sortOrder:ListWorkteams', listWorkteams_sortOrder - The sort order for results. The default is Ascending.

$sel:maxResults:ListWorkteams', listWorkteams_maxResults - The maximum number of work teams to return in each page of the response.

$sel:sortBy:ListWorkteams', listWorkteams_sortBy - The field to sort results by. The default is CreationTime.

Request Lenses

listWorkteams_nameContains :: Lens' ListWorkteams (Maybe Text) Source #

A string in the work team's name. This filter returns only work teams whose name contains the specified string.

listWorkteams_nextToken :: Lens' ListWorkteams (Maybe Text) Source #

If the result of the previous ListWorkteams request was truncated, the response includes a NextToken. To retrieve the next set of labeling jobs, use the token in the next request.

listWorkteams_sortOrder :: Lens' ListWorkteams (Maybe SortOrder) Source #

The sort order for results. The default is Ascending.

listWorkteams_maxResults :: Lens' ListWorkteams (Maybe Natural) Source #

The maximum number of work teams to return in each page of the response.

listWorkteams_sortBy :: Lens' ListWorkteams (Maybe ListWorkteamsSortByOptions) Source #

The field to sort results by. The default is CreationTime.

Destructuring the Response

data ListWorkteamsResponse Source #

See: newListWorkteamsResponse smart constructor.

Constructors

ListWorkteamsResponse'
Fields nextToken :: Maybe Text If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of work teams, use it in the subsequent request. httpStatus :: Int The response's http status code. workteams :: [Workteam] An array of `Workteam` objects, each describing a work team.

Instances

Instances details

Eq ListWorkteamsResponse Source #
Instance details Defined in Amazonka.SageMaker.ListWorkteams Methods (==) :: ListWorkteamsResponse -> ListWorkteamsResponse -> Bool # (/=) :: ListWorkteamsResponse -> ListWorkteamsResponse -> Bool #
Read ListWorkteamsResponse Source #
Instance details Defined in Amazonka.SageMaker.ListWorkteams Methods readsPrec :: Int -> ReadS ListWorkteamsResponse # readList :: ReadS [ListWorkteamsResponse] # readPrec :: ReadPrec ListWorkteamsResponse # readListPrec :: ReadPrec [ListWorkteamsResponse] #
Show ListWorkteamsResponse Source #
Instance details Defined in Amazonka.SageMaker.ListWorkteams Methods showsPrec :: Int -> ListWorkteamsResponse -> ShowS # show :: ListWorkteamsResponse -> String # showList :: [ListWorkteamsResponse] -> ShowS #
Generic ListWorkteamsResponse Source #
Instance details Defined in Amazonka.SageMaker.ListWorkteams Associated Types type Rep ListWorkteamsResponse :: Type -> Type # Methods from :: ListWorkteamsResponse -> Rep ListWorkteamsResponse x # to :: Rep ListWorkteamsResponse x -> ListWorkteamsResponse #
NFData ListWorkteamsResponse Source #
Instance details Defined in Amazonka.SageMaker.ListWorkteams Methods rnf :: ListWorkteamsResponse -> () #
type Rep ListWorkteamsResponse Source #
Instance details Defined in Amazonka.SageMaker.ListWorkteams type Rep ListWorkteamsResponse = D1 ('MetaData "ListWorkteamsResponse" "Amazonka.SageMaker.ListWorkteams" "libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker" 'False) (C1 ('MetaCons "ListWorkteamsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "workteams") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Workteam]))))

newListWorkteamsResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListWorkteamsResponse'`
-> ListWorkteamsResponse

Create a value of ListWorkteamsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:nextToken:ListWorkteams', listWorkteamsResponse_nextToken - If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of work teams, use it in the subsequent request.

$sel:httpStatus:ListWorkteamsResponse', listWorkteamsResponse_httpStatus - The response's http status code.

$sel:workteams:ListWorkteamsResponse', listWorkteamsResponse_workteams - An array of Workteam objects, each describing a work team.

Response Lenses

listWorkteamsResponse_nextToken :: Lens' ListWorkteamsResponse (Maybe Text) Source #

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of work teams, use it in the subsequent request.

listWorkteamsResponse_httpStatus :: Lens' ListWorkteamsResponse Int Source #

The response's http status code.

listWorkteamsResponse_workteams :: Lens' ListWorkteamsResponse [Workteam] Source #

An array of Workteam objects, each describing a work team.