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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists endpoints.

This operation returns paginated results.

Synopsis

data ListEndpoints = ListEndpoints' {
- nameContains :: Maybe Text
- lastModifiedTimeBefore :: Maybe POSIX
- creationTimeAfter :: Maybe POSIX
- nextToken :: Maybe Text
- sortOrder :: Maybe OrderKey
- lastModifiedTimeAfter :: Maybe POSIX
- creationTimeBefore :: Maybe POSIX
- statusEquals :: Maybe EndpointStatus
- maxResults :: Maybe Natural
- sortBy :: Maybe EndpointSortKey
}
newListEndpoints :: ListEndpoints
listEndpoints_nameContains :: Lens' ListEndpoints (Maybe Text)
listEndpoints_lastModifiedTimeBefore :: Lens' ListEndpoints (Maybe UTCTime)
listEndpoints_creationTimeAfter :: Lens' ListEndpoints (Maybe UTCTime)
listEndpoints_nextToken :: Lens' ListEndpoints (Maybe Text)
listEndpoints_sortOrder :: Lens' ListEndpoints (Maybe OrderKey)
listEndpoints_lastModifiedTimeAfter :: Lens' ListEndpoints (Maybe UTCTime)
listEndpoints_creationTimeBefore :: Lens' ListEndpoints (Maybe UTCTime)
listEndpoints_statusEquals :: Lens' ListEndpoints (Maybe EndpointStatus)
listEndpoints_maxResults :: Lens' ListEndpoints (Maybe Natural)
listEndpoints_sortBy :: Lens' ListEndpoints (Maybe EndpointSortKey)
data ListEndpointsResponse = ListEndpointsResponse' {
- nextToken :: Maybe Text
- httpStatus :: Int
- endpoints :: [EndpointSummary]
}
newListEndpointsResponse :: Int -> ListEndpointsResponse
listEndpointsResponse_nextToken :: Lens' ListEndpointsResponse (Maybe Text)
listEndpointsResponse_httpStatus :: Lens' ListEndpointsResponse Int
listEndpointsResponse_endpoints :: Lens' ListEndpointsResponse [EndpointSummary]

Creating a Request

data ListEndpoints Source #

See: newListEndpoints smart constructor.

Constructors

ListEndpoints'

Fields

nameContains :: Maybe Text
A string in endpoint names. This filter returns only endpoints whose name contains the specified string.
lastModifiedTimeBefore :: Maybe POSIX
A filter that returns only endpoints that were modified before the specified timestamp.
creationTimeAfter :: Maybe POSIX
A filter that returns only endpoints with a creation time greater than or equal to the specified time (timestamp).
nextToken :: Maybe Text
If the result of a ListEndpoints request was truncated, the response includes a NextToken. To retrieve the next set of endpoints, use the token in the next request.
sortOrder :: Maybe OrderKey
The sort order for results. The default is Descending.
lastModifiedTimeAfter :: Maybe POSIX
A filter that returns only endpoints that were modified after the specified timestamp.
creationTimeBefore :: Maybe POSIX
A filter that returns only endpoints that were created before the specified time (timestamp).
statusEquals :: Maybe EndpointStatus
A filter that returns only endpoints with the specified status.
maxResults :: Maybe Natural
The maximum number of endpoints to return in the response. This value defaults to 10.
sortBy :: Maybe EndpointSortKey
Sorts the list of results. The default is CreationTime.

Instances

Instances details

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

newListEndpoints :: ListEndpoints Source #

Create a value of ListEndpoints 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:ListEndpoints', listEndpoints_nameContains - A string in endpoint names. This filter returns only endpoints whose name contains the specified string.

$sel:lastModifiedTimeBefore:ListEndpoints', listEndpoints_lastModifiedTimeBefore - A filter that returns only endpoints that were modified before the specified timestamp.

$sel:creationTimeAfter:ListEndpoints', listEndpoints_creationTimeAfter - A filter that returns only endpoints with a creation time greater than or equal to the specified time (timestamp).

$sel:nextToken:ListEndpoints', listEndpoints_nextToken - If the result of a ListEndpoints request was truncated, the response includes a NextToken. To retrieve the next set of endpoints, use the token in the next request.

$sel:sortOrder:ListEndpoints', listEndpoints_sortOrder - The sort order for results. The default is Descending.

$sel:lastModifiedTimeAfter:ListEndpoints', listEndpoints_lastModifiedTimeAfter - A filter that returns only endpoints that were modified after the specified timestamp.

$sel:creationTimeBefore:ListEndpoints', listEndpoints_creationTimeBefore - A filter that returns only endpoints that were created before the specified time (timestamp).

$sel:statusEquals:ListEndpoints', listEndpoints_statusEquals - A filter that returns only endpoints with the specified status.

$sel:maxResults:ListEndpoints', listEndpoints_maxResults - The maximum number of endpoints to return in the response. This value defaults to 10.

$sel:sortBy:ListEndpoints', listEndpoints_sortBy - Sorts the list of results. The default is CreationTime.

Request Lenses

listEndpoints_nameContains :: Lens' ListEndpoints (Maybe Text) Source #

A string in endpoint names. This filter returns only endpoints whose name contains the specified string.

listEndpoints_lastModifiedTimeBefore :: Lens' ListEndpoints (Maybe UTCTime) Source #

A filter that returns only endpoints that were modified before the specified timestamp.

listEndpoints_creationTimeAfter :: Lens' ListEndpoints (Maybe UTCTime) Source #

A filter that returns only endpoints with a creation time greater than or equal to the specified time (timestamp).

listEndpoints_nextToken :: Lens' ListEndpoints (Maybe Text) Source #

If the result of a ListEndpoints request was truncated, the response includes a NextToken. To retrieve the next set of endpoints, use the token in the next request.

listEndpoints_sortOrder :: Lens' ListEndpoints (Maybe OrderKey) Source #

The sort order for results. The default is Descending.

listEndpoints_lastModifiedTimeAfter :: Lens' ListEndpoints (Maybe UTCTime) Source #

A filter that returns only endpoints that were modified after the specified timestamp.

listEndpoints_creationTimeBefore :: Lens' ListEndpoints (Maybe UTCTime) Source #

A filter that returns only endpoints that were created before the specified time (timestamp).

listEndpoints_statusEquals :: Lens' ListEndpoints (Maybe EndpointStatus) Source #

A filter that returns only endpoints with the specified status.

listEndpoints_maxResults :: Lens' ListEndpoints (Maybe Natural) Source #

The maximum number of endpoints to return in the response. This value defaults to 10.

listEndpoints_sortBy :: Lens' ListEndpoints (Maybe EndpointSortKey) Source #

Sorts the list of results. The default is CreationTime.

Destructuring the Response

data ListEndpointsResponse Source #

See: newListEndpointsResponse smart constructor.

Constructors

ListEndpointsResponse'
Fields nextToken :: Maybe Text If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of training jobs, use it in the subsequent request. httpStatus :: Int The response's http status code. endpoints :: [EndpointSummary] An array or endpoint objects.

Instances

Instances details

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

newListEndpointsResponse Source #

Arguments

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

Create a value of ListEndpointsResponse 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:ListEndpoints', listEndpointsResponse_nextToken - If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of training jobs, use it in the subsequent request.

$sel:httpStatus:ListEndpointsResponse', listEndpointsResponse_httpStatus - The response's http status code.

$sel:endpoints:ListEndpointsResponse', listEndpointsResponse_endpoints - An array or endpoint objects.

Response Lenses

listEndpointsResponse_nextToken :: Lens' ListEndpointsResponse (Maybe Text) Source #

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

listEndpointsResponse_httpStatus :: Lens' ListEndpointsResponse Int Source #

The response's http status code.

listEndpointsResponse_endpoints :: Lens' ListEndpointsResponse [EndpointSummary] Source #

An array or endpoint objects.