user_profiles

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

Overview

Name	user_profiles
Type	Resource
Id	aws.datazone.user_profiles

Fields

The following fields are returned by SELECT queries:

get_user_profile

Name	Datatype	Description
id	string	The identifier of the user profile. (pattern: <code>([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}</code>)
details	object	The user profile details.
domain_id	string	the identifier of the Amazon DataZone domain of which you want to get the user profile. (pattern: <code>dzd[-][a-zA-Z0-9-]{1,36}</code>)
status	string	The status of the user profile. (ASSIGNED, NOT_ASSIGNED, ACTIVATED, DEACTIVATED)
type_	string	The type of the user profile. (IAM, SSO)

search_user_profiles

Name	Datatype	Description
id	string	The ID of the user profile. (pattern: <code>([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}</code>)
details	object	The details of the user profile.
domain_id	string	The ID of the Amazon DataZone domain of the user profile. (pattern: <code>dzd[-][a-zA-Z0-9-]{1,36}</code>)
status	string	The status of the user profile. (ASSIGNED, NOT_ASSIGNED, ACTIVATED, DEACTIVATED)
type_	string	The type of the user profile. (IAM, SSO)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_user_profile	select	domain_identifier, user_identifier, region	type, sessionName	Gets a user profile in Amazon DataZone.
search_user_profiles	select	domain_identifier, region		Searches user profiles in Amazon DataZone.
create_user_profile	insert	domain_identifier, region, userIdentifier		Creates a user profile in Amazon DataZone.
update_user_profile	update	domain_identifier, user_identifier, region, status		Updates the specified user profile in Amazon DataZone.

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 identifier of the Amazon DataZone domain in which a user profile is updated.
region	string	AWS region (default: us-east-1)
user_identifier	string	The identifier of the user whose user profile is to be updated.
sessionName	string	The session name for IAM role sessions.
type	string	The type of the user profile.

SELECT examples

get_user_profile

Gets a user profile in Amazon DataZone.

SELECT
id,
details,
domain_id,
status,
type_
FROM aws.datazone.user_profiles
WHERE domain_identifier = '{{ domain_identifier }}' -- required
AND user_identifier = '{{ user_identifier }}' -- required
AND region = '{{ region }}' -- required
AND type = '{{ type }}'
AND sessionName = '{{ sessionName }}'
;

search_user_profiles

Searches user profiles in Amazon DataZone.

SELECT
id,
details,
domain_id,
status,
type_
FROM aws.datazone.user_profiles
WHERE domain_identifier = '{{ domain_identifier }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples

create_user_profile

Creates a user profile in Amazon DataZone.

INSERT INTO aws.datazone.user_profiles (
userIdentifier,
userType,
sessionName,
clientToken,
domain_identifier,
region
)
SELECT 
'{{ userIdentifier }}' /* required */,
'{{ userType }}',
'{{ sessionName }}',
'{{ clientToken }}',
'{{ domain_identifier }}',
'{{ region }}'
RETURNING
id,
details,
domain_id,
status,
type_
;

Manifest

# Description fields are for documentation purposes
- name: user_profiles
props:
  - name: domain_identifier
    value: "{{ domain_identifier }}"
    description: Required parameter for the user_profiles resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the user_profiles resource.
  - name: userIdentifier
    value: "{{ userIdentifier }}"
  - name: userType
    value: "{{ userType }}"
    valid_values: ['IAM_USER', 'IAM_ROLE', 'SSO_USER', 'IAM_ROLE_SESSION']
  - name: sessionName
    value: "{{ sessionName }}"
  - name: clientToken
    value: "{{ clientToken }}"

UPDATE examples

update_user_profile

Updates the specified user profile in Amazon DataZone.

UPDATE aws.datazone.user_profiles
SET 
type = '{{ type }}',
status = '{{ status }}',
sessionName = '{{ sessionName }}'
WHERE 
domain_identifier = '{{ domain_identifier }}' --required
AND user_identifier = '{{ user_identifier }}' --required
AND region = '{{ region }}' --required
AND status = '{{ status }}' --required
RETURNING
id,
details,
domain_id,
status,
type_;