Amazonka.SageMaker.ListWorkteams

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.

Creating a Request

data ListWorkteams

See: newListWorkteams smart constructor.

Constructors

ListWorkteams'

Fields

• maxResults :: Maybe Natural

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

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

• sortBy :: Maybe ListWorkteamsSortByOptions

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

• sortOrder :: Maybe SortOrder

  The sort order for results. The default is Ascending.

Instances

ToJSON ListWorkteams

Defined in Amazonka.SageMaker.ListWorkteams

Methods

toJSON :: ListWorkteams -> Value

toEncoding :: ListWorkteams -> Encoding

toJSONList :: [ListWorkteams] -> Value

toEncodingList :: [ListWorkteams] -> Encoding

ToHeaders ListWorkteams

Defined in Amazonka.SageMaker.ListWorkteams

Methods

toHeaders :: ListWorkteams -> [Header]

ToPath ListWorkteams

Defined in Amazonka.SageMaker.ListWorkteams

Methods

toPath :: ListWorkteams -> ByteString

ToQuery ListWorkteams

Defined in Amazonka.SageMaker.ListWorkteams

Methods

toQuery :: ListWorkteams -> QueryString

AWSPager ListWorkteams

Defined in Amazonka.SageMaker.ListWorkteams

Methods

page :: ListWorkteams -> AWSResponse ListWorkteams -> Maybe ListWorkteams

AWSRequest ListWorkteams

Defined in Amazonka.SageMaker.ListWorkteams

Associated Types

type AWSResponse ListWorkteams

Methods

request :: (Service -> Service) -> ListWorkteams -> Request ListWorkteams

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListWorkteams -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListWorkteams)))

Generic ListWorkteams

Defined in Amazonka.SageMaker.ListWorkteams

Associated Types

type Rep ListWorkteams :: Type -> Type

Methods

from :: ListWorkteams -> Rep ListWorkteams x

to :: Rep ListWorkteams x -> ListWorkteams

Read ListWorkteams

Defined in Amazonka.SageMaker.ListWorkteams

Methods

readsPrec :: Int -> ReadS ListWorkteams

readList :: ReadS [ListWorkteams]

readPrec :: ReadPrec ListWorkteams

readListPrec :: ReadPrec [ListWorkteams]

Show ListWorkteams

Defined in Amazonka.SageMaker.ListWorkteams

Methods

showsPrec :: Int -> ListWorkteams -> ShowS

show :: ListWorkteams -> String

showList :: [ListWorkteams] -> ShowS

NFData ListWorkteams

Defined in Amazonka.SageMaker.ListWorkteams

Methods

rnf :: ListWorkteams -> ()

Eq ListWorkteams

Defined in Amazonka.SageMaker.ListWorkteams

Methods

(==) :: ListWorkteams -> ListWorkteams -> Bool

(/=) :: ListWorkteams -> ListWorkteams -> Bool

Hashable ListWorkteams

Defined in Amazonka.SageMaker.ListWorkteams

Methods

hashWithSalt :: Int -> ListWorkteams -> Int

hash :: ListWorkteams -> Int

type AWSResponse ListWorkteams

Defined in Amazonka.SageMaker.ListWorkteams

type AWSResponse ListWorkteams = ListWorkteamsResponse

type Rep ListWorkteams

Defined in Amazonka.SageMaker.ListWorkteams

type Rep ListWorkteams = D1 ('MetaData "ListWorkteams" "Amazonka.SageMaker.ListWorkteams" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "ListWorkteams'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nameContains") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "sortBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ListWorkteamsSortByOptions)) :*: S1 ('MetaSel ('Just "sortOrder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SortOrder))))))

newListWorkteams :: ListWorkteams

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:maxResults:ListWorkteams', listWorkteams_maxResults - The maximum number of work teams to return in each page of the response.

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

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:sortBy:ListWorkteams', listWorkteams_sortBy - The field to sort results by. The default is CreationTime.

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

Request Lenses

listWorkteams_maxResults :: Lens' ListWorkteams (Maybe Natural)

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

listWorkteams_nameContains :: Lens' ListWorkteams (Maybe Text)

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)

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_sortBy :: Lens' ListWorkteams (Maybe ListWorkteamsSortByOptions)

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

listWorkteams_sortOrder :: Lens' ListWorkteams (Maybe SortOrder)

The sort order for results. The default is Ascending.

Destructuring the Response

data ListWorkteamsResponse

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

Generic ListWorkteamsResponse

Defined in Amazonka.SageMaker.ListWorkteams

Associated Types

type Rep ListWorkteamsResponse :: Type -> Type

Methods

from :: ListWorkteamsResponse -> Rep ListWorkteamsResponse x

to :: Rep ListWorkteamsResponse x -> ListWorkteamsResponse

Read ListWorkteamsResponse

Defined in Amazonka.SageMaker.ListWorkteams

Methods

readsPrec :: Int -> ReadS ListWorkteamsResponse

readList :: ReadS [ListWorkteamsResponse]

readPrec :: ReadPrec ListWorkteamsResponse

readListPrec :: ReadPrec [ListWorkteamsResponse]

Show ListWorkteamsResponse

Defined in Amazonka.SageMaker.ListWorkteams

Methods

showsPrec :: Int -> ListWorkteamsResponse -> ShowS

show :: ListWorkteamsResponse -> String

showList :: [ListWorkteamsResponse] -> ShowS

NFData ListWorkteamsResponse

Defined in Amazonka.SageMaker.ListWorkteams

Methods

rnf :: ListWorkteamsResponse -> ()

Eq ListWorkteamsResponse

Defined in Amazonka.SageMaker.ListWorkteams

Methods

(==) :: ListWorkteamsResponse -> ListWorkteamsResponse -> Bool

(/=) :: ListWorkteamsResponse -> ListWorkteamsResponse -> Bool

type Rep ListWorkteamsResponse

Defined in Amazonka.SageMaker.ListWorkteams

type Rep ListWorkteamsResponse = D1 ('MetaData "ListWorkteamsResponse" "Amazonka.SageMaker.ListWorkteams" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" '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

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:

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)

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

The response's http status code.

listWorkteamsResponse_workteams :: Lens' ListWorkteamsResponse [Workteam]

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