user_details

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

Overview

Name	user_details
Type	Resource
Id	aws.codecatalyst.user_details

Fields

The following fields are returned by SELECT queries:

get_user_details

Name	Datatype	Description
display_name	string	The friendly name displayed for the user in Amazon CodeCatalyst.
primary_email	object	The email address provided by the user when they signed up.
user_id	string	The system-generated unique ID of the user.
user_name	string	The name of the user as displayed in Amazon CodeCatalyst.
version	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_user_details	select	region	id, userName	Returns information about a user.

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)
id	string	The system-generated unique ID of the user.
userName	string	The name of the user as displayed in Amazon CodeCatalyst.

SELECT examples

get_user_details

Returns information about a user.

SELECT
display_name,
primary_email,
user_id,
user_name,
version
FROM aws.codecatalyst.user_details
WHERE region = '{{ region }}' -- required
AND id = '{{ id }}'
AND userName = '{{ userName }}'
;