catalog_items

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

Overview

Name	catalog_items
Type	Resource
Id	aws.outposts.catalog_items

Fields

The following fields are returned by SELECT queries:

get_catalog_item

Name	Datatype	Description
catalog_item_id	string	The ID of the catalog item. (pattern: <code>OR-[A-Z0-9]{7}</code>)
ec2_capacities	array	Information about the EC2 capacity of an item.
item_status	string	The status of a catalog item. (AVAILABLE, DISCONTINUED)
power_kva	number (float)	Information about the power draw of an item.
supported_storage	array	The supported storage options for the catalog item.
supported_uplink_gbps	array	The uplink speed this catalog item requires for the connection to the Region.
weight_lbs	integer	The weight of the item in pounds.

list_catalog_items

Name	Datatype	Description
catalog_item_id	string	The ID of the catalog item. (pattern: <code>OR-[A-Z0-9]{7}</code>)
ec2_capacities	array	Information about the EC2 capacity of an item.
item_status	string	The status of a catalog item. (AVAILABLE, DISCONTINUED)
power_kva	number (float)	Information about the power draw of an item.
supported_storage	array	The supported storage options for the catalog item.
supported_uplink_gbps	array	The uplink speed this catalog item requires for the connection to the Region.
weight_lbs	integer	The weight of the item in pounds.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_catalog_item	select	catalog_item_id, region		Gets information about the specified catalog item.
list_catalog_items	select	region	NextToken, MaxResults, ItemClassFilter, SupportedStorageFilter, EC2FamilyFilter	Lists the items in the catalog. Use filters to return specific results. If you specify multiple filters, the results include only the resources that match all of the specified filters. For a filter where you can specify multiple values, the results include items that match any of the values that you specify for the filter.

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
catalog_item_id	string	The ID of the catalog item.
region	string	AWS region (default: us-east-1)
EC2FamilyFilter	array	Filters the results by EC2 family (for example, M5).
ItemClassFilter	array	Filters the results by item class.
MaxResults	integer
NextToken	string
SupportedStorageFilter	array	Filters the results by storage option.

SELECT examples

get_catalog_item

Gets information about the specified catalog item.

SELECT
catalog_item_id,
ec2_capacities,
item_status,
power_kva,
supported_storage,
supported_uplink_gbps,
weight_lbs
FROM aws.outposts.catalog_items
WHERE catalog_item_id = '{{ catalog_item_id }}' -- required
AND region = '{{ region }}' -- required
;

list_catalog_items

Lists the items in the catalog. Use filters to return specific results. If you specify multiple filters, the results include only the resources that match all of the specified filters. For a filter where you can specify multiple values, the results include items that match any of the values that you specify for the filter.

SELECT
catalog_item_id,
ec2_capacities,
item_status,
power_kva,
supported_storage,
supported_uplink_gbps,
weight_lbs
FROM aws.outposts.catalog_items
WHERE region = '{{ region }}' -- required
AND NextToken = '{{ NextToken }}'
AND MaxResults = '{{ MaxResults }}'
AND ItemClassFilter = '{{ ItemClassFilter }}'
AND SupportedStorageFilter = '{{ SupportedStorageFilter }}'
AND EC2FamilyFilter = '{{ EC2FamilyFilter }}'
;