objects

Creates, updates, deletes, gets or lists an objects resource.

Overview

Name	objects
Type	Resource
Id	aws.datapipeline.objects

Fields

The following fields are returned by SELECT queries:

describe_objects

Name	Datatype	Description
id	string	The ID of the object. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</code>)
name	string	The name of the object. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</code>)
fields	array	Key-value pairs that define the properties of the object.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_objects	select	region		Gets the object definitions for a set of objects associated with the pipeline. Object definitions are composed of a set of fields that define the properties of the object.
query_objects	exec	region, pipelineId, sphere		Queries the specified pipeline for the names of objects that match the specified set of conditions.

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

describe_objects

Gets the object definitions for a set of objects associated with the pipeline. Object definitions are composed of a set of fields that define the properties of the object.

SELECT
id,
name,
fields
FROM aws.datapipeline.objects
WHERE region = '{{ region }}' -- required
;

Lifecycle Methods

query_objects

Queries the specified pipeline for the names of objects that match the specified set of conditions.

EXEC aws.datapipeline.objects.query_objects 
@region='{{ region }}' --required 
@@json=
'{
"pipelineId": "{{ pipelineId }}", 
"query": "{{ query }}", 
"sphere": "{{ sphere }}", 
"marker": "{{ marker }}", 
"limit": {{ limit }}
}'
;