Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . appsync ]

list-types

Description

Lists the types for a given API.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  list-types
--api-id <value>
--format <value>
[--next-token <value>]
[--max-results <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--api-id (string)

The API ID.

--format (string)

The type format: SDL or JSON.

Possible values:

  • SDL
  • JSON

--next-token (string)

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.

--max-results (integer)

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

types -> (list)

The Type objects.

(structure)

Describes a type.

name -> (string)

The type name.

description -> (string)

The type description.

arn -> (string)

The type ARN.

definition -> (string)

The type definition.

format -> (string)

The type format: SDL or JSON.

nextToken -> (string)

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