environment_actions

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

Overview

Name	environment_actions
Type	Resource
Id	aws.datazone.environment_actions

Fields

The following fields are returned by SELECT queries:

get_environment_action

Name	Datatype	Description
id	string	The ID of the environment action. (pattern: <code>[a-zA-Z0-9_-]{1,36}</code>)
name	string	The name of the environment action.
description	string	The description of the environment action.
domain_id	string	The ID of the Amazon DataZone domain in which the environment action lives. (pattern: <code>dzd[-][a-zA-Z0-9-]{1,36}</code>)
environment_id	string	The environment ID of the environment action. (pattern: <code>[a-zA-Z0-9_-]{1,36}</code>)
parameters	object	The parameters of the environment action.

list_environment_actions

Name	Datatype	Description
id	string	The ID of the environment action. (pattern: <code>[a-zA-Z0-9_-]{1,36}</code>)
name	string	The name of the environment action.
description	string	The environment action description.
domain_id	string	The Amazon DataZone domain ID of the environment action. (pattern: <code>dzd[-][a-zA-Z0-9-]{1,36}</code>)
environment_id	string	The environment ID of the environment action. (pattern: <code>[a-zA-Z0-9_-]{1,36}</code>)
parameters	object	The parameters of the environment action.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_environment_action	select	domain_identifier, environment_identifier, identifier, region		Gets the specified environment action.
list_environment_actions	select	domain_identifier, environment_identifier, region	nextToken, maxResults	Lists existing environment actions.
create_environment_action	insert	domain_identifier, environment_identifier, region, name, parameters		Creates an action for the environment, for example, creates a console link for an analytics tool that is available in this environment.
update_environment_action	update	domain_identifier, environment_identifier, identifier, region		Updates an environment action.
delete_environment_action	delete	domain_identifier, environment_identifier, identifier, region		Deletes an action for the environment, for example, deletes a console link for an analytics tool that is available in this environment.

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
domain_identifier	string	The ID of the Amazon DataZone domain in which an environment action is deleted.
environment_identifier	string	The ID of the environment where an environment action is deleted.
identifier	string	The ID of the environment action that is deleted.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of environment actions to return in a single call to ListEnvironmentActions. When the number of environment actions to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListEnvironmentActions to list the next set of environment actions.
nextToken	string	When the number of environment actions is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of environment actions, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListEnvironmentActions to list the next set of environment actions.

SELECT examples

get_environment_action

Gets the specified environment action.

SELECT
id,
name,
description,
domain_id,
environment_id,
parameters
FROM aws.datazone.environment_actions
WHERE domain_identifier = '{{ domain_identifier }}' -- required
AND environment_identifier = '{{ environment_identifier }}' -- required
AND identifier = '{{ identifier }}' -- required
AND region = '{{ region }}' -- required
;

list_environment_actions

Lists existing environment actions.

SELECT
id,
name,
description,
domain_id,
environment_id,
parameters
FROM aws.datazone.environment_actions
WHERE domain_identifier = '{{ domain_identifier }}' -- required
AND environment_identifier = '{{ environment_identifier }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

INSERT examples

create_environment_action

Creates an action for the environment, for example, creates a console link for an analytics tool that is available in this environment.

INSERT INTO aws.datazone.environment_actions (
name,
parameters,
description,
domain_identifier,
environment_identifier,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ parameters }}' /* required */,
'{{ description }}',
'{{ domain_identifier }}',
'{{ environment_identifier }}',
'{{ region }}'
RETURNING
id,
name,
description,
domain_id,
environment_id,
parameters
;

Manifest

# Description fields are for documentation purposes
- name: environment_actions
props:
  - name: domain_identifier
    value: "{{ domain_identifier }}"
    description: Required parameter for the environment_actions resource.
  - name: environment_identifier
    value: "{{ environment_identifier }}"
    description: Required parameter for the environment_actions resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the environment_actions resource.
  - name: name
    value: "{{ name }}"
  - name: parameters
    description: |
      The parameters of the environment action.
    value:
      awsConsoleLink:
        uri: "{{ uri }}"
  - name: description
    value: "{{ description }}"

UPDATE examples

update_environment_action

Updates an environment action.

UPDATE aws.datazone.environment_actions
SET 
parameters = '{{ parameters }}',
name = '{{ name }}',
description = '{{ description }}'
WHERE 
domain_identifier = '{{ domain_identifier }}' --required
AND environment_identifier = '{{ environment_identifier }}' --required
AND identifier = '{{ identifier }}' --required
AND region = '{{ region }}' --required
RETURNING
id,
name,
description,
domain_id,
environment_id,
parameters;

DELETE examples

delete_environment_action

Deletes an action for the environment, for example, deletes a console link for an analytics tool that is available in this environment.

DELETE FROM aws.datazone.environment_actions
WHERE domain_identifier = '{{ domain_identifier }}' --required
AND environment_identifier = '{{ environment_identifier }}' --required
AND identifier = '{{ identifier }}' --required
AND region = '{{ region }}' --required
;