You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::AppSync::Types::GetIntrospectionSchemaRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb

Overview

Note:

When making an API call, you may pass GetIntrospectionSchemaRequest data as a hash:

{
  api_id: "String", # required
  format: "SDL", # required, accepts SDL, JSON
  include_directives: false,
}

Instance Attribute Summary collapse

Instance Attribute Details

#api_idString

The API ID.

Returns:

  • (String)


1215
1216
1217
1218
1219
1220
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1215

class GetIntrospectionSchemaRequest < Struct.new(
  :api_id,
  :format,
  :include_directives)
  include Aws::Structure
end

#formatString

The schema format: SDL or JSON.

Returns:

  • (String)


1215
1216
1217
1218
1219
1220
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1215

class GetIntrospectionSchemaRequest < Struct.new(
  :api_id,
  :format,
  :include_directives)
  include Aws::Structure
end

#include_directivesBoolean

A flag that specifies whether the schema introspection should contain directives.

Returns:

  • (Boolean)


1215
1216
1217
1218
1219
1220
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1215

class GetIntrospectionSchemaRequest < Struct.new(
  :api_id,
  :format,
  :include_directives)
  include Aws::Structure
end