Class: Aws::RoboMaker::Types::StartSimulationJobBatchRequest

Inherits:

Struct

• Object
• Struct
• Aws::RoboMaker::Types::StartSimulationJobBatchRequest

Defined in:

gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb

Overview

Note:

When making an API call, you may pass StartSimulationJobBatchRequest data as a hash:

{
  client_request_token: "ClientRequestToken",
  batch_policy: {
    timeout_in_seconds: 1,
    max_concurrency: 1,
  },
  create_simulation_job_requests: [ # required
    {
      output_location: {
        s3_bucket: "S3Bucket",
        s3_prefix: "S3Key",
      },
      logging_config: {
        record_all_ros_topics: false,
      },
      max_job_duration_in_seconds: 1, # required
      iam_role: "IamRole",
      failure_behavior: "Fail", # accepts Fail, Continue
      use_default_applications: false,
      robot_applications: [
        {
          application: "Arn", # required
          application_version: "Version",
          launch_config: { # required
            package_name: "Command",
            launch_file: "Command",
            environment_variables: {
              "EnvironmentVariableKey" => "EnvironmentVariableValue",
            },
            port_forwarding_config: {
              port_mappings: [
                {
                  job_port: 1, # required
                  application_port: 1, # required
                  enable_on_public_ip: false,
                },
              ],
            },
            stream_ui: false,
            command: ["NonEmptyString"],
          },
          upload_configurations: [
            {
              name: "Name", # required
              path: "Path", # required
              upload_behavior: "UPLOAD_ON_TERMINATE", # required, accepts UPLOAD_ON_TERMINATE, UPLOAD_ROLLING_AUTO_REMOVE
            },
          ],
          use_default_upload_configurations: false,
          tools: [
            {
              stream_ui: false,
              name: "Name", # required
              command: "UnrestrictedCommand", # required
              stream_output_to_cloud_watch: false,
              exit_behavior: "FAIL", # accepts FAIL, RESTART
            },
          ],
          use_default_tools: false,
        },
      ],
      simulation_applications: [
        {
          application: "Arn", # required
          application_version: "Version",
          launch_config: { # required
            package_name: "Command",
            launch_file: "Command",
            environment_variables: {
              "EnvironmentVariableKey" => "EnvironmentVariableValue",
            },
            port_forwarding_config: {
              port_mappings: [
                {
                  job_port: 1, # required
                  application_port: 1, # required
                  enable_on_public_ip: false,
                },
              ],
            },
            stream_ui: false,
            command: ["NonEmptyString"],
          },
          upload_configurations: [
            {
              name: "Name", # required
              path: "Path", # required
              upload_behavior: "UPLOAD_ON_TERMINATE", # required, accepts UPLOAD_ON_TERMINATE, UPLOAD_ROLLING_AUTO_REMOVE
            },
          ],
          world_configs: [
            {
              world: "Arn",
            },
          ],
          use_default_upload_configurations: false,
          tools: [
            {
              stream_ui: false,
              name: "Name", # required
              command: "UnrestrictedCommand", # required
              stream_output_to_cloud_watch: false,
              exit_behavior: "FAIL", # accepts FAIL, RESTART
            },
          ],
          use_default_tools: false,
        },
      ],
      data_sources: [
        {
          name: "Name", # required
          s3_bucket: "S3Bucket", # required
          s3_keys: ["S3KeyOrPrefix"], # required
          type: "Prefix", # accepts Prefix, Archive, File
          destination: "Path",
        },
      ],
      vpc_config: {
        subnets: ["NonEmptyString"], # required
        security_groups: ["NonEmptyString"],
        assign_public_ip: false,
      },
      compute: {
        simulation_unit_limit: 1,
        compute_type: "CPU", # accepts CPU, GPU_AND_CPU
        gpu_unit_limit: 1,
      },
      tags: {
        "TagKey" => "TagValue",
      },
    },
  ],
  tags: {
    "TagKey" => "TagValue",
  },
}

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #batch_policy ⇒ Types::BatchPolicy

  The batch policy.

• #client_request_token ⇒ String

  Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

• #create_simulation_job_requests ⇒ Array<Types::SimulationJobRequest>

  A list of simulation job requests to create in the batch.

• #tags ⇒ Hash<String,String>

  A map that contains tag keys and tag values that are attached to the deployment job batch.

Instance Attribute Details

#batch_policy ⇒ Types::BatchPolicy

The batch policy.

Returns:

• (Types::BatchPolicy)

# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 6199

class StartSimulationJobBatchRequest < Struct.new(
  :client_request_token,
  :batch_policy,
  :create_simulation_job_requests,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#client_request_token ⇒ String

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

• (String)

# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 6199

class StartSimulationJobBatchRequest < Struct.new(
  :client_request_token,
  :batch_policy,
  :create_simulation_job_requests,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#create_simulation_job_requests ⇒ Array<Types::SimulationJobRequest>

A list of simulation job requests to create in the batch.

Returns:

• (Array<Types::SimulationJobRequest>)

# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 6199

class StartSimulationJobBatchRequest < Struct.new(
  :client_request_token,
  :batch_policy,
  :create_simulation_job_requests,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

A map that contains tag keys and tag values that are attached to the deployment job batch.

Returns:

• (Hash<String,String>)

# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 6199

class StartSimulationJobBatchRequest < Struct.new(
  :client_request_token,
  :batch_policy,
  :create_simulation_job_requests,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end