Download OpenAPI specification:Download
The assets management service. The service provides additional validation layer in front of assets to ensure the user supplied configuration is consistent. The service also provides different utility functions.
Endpoint for exporting the protection scope of a deployment along with
asset metadata. By default the endpoints returns data in CSV
format
if no Accept
header specified.
cURL example:
account_id required | string The AIMS account ID whose assets are being accessed. Only valid account IDs are acceptable.
Invalid account IDs result in an |
deployment_id required | string The ID of the deployment source as represented in the deployments service (uppercase UUID). |
alcli assets_manager export_scope \ --account_id 134235158 \ --deployment_id 843BD5F3-583D-48D7-B929-616B100D6B7B \ > scope.csv
type,key,name,protection_level,cidr_block,region,network,subnet,cidr_ranges vpc,/aws/us-west-2/vpc/vpc-43f82c3a,vpc-43f82c3a,inherited,172.31.0.0/16,us-west-2,,,"[""172.31.0.0/16""]" subnet,/aws/us-west-2/subnet/subnet-094f8853,subnet-094f8853,inherited,172.31.0.0/20,us-west-2,,, subnet,/aws/us-west-2/subnet/subnet-78f2e71e,subnet-78f2e71e,inherited,172.31.16.0/20,us-west-2,,, subnet,/aws/us-west-2/subnet/subnet-94ccb0bc,subnet-94ccb0bc,inherited,172.31.48.0/20,us-west-2,,, subnet,/aws/us-west-2/subnet/subnet-974c78df,subnet-974c78df,inherited,172.31.32.0/20,us-west-2,,,
Endpoint for importing the protection scope of a deployment.
account_id required | string The AIMS account ID whose assets are being accessed. Only valid account IDs are acceptable.
Invalid account IDs result in an |
deployment_id required | string The ID of the deployment source as represented in the deployments service (uppercase UUID). |
write | boolean Default: false The option is used to perform write operation if specified as |
By default If no Content-Type
header specified the CSV
format assumed.
The data format is the same as returned by the export endpoint.
The required fields are: type
, key
and protection_level
.
All other fields are ignored. Any invalid items are ignored.
The protection scope policy id to protection_level
mapping:
D12D5E67-166C-474F-87AA-6F86FC9FB9BC
- professionalA8E8B104-8F45-411D-A240-A30EA5FE25B0
- essentialsEC735B49-2517-4D98-BB9D-BEBC1E75D56D
- enterpriseA562D3E4-ECBE-426E-B2CF-78D2336E5D63
- lm_essentials7E184449-FB15-4693-807F-C01A1ECD7E66
- lmproD2A589A9-EA56-456C-844E-65843B483D68
- tmprotype required | string (AssetType) Asset type |
key required | string (AssetKey) Asset key |
protection_level required | string (ProtectionLevel) Enum: "professional" "essentials" "enterprise" "lm_essentials" "lmpro" "tmpro" "excluded" "inherited" |
name | string (AssetName) Asset Name |
cidr_block | string (CidrBlock) The subnet cidr_block |
region | string The region asset name containing the asset. Informational only. |
network | string The vpc/network asset name containing the asset. Informational only. |
cidr_ranges | Array of strings (CidrBlock) The network list of CIDRs |
type,key,name,protection_level,cidr_block,region,network,subnet,cidr_ranges vpc,/aws/us-west-2/vpc/vpc-43f82c3a,vpc-43f82c3a,inherited,172.31.0.0/16,us-west-2,,,"[""172.31.0.0/16""]" subnet,/aws/us-west-2/subnet/subnet-094f8853,subnet-094f8853,inherited,172.31.0.0/20,us-west-2,,, subnet,/aws/us-west-2/subnet/subnet-78f2e71e,subnet-78f2e71e,inherited,172.31.16.0/20,us-west-2,,, subnet,/aws/us-west-2/subnet/subnet-94ccb0bc,subnet-94ccb0bc,inherited,172.31.48.0/20,us-west-2,,, subnet,/aws/us-west-2/subnet/subnet-974c78df,subnet-974c78df,inherited,172.31.32.0/20,us-west-2,,,
{- "new_scope": {
- "include": [
- {
- "type": "vpc",
- "policy": {
- "id": "D12D5E67-166C-474F-87AA-6F86FC9FB9BC"
}, - "key": "/aws/ca-central-1/vpc/vpc-e0a0a689"
}
], - "exclude": [
- {
- "type": "host",
- "key": "/aws/ca-central-1/host/i-031b312d8b6472247"
}
]
}, - "included": [
- {
- "type": "vpc",
- "policy": {
- "id": "D12D5E67-166C-474F-87AA-6F86FC9FB9BC"
}, - "key": "/aws/ca-central-1/vpc/vpc-e0a0a689"
}
], - "excluded": [
- {
- "type": "region",
- "policy": {
- "id": "D12D5E67-166C-474F-87AA-6F86FC9FB9BC"
}, - "key": "/aws/us-east-1"
}, - {
- "type": "host",
- "policy": {
- "id": "D12D5E67-166C-474F-87AA-6F86FC9FB9BC"
}, - "key": "/aws/eu-west-2/host/i-0e36e01a0efd53cbf"
}, - {
- "type": "host",
- "key": "/aws/ca-central-1/host/i-031b312d8b6472247"
}
]
}
Create network
account_id required | string The AIMS account ID whose assets are being accessed. Only valid account IDs are acceptable.
Invalid account IDs result in an |
deployment_id required | string The ID of the deployment source as represented in the deployments service (uppercase UUID). |
force_large_network | boolean Default: false The option is used to suppress the network size validation if specified as
|
network_name required | string (AssetName) Asset Name |
cidr_ranges required | Array of strings (CidrBlock) |
public_cidr_ranges | Array of strings (CidrBlock) |
span_port_enabled | boolean (SpanPortEnabled) Default: false |
{- "network_name": "Network",
- "cidr_ranges": [
- "10.0.0.0/16"
]
}
{- "key": "/dc/network/2C6B298D-B6C6-4798-B498-2180FC1F4996",
- "network_name": "Network",
- "network_uuid": "88FCC8F6-EEE8-EE07-6AC5-3E88E85AE310",
- "cidr_ranges": [
- "10.0.0.0/16"
], - "claim_key": "e318c8e213d3accf26aa07fc33e6154b055135862c49b8c5e1",
- "span_port_enabled": false
}
Update network
account_id required | string The AIMS account ID whose assets are being accessed. Only valid account IDs are acceptable.
Invalid account IDs result in an |
deployment_id required | string The ID of the deployment source as represented in the deployments service (uppercase UUID). |
network_uuid required | string The UUID of the network asset as represented in the assets service (uppercase UUID). |
force_large_network | boolean Default: false The option is used to suppress the network size validation if specified as
|
network_name | string (AssetName) Asset Name |
cidr_ranges | Array of strings (CidrBlock) |
public_cidr_ranges | Array of strings (CidrBlock) |
span_port_enabled | boolean (SpanPortEnabled) Default: false |
{- "cidr_ranges": [
- "10.0.0.0/16",
- "10.1.0.0/16"
]
}
{- "key": "/dc/network/2C6B298D-B6C6-4798-B498-2180FC1F4996",
- "network_name": "Network",
- "network_uuid": "88FCC8F6-EEE8-EE07-6AC5-3E88E85AE310",
- "cidr_ranges": [
- "10.0.0.0/16"
], - "claim_key": "e318c8e213d3accf26aa07fc33e6154b055135862c49b8c5e1",
- "span_port_enabled": false
}