service_actions

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

Overview

Name	service_actions
Type	Resource
Id	aws.servicecatalog.service_actions

Fields

The following fields are returned by SELECT queries:

describe_service_action

Name	Datatype	Description
definition	object	A map that defines the self-service action.
service_action_summary	object	Summary information about the self-service action.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_service_action	select	region		Describes a self-service action.
create_service_action	insert	region, DefinitionType, Definition, IdempotencyToken		Creates a self-service action.
update_service_action	update	region		Updates a self-service action.
delete_service_action	delete	region		Deletes a self-service action.
list_service_actions	exec	region		Lists all self-service actions.

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_service_action

Describes a self-service action.

SELECT
definition,
service_action_summary
FROM aws.servicecatalog.service_actions
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_service_action

Creates a self-service action.

INSERT INTO aws.servicecatalog.service_actions (
Name,
DefinitionType,
Definition,
Description,
AcceptLanguage,
IdempotencyToken,
region
)
SELECT 
'{{ Name }}',
'{{ DefinitionType }}' /* required */,
'{{ Definition }}' /* required */,
'{{ Description }}',
'{{ AcceptLanguage }}',
'{{ IdempotencyToken }}' /* required */,
'{{ region }}'
RETURNING
service_action_detail
;

Manifest

# Description fields are for documentation purposes
- name: service_actions
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the service_actions resource.
  - name: Name
    value: "{{ Name }}"
    description: |
      The self-service action name.
  - name: DefinitionType
    value: "{{ DefinitionType }}"
    description: |
      The service action definition type. For example, SSM_AUTOMATION.
    valid_values: ['SSM_AUTOMATION']
  - name: Definition
    value: "{{ Definition }}"
    description: |
      The self-service action definition. Can be one of the following: Name The name of the Amazon Web Services Systems Manager document (SSM document). For example, AWS-RestartEC2Instance. If you are using a shared SSM document, you must provide the ARN instead of the name. Version The Amazon Web Services Systems Manager automation document version. For example, "Version": "1" AssumeRole The Amazon Resource Name (ARN) of the role that performs the self-service actions on your behalf. For example, "AssumeRole": "arn:aws:iam::12345678910:role/ActionRole". To reuse the provisioned product launch role, set to "AssumeRole": "LAUNCH_ROLE". Parameters The list of parameters in JSON format. For example: [{"Name":"InstanceId","Type":"TARGET"}] or [{"Name":"InstanceId","Type":"TEXT_VALUE"}].
  - name: Description
    value: "{{ Description }}"
    description: |
      The self-service action description.
  - name: AcceptLanguage
    value: "{{ AcceptLanguage }}"
    description: |
      The language code. jp - Japanese zh - Chinese
  - name: IdempotencyToken
    value: "{{ IdempotencyToken }}"
    description: |
      A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

UPDATE examples

update_service_action

Updates a self-service action.

UPDATE aws.servicecatalog.service_actions
SET 
Id = '{{ Id }}',
Name = '{{ Name }}',
Definition = '{{ Definition }}',
Description = '{{ Description }}',
AcceptLanguage = '{{ AcceptLanguage }}'
WHERE 
region = '{{ region }}' --required
RETURNING
service_action_detail;

DELETE examples

delete_service_action

Deletes a self-service action.

DELETE FROM aws.servicecatalog.service_actions
WHERE region = '{{ region }}' --required
;

Lifecycle Methods

list_service_actions

Lists all self-service actions.

EXEC aws.servicecatalog.service_actions.list_service_actions 
@region='{{ region }}' --required 
@@json=
'{
"AcceptLanguage": "{{ AcceptLanguage }}", 
"PageSize": {{ PageSize }}, 
"PageToken": "{{ PageToken }}"
}'
;