registries

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

Overview

Name	registries
Type	Resource
Id	aws.glue.registries

Fields

The following fields are returned by SELECT queries:

get_registry

Name	Datatype	Description
created_time	string	The date and time the registry was created.
description	string	A description of the registry. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</code>)
registry_arn	string	The Amazon Resource Name (ARN) of the registry. (pattern: <code>arn:aws(-(cn|us-gov|iso(-[bef])?))?:glue:.*</code>)
registry_name	string	The name of the registry. (pattern: <code>[a-zA-Z0-9-_$#.]+</code>)
status	string	The status of the registry. (AVAILABLE, DELETING)
updated_time	string	The date and time the registry was updated.

list_registries

Name	Datatype	Description
created_time	string	The data the registry was created.
description	string	A description of the registry. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</code>)
registry_arn	string	The Amazon Resource Name (ARN) of the registry. (pattern: <code>arn:aws(-(cn|us-gov|iso(-[bef])?))?:glue:.*</code>)
registry_name	string	The name of the registry. (pattern: <code>[a-zA-Z0-9-_$#.]+</code>)
status	string	The status of the registry. (AVAILABLE, DELETING)
updated_time	string	The date the registry was updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_registry	select	region		Describes the specified registry in detail.
list_registries	select	region		Returns a list of registries that you have created, with minimal registry information. Registries in the Deleting status will not be included in the results. Empty results will be returned if there are no registries available.
create_registry	insert	region, RegistryName		Creates a new registry which may be used to hold a collection of schemas.
update_registry	update	region, RegistryId		Updates an existing registry which is used to hold a collection of schemas. The updated properties relate to the registry, and do not modify any of the schemas within the registry.
delete_registry	delete	region		Delete the entire registry including schema and all of its versions. To get the status of the delete operation, you can call the GetRegistry API after the asynchronous call. Deleting a registry will deactivate all online operations for the registry such as the UpdateRegistry, CreateSchema, UpdateSchema, and RegisterSchemaVersion APIs.

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)

SELECT examples

get_registry

Describes the specified registry in detail.

SELECT
created_time,
description,
registry_arn,
registry_name,
status,
updated_time
FROM aws.glue.registries
WHERE region = '{{ region }}' -- required
;

list_registries

Returns a list of registries that you have created, with minimal registry information. Registries in the Deleting status will not be included in the results. Empty results will be returned if there are no registries available.

SELECT
created_time,
description,
registry_arn,
registry_name,
status,
updated_time
FROM aws.glue.registries
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_registry

Creates a new registry which may be used to hold a collection of schemas.

INSERT INTO aws.glue.registries (
RegistryName,
Description,
Tags,
region
)
SELECT 
'{{ RegistryName }}' /* required */,
'{{ Description }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
description,
registry_arn,
registry_name,
tags
;

Manifest

# Description fields are for documentation purposes
- name: registries
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the registries resource.
  - name: RegistryName
    value: "{{ RegistryName }}"
    description: |
      Name of the registry to be created of max length of 255, and may only contain letters, numbers, hyphen, underscore, dollar sign, or hash mark. No whitespace.
  - name: Description
    value: "{{ Description }}"
    description: |
      A description of the registry. If description is not provided, there will not be any default value for this.
  - name: Tags
    value: "{{ Tags }}"
    description: |
      Amazon Web Services tags that contain a key value pair and may be searched by console, command line, or API.

UPDATE examples

update_registry

Updates an existing registry which is used to hold a collection of schemas. The updated properties relate to the registry, and do not modify any of the schemas within the registry.

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

DELETE examples

delete_registry

Delete the entire registry including schema and all of its versions. To get the status of the delete operation, you can call the GetRegistry API after the asynchronous call. Deleting a registry will deactivate all online operations for the registry such as the UpdateRegistry, CreateSchema, UpdateSchema, and RegisterSchemaVersion APIs.

DELETE FROM aws.glue.registries
WHERE region = '{{ region }}' --required
;