sandboxes

Creates, updates, deletes, gets or lists a sandboxes resource.

Overview

Name	sandboxes
Type	Resource
Id	aws.codebuild.sandboxes

Fields

The following fields are returned by SELECT queries:

batch_get_sandboxes

Name	Datatype	Description
sandboxes	array	Information about the requested sandboxes.
sandboxes_not_found	array	The IDs of sandboxes for which information could not be found.

list_sandboxes

Name	Datatype	Description
id	string	Information about the requested sandbox IDs.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
batch_get_sandboxes	select	region		Gets information about the sandbox status.
list_sandboxes	select	region		Gets a list of sandboxes.
start_command_execution	exec	region, sandboxId, command		Starts a command execution.
start_sandbox_connection	exec	region, sandboxId		Starts a sandbox connection.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

batch_get_sandboxes

Gets information about the sandbox status.

SELECT
sandboxes,
sandboxes_not_found
FROM aws.codebuild.sandboxes
WHERE region = '{{ region }}' -- required
;

list_sandboxes

Gets a list of sandboxes.

SELECT
id
FROM aws.codebuild.sandboxes
WHERE region = '{{ region }}' -- required
;

Lifecycle Methods

start_command_execution

Starts a command execution.

EXEC aws.codebuild.sandboxes.start_command_execution 
@region='{{ region }}' --required 
@@json=
'{
"sandboxId": "{{ sandboxId }}", 
"command": "{{ command }}", 
"type": "{{ type }}"
}'
;

start_sandbox_connection

Starts a sandbox connection.

EXEC aws.codebuild.sandboxes.start_sandbox_connection 
@region='{{ region }}' --required 
@@json=
'{
"sandboxId": "{{ sandboxId }}"
}'
;