Amazonka.SageMaker.ListEndpoints

Lists endpoints.

This operation returns paginated results.

Creating a Request

data ListEndpoints

See: newListEndpoints smart constructor.

Constructors

ListEndpoints'

Fields

• creationTimeAfter :: Maybe POSIX

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

• creationTimeBefore :: Maybe POSIX

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

• lastModifiedTimeAfter :: Maybe POSIX

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

• lastModifiedTimeBefore :: Maybe POSIX

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

• maxResults :: Maybe Natural

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

• nameContains :: Maybe Text

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

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

• sortBy :: Maybe EndpointSortKey

  Sorts the list of results. The default is CreationTime.

• sortOrder :: Maybe OrderKey

  The sort order for results. The default is Descending.

• statusEquals :: Maybe EndpointStatus

  A filter that returns only endpoints with the specified status.

Instances

ToJSON ListEndpoints

Defined in Amazonka.SageMaker.ListEndpoints

Methods

toJSON :: ListEndpoints -> Value

toEncoding :: ListEndpoints -> Encoding

toJSONList :: [ListEndpoints] -> Value

toEncodingList :: [ListEndpoints] -> Encoding

ToHeaders ListEndpoints

Defined in Amazonka.SageMaker.ListEndpoints

Methods

toHeaders :: ListEndpoints -> [Header]

ToPath ListEndpoints

Defined in Amazonka.SageMaker.ListEndpoints

Methods

toPath :: ListEndpoints -> ByteString

ToQuery ListEndpoints

Defined in Amazonka.SageMaker.ListEndpoints

Methods

toQuery :: ListEndpoints -> QueryString

AWSPager ListEndpoints

Defined in Amazonka.SageMaker.ListEndpoints

Methods

page :: ListEndpoints -> AWSResponse ListEndpoints -> Maybe ListEndpoints

AWSRequest ListEndpoints

Defined in Amazonka.SageMaker.ListEndpoints

Associated Types

type AWSResponse ListEndpoints

Methods

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

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

Generic ListEndpoints

Defined in Amazonka.SageMaker.ListEndpoints

Associated Types

type Rep ListEndpoints :: Type -> Type

Methods

from :: ListEndpoints -> Rep ListEndpoints x

to :: Rep ListEndpoints x -> ListEndpoints

Read ListEndpoints

Defined in Amazonka.SageMaker.ListEndpoints

Methods

readsPrec :: Int -> ReadS ListEndpoints

readList :: ReadS [ListEndpoints]

readPrec :: ReadPrec ListEndpoints

readListPrec :: ReadPrec [ListEndpoints]

Show ListEndpoints

Defined in Amazonka.SageMaker.ListEndpoints

Methods

showsPrec :: Int -> ListEndpoints -> ShowS

show :: ListEndpoints -> String

showList :: [ListEndpoints] -> ShowS

NFData ListEndpoints

Defined in Amazonka.SageMaker.ListEndpoints

Methods

rnf :: ListEndpoints -> ()

Eq ListEndpoints

Defined in Amazonka.SageMaker.ListEndpoints

Methods

(==) :: ListEndpoints -> ListEndpoints -> Bool

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

Hashable ListEndpoints

Defined in Amazonka.SageMaker.ListEndpoints

Methods

hashWithSalt :: Int -> ListEndpoints -> Int

hash :: ListEndpoints -> Int

type AWSResponse ListEndpoints

Defined in Amazonka.SageMaker.ListEndpoints

type AWSResponse ListEndpoints = ListEndpointsResponse

type Rep ListEndpoints

Defined in Amazonka.SageMaker.ListEndpoints

type Rep ListEndpoints = D1 ('MetaData "ListEndpoints" "Amazonka.SageMaker.ListEndpoints" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "ListEndpoints'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "creationTimeAfter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "creationTimeBefore") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "lastModifiedTimeAfter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "lastModifiedTimeBefore") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: 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 EndpointSortKey)) :*: (S1 ('MetaSel ('Just "sortOrder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OrderKey)) :*: S1 ('MetaSel ('Just "statusEquals") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EndpointStatus)))))))

newListEndpoints :: ListEndpoints

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:creationTimeAfter:ListEndpoints', listEndpoints_creationTimeAfter - A filter that returns only endpoints with a creation time greater than or equal to the specified time (timestamp).

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

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

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

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

$sel:nameContains:ListEndpoints', listEndpoints_nameContains - A string in endpoint names. This filter returns only endpoints whose name contains the specified string.

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:sortBy:ListEndpoints', listEndpoints_sortBy - Sorts the list of results. The default is CreationTime.

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

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

Request Lenses

listEndpoints_creationTimeAfter :: Lens' ListEndpoints (Maybe UTCTime)

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

listEndpoints_creationTimeBefore :: Lens' ListEndpoints (Maybe UTCTime)

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

listEndpoints_lastModifiedTimeAfter :: Lens' ListEndpoints (Maybe UTCTime)

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

listEndpoints_lastModifiedTimeBefore :: Lens' ListEndpoints (Maybe UTCTime)

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

listEndpoints_maxResults :: Lens' ListEndpoints (Maybe Natural)

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

listEndpoints_nameContains :: Lens' ListEndpoints (Maybe Text)

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

listEndpoints_nextToken :: Lens' ListEndpoints (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.

listEndpoints_sortBy :: Lens' ListEndpoints (Maybe EndpointSortKey)

Sorts the list of results. The default is CreationTime.

listEndpoints_sortOrder :: Lens' ListEndpoints (Maybe OrderKey)

The sort order for results. The default is Descending.

listEndpoints_statusEquals :: Lens' ListEndpoints (Maybe EndpointStatus)

A filter that returns only endpoints with the specified status.

Destructuring the Response

data ListEndpointsResponse

See: newListEndpointsResponse smart constructor.

Constructors

ListEndpointsResponse'

Fields

• nextToken :: Maybe Text

  If the response is truncated, 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

Generic ListEndpointsResponse

Defined in Amazonka.SageMaker.ListEndpoints

Associated Types

type Rep ListEndpointsResponse :: Type -> Type

Methods

from :: ListEndpointsResponse -> Rep ListEndpointsResponse x

to :: Rep ListEndpointsResponse x -> ListEndpointsResponse

Read ListEndpointsResponse

Defined in Amazonka.SageMaker.ListEndpoints

Methods

readsPrec :: Int -> ReadS ListEndpointsResponse

readList :: ReadS [ListEndpointsResponse]

readPrec :: ReadPrec ListEndpointsResponse

readListPrec :: ReadPrec [ListEndpointsResponse]

Show ListEndpointsResponse

Defined in Amazonka.SageMaker.ListEndpoints

Methods

showsPrec :: Int -> ListEndpointsResponse -> ShowS

show :: ListEndpointsResponse -> String

showList :: [ListEndpointsResponse] -> ShowS

NFData ListEndpointsResponse

Defined in Amazonka.SageMaker.ListEndpoints

Methods

rnf :: ListEndpointsResponse -> ()

Eq ListEndpointsResponse

Defined in Amazonka.SageMaker.ListEndpoints

Methods

(==) :: ListEndpointsResponse -> ListEndpointsResponse -> Bool

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

type Rep ListEndpointsResponse

Defined in Amazonka.SageMaker.ListEndpoints

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

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:

ListEndpoints, listEndpointsResponse_nextToken - If the response is truncated, 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.

ListEndpointsResponse, listEndpointsResponse_endpoints - An array or endpoint objects.

Response Lenses

listEndpointsResponse_nextToken :: Lens' ListEndpointsResponse (Maybe Text)

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

listEndpointsResponse_httpStatus :: Lens' ListEndpointsResponse Int

The response's http status code.

listEndpointsResponse_endpoints :: Lens' ListEndpointsResponse [EndpointSummary]

An array or endpoint objects.