Amazon Batch Compute Environments API

Operations for managing compute environments

Documentation

Specifications

Schemas & Data

Other Resources

🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/amazon-batch/refs/heads/main/json-ld/amazon-batch-context.jsonld
🔗
SpectralRuleset
https://raw.githubusercontent.com/api-evangelist/amazon-batch/refs/heads/main/spectral/ruleset.yml
🔗
Capabilities
https://raw.githubusercontent.com/api-evangelist/amazon-batch/refs/heads/main/capabilities/capabilities.yml
🔗
Vocabulary
https://raw.githubusercontent.com/api-evangelist/amazon-batch/refs/heads/main/vocabulary/vocabulary.yml
🔗
Pricing
https://aws.amazon.com/batch/pricing/
🔗
FAQ
https://aws.amazon.com/batch/faqs/
🔗
UserGuide
https://docs.aws.amazon.com/batch/latest/userguide/what-is-batch.html
🔗
CLIReference
https://docs.aws.amazon.com/cli/latest/reference/batch/
🔗
Security
https://docs.aws.amazon.com/batch/latest/userguide/security.html
🔗
Packages
https://raw.githubusercontent.com/api-evangelist/amazon-batch/refs/heads/main/packages/amazon-batch-packages.yml
🔗
LLMsTxt
https://raw.githubusercontent.com/api-evangelist/amazon-batch/refs/heads/main/llms/amazon-batch-llms.txt
🔗
Conformance
https://raw.githubusercontent.com/api-evangelist/amazon-batch/refs/heads/main/conformance/amazon-batch-conformance.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/amazon-batch/refs/heads/main/errors/amazon-batch-problem-types.yml
🔗
Lifecycle
https://raw.githubusercontent.com/api-evangelist/amazon-batch/refs/heads/main/lifecycle/amazon-batch-lifecycle.yml
🔗
APIsJSON
https://raw.githubusercontent.com/api-evangelist/amazon-batch/refs/heads/main/apis.yml

OpenAPI Specification

amazon-batch-compute-environments-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon Batch AWS Batch Compute Environments API
  description: The AWS Batch API enables programmatic management of batch computing workloads, including creating compute environments, job queues, job definitions, scheduling policies, and submitting and monitoring jobs at any scale.
  version: '2016-08-10'
  contact:
    name: AWS Support
    url: https://aws.amazon.com/premiumsupport/
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  x-logo:
    url: https://a0.awsstatic.com/libra-css/images/logos/aws_logo_smile_1200x630.png
servers:
- url: https://batch.{region}.amazonaws.com
  description: AWS Batch regional endpoint
  variables:
    region:
      default: us-east-1
      description: AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-southeast-1
      - ap-southeast-2
      - ap-south-1
      - sa-east-1
      - ca-central-1
security:
- sigv4: []
tags:
- name: Compute Environments
  description: Operations for managing compute environments
paths:
  /v1/createcomputeenvironment:
    post:
      operationId: CreateComputeEnvironment
      summary: Amazon Batch Create a compute environment
      description: Creates an AWS Batch compute environment.
      tags:
      - Compute Environments
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateComputeEnvironmentInput'
      responses:
        '200':
          description: Compute environment created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateComputeEnvironmentOutput'
components:
  schemas:
    CreateComputeEnvironmentOutput:
      type: object
      properties:
        computeEnvironmentName:
          type: string
        computeEnvironmentArn:
          type: string
    CreateComputeEnvironmentInput:
      type: object
      required:
      - computeEnvironmentName
      - type
      properties:
        computeEnvironmentName:
          type: string
        type:
          type: string
          enum:
          - MANAGED
          - UNMANAGED
        computeResources:
          type: object
        serviceRole:
          type: string
  securitySchemes:
    sigv4:
      type: apiKey
      name: Authorization
      in: header
      description: AWS Signature Version 4