Batch

Implementation details for API batch

Coverage Overview

Batch is supported by LocalStack only in the pro image.

AvailabilityTesting*
OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
CancelJob✔️pro✔️
CreateComputeEnvironment✔️pro✔️✔️✔️✔️✔️Show Tests
CreateJobQueue✔️pro✔️✔️✔️✔️✔️Show Tests
CreateSchedulingPolicy✔️pro✔️✔️
DeleteComputeEnvironment✔️pro✔️✔️✔️✔️✔️Show Tests
DeleteJobQueue✔️pro✔️✔️✔️✔️✔️Show Tests
DeleteSchedulingPolicy✔️pro✔️✔️
DeregisterJobDefinition✔️pro✔️✔️✔️✔️✔️Show Tests
DescribeComputeEnvironments✔️pro✔️✔️✔️✔️✔️Show Tests
DescribeJobDefinitions✔️pro✔️✔️✔️✔️✔️Show Tests
DescribeJobQueues✔️pro✔️✔️✔️✔️✔️Show Tests
DescribeJobs✔️pro✔️✔️✔️✔️Show Tests
DescribeSchedulingPolicies✔️pro✔️✔️
GetJobQueueSnapshot
ListJobs✔️pro✔️
ListSchedulingPolicies✔️pro✔️
ListTagsForResource✔️pro✔️
RegisterJobDefinition✔️pro✔️✔️✔️✔️✔️Show Tests
SubmitJob✔️pro✔️✔️✔️✔️Show Tests
TagResource✔️pro✔️✔️
TerminateJob✔️pro✔️
UntagResource✔️pro✔️✔️
UpdateComputeEnvironment✔️pro✔️✔️✔️Show Tests
UpdateJobQueue✔️pro✔️✔️
UpdateSchedulingPolicy✔️pro✔️✔️

Terminology

  • Internal Test Suite: tested by LocalStack's internal integration test suite
  • External Test Suite: covered by an external integration test suite, that runs against LocalStack
  • Terraform Validated: operation tested with Terraform
  • AWS Validated: the integration test that includes this operation call was validated against AWS
  • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

Testing Details

This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

How to read the test details?

For each operation we put up a list of the related integration test cases.
Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

  • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
  • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
    • test name
    • status code returned (which is the expected one for the test case)
    • information about validation:
      • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
      • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


CreateComputeEnvironment

Parameters: computeEnvironmentName, computeResources, serviceRole, state, type
  • LocalStack Pro
    • test_deployed_compute_environment LocalStack Pro: tests/aws/services/cloudformation/resources/test_batch.py::TestBatch::test_deployed_compute_environment HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_batch_failure LocalStack Pro: tests/aws/services/stepfunctions/test_batch_integration.py::TestBatchIntegration::test_batch_failure HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_batch_invalid LocalStack Pro: tests/aws/services/stepfunctions/test_batch_integration.py::TestBatchIntegration::test_batch_invalid HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_batch_request_response LocalStack Pro: tests/aws/services/stepfunctions/test_batch_integration.py::TestBatchIntegration::test_batch_request_response HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_batch_sync LocalStack Pro: tests/aws/services/stepfunctions/test_batch_integration.py::TestBatchIntegration::test_batch_sync HTTP Status Code: 200 AWS validated Snapshot Tested
Parameters: computeEnvironmentName, computeResources, serviceRole, type
  • LocalStack Pro
    • test_batch_create_compute_environment LocalStack Pro: tests/aws/services/iam/test_iam_enforcement.py::TestIAMEnforcementIdentityBasedPolicies::test_batch_create_compute_environment HTTP Status Code: 200
    • test_environment_with_empty_params LocalStack Pro: tests/aws/services/batch/test_batch.py::TestBatch::test_environment_with_empty_params HTTP Status Code: 400 (ClientException)
Parameters: computeEnvironmentName, serviceRole, type
  • LocalStack Pro
    • test_create_job_default_command LocalStack Pro: tests/aws/services/batch/test_batch.py::TestBatch::test_create_job_default_command HTTP Status Code: 200
    • test_create_submit_job LocalStack Pro: tests/aws/services/batch/test_batch.py::TestBatch::test_create_submit_job HTTP Status Code: 200
    • test_create_with_additional_config LocalStack Pro: tests/aws/services/batch/test_batch.py::TestBatch::test_create_with_additional_config HTTP Status Code: 200

CreateJobQueue

Parameters: computeEnvironmentOrder, jobQueueName, priority, state
  • LocalStack Pro
    • test_create_job_default_command LocalStack Pro: tests/aws/services/batch/test_batch.py::TestBatch::test_create_job_default_command HTTP Status Code: 200
    • test_create_submit_job LocalStack Pro: tests/aws/services/batch/test_batch.py::TestBatch::test_create_submit_job HTTP Status Code: 200
    • test_create_with_additional_config LocalStack Pro: tests/aws/services/batch/test_batch.py::TestBatch::test_create_with_additional_config HTTP Status Code: 200
    • test_deployed_compute_environment LocalStack Pro: tests/aws/services/cloudformation/resources/test_batch.py::TestBatch::test_deployed_compute_environment HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_batch_failure LocalStack Pro: tests/aws/services/stepfunctions/test_batch_integration.py::TestBatchIntegration::test_batch_failure HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_batch_invalid LocalStack Pro: tests/aws/services/stepfunctions/test_batch_integration.py::TestBatchIntegration::test_batch_invalid HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_batch_request_response LocalStack Pro: tests/aws/services/stepfunctions/test_batch_integration.py::TestBatchIntegration::test_batch_request_response HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_batch_sync LocalStack Pro: tests/aws/services/stepfunctions/test_batch_integration.py::TestBatchIntegration::test_batch_sync HTTP Status Code: 200 AWS validated Snapshot Tested

DeleteComputeEnvironment

Parameters: computeEnvironment
  • LocalStack Pro
    • test_create_with_additional_config LocalStack Pro: tests/aws/services/batch/test_batch.py::TestBatch::test_create_with_additional_config HTTP Status Code: 200
    • test_submit_job LocalStack Pro: tests/aws/services/cloudformation/resources/test_batch.py::TestBatch::test_submit_job HTTP Status Code: 200 AWS validated
    • test_batch_create_compute_environment LocalStack Pro: tests/aws/services/iam/test_iam_enforcement.py::TestIAMEnforcementIdentityBasedPolicies::test_batch_create_compute_environment HTTP Status Code: 200
    • test_batch_failure LocalStack Pro: tests/aws/services/stepfunctions/test_batch_integration.py::TestBatchIntegration::test_batch_failure HTTP Status Code: 200 AWS validated Snapshot Tested

DeleteJobQueue

Parameters: jobQueue
  • LocalStack Pro
    • test_create_job_default_command LocalStack Pro: tests/aws/services/batch/test_batch.py::TestBatch::test_create_job_default_command HTTP Status Code: 200
    • test_create_submit_job LocalStack Pro: tests/aws/services/batch/test_batch.py::TestBatch::test_create_submit_job HTTP Status Code: 200
    • test_create_with_additional_config LocalStack Pro: tests/aws/services/batch/test_batch.py::TestBatch::test_create_with_additional_config HTTP Status Code: 200
    • test_submit_job LocalStack Pro: tests/aws/services/cloudformation/resources/test_batch.py::TestBatch::test_submit_job HTTP Status Code: 200 AWS validated
    • test_batch_failure LocalStack Pro: tests/aws/services/stepfunctions/test_batch_integration.py::TestBatchIntegration::test_batch_failure HTTP Status Code: 200 AWS validated Snapshot Tested

DeregisterJobDefinition

Parameters: jobDefinition
  • LocalStack Pro
    • test_create_job_default_command LocalStack Pro: tests/aws/services/batch/test_batch.py::TestBatch::test_create_job_default_command HTTP Status Code: 200
    • test_create_submit_job LocalStack Pro: tests/aws/services/batch/test_batch.py::TestBatch::test_create_submit_job HTTP Status Code: 200
    • test_create_with_additional_config LocalStack Pro: tests/aws/services/batch/test_batch.py::TestBatch::test_create_with_additional_config HTTP Status Code: 200
    • test_describe_all_active_job_definitions LocalStack Pro: tests/aws/services/batch/test_batch.py::TestBatch::test_describe_all_active_job_definitions HTTP Status Code: 200
    • test_describe_filtered_job_definitions LocalStack Pro: tests/aws/services/batch/test_batch.py::TestBatch::test_describe_filtered_job_definitions HTTP Status Code: 200
    • test_submit_job LocalStack Pro: tests/aws/services/cloudformation/resources/test_batch.py::TestBatch::test_submit_job HTTP Status Code: 200 AWS validated
    • test_batch_failure LocalStack Pro: tests/aws/services/stepfunctions/test_batch_integration.py::TestBatchIntegration::test_batch_failure HTTP Status Code: 200 AWS validated Snapshot Tested

DescribeComputeEnvironments

Parameters: computeEnvironments
  • LocalStack Pro
    • test_deployed_compute_environment LocalStack Pro: tests/aws/services/cloudformation/resources/test_batch.py::TestBatch::test_deployed_compute_environment HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_deployed_compute_environment LocalStack Pro: tests/aws/services/cloudformation/resources/test_batch.py::TestBatch::test_deployed_compute_environment HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_submit_job LocalStack Pro: tests/aws/services/cloudformation/resources/test_batch.py::TestBatch::test_submit_job HTTP Status Code: 200 AWS validated
    • test_batch_failure LocalStack Pro: tests/aws/services/stepfunctions/test_batch_integration.py::TestBatchIntegration::test_batch_failure HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_batch_invalid LocalStack Pro: tests/aws/services/stepfunctions/test_batch_integration.py::TestBatchIntegration::test_batch_invalid HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_batch_request_response LocalStack Pro: tests/aws/services/stepfunctions/test_batch_integration.py::TestBatchIntegration::test_batch_request_response HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_batch_sync LocalStack Pro: tests/aws/services/stepfunctions/test_batch_integration.py::TestBatchIntegration::test_batch_sync HTTP Status Code: 200 AWS validated Snapshot Tested

DescribeJobDefinitions

Parameters: jobDefinitions
  • LocalStack Pro
    • test_describe_filtered_job_definitions LocalStack Pro: tests/aws/services/batch/test_batch.py::TestBatch::test_describe_filtered_job_definitions HTTP Status Code: 200
    • test_deployed_job_definition LocalStack Pro: tests/aws/services/cloudformation/resources/test_batch.py::TestBatch::test_deployed_job_definition HTTP Status Code: 200 AWS validated Snapshot Tested
Parameters: status
  • LocalStack Pro
    • test_describe_all_active_job_definitions LocalStack Pro: tests/aws/services/batch/test_batch.py::TestBatch::test_describe_all_active_job_definitions HTTP Status Code: 200

DescribeJobQueues

Parameters: jobQueues
  • LocalStack Pro
    • test_deployed_job_queue LocalStack Pro: tests/aws/services/cloudformation/resources/test_batch.py::TestBatch::test_deployed_job_queue HTTP Status Code: 200 AWS validated Snapshot Tested

DescribeJobs

Parameters: jobs
  • LocalStack Pro
    • test_create_job_default_command LocalStack Pro: tests/aws/services/batch/test_batch.py::TestBatch::test_create_job_default_command HTTP Status Code: 200
    • test_create_submit_job LocalStack Pro: tests/aws/services/batch/test_batch.py::TestBatch::test_create_submit_job HTTP Status Code: 200
    • test_create_with_additional_config LocalStack Pro: tests/aws/services/batch/test_batch.py::TestBatch::test_create_with_additional_config HTTP Status Code: 200
    • test_submit_job LocalStack Pro: tests/aws/services/cloudformation/resources/test_batch.py::TestBatch::test_submit_job HTTP Status Code: 200 AWS validated
    • test_batch_failure LocalStack Pro: tests/aws/services/stepfunctions/test_batch_integration.py::TestBatchIntegration::test_batch_failure HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_batch_sync LocalStack Pro: tests/aws/services/stepfunctions/test_batch_integration.py::TestBatchIntegration::test_batch_sync HTTP Status Code: 200 AWS validated Snapshot Tested

RegisterJobDefinition

Parameters: containerProperties, jobDefinitionName, platformCapabilities, retryStrategy, timeout, type
  • LocalStack Pro
    • test_deployed_compute_environment LocalStack Pro: tests/aws/services/cloudformation/resources/test_batch.py::TestBatch::test_deployed_compute_environment HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_batch_failure LocalStack Pro: tests/aws/services/stepfunctions/test_batch_integration.py::TestBatchIntegration::test_batch_failure HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_batch_invalid LocalStack Pro: tests/aws/services/stepfunctions/test_batch_integration.py::TestBatchIntegration::test_batch_invalid HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_batch_request_response LocalStack Pro: tests/aws/services/stepfunctions/test_batch_integration.py::TestBatchIntegration::test_batch_request_response HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_batch_sync LocalStack Pro: tests/aws/services/stepfunctions/test_batch_integration.py::TestBatchIntegration::test_batch_sync HTTP Status Code: 200 AWS validated Snapshot Tested
Parameters: containerProperties, jobDefinitionName, type
  • LocalStack Pro
    • test_create_job_default_command LocalStack Pro: tests/aws/services/batch/test_batch.py::TestBatch::test_create_job_default_command HTTP Status Code: 200
    • test_create_submit_job LocalStack Pro: tests/aws/services/batch/test_batch.py::TestBatch::test_create_submit_job HTTP Status Code: 200
    • test_create_with_additional_config LocalStack Pro: tests/aws/services/batch/test_batch.py::TestBatch::test_create_with_additional_config HTTP Status Code: 200
    • test_describe_all_active_job_definitions LocalStack Pro: tests/aws/services/batch/test_batch.py::TestBatch::test_describe_all_active_job_definitions HTTP Status Code: 200
    • test_describe_filtered_job_definitions LocalStack Pro: tests/aws/services/batch/test_batch.py::TestBatch::test_describe_filtered_job_definitions HTTP Status Code: 200

SubmitJob

Parameters: containerOverrides, jobDefinition, jobName, jobQueue
  • LocalStack Pro
    • test_create_submit_job LocalStack Pro: tests/aws/services/batch/test_batch.py::TestBatch::test_create_submit_job HTTP Status Code: 200
    • test_create_with_additional_config LocalStack Pro: tests/aws/services/batch/test_batch.py::TestBatch::test_create_with_additional_config HTTP Status Code: 200
    • test_batch_failure LocalStack Pro: tests/aws/services/stepfunctions/test_batch_integration.py::TestBatchIntegration::test_batch_failure HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_batch_sync LocalStack Pro: tests/aws/services/stepfunctions/test_batch_integration.py::TestBatchIntegration::test_batch_sync HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_batch_invalid LocalStack Pro: tests/aws/services/stepfunctions/test_batch_integration.py::TestBatchIntegration::test_batch_invalid HTTP Status Code: 400 (ClientException) AWS validated Snapshot Tested
Parameters: jobDefinition, jobName, jobQueue
  • LocalStack Pro
    • test_create_job_default_command LocalStack Pro: tests/aws/services/batch/test_batch.py::TestBatch::test_create_job_default_command HTTP Status Code: 200
    • test_submit_job LocalStack Pro: tests/aws/services/cloudformation/resources/test_batch.py::TestBatch::test_submit_job HTTP Status Code: 200 AWS validated
    • test_batch_request_response LocalStack Pro: tests/aws/services/stepfunctions/test_batch_integration.py::TestBatchIntegration::test_batch_request_response HTTP Status Code: 200 AWS validated Snapshot Tested

UpdateComputeEnvironment

Parameters: computeEnvironment, state
  • LocalStack Pro
    • test_batch_create_compute_environment LocalStack Pro: tests/aws/services/iam/test_iam_enforcement.py::TestIAMEnforcementIdentityBasedPolicies::test_batch_create_compute_environment HTTP Status Code: 200

Last modified July 22, 2024: Update Parity Coverage Docs (#1393) (1200bd259)