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.AppSync.ListTypes

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the types for a given API.

This operation returns paginated results.

Synopsis

data ListTypes = ListTypes' {
- nextToken :: Maybe Text
- maxResults :: Maybe Natural
- apiId :: Text
- format :: TypeDefinitionFormat
}
newListTypes :: Text -> TypeDefinitionFormat -> ListTypes
listTypes_nextToken :: Lens' ListTypes (Maybe Text)
listTypes_maxResults :: Lens' ListTypes (Maybe Natural)
listTypes_apiId :: Lens' ListTypes Text
listTypes_format :: Lens' ListTypes TypeDefinitionFormat
data ListTypesResponse = ListTypesResponse' {
- types :: Maybe [Type]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListTypesResponse :: Int -> ListTypesResponse
listTypesResponse_types :: Lens' ListTypesResponse (Maybe [Type])
listTypesResponse_nextToken :: Lens' ListTypesResponse (Maybe Text)
listTypesResponse_httpStatus :: Lens' ListTypesResponse Int

Creating a Request

data ListTypes Source #

See: newListTypes smart constructor.

Constructors

ListTypes'
Fields nextToken :: Maybe Text An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list. maxResults :: Maybe Natural The maximum number of results you want the request to return. apiId :: Text The API ID. format :: TypeDefinitionFormat The type format: SDL or JSON.

Instances

Instances details

Eq ListTypes Source #
Instance details Defined in Amazonka.AppSync.ListTypes Methods (==) :: ListTypes -> ListTypes -> Bool # (/=) :: ListTypes -> ListTypes -> Bool #
Read ListTypes Source #
Instance details Defined in Amazonka.AppSync.ListTypes Methods readsPrec :: Int -> ReadS ListTypes # readList :: ReadS [ListTypes] # readPrec :: ReadPrec ListTypes # readListPrec :: ReadPrec [ListTypes] #
Show ListTypes Source #
Instance details Defined in Amazonka.AppSync.ListTypes Methods showsPrec :: Int -> ListTypes -> ShowS # show :: ListTypes -> String # showList :: [ListTypes] -> ShowS #
Generic ListTypes Source #
Instance details Defined in Amazonka.AppSync.ListTypes Associated Types type Rep ListTypes :: Type -> Type # Methods from :: ListTypes -> Rep ListTypes x # to :: Rep ListTypes x -> ListTypes #
NFData ListTypes Source #
Instance details Defined in Amazonka.AppSync.ListTypes Methods rnf :: ListTypes -> () #
Hashable ListTypes Source #
Instance details Defined in Amazonka.AppSync.ListTypes Methods hashWithSalt :: Int -> ListTypes -> Int # hash :: ListTypes -> Int #
AWSPager ListTypes Source #
Instance details Defined in Amazonka.AppSync.ListTypes Methods page :: ListTypes -> AWSResponse ListTypes -> Maybe ListTypes #
AWSRequest ListTypes Source #
Instance details Defined in Amazonka.AppSync.ListTypes Associated Types type AWSResponse ListTypes # Methods request :: ListTypes -> Request ListTypes # response :: MonadResource m => Logger -> Service -> Proxy ListTypes -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListTypes))) #
ToHeaders ListTypes Source #
Instance details Defined in Amazonka.AppSync.ListTypes Methods toHeaders :: ListTypes -> [Header] #
ToPath ListTypes Source #
Instance details Defined in Amazonka.AppSync.ListTypes Methods toPath :: ListTypes -> ByteString #
ToQuery ListTypes Source #
Instance details Defined in Amazonka.AppSync.ListTypes Methods toQuery :: ListTypes -> QueryString #
type Rep ListTypes Source #
Instance details Defined in Amazonka.AppSync.ListTypes type Rep ListTypes = D1 ('MetaData "ListTypes" "Amazonka.AppSync.ListTypes" "libZSservicesZSamazonka-appsyncZSamazonka-appsync" 'False) (C1 ('MetaCons "ListTypes'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "apiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "format") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TypeDefinitionFormat))))
type AWSResponse ListTypes Source #
Instance details Defined in Amazonka.AppSync.ListTypes type AWSResponse ListTypes = ListTypesResponse

newListTypes Source #

Arguments

:: Text	`$sel:apiId:ListTypes'`
-> TypeDefinitionFormat	`$sel:format:ListTypes'`
-> ListTypes

Create a value of ListTypes 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:ListTypes', listTypes_nextToken - An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

$sel:maxResults:ListTypes', listTypes_maxResults - The maximum number of results you want the request to return.

$sel:apiId:ListTypes', listTypes_apiId - The API ID.

$sel:format:ListTypes', listTypes_format - The type format: SDL or JSON.

Request Lenses

listTypes_nextToken :: Lens' ListTypes (Maybe Text) Source #

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

listTypes_maxResults :: Lens' ListTypes (Maybe Natural) Source #

The maximum number of results you want the request to return.

listTypes_apiId :: Lens' ListTypes Text Source #

The API ID.

listTypes_format :: Lens' ListTypes TypeDefinitionFormat Source #

The type format: SDL or JSON.

Destructuring the Response

data ListTypesResponse Source #

See: newListTypesResponse smart constructor.

Constructors

ListTypesResponse'
Fields types :: Maybe [Type] The `Type` objects. nextToken :: Maybe Text An identifier to be passed in the next request to this operation to return the next set of items in the list. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newListTypesResponse Source #

Arguments

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

Create a value of ListTypesResponse 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:types:ListTypesResponse', listTypesResponse_types - The Type objects.

$sel:nextToken:ListTypes', listTypesResponse_nextToken - An identifier to be passed in the next request to this operation to return the next set of items in the list.

$sel:httpStatus:ListTypesResponse', listTypesResponse_httpStatus - The response's http status code.

Response Lenses

listTypesResponse_types :: Lens' ListTypesResponse (Maybe [Type]) Source #

The Type objects.

listTypesResponse_nextToken :: Lens' ListTypesResponse (Maybe Text) Source #

An identifier to be passed in the next request to this operation to return the next set of items in the list.

listTypesResponse_httpStatus :: Lens' ListTypesResponse Int Source #

The response's http status code.