registries

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

Overview

Name	registries
Type	Resource
Id	aws.schemas.registries

Fields

The following fields are returned by SELECT queries:

describe_registry

Name	Datatype	Description
description	string	The description of the registry.
registry_arn	string	The ARN of the registry.
registry_name	string	The name of the registry.
tags	object	Tags associated with the registry.

list_registries

Name	Datatype	Description
registry_arn	string	The ARN of the registry.
registry_name	string	The name of the registry.
tags	object	Tags associated with the registry.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_registry	select	registry_name, region		Describes the registry.
list_registries	select	region	limit, nextToken, registryNamePrefix, scope	List the registries.
create_registry	insert	registry_name, region		Creates a registry.
update_registry	update	registry_name, region		Updates a registry.
delete_registry	delete	registry_name, region		Deletes a Registry.
export_schema	exec	registry_name, schema_name, type, region	schemaVersion

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)
registry_name	string	The name of the registry.
schema_name	string	The name of the schema.
type	string
limit	integer
nextToken	string	The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.
registryNamePrefix	string	Specifying this limits the results to only those registry names that start with the specified prefix.
schemaVersion	string	Specifying this limits the results to only this schema version.
scope	string	Can be set to Local or AWS to limit responses to your custom registries, or the ones provided by AWS.

SELECT examples

describe_registry

Describes the registry.

SELECT
description,
registry_arn,
registry_name,
tags
FROM aws.schemas.registries
WHERE registry_name = '{{ registry_name }}' -- required
AND region = '{{ region }}' -- required
;

list_registries

List the registries.

SELECT
registry_arn,
registry_name,
tags
FROM aws.schemas.registries
WHERE region = '{{ region }}' -- required
AND limit = '{{ limit }}'
AND nextToken = '{{ nextToken }}'
AND registryNamePrefix = '{{ registryNamePrefix }}'
AND scope = '{{ scope }}'
;

INSERT examples

create_registry

Creates a registry.

INSERT INTO aws.schemas.registries (
Description,
Tags,
registry_name,
region
)
SELECT 
'{{ Description }}',
'{{ Tags }}',
'{{ registry_name }}',
'{{ region }}'
RETURNING
description,
registry_arn,
registry_name,
tags
;

Manifest

# Description fields are for documentation purposes
- name: registries
props:
  - name: registry_name
    value: "{{ registry_name }}"
    description: Required parameter for the registries resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the registries resource.
  - name: Description
    value: "{{ Description }}"
  - name: Tags
    value: "{{ Tags }}"
    description: |
      Key-value pairs associated with a resource.

UPDATE examples

update_registry

Updates a registry.

UPDATE aws.schemas.registries
SET 
Description = '{{ Description }}'
WHERE 
registry_name = '{{ registry_name }}' --required
AND region = '{{ region }}' --required
RETURNING
description,
registry_arn,
registry_name,
tags;

DELETE examples

delete_registry

Deletes a Registry.

DELETE FROM aws.schemas.registries
WHERE registry_name = '{{ registry_name }}' --required
AND region = '{{ region }}' --required
;

Lifecycle Methods

export_schema

Success

EXEC aws.schemas.registries.export_schema 
@registry_name='{{ registry_name }}' --required, 
@schema_name='{{ schema_name }}' --required, 
@type='{{ type }}' --required, 
@region='{{ region }}' --required, 
@schemaVersion='{{ schemaVersion }}'
;