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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Use this operation to list all private and vendor workforces in an Amazon Web Services Region. Note that you can only have one private workforce per Amazon Web Services Region.

This operation returns paginated results.

Synopsis

data ListWorkforces = ListWorkforces' {
- nameContains :: Maybe Text
- nextToken :: Maybe Text
- sortOrder :: Maybe SortOrder
- maxResults :: Maybe Natural
- sortBy :: Maybe ListWorkforcesSortByOptions
}
newListWorkforces :: ListWorkforces
listWorkforces_nameContains :: Lens' ListWorkforces (Maybe Text)
listWorkforces_nextToken :: Lens' ListWorkforces (Maybe Text)
listWorkforces_sortOrder :: Lens' ListWorkforces (Maybe SortOrder)
listWorkforces_maxResults :: Lens' ListWorkforces (Maybe Natural)
listWorkforces_sortBy :: Lens' ListWorkforces (Maybe ListWorkforcesSortByOptions)
data ListWorkforcesResponse = ListWorkforcesResponse' {
- nextToken :: Maybe Text
- httpStatus :: Int
- workforces :: [Workforce]
}
newListWorkforcesResponse :: Int -> ListWorkforcesResponse
listWorkforcesResponse_nextToken :: Lens' ListWorkforcesResponse (Maybe Text)
listWorkforcesResponse_httpStatus :: Lens' ListWorkforcesResponse Int
listWorkforcesResponse_workforces :: Lens' ListWorkforcesResponse [Workforce]

Creating a Request

data ListWorkforces Source #

See: newListWorkforces smart constructor.

Constructors

ListWorkforces'

Fields

nameContains :: Maybe Text
A filter you can use to search for workforces using part of the workforce name.
nextToken :: Maybe Text
A token to resume pagination.
sortOrder :: Maybe SortOrder
Sort workforces in ascending or descending order.
maxResults :: Maybe Natural
The maximum number of workforces returned in the response.
sortBy :: Maybe ListWorkforcesSortByOptions
Sort workforces using the workforce name or creation date.

Instances

Instances details

Eq ListWorkforces Source #
Instance details Defined in Amazonka.SageMaker.ListWorkforces Methods (==) :: ListWorkforces -> ListWorkforces -> Bool # (/=) :: ListWorkforces -> ListWorkforces -> Bool #
Read ListWorkforces Source #
Instance details Defined in Amazonka.SageMaker.ListWorkforces Methods readsPrec :: Int -> ReadS ListWorkforces # readList :: ReadS [ListWorkforces] # readPrec :: ReadPrec ListWorkforces # readListPrec :: ReadPrec [ListWorkforces] #
Show ListWorkforces Source #
Instance details Defined in Amazonka.SageMaker.ListWorkforces Methods showsPrec :: Int -> ListWorkforces -> ShowS # show :: ListWorkforces -> String # showList :: [ListWorkforces] -> ShowS #
Generic ListWorkforces Source #
Instance details Defined in Amazonka.SageMaker.ListWorkforces Associated Types type Rep ListWorkforces :: Type -> Type # Methods from :: ListWorkforces -> Rep ListWorkforces x # to :: Rep ListWorkforces x -> ListWorkforces #
NFData ListWorkforces Source #
Instance details Defined in Amazonka.SageMaker.ListWorkforces Methods rnf :: ListWorkforces -> () #
Hashable ListWorkforces Source #
Instance details Defined in Amazonka.SageMaker.ListWorkforces Methods hashWithSalt :: Int -> ListWorkforces -> Int # hash :: ListWorkforces -> Int #
ToJSON ListWorkforces Source #
Instance details Defined in Amazonka.SageMaker.ListWorkforces Methods toJSON :: ListWorkforces -> Value # toEncoding :: ListWorkforces -> Encoding # toJSONList :: [ListWorkforces] -> Value # toEncodingList :: [ListWorkforces] -> Encoding #
AWSPager ListWorkforces Source #
Instance details Defined in Amazonka.SageMaker.ListWorkforces Methods page :: ListWorkforces -> AWSResponse ListWorkforces -> Maybe ListWorkforces #
AWSRequest ListWorkforces Source #
Instance details Defined in Amazonka.SageMaker.ListWorkforces Associated Types type AWSResponse ListWorkforces # Methods request :: ListWorkforces -> Request ListWorkforces # response :: MonadResource m => Logger -> Service -> Proxy ListWorkforces -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListWorkforces))) #
ToHeaders ListWorkforces Source #
Instance details Defined in Amazonka.SageMaker.ListWorkforces Methods toHeaders :: ListWorkforces -> [Header] #
ToPath ListWorkforces Source #
Instance details Defined in Amazonka.SageMaker.ListWorkforces Methods toPath :: ListWorkforces -> ByteString #
ToQuery ListWorkforces Source #
Instance details Defined in Amazonka.SageMaker.ListWorkforces Methods toQuery :: ListWorkforces -> QueryString #
type Rep ListWorkforces Source #
Instance details Defined in Amazonka.SageMaker.ListWorkforces type Rep ListWorkforces = D1 ('MetaData "ListWorkforces" "Amazonka.SageMaker.ListWorkforces" "libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker" 'False) (C1 ('MetaCons "ListWorkforces'" '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 ListWorkforcesSortByOptions))))))
type AWSResponse ListWorkforces Source #
Instance details Defined in Amazonka.SageMaker.ListWorkforces type AWSResponse ListWorkforces = ListWorkforcesResponse

newListWorkforces :: ListWorkforces Source #

Create a value of ListWorkforces 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:ListWorkforces', listWorkforces_nameContains - A filter you can use to search for workforces using part of the workforce name.

$sel:nextToken:ListWorkforces', listWorkforces_nextToken - A token to resume pagination.

$sel:sortOrder:ListWorkforces', listWorkforces_sortOrder - Sort workforces in ascending or descending order.

$sel:maxResults:ListWorkforces', listWorkforces_maxResults - The maximum number of workforces returned in the response.

$sel:sortBy:ListWorkforces', listWorkforces_sortBy - Sort workforces using the workforce name or creation date.

Request Lenses

listWorkforces_nameContains :: Lens' ListWorkforces (Maybe Text) Source #

A filter you can use to search for workforces using part of the workforce name.

listWorkforces_nextToken :: Lens' ListWorkforces (Maybe Text) Source #

A token to resume pagination.

listWorkforces_sortOrder :: Lens' ListWorkforces (Maybe SortOrder) Source #

Sort workforces in ascending or descending order.

listWorkforces_maxResults :: Lens' ListWorkforces (Maybe Natural) Source #

The maximum number of workforces returned in the response.

listWorkforces_sortBy :: Lens' ListWorkforces (Maybe ListWorkforcesSortByOptions) Source #

Sort workforces using the workforce name or creation date.

Destructuring the Response

data ListWorkforcesResponse Source #

See: newListWorkforcesResponse smart constructor.

Constructors

ListWorkforcesResponse'
Fields nextToken :: Maybe Text A token to resume pagination. httpStatus :: Int The response's http status code. workforces :: [Workforce] A list containing information about your workforce.

Instances

Instances details

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

newListWorkforcesResponse Source #

Arguments

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

Create a value of ListWorkforcesResponse 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:ListWorkforces', listWorkforcesResponse_nextToken - A token to resume pagination.

$sel:httpStatus:ListWorkforcesResponse', listWorkforcesResponse_httpStatus - The response's http status code.

$sel:workforces:ListWorkforcesResponse', listWorkforcesResponse_workforces - A list containing information about your workforce.

Response Lenses

listWorkforcesResponse_nextToken :: Lens' ListWorkforcesResponse (Maybe Text) Source #

A token to resume pagination.

listWorkforcesResponse_httpStatus :: Lens' ListWorkforcesResponse Int Source #

The response's http status code.

listWorkforcesResponse_workforces :: Lens' ListWorkforcesResponse [Workforce] Source #

A list containing information about your workforce.