Amazonka.AppSync.ListTypes

Lists the types for a given API.

This operation returns paginated results.

Creating a Request

data ListTypes

See: newListTypes smart constructor.

Constructors

ListTypes'

Fields

• maxResults :: Maybe Natural

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

• nextToken :: Maybe Text

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

• apiId :: Text

  The API ID.

• format :: TypeDefinitionFormat

  The type format: SDL or JSON.

Instances

ToHeaders ListTypes

Defined in Amazonka.AppSync.ListTypes

Methods

toHeaders :: ListTypes -> [Header]

ToPath ListTypes

Defined in Amazonka.AppSync.ListTypes

Methods

toPath :: ListTypes -> ByteString

ToQuery ListTypes

Defined in Amazonka.AppSync.ListTypes

Methods

toQuery :: ListTypes -> QueryString

AWSPager ListTypes

Defined in Amazonka.AppSync.ListTypes

Methods

page :: ListTypes -> AWSResponse ListTypes -> Maybe ListTypes

AWSRequest ListTypes

Defined in Amazonka.AppSync.ListTypes

Associated Types

type AWSResponse ListTypes

Methods

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

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

Generic ListTypes

Defined in Amazonka.AppSync.ListTypes

Associated Types

type Rep ListTypes :: Type -> Type

Methods

from :: ListTypes -> Rep ListTypes x

to :: Rep ListTypes x -> ListTypes

Read ListTypes

Defined in Amazonka.AppSync.ListTypes

Methods

readsPrec :: Int -> ReadS ListTypes

readList :: ReadS [ListTypes]

readPrec :: ReadPrec ListTypes

readListPrec :: ReadPrec [ListTypes]

Show ListTypes

Defined in Amazonka.AppSync.ListTypes

Methods

showsPrec :: Int -> ListTypes -> ShowS

show :: ListTypes -> String

showList :: [ListTypes] -> ShowS

NFData ListTypes

Defined in Amazonka.AppSync.ListTypes

Methods

rnf :: ListTypes -> ()

Eq ListTypes

Defined in Amazonka.AppSync.ListTypes

Methods

(==) :: ListTypes -> ListTypes -> Bool

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

Hashable ListTypes

Defined in Amazonka.AppSync.ListTypes

Methods

hashWithSalt :: Int -> ListTypes -> Int

hash :: ListTypes -> Int

type AWSResponse ListTypes

Defined in Amazonka.AppSync.ListTypes

type AWSResponse ListTypes = ListTypesResponse

type Rep ListTypes

Defined in Amazonka.AppSync.ListTypes

type Rep ListTypes = D1 ('MetaData "ListTypes" "Amazonka.AppSync.ListTypes" "amazonka-appsync-2.0-4Pb6UqteLv1I9NIWaj90bg" 'False) (C1 ('MetaCons "ListTypes'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "apiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "format") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TypeDefinitionFormat))))

newListTypes

Arguments

:: Text

ListTypes

-> TypeDefinitionFormat

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:maxResults:ListTypes', listTypes_maxResults - The maximum number of results that you want the request to return.

ListTypes, listTypes_nextToken - An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.

ListTypes, listTypes_apiId - The API ID.

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

Request Lenses

listTypes_maxResults :: Lens' ListTypes (Maybe Natural)

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

listTypes_nextToken :: Lens' ListTypes (Maybe Text)

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

listTypes_apiId :: Lens' ListTypes Text

The API ID.

listTypes_format :: Lens' ListTypes TypeDefinitionFormat

The type format: SDL or JSON.

Destructuring the Response

data ListTypesResponse

See: newListTypesResponse smart constructor.

Constructors

ListTypesResponse'

Fields

• nextToken :: Maybe Text

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

• types :: Maybe [Type]

  The Type objects.

• httpStatus :: Int

  The response's http status code.

Instances

Generic ListTypesResponse

Defined in Amazonka.AppSync.ListTypes

Associated Types

type Rep ListTypesResponse :: Type -> Type

Methods

from :: ListTypesResponse -> Rep ListTypesResponse x

to :: Rep ListTypesResponse x -> ListTypesResponse

Read ListTypesResponse

Defined in Amazonka.AppSync.ListTypes

Methods

readsPrec :: Int -> ReadS ListTypesResponse

readList :: ReadS [ListTypesResponse]

readPrec :: ReadPrec ListTypesResponse

readListPrec :: ReadPrec [ListTypesResponse]

Show ListTypesResponse

Defined in Amazonka.AppSync.ListTypes

Methods

showsPrec :: Int -> ListTypesResponse -> ShowS

show :: ListTypesResponse -> String

showList :: [ListTypesResponse] -> ShowS

NFData ListTypesResponse

Defined in Amazonka.AppSync.ListTypes

Methods

rnf :: ListTypesResponse -> ()

Eq ListTypesResponse

Defined in Amazonka.AppSync.ListTypes

Methods

(==) :: ListTypesResponse -> ListTypesResponse -> Bool

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

type Rep ListTypesResponse

Defined in Amazonka.AppSync.ListTypes

type Rep ListTypesResponse = D1 ('MetaData "ListTypesResponse" "Amazonka.AppSync.ListTypes" "amazonka-appsync-2.0-4Pb6UqteLv1I9NIWaj90bg" 'False) (C1 ('MetaCons "ListTypesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "types") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Type])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListTypesResponse

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:

ListTypes, listTypesResponse_nextToken - An identifier to pass in the next request to this operation to return the next set of items in the list.

$sel:types:ListTypesResponse', listTypesResponse_types - The Type objects.

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

Response Lenses

listTypesResponse_nextToken :: Lens' ListTypesResponse (Maybe Text)

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

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

The Type objects.

listTypesResponse_httpStatus :: Lens' ListTypesResponse Int

The response's http status code.