spaces

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

Overview

Name	spaces
Type	Resource
Id	aws.codecatalyst.spaces

Fields

The following fields are returned by SELECT queries:

get_space

Name	Datatype	Description
name	string	The name of the space. (pattern: <code>[a-zA-Z0-9]+(?:[-_.][a-zA-Z0-9]+)*</code>)
description	string	The description of the space.
display_name	string	The friendly name of the space displayed to users.
region_name	string	The Amazon Web Services Region where the space exists. (pattern: <code>(us(?:-gov)?|af|ap|ca|cn|eu|sa)-(central|(?:north|south)?(?:east|west)?)-(\d+)</code>)

list_spaces

Name	Datatype	Description
name	string	The name of the space. (pattern: <code>[a-zA-Z0-9]+(?:[-_.][a-zA-Z0-9]+)*</code>)
description	string	The description of the space.
display_name	string	The friendly name of the space displayed to users.
region_name	string	The Amazon Web Services Region where the space exists. (pattern: <code>(us(?:-gov)?|af|ap|ca|cn|eu|sa)-(central|(?:north|south)?(?:east|west)?)-(\d+)</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_space	select	name, region		Returns information about an space.
list_spaces	select	region		Retrieves a list of spaces.
update_space	update	name, region		Changes one or more values for a space.
delete_space	delete	name, region		Deletes a space. Deleting a space cannot be undone. Additionally, since space names must be unique across Amazon CodeCatalyst, you cannot reuse names of deleted spaces.

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
name	string	The name of the space. To retrieve a list of space names, use ListSpaces.
region	string	AWS region (default: us-east-1)

SELECT examples

get_space

Returns information about an space.

SELECT
name,
description,
display_name,
region_name
FROM aws.codecatalyst.spaces
WHERE name = '{{ name }}' -- required
AND region = '{{ region }}' -- required
;

list_spaces

Retrieves a list of spaces.

SELECT
name,
description,
display_name,
region_name
FROM aws.codecatalyst.spaces
WHERE region = '{{ region }}' -- required
;

UPDATE examples

update_space

Changes one or more values for a space.

UPDATE aws.codecatalyst.spaces
SET 
description = '{{ description }}'
WHERE 
name = '{{ name }}' --required
AND region = '{{ region }}' --required
RETURNING
name,
description,
display_name;

DELETE examples

delete_space

Deletes a space. Deleting a space cannot be undone. Additionally, since space names must be unique across Amazon CodeCatalyst, you cannot reuse names of deleted spaces.

DELETE FROM aws.codecatalyst.spaces
WHERE name = '{{ name }}' --required
AND region = '{{ region }}' --required
;