Skip to content

Aws Instances

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/aws-instances/ List Aws Instances
GET /api/aws-instances/{uuid}/ Retrieve
POST /api/aws-instances/ Create
POST /api/aws-instances/{uuid}/pull/ Synchronize resource state
POST /api/aws-instances/{uuid}/unlink/ Unlink resource
PUT /api/aws-instances/{uuid}/ Update
PATCH /api/aws-instances/{uuid}/ Partial Update
DELETE /api/aws-instances/{uuid}/ Delete
Other Actions
POST /api/aws-instances/{uuid}/resize/ Resize
POST /api/aws-instances/{uuid}/restart/ Restart
POST /api/aws-instances/{uuid}/start/ Start
POST /api/aws-instances/{uuid}/stop/ Stop

Core CRUD

List Aws Instances

1
2
3
4
http \
  GET \
  https://api.example.com/api/aws-instances/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.aws_instances import aws_instances_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = aws_instances_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: aws_instances_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { awsInstancesList } from 'waldur-js-client';

try {
  const response = await awsInstancesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
backend_id string
can_manage boolean Can manage
customer string (uuid)
customer_abbreviation string
customer_name string
customer_native_name string
customer_uuid string (uuid)
description string
external_ip string
field array
name string
name_exact string
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
project string (uuid)
project_name string
project_uuid string (uuid)
service_settings_name string
service_settings_uuid string (uuid)
state array
uuid string (uuid)

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
start_time string (date-time)
cores integer Number of cores in a VM
ram integer Memory size in MiB
disk integer Disk size in MiB
min_ram integer Minimum memory size in MiB
min_disk integer Minimum disk size in MiB
user_data string Additional data that will be added to instance on provisioning
external_ips array of string (ipv4)s
internal_ips array of string (ipv4)s
latitude number (double)
longitude number (double)
key_name string
key_fingerprint string
image_name string
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/aws-instances/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.aws_instances import aws_instances_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = aws_instances_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: aws_instances_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { awsInstancesRetrieve } from 'waldur-js-client';

try {
  const response = await awsInstancesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
start_time string (date-time)
cores integer Number of cores in a VM
ram integer Memory size in MiB
disk integer Disk size in MiB
min_ram integer Minimum memory size in MiB
min_disk integer Minimum disk size in MiB
user_data string Additional data that will be added to instance on provisioning
external_ips array of string (ipv4)s
internal_ips array of string (ipv4)s
latitude number (double)
longitude number (double)
key_name string
key_fingerprint string
image_name string
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Create

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
http \
  POST \
  https://api.example.com/api/aws-instances/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-aws-instance" \
  service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  region="https://api.example.com/api/region/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  image="https://api.example.com/api/image/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  size=100

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.aws_instance_request import AwsInstanceRequest # (1)
from waldur_api_client.api.aws_instances import aws_instances_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = AwsInstanceRequest(
    name="my-awesome-aws-instance",
    service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    region="https://api.example.com/api/region/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    image="https://api.example.com/api/image/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    size=100
)
response = aws_instances_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: AwsInstanceRequest
  2. API Source: aws_instances_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
import { awsInstancesCreate } from 'waldur-js-client';

try {
  const response = await awsInstancesCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "name": "my-awesome-aws-instance",
    "service_settings": "https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "project": "https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "region": "https://api.example.com/api/region/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "image": "https://api.example.com/api/image/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "size": 100
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
name string ✓
description string
service_settings string (uri) ✓
project string (uri) ✓
ssh_public_key string (uri)
Constraints: write-only
user_data string Additional data that will be added to instance on provisioning
region string (uri) ✓
Constraints: write-only
image string (uri) ✓
Constraints: write-only
size string (uri) ✓
Constraints: write-only

201 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
start_time string (date-time)
cores integer Number of cores in a VM
ram integer Memory size in MiB
disk integer Disk size in MiB
min_ram integer Minimum memory size in MiB
min_disk integer Minimum disk size in MiB
user_data string Additional data that will be added to instance on provisioning
external_ips array of string (ipv4)s
internal_ips array of string (ipv4)s
latitude number (double)
longitude number (double)
key_name string
key_fingerprint string
image_name string
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Synchronize resource state

Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.

1
2
3
4
http \
  POST \
  https://api.example.com/api/aws-instances/a1b2c3d4-e5f6-7890-abcd-ef1234567890/pull/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.aws_instances import aws_instances_pull # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = aws_instances_pull.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: aws_instances_pull
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { awsInstancesPull } from 'waldur-js-client';

try {
  const response = await awsInstancesPull({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

202 - No response body

409 - No response body

Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state.

1
2
3
4
http \
  POST \
  https://api.example.com/api/aws-instances/a1b2c3d4-e5f6-7890-abcd-ef1234567890/unlink/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.aws_instances import aws_instances_unlink # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = aws_instances_unlink.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: aws_instances_unlink
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { awsInstancesUnlink } from 'waldur-js-client';

try {
  const response = await awsInstancesUnlink({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Update

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
http \
  PUT \
  https://api.example.com/api/aws-instances/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-aws-instance" \
  service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  region="https://api.example.com/api/region/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  image="https://api.example.com/api/image/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  size=100

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.aws_instance_request import AwsInstanceRequest # (1)
from waldur_api_client.api.aws_instances import aws_instances_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = AwsInstanceRequest(
    name="my-awesome-aws-instance",
    service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    region="https://api.example.com/api/region/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    image="https://api.example.com/api/image/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    size=100
)
response = aws_instances_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: AwsInstanceRequest
  2. API Source: aws_instances_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
import { awsInstancesUpdate } from 'waldur-js-client';

try {
  const response = await awsInstancesUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-aws-instance",
    "service_settings": "https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "project": "https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "region": "https://api.example.com/api/region/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "image": "https://api.example.com/api/image/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "size": 100
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string ✓
description string
service_settings string (uri) ✓
project string (uri) ✓
ssh_public_key string (uri)
Constraints: write-only
user_data string Additional data that will be added to instance on provisioning
region string (uri) ✓
Constraints: write-only
image string (uri) ✓
Constraints: write-only
size string (uri) ✓
Constraints: write-only

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
start_time string (date-time)
cores integer Number of cores in a VM
ram integer Memory size in MiB
disk integer Disk size in MiB
min_ram integer Minimum memory size in MiB
min_disk integer Minimum disk size in MiB
user_data string Additional data that will be added to instance on provisioning
external_ips array of string (ipv4)s
internal_ips array of string (ipv4)s
latitude number (double)
longitude number (double)
key_name string
key_fingerprint string
image_name string
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/aws-instances/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_aws_instance_request import PatchedAwsInstanceRequest # (1)
from waldur_api_client.api.aws_instances import aws_instances_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedAwsInstanceRequest()
response = aws_instances_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedAwsInstanceRequest
  2. API Source: aws_instances_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { awsInstancesPartialUpdate } from 'waldur-js-client';

try {
  const response = await awsInstancesPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
name string
description string

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
start_time string (date-time)
cores integer Number of cores in a VM
ram integer Memory size in MiB
disk integer Disk size in MiB
min_ram integer Minimum memory size in MiB
min_disk integer Minimum disk size in MiB
user_data string Additional data that will be added to instance on provisioning
external_ips array of string (ipv4)s
internal_ips array of string (ipv4)s
latitude number (double)
longitude number (double)
key_name string
key_fingerprint string
image_name string
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/aws-instances/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.aws_instances import aws_instances_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = aws_instances_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: aws_instances_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { awsInstancesDestroy } from 'waldur-js-client';

try {
  const response = await awsInstancesDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

Resize

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/aws-instances/a1b2c3d4-e5f6-7890-abcd-ef1234567890/resize/ \
  Authorization:"Token YOUR_API_TOKEN" \
  size=100

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.aws_instance_resize_request import AwsInstanceResizeRequest # (1)
from waldur_api_client.api.aws_instances import aws_instances_resize # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = AwsInstanceResizeRequest(
    size=100
)
response = aws_instances_resize.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: AwsInstanceResizeRequest
  2. API Source: aws_instances_resize
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { awsInstancesResize } from 'waldur-js-client';

try {
  const response = await awsInstancesResize({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "size": 100
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
size string (uri) ✓

200 -

Field Type
size string (uri)

Restart

1
2
3
4
http \
  POST \
  https://api.example.com/api/aws-instances/a1b2c3d4-e5f6-7890-abcd-ef1234567890/restart/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.aws_instances import aws_instances_restart # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = aws_instances_restart.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: aws_instances_restart
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { awsInstancesRestart } from 'waldur-js-client';

try {
  const response = await awsInstancesRestart({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Start

1
2
3
4
http \
  POST \
  https://api.example.com/api/aws-instances/a1b2c3d4-e5f6-7890-abcd-ef1234567890/start/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.aws_instances import aws_instances_start # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = aws_instances_start.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: aws_instances_start
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { awsInstancesStart } from 'waldur-js-client';

try {
  const response = await awsInstancesStart({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Stop

1
2
3
4
http \
  POST \
  https://api.example.com/api/aws-instances/a1b2c3d4-e5f6-7890-abcd-ef1234567890/stop/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.aws_instances import aws_instances_stop # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = aws_instances_stop.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: aws_instances_stop
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { awsInstancesStop } from 'waldur-js-client';

try {
  const response = await awsInstancesStop({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body