find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/amazon-amplify:amazon-amplify-backendenvironments-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.1.0
info:
  title: AWS Amplify Backendenvironments API
  version: '2017-07-25'
  description: Generated from AWS's published Smithy model for AWS Amplify. 4 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://amplify.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /apps/{appId}/backendenvironments:
    post:
      operationId: CreateBackendEnvironment
      summary: Create Backend Environment
      description: Creates a new backend environment for an Amplify app. This API is available only to Amplify Gen 1 applications
        where the backend is created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available
        to Amplify Gen 2 applications. When you deploy an application with Amplify Gen 2, you provision the app's backend
        infrastructure using Typescript code.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateBackendEnvironmentResult'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '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/CreateBackendEnvironmentRequest'
      tags:
      - Backendenvironments
    get:
      operationId: ListBackendEnvironments
      summary: List Backend Environments
      description: Lists the backend environments for an Amplify app. This API is available only to Amplify Gen 1 applications
        where the backend is created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available
        to Amplify Gen 2 applications. When you deploy an application with Amplify Gen 2, you provision the app's backend
        infrastructure using Typescript code.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListBackendEnvironmentsResult'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListBackendEnvironmentsRequest'
      tags:
      - Backendenvironments
  /apps/{appId}/backendenvironments/{environmentName}:
    delete:
      operationId: DeleteBackendEnvironment
      summary: Delete Backend Environment
      description: Deletes a backend environment for an Amplify app. This API is available only to Amplify Gen 1 applications
        where the backend is created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available
        to Amplify Gen 2 applications. When you deploy an application with Amplify Gen 2, you provision the app's backend
        infrastructure using Typescript code.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteBackendEnvironmentResult'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '503':
          description: DependentServiceFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DependentServiceFailureException'
        '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/DeleteBackendEnvironmentRequest'
      tags:
      - Backendenvironments
    get:
      operationId: GetBackendEnvironment
      summary: Get Backend Environment
      description: Returns a backend environment for an Amplify app. This API is available only to Amplify Gen 1 applications
        where the backend is created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available
        to Amplify Gen 2 applications. When you deploy an application with Amplify Gen 2, you provision the app's backend
        infrastructure using Typescript code.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetBackendEnvironmentResult'
        '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/GetBackendEnvironmentRequest'
      tags:
      - Backendenvironments
components:
  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: amplify
  schemas:
    BackendEnvironment:
      type: object
      properties:
        backendEnvironmentArn:
          type: string
          description: The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.
        environmentName:
          type: string
          description: The name for a backend environment that is part of an Amplify app.
        stackName:
          type: string
          description: The AWS CloudFormation stack name of a backend environment.
        deploymentArtifacts:
          type: string
          description: The name of deployment artifacts.
        createTime:
          type: string
          format: date-time
          description: The creation date and time for a backend environment that is part of an Amplify app.
        updateTime:
          type: string
          format: date-time
          description: The last updated date and time for a backend environment that is part of an Amplify app.
      required:
      - backendEnvironmentArn
      - environmentName
      - createTime
      - updateTime
    BadRequestException:
      type: object
      properties:
        message:
          type: string
    CreateBackendEnvironmentRequest:
      type: object
      properties:
        appId:
          type: string
          description: The unique ID for an Amplify app.
        environmentName:
          type: string
          description: The name for the backend environment.
        stackName:
          type: string
          description: The AWS CloudFormation stack name of a backend environment.
        deploymentArtifacts:
          type: string
          description: The name of deployment artifacts.
      required:
      - appId
      - environmentName
    CreateBackendEnvironmentResult:
      type: object
      properties:
        backendEnvironment:
          $ref: '#/components/schemas/BackendEnvironment'
      required:
      - backendEnvironment
    DeleteBackendEnvironmentRequest:
      type: object
      properties:
        appId:
          type: string
          description: The unique ID of an Amplify app.
        environmentName:
          type: string
          description: The name of a backend environment of an Amplify app.
      required:
      - appId
      - environmentName
    DeleteBackendEnvironmentResult:
      type: object
      properties:
        backendEnvironment:
          $ref: '#/components/schemas/BackendEnvironment'
      required:
      - backendEnvironment
    DependentServiceFailureException:
      type: object
      properties:
        message:
          type: string
    GetBackendEnvironmentRequest:
      type: object
      properties:
        appId:
          type: string
          description: The unique id for an Amplify app.
        environmentName:
          type: string
          description: The name for the backend environment.
      required:
      - appId
      - environmentName
    GetBackendEnvironmentResult:
      type: object
      properties:
        backendEnvironment:
          $ref: '#/components/schemas/BackendEnvironment'
      required:
      - backendEnvironment
    InternalFailureException:
      type: object
      properties:
        message:
          type: string
    LimitExceededException:
      type: object
      properties:
        message:
          type: string
    ListBackendEnvironmentsRequest:
      type: object
      properties:
        appId:
          type: string
          description: The unique ID for an Amplify app.
        environmentName:
          type: string
          description: The name of the backend environment
        nextToken:
          type: string
          description: A pagination token. Set to null to start listing backend environments from the start. If a non-null
            pagination token is returned in a result, pass its value in here to list more backend environments.
        maxResults:
          type: integer
          description: The maximum number of records to list in a single response.
      required:
      - appId
    ListBackendEnvironmentsResult:
      type: object
      properties:
        backendEnvironments:
          type: array
          items:
            $ref: '#/components/schemas/BackendEnvironment'
          description: The list of backend environments for an Amplify app.
        nextToken:
          type: string
          description: A pagination token. If a non-null pagination token is returned in a result, pass its value in another
            request to retrieve more entries.
      required:
      - backendEnvironments
    NotFoundException:
      type: object
      properties:
        message:
          type: string
    UnauthorizedException:
      type: object
      properties:
        message:
          type: string
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/amplify/service/2017-07-25/amplify-2017-07-25.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)