usage_profiles

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

Overview

Name	usage_profiles
Type	Resource
Id	aws.glue.usage_profiles

Fields

The following fields are returned by SELECT queries:

get_usage_profile

Name	Datatype	Description
configuration	object	A ProfileConfiguration object specifying the job and session values for the profile.
created_on	string (date-time)	The date and time when the usage profile was created.
description	string	A description of the usage profile. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</code>)
last_modified_on	string (date-time)	The date and time when the usage profile was last modified.
name	string	The name of the usage profile. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_usage_profile	select	region		Retrieves information about the specified Glue usage profile.
create_usage_profile	insert	region		Creates an Glue usage profile.
update_usage_profile	update	region		Update an Glue usage profile.
delete_usage_profile	delete	region		Deletes the Glue specified usage profile.
list_usage_profiles	exec	region		List all the Glue usage profiles.

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_usage_profile

Retrieves information about the specified Glue usage profile.

SELECT
configuration,
created_on,
description,
last_modified_on,
name
FROM aws.glue.usage_profiles
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_usage_profile

Creates an Glue usage profile.

INSERT INTO aws.glue.usage_profiles (
Name,
Description,
Configuration,
Tags,
region
)
SELECT 
'{{ Name }}',
'{{ Description }}',
'{{ Configuration }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
name
;

Manifest

# Description fields are for documentation purposes
- name: usage_profiles
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the usage_profiles resource.
  - name: Name
    value: "{{ Name }}"
    description: |
      The name of the usage profile.
  - name: Description
    value: "{{ Description }}"
    description: |
      A description of the usage profile.
  - name: Configuration
    description: |
      A ProfileConfiguration object specifying the job and session values for the profile.
    value:
      SessionConfiguration: "{{ SessionConfiguration }}"
      JobConfiguration: "{{ JobConfiguration }}"
  - name: Tags
    value: "{{ Tags }}"
    description: |
      A list of tags applied to the usage profile.

UPDATE examples

update_usage_profile

Update an Glue usage profile.

UPDATE aws.glue.usage_profiles
SET 
Name = '{{ Name }}',
Description = '{{ Description }}',
Configuration = '{{ Configuration }}'
WHERE 
region = '{{ region }}' --required
RETURNING
name;

DELETE examples

delete_usage_profile

Deletes the Glue specified usage profile.

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

Lifecycle Methods

list_usage_profiles

List all the Glue usage profiles.

EXEC aws.glue.usage_profiles.list_usage_profiles 
@region='{{ region }}' --required 
@@json=
'{
"NextToken": "{{ NextToken }}", 
"MaxResults": {{ MaxResults }}
}'
;