amazonka-comprehend-2.0: Amazon Comprehend SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Comprehend.ListEndpoints

Description

Gets a list of all existing endpoints that you've created. For information about endpoints, see Managing endpoints.

This operation returns paginated results.

Synopsis

Creating a Request

data ListEndpoints Source #

See: newListEndpoints smart constructor.

Constructors

ListEndpoints' 

Fields

  • filter' :: Maybe EndpointFilter

    Filters the endpoints that are returned. You can filter endpoints on their name, model, status, or the date and time that they were created. You can only set one filter at a time.

  • maxResults :: Maybe Natural

    The maximum number of results to return in each page. The default is 100.

  • nextToken :: Maybe Text

    Identifies the next page of results to return.

Instances

Instances details
ToJSON ListEndpoints Source # 
Instance details

Defined in Amazonka.Comprehend.ListEndpoints

Methods

toJSON :: ListEndpoints -> Value #

toEncoding :: ListEndpoints -> Encoding #

toJSONList :: [ListEndpoints] -> Value #

toEncodingList :: [ListEndpoints] -> Encoding #

ToHeaders ListEndpoints Source # 
Instance details

Defined in Amazonka.Comprehend.ListEndpoints

Methods

toHeaders :: ListEndpoints -> [Header] #

ToPath ListEndpoints Source # 
Instance details

Defined in Amazonka.Comprehend.ListEndpoints

Methods

toPath :: ListEndpoints -> ByteString #

ToQuery ListEndpoints Source # 
Instance details

Defined in Amazonka.Comprehend.ListEndpoints

Methods

toQuery :: ListEndpoints -> QueryString #

AWSPager ListEndpoints Source # 
Instance details

Defined in Amazonka.Comprehend.ListEndpoints

Methods

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

AWSRequest ListEndpoints Source # 
Instance details

Defined in Amazonka.Comprehend.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 Source # 
Instance details

Defined in Amazonka.Comprehend.ListEndpoints

Associated Types

type Rep ListEndpoints :: Type -> Type #

Methods

from :: ListEndpoints -> Rep ListEndpoints x #

to :: Rep ListEndpoints x -> ListEndpoints #

Read ListEndpoints Source # 
Instance details

Defined in Amazonka.Comprehend.ListEndpoints

Methods

readsPrec :: Int -> ReadS ListEndpoints #

readList :: ReadS [ListEndpoints] #

readPrec :: ReadPrec ListEndpoints #

readListPrec :: ReadPrec [ListEndpoints] #

Show ListEndpoints Source # 
Instance details

Defined in Amazonka.Comprehend.ListEndpoints

Methods

showsPrec :: Int -> ListEndpoints -> ShowS #

show :: ListEndpoints -> String #

showList :: [ListEndpoints] -> ShowS #

NFData ListEndpoints Source # 
Instance details

Defined in Amazonka.Comprehend.ListEndpoints

Methods

rnf :: ListEndpoints -> () #

Eq ListEndpoints Source # 
Instance details

Defined in Amazonka.Comprehend.ListEndpoints

Methods

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

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

Hashable ListEndpoints Source # 
Instance details

Defined in Amazonka.Comprehend.ListEndpoints

Methods

hashWithSalt :: Int -> ListEndpoints -> Int #

hash :: ListEndpoints -> Int #

type AWSResponse ListEndpoints Source # 
Instance details

Defined in Amazonka.Comprehend.ListEndpoints

type AWSResponse ListEndpoints = ListEndpointsResponse
type Rep ListEndpoints Source # 
Instance details

Defined in Amazonka.Comprehend.ListEndpoints

type Rep ListEndpoints = D1 ('MetaData "ListEndpoints" "Amazonka.Comprehend.ListEndpoints" "amazonka-comprehend-2.0-Ko6GCjAQF2RARapSdPn69F" 'False) (C1 ('MetaCons "ListEndpoints'" 'PrefixI 'True) (S1 ('MetaSel ('Just "filter'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EndpointFilter)) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

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:filter':ListEndpoints', listEndpoints_filter - Filters the endpoints that are returned. You can filter endpoints on their name, model, status, or the date and time that they were created. You can only set one filter at a time.

$sel:maxResults:ListEndpoints', listEndpoints_maxResults - The maximum number of results to return in each page. The default is 100.

ListEndpoints, listEndpoints_nextToken - Identifies the next page of results to return.

Request Lenses

listEndpoints_filter :: Lens' ListEndpoints (Maybe EndpointFilter) Source #

Filters the endpoints that are returned. You can filter endpoints on their name, model, status, or the date and time that they were created. You can only set one filter at a time.

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

The maximum number of results to return in each page. The default is 100.

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

Identifies the next page of results to return.

Destructuring the Response

data ListEndpointsResponse Source #

See: newListEndpointsResponse smart constructor.

Constructors

ListEndpointsResponse' 

Fields

Instances

Instances details
Generic ListEndpointsResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListEndpoints

Associated Types

type Rep ListEndpointsResponse :: Type -> Type #

Methods

from :: ListEndpointsResponse -> Rep ListEndpointsResponse x #

to :: Rep ListEndpointsResponse x -> ListEndpointsResponse #

Read ListEndpointsResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListEndpoints

Methods

readsPrec :: Int -> ReadS ListEndpointsResponse #

readList :: ReadS [ListEndpointsResponse] #

readPrec :: ReadPrec ListEndpointsResponse #

readListPrec :: ReadPrec [ListEndpointsResponse] #

Show ListEndpointsResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListEndpoints

Methods

showsPrec :: Int -> ListEndpointsResponse -> ShowS #

show :: ListEndpointsResponse -> String #

showList :: [ListEndpointsResponse] -> ShowS #

NFData ListEndpointsResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListEndpoints

Methods

rnf :: ListEndpointsResponse -> () #

Eq ListEndpointsResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListEndpoints

Methods

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

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

type Rep ListEndpointsResponse Source # 
Instance details

Defined in Amazonka.Comprehend.ListEndpoints

type Rep ListEndpointsResponse = D1 ('MetaData "ListEndpointsResponse" "Amazonka.Comprehend.ListEndpoints" "amazonka-comprehend-2.0-Ko6GCjAQF2RARapSdPn69F" 'False) (C1 ('MetaCons "ListEndpointsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "endpointPropertiesList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EndpointProperties])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

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:endpointPropertiesList:ListEndpointsResponse', listEndpointsResponse_endpointPropertiesList - Displays a list of endpoint properties being retrieved by the service in response to the request.

ListEndpoints, listEndpointsResponse_nextToken - Identifies the next page of results to return.

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

Response Lenses

listEndpointsResponse_endpointPropertiesList :: Lens' ListEndpointsResponse (Maybe [EndpointProperties]) Source #

Displays a list of endpoint properties being retrieved by the service in response to the request.

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

Identifies the next page of results to return.

listEndpointsResponse_httpStatus :: Lens' ListEndpointsResponse Int Source #

The response's http status code.