Amazonka.AppSync.StartSchemaCreation

Adds a new schema to your GraphQL API.

This operation is asynchronous. Use to determine when it has completed.

Creating a Request

data StartSchemaCreation

See: newStartSchemaCreation smart constructor.

Constructors

StartSchemaCreation'

Fields

• apiId :: Text

  The API ID.

• definition :: Base64

  The schema definition, in GraphQL schema language format.

Instances

ToJSON StartSchemaCreation

Defined in Amazonka.AppSync.StartSchemaCreation

Methods

toJSON :: StartSchemaCreation -> Value

toEncoding :: StartSchemaCreation -> Encoding

toJSONList :: [StartSchemaCreation] -> Value

toEncodingList :: [StartSchemaCreation] -> Encoding

ToHeaders StartSchemaCreation

Defined in Amazonka.AppSync.StartSchemaCreation

Methods

toHeaders :: StartSchemaCreation -> [Header]

ToPath StartSchemaCreation

Defined in Amazonka.AppSync.StartSchemaCreation

Methods

toPath :: StartSchemaCreation -> ByteString

ToQuery StartSchemaCreation

Defined in Amazonka.AppSync.StartSchemaCreation

Methods

toQuery :: StartSchemaCreation -> QueryString

AWSRequest StartSchemaCreation

Defined in Amazonka.AppSync.StartSchemaCreation

Associated Types

type AWSResponse StartSchemaCreation

Methods

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

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

Generic StartSchemaCreation

Defined in Amazonka.AppSync.StartSchemaCreation

Associated Types

type Rep StartSchemaCreation :: Type -> Type

Methods

from :: StartSchemaCreation -> Rep StartSchemaCreation x

to :: Rep StartSchemaCreation x -> StartSchemaCreation

Read StartSchemaCreation

Defined in Amazonka.AppSync.StartSchemaCreation

Methods

readsPrec :: Int -> ReadS StartSchemaCreation

readList :: ReadS [StartSchemaCreation]

readPrec :: ReadPrec StartSchemaCreation

readListPrec :: ReadPrec [StartSchemaCreation]

Show StartSchemaCreation

Defined in Amazonka.AppSync.StartSchemaCreation

Methods

showsPrec :: Int -> StartSchemaCreation -> ShowS

show :: StartSchemaCreation -> String

showList :: [StartSchemaCreation] -> ShowS

NFData StartSchemaCreation

Defined in Amazonka.AppSync.StartSchemaCreation

Methods

rnf :: StartSchemaCreation -> ()

Eq StartSchemaCreation

Defined in Amazonka.AppSync.StartSchemaCreation

Methods

(==) :: StartSchemaCreation -> StartSchemaCreation -> Bool

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

Hashable StartSchemaCreation

Defined in Amazonka.AppSync.StartSchemaCreation

Methods

hashWithSalt :: Int -> StartSchemaCreation -> Int

hash :: StartSchemaCreation -> Int

type AWSResponse StartSchemaCreation

Defined in Amazonka.AppSync.StartSchemaCreation

type AWSResponse StartSchemaCreation = StartSchemaCreationResponse

type Rep StartSchemaCreation

Defined in Amazonka.AppSync.StartSchemaCreation

type Rep StartSchemaCreation = D1 ('MetaData "StartSchemaCreation" "Amazonka.AppSync.StartSchemaCreation" "amazonka-appsync-2.0-4Pb6UqteLv1I9NIWaj90bg" 'False) (C1 ('MetaCons "StartSchemaCreation'" 'PrefixI 'True) (S1 ('MetaSel ('Just "apiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "definition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Base64)))

newStartSchemaCreation

Arguments

:: Text

StartSchemaCreation

-> ByteString

StartSchemaCreation

-> StartSchemaCreation

Create a value of StartSchemaCreation 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:

StartSchemaCreation, startSchemaCreation_apiId - The API ID.

StartSchemaCreation, startSchemaCreation_definition - The schema definition, in GraphQL schema language format.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

Request Lenses

startSchemaCreation_apiId :: Lens' StartSchemaCreation Text

The API ID.

startSchemaCreation_definition :: Lens' StartSchemaCreation ByteString

The schema definition, in GraphQL schema language format.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

Destructuring the Response

data StartSchemaCreationResponse

See: newStartSchemaCreationResponse smart constructor.

Constructors

StartSchemaCreationResponse'

Fields

• status :: Maybe SchemaStatus

  The current state of the schema (PROCESSING, FAILED, SUCCESS, or NOT_APPLICABLE). When the schema is in the ACTIVE state, you can add data.

• httpStatus :: Int

  The response's http status code.

Instances

Generic StartSchemaCreationResponse

Defined in Amazonka.AppSync.StartSchemaCreation

Associated Types

type Rep StartSchemaCreationResponse :: Type -> Type

Methods

from :: StartSchemaCreationResponse -> Rep StartSchemaCreationResponse x

to :: Rep StartSchemaCreationResponse x -> StartSchemaCreationResponse

Read StartSchemaCreationResponse

Defined in Amazonka.AppSync.StartSchemaCreation

Methods

readsPrec :: Int -> ReadS StartSchemaCreationResponse

readList :: ReadS [StartSchemaCreationResponse]

readPrec :: ReadPrec StartSchemaCreationResponse

readListPrec :: ReadPrec [StartSchemaCreationResponse]

Show StartSchemaCreationResponse

Defined in Amazonka.AppSync.StartSchemaCreation

Methods

showsPrec :: Int -> StartSchemaCreationResponse -> ShowS

show :: StartSchemaCreationResponse -> String

showList :: [StartSchemaCreationResponse] -> ShowS

NFData StartSchemaCreationResponse

Defined in Amazonka.AppSync.StartSchemaCreation

Methods

rnf :: StartSchemaCreationResponse -> ()

Eq StartSchemaCreationResponse

Defined in Amazonka.AppSync.StartSchemaCreation

Methods

(==) :: StartSchemaCreationResponse -> StartSchemaCreationResponse -> Bool

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

type Rep StartSchemaCreationResponse

Defined in Amazonka.AppSync.StartSchemaCreation

type Rep StartSchemaCreationResponse = D1 ('MetaData "StartSchemaCreationResponse" "Amazonka.AppSync.StartSchemaCreation" "amazonka-appsync-2.0-4Pb6UqteLv1I9NIWaj90bg" 'False) (C1 ('MetaCons "StartSchemaCreationResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SchemaStatus)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newStartSchemaCreationResponse

Arguments

:: Int

$sel:httpStatus:StartSchemaCreationResponse'

-> StartSchemaCreationResponse

Create a value of StartSchemaCreationResponse 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:

StartSchemaCreationResponse, startSchemaCreationResponse_status - The current state of the schema (PROCESSING, FAILED, SUCCESS, or NOT_APPLICABLE). When the schema is in the ACTIVE state, you can add data.

$sel:httpStatus:StartSchemaCreationResponse', startSchemaCreationResponse_httpStatus - The response's http status code.

Response Lenses

startSchemaCreationResponse_status :: Lens' StartSchemaCreationResponse (Maybe SchemaStatus)

The current state of the schema (PROCESSING, FAILED, SUCCESS, or NOT_APPLICABLE). When the schema is in the ACTIVE state, you can add data.

startSchemaCreationResponse_httpStatus :: Lens' StartSchemaCreationResponse Int

The response's http status code.