discoverers

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

Overview

Name	discoverers
Type	Resource
Id	aws.schemas.discoverers

Fields

The following fields are returned by SELECT queries:

describe_discoverer

Name	Datatype	Description
cross_account	boolean	The Status if the discoverer will discover schemas from events sent from another account.
description	string	The description of the discoverer.
discoverer_arn	string	The ARN of the discoverer.
discoverer_id	string	The ID of the discoverer.
source_arn	string	The ARN of the event bus.
state	string	The state of the discoverer. (STARTED, STOPPED)
tags	object	Tags associated with the resource.

list_discoverers

Name	Datatype	Description
cross_account	boolean	The Status if the discoverer will discover schemas from events sent from another account.
discoverer_arn	string	The ARN of the discoverer.
discoverer_id	string	The ID of the discoverer.
source_arn	string	The ARN of the event bus.
state	string	The state of the discoverer. (STARTED, STOPPED)
tags	object	Tags associated with the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_discoverer	select	discoverer_id, region		Describes the discoverer.
list_discoverers	select	region	discovererIdPrefix, limit, nextToken, sourceArnPrefix	List the discoverers.
create_discoverer	insert	region, SourceArn		Creates a discoverer.
update_discoverer	update	discoverer_id, region		Updates the discoverer
delete_discoverer	delete	discoverer_id, region		Deletes a discoverer.
start_discoverer	exec	discoverer_id, region		Starts the discoverer
stop_discoverer	exec	discoverer_id, region		Stops the discoverer

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
discoverer_id	string	The ID of the discoverer.
region	string	AWS region (default: us-east-1)
discovererIdPrefix	string	Specifying this limits the results to only those discoverer IDs that start with the specified prefix.
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.
sourceArnPrefix	string	Specifying this limits the results to only those ARNs that start with the specified prefix.

SELECT examples

describe_discoverer

Describes the discoverer.

SELECT
cross_account,
description,
discoverer_arn,
discoverer_id,
source_arn,
state,
tags
FROM aws.schemas.discoverers
WHERE discoverer_id = '{{ discoverer_id }}' -- required
AND region = '{{ region }}' -- required
;

list_discoverers

List the discoverers.

SELECT
cross_account,
discoverer_arn,
discoverer_id,
source_arn,
state,
tags
FROM aws.schemas.discoverers
WHERE region = '{{ region }}' -- required
AND discovererIdPrefix = '{{ discovererIdPrefix }}'
AND limit = '{{ limit }}'
AND nextToken = '{{ nextToken }}'
AND sourceArnPrefix = '{{ sourceArnPrefix }}'
;

INSERT examples

create_discoverer

Creates a discoverer.

INSERT INTO aws.schemas.discoverers (
Description,
SourceArn,
CrossAccount,
Tags,
region
)
SELECT 
'{{ Description }}',
'{{ SourceArn }}' /* required */,
{{ CrossAccount }},
'{{ Tags }}',
'{{ region }}'
RETURNING
cross_account,
description,
discoverer_arn,
discoverer_id,
source_arn,
state,
tags
;

Manifest

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

UPDATE examples

update_discoverer

Updates the discoverer

UPDATE aws.schemas.discoverers
SET 
Description = '{{ Description }}',
CrossAccount = {{ CrossAccount }}
WHERE 
discoverer_id = '{{ discoverer_id }}' --required
AND region = '{{ region }}' --required
RETURNING
cross_account,
description,
discoverer_arn,
discoverer_id,
source_arn,
state,
tags;

DELETE examples

delete_discoverer

Deletes a discoverer.

DELETE FROM aws.schemas.discoverers
WHERE discoverer_id = '{{ discoverer_id }}' --required
AND region = '{{ region }}' --required
;

Lifecycle Methods

start_discoverer

Starts the discoverer

EXEC aws.schemas.discoverers.start_discoverer 
@discoverer_id='{{ discoverer_id }}' --required, 
@region='{{ region }}' --required
;

stop_discoverer

Stops the discoverer

EXEC aws.schemas.discoverers.stop_discoverer 
@discoverer_id='{{ discoverer_id }}' --required, 
@region='{{ region }}' --required
;