Amazon AppSync Appsync Operations API

openapi: 3.2.0
info:
  title: AWS AppSync Operations API
  version: '2017-07-25'
  description: Generated from AWS's published Smithy model for AWS AppSync. 9 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://appsync.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Operations
paths:
  /v1/sourceApis/{sourceApiIdentifier}/mergedApiAssociations:
    post:
      operationId: AssociateMergedGraphqlApi
      summary: Associate Merged Graphql Api
      description: Creates an association between a Merged API and source API using the source API's identifier.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssociateMergedGraphqlApiResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '409':
          description: ConcurrentModificationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConcurrentModificationException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '429':
          description: LimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AssociateMergedGraphqlApiRequest'
      tags:
      - Operations
  /v1/sourceApis/{sourceApiIdentifier}/mergedApiAssociations/{associationId}:
    delete:
      operationId: DisassociateMergedGraphqlApi
      summary: Disassociate Merged Graphql Api
      description: Deletes an association between a Merged API and source API using the source API's identifier and the association ID.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DisassociateMergedGraphqlApiResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '409':
          description: ConcurrentModificationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConcurrentModificationException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DisassociateMergedGraphqlApiRequest'
      tags:
      - Operations
  /v1/dataplane-evaluatecode:
    post:
      operationId: EvaluateCode
      summary: Evaluate Code
      description: Evaluates the given code and returns the response. The code definition requirements depend on the specified runtime. For APPSYNC_JS runtimes, the code defines the request and response functions. The request function takes the incoming request after a GraphQL operation is parsed and converts it into a request configuration for the selected data source operation. The response function interprets responses from the data source and maps it to the shape of the GraphQL field output type.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EvaluateCodeResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EvaluateCodeRequest'
      tags:
      - Operations
  /v1/apis/{apiId}/FlushCache:
    delete:
      operationId: FlushApiCache
      summary: Flush Api Cache
      description: Flushes an ApiCache object.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FlushApiCacheResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '409':
          description: ConcurrentModificationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConcurrentModificationException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FlushApiCacheRequest'
      tags:
      - Operations
  /v1/apis/{apiId}/environmentVariables:
    get:
      operationId: GetGraphqlApiEnvironmentVariables
      summary: Get Graphql Api Environment Variables
      description: Retrieves the list of environmental variable key-value pairs associated with an API by its ID value.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetGraphqlApiEnvironmentVariablesResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetGraphqlApiEnvironmentVariablesRequest'
      tags:
      - Operations
    put:
      operationId: PutGraphqlApiEnvironmentVariables
      summary: Put Graphql Api Environment Variables
      description: 'Creates a list of environmental variables in an API by its ID value. When creating an environmental variable, it must follow the constraints below: Both JavaScript and VTL templates support environmental variables. Environmental variables are not evaluated before function invocation. Environmental variables only support string values. Any defined value in an environmental variable is considered a string literal and not expanded. Variable evaluations should ideally be performed in the function code. When creating an environmental variable key-value pair, it must follow the additional constraints below: Keys must begin with a letter. Keys must be at least two characters long. Keys can only contain letters, numbers, and the underscore character (_). Values can be up to 512 characters long. You can configure up to 50 key-value pairs in a GraphQL API. You can create a list of environmental variables by adding it to the environmentVariables payload as a list in the format {"key1":"value1","key2":"value2", …}. Note that each call of the PutGraphqlApiEnvironmentVariables action will result in the overwriting of the existing environmental variable list of that API. This means the existing e'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutGraphqlApiEnvironmentVariablesResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '409':
          description: ConcurrentModificationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConcurrentModificationException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutGraphqlApiEnvironmentVariablesRequest'
      tags:
      - Operations
  /v1/apis/{apiId}/schemacreation:
    get:
      operationId: GetSchemaCreationStatus
      summary: Get Schema Creation Status
      description: Retrieves the current status of a schema creation operation.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSchemaCreationStatusResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetSchemaCreationStatusRequest'
      tags:
      - Operations
    post:
      operationId: StartSchemaCreation
      summary: Start Schema Creation
      description: Adds a new schema to your GraphQL API. This operation is asynchronous. Use to determine when it has completed.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StartSchemaCreationResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '409':
          description: ConcurrentModificationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConcurrentModificationException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StartSchemaCreationRequest'
      tags:
      - Operations
  /v1/mergedApis/{mergedApiIdentifier}/sourceApiAssociations/{associationId}/merge:
    post:
      operationId: StartSchemaMerge
      summary: Start Schema Merge
      description: Initiates a merge operation. Returns a status that shows the result of the merge operation.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StartSchemaMergeResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '409':
          description: ConcurrentModificationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConcurrentModificationException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StartSchemaMergeRequest'
      tags:
      - Operations
components:
  schemas:
    SourceApiAssociation:
      type: object
      properties:
        associationId:
          type: string
          description: The ID generated by the AppSync service for the source API association.
        associationArn:
          type: string
          description: The Amazon Resource Name (ARN) of the source API association.
        sourceApiId:
          type: string
          description: The ID of the AppSync source API.
        sourceApiArn:
          type: string
          description: The Amazon Resource Name (ARN) of the AppSync source API.
        mergedApiArn:
          type: string
          description: The Amazon Resource Name (ARN) of the AppSync Merged API.
        mergedApiId:
          type: string
          description: The ID of the AppSync Merged API.
        description:
          type: string
          description: The description field.
        sourceApiAssociationConfig:
          $ref: '#/components/schemas/SourceApiAssociationConfig'
        sourceApiAssociationStatus:
          type: string
          enum:
          - MERGE_SCHEDULED
          - MERGE_FAILED
          - MERGE_SUCCESS
          - MERGE_IN_PROGRESS
          - AUTO_MERGE_SCHEDULE_FAILED
          - DELETION_SCHEDULED
          - DELETION_IN_PROGRESS
          - DELETION_FAILED
          description: The state of the source API association.
        sourceApiAssociationStatusDetail:
          type: string
          description: The detailed message related to the current state of the source API association.
        lastSuccessfulMergeDate:
          type: string
          format: date-time
          description: The datetime value of the last successful merge of the source API association. The result will be in UTC format and your local time zone.
    BadRequestDetail:
      type: object
      properties:
        codeErrors:
          type: array
          items:
            $ref: '#/components/schemas/CodeError'
          description: Contains the list of errors in the request.
    GetGraphqlApiEnvironmentVariablesResponse:
      type: object
      properties:
        environmentVariables:
          type: object
          additionalProperties:
            type: string
          description: 'The payload containing each environmental variable in the "key" : "value" format.'
    GetSchemaCreationStatusResponse:
      type: object
      properties:
        status:
          type: string
          enum:
          - PROCESSING
          - ACTIVE
          - DELETING
          - FAILED
          - SUCCESS
          - NOT_APPLICABLE
          description: The current state of the schema (PROCESSING, FAILED, SUCCESS, or NOT_APPLICABLE). When the schema is in the ACTIVE state, you can add data.
        details:
          type: string
          description: Detailed information about the status of the schema creation operation.
    PutGraphqlApiEnvironmentVariablesRequest:
      type: object
      properties:
        apiId:
          type: string
          description: The ID of the API to which the environmental variable list will be written.
        environmentVariables:
          type: object
          additionalProperties:
            type: string
          description: 'The list of environmental variables to add to the API. When creating an environmental variable key-value pair, it must follow the additional constraints below: Keys must begin with a letter. Keys must be at least two characters long. Keys can only contain letters, numbers, and the underscore character (_). Values can be up to 512 characters long. You can configure up to 50 key-value pairs in a GraphQL API. You can create a list of environmental variables by adding it to the environmentVariables payload as a list in the format {"key1":"value1","key2":"value2", …}. Note that each call of the Put'
      required:
      - apiId
      - environmentVariables
    ConcurrentModificationException:
      type: object
      properties:
        message:
          type: string
    GetGraphqlApiEnvironmentVariablesRequest:
      type: object
      properties:
        apiId:
          type: string
          description: The ID of the API from which the environmental variable list will be retrieved.
      required:
      - apiId
    EvaluateCodeRequest:
      type: object
      properties:
        runtime:
          $ref: '#/components/schemas/AppSyncRuntime'
        code:
          type: string
          description: The code definition to be evaluated. Note that code and runtime are both required for this action. The runtime value must be APPSYNC_JS.
        context:
          type: string
          description: The map that holds all of the contextual information for your resolver invocation. A context is required for this action.
        function:
          type: string
          description: The function within the code to be evaluated. If provided, the valid values are request and response.
      required:
      - runtime
      - code
      - context
    GetSchemaCreationStatusRequest:
      type: object
      properties:
        apiId:
          type: string
          description: The API ID.
      required:
      - apiId
    EvaluateCodeErrorDetail:
      type: object
      properties:
        message:
          type: string
          description: The error payload.
        codeErrors:
          type: array
          items:
            $ref: '#/components/schemas/CodeError'
          description: Contains the list of CodeError objects.
    LimitExceededException:
      type: object
      properties:
        message:
          type: string
    AppSyncRuntime:
      type: object
      properties:
        name:
          type: string
          enum:
          - APPSYNC_JS
          description: The name of the runtime to use. Currently, the only allowed value is APPSYNC_JS.
        runtimeVersion:
          type: string
          description: The version of the runtime to use. Currently, the only allowed version is 1.0.0.
      required:
      - name
      - runtimeVersion
    BadRequestException:
      type: object
      properties:
        message:
          type: string
        reason:
          type: string
          enum:
          - CODE_ERROR
        detail:
          $ref: '#/components/schemas/BadRequestDetail'
    DisassociateMergedGraphqlApiRequest:
      type: object
      properties:
        sourceApiIdentifier:
          type: string
          description: The identifier of the AppSync Source API. This is generated by the AppSync service. In most cases, source APIs (especially in your account) only require the API ID value or ARN of the source API. However, source APIs from other accounts (cross-account use cases) strictly require the full resource ARN of the source API.
        associationId:
          type: string
          description: The ID generated by the AppSync service for the source API association.
      required:
      - sourceApiIdentifier
      - associationId
    StartSchemaMergeRequest:
      type: object
      properties:
        associationId:
          type: string
          description: The ID generated by the AppSync service for the source API association.
        mergedApiIdentifier:
          type: string
          description: The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.
      required:
      - associationId
      - mergedApiIdentifier
    FlushApiCacheRequest:
      type: object
      properties:
        apiId:
          type: string
          description: The API ID.
      required:
      - apiId
    CodeError:
      type: object
      properties:
        errorType:
          type: string
          description: 'The type of code error. Examples include, but aren''t limited to: LINT_ERROR, PARSER_ERROR.'
        value:
          type: string
          description: 'A user presentable error. Examples include, but aren''t limited to: Parsing error: Unterminated string literal.'
        location:
          $ref: '#/components/schemas/CodeErrorLocation'
    FlushApiCacheResponse:
      type: object
      properties: {}
    StartSchemaMergeResponse:
      type: object
      properties:
        sourceApiAssociationStatus:
          type: string
          enum:
          - MERGE_SCHEDULED
          - MERGE_FAILED
          - MERGE_SUCCESS
          - MERGE_IN_PROGRESS
          - AUTO_MERGE_SCHEDULE_FAILED
          - DELETION_SCHEDULED
          - DELETION_IN_PROGRESS
          - DELETION_FAILED
          description: The state of the source API association.
    EvaluateCodeResponse:
      type: object
      properties:
        evaluationResult:
          type: string
          description: The result of the evaluation operation.
        error:
          $ref: '#/components/schemas/EvaluateCodeErrorDetail'
        logs:
          type: array
          items:
            type: string
          description: A list of logs that were generated by calls to util.log.info and util.log.error in the evaluated code.
        stash:
          type: string
          description: An object available inside each resolver and function handler. A single stash object lives through a single resolver run. Therefore, you can use the stash to pass arbitrary data across request and response handlers and across functions in a pipeline resolver.
        outErrors:
          type: string
          description: The list of runtime errors that are added to the GraphQL operation response.
    CodeErrorLocation:
      type: object
      properties:
        line:
          type: integer
          description: The line number in the code. Defaults to 0 if unknown.
        column:
          type: integer
          description: The column number in the code. Defaults to 0 if unknown.
        span:
          type: integer
          description: The span/length of the error. Defaults to -1 if unknown.
    DisassociateMergedGraphqlApiResponse:
      type: object
      properties:
        sourceApiAssociationStatus:
          type: string
          enum:
          - MERGE_SCHEDULED
          - MERGE_FAILED
          - MERGE_SUCCESS
          - MERGE_IN_PROGRESS
          - AUTO_MERGE_SCHEDULE_FAILED
          - DELETION_SCHEDULED
          - DELETION_IN_PROGRESS
          - DELETION_FAILED
          description: The state of the source API association.
    InternalFailureException:
      type: object
      properties:
        message:
          type: string
    UnauthorizedException:
      type: object
      properties:
        message:
          type: string
    NotFoundException:
      type: object
      properties:
        message:
          type: string
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
    SourceApiAssociationConfig:
      type: object
      properties:
        mergeType:
          type: string
          enum:
          - MANUAL_MERGE
          - AUTO_MERGE
          description: The property that indicates which merging option is enabled in the source API association. Valid merge types are MANUAL_MERGE (default) and AUTO_MERGE. Manual merges are the default behavior and require the user to trigger any changes from the source APIs to the merged API manually. Auto merges subscribe the merged API to the changes performed on the source APIs so that any change in the source APIs are also made to the merged API. Auto merges use MergedApiExecutionRoleArn to perform merge operations.
    StartSchemaCreationResponse:
      type: object
      properties:
        status:
          type: string
          enum:
          - PROCESSING
          - ACTIVE
          - DELETING
          - FAILED
          - SUCCESS
          - NOT_APPLICABLE
          description: The current state of the schema (PROCESSING, FAILED, SUCCESS, or NOT_APPLICABLE). When the schema is in the ACTIVE state, you can add data.
    AssociateMergedGraphqlApiResponse:
      type: object
      properties:
        sourceApiAssociation:
          $ref: '#/components/schemas/SourceApiAssociation'
    AssociateMergedGraphqlApiRequest:
      type: object
      properties:
        sourceApiIdentifier:
          type: string
          description: The identifier of the AppSync Source API. This is generated by the AppSync service. In most cases, source APIs (especially in your account) only require the API ID value or ARN of the source API. However, source APIs from other accounts (cross-account use cases) strictly require the full resource ARN of the source API.
        mergedApiIdentifier:
          type: string
          description: The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.
        description:
          type: string
          description: The description field.
        sourceApiAssociationConfig:
          $ref: '#/components/schemas/SourceApiAssociationConfig'
      required:
      - sourceApiIdentifier
      - mergedApiIdentifier
    PutGraphqlApiEnvironmentVariablesResponse:
      type: object
      properties:
        environmentVariables:
          type: object
          additionalProperties:
            type: string
          description: 'The payload containing each environmental variable in the "key" : "value" format.'
    StartSchemaCreationRequest:
      type: object
      properties:
        apiId:
          type: string
          description: The API ID.
        definition:
          type: string
          format: byte
          description: The schema definition, in GraphQL schema language format.
      required:
      - apiId
      - definition
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: appsync
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/appsync/service/2017-07-25/appsync-2017-07-25.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)