profiles

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

Overview

Name	profiles
Type	Resource
Id	aws.b2bi.profiles

Fields

The following fields are returned by SELECT queries:

get_profile

Name	Datatype	Description
name	string	Returns the name of the profile, used to identify it.
business_name	string	Returns the name for the business associated with this profile.
created_at	string (date-time)	Returns a timestamp for creation date and time of the transformer.
email	string	Returns the email address associated with this customer profile. (pattern: <code>[\w.-]+@[\w.-]+</code>)
log_group_name	string	Returns the name of the logging group.
logging	string	Returns whether or not logging is enabled for this profile. (ENABLED, DISABLED)
modified_at	string (date-time)	Returns a timestamp for last time the profile was modified.
phone	string	Returns the phone number associated with the profile. (pattern: <code>+?([0-9 \t-()/]{7,})(?:\s*(?:#|x.?|ext.?|extension) \t*(\d+))?</code>)
profile_arn	string	Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.
profile_id	string	Returns the unique, system-generated identifier for the profile. (pattern: <code>[a-zA-Z0-9_-]+</code>)

list_profiles

Name	Datatype	Description
name	string	Returns the display name for profile.
business_name	string	Returns the name for the business associated with this profile.
created_at	string (date-time)	Returns the timestamp for creation date and time of the profile.
log_group_name	string	Returns the name of the logging group.
logging	string	Specifies whether or not logging is enabled for this profile. (ENABLED, DISABLED)
modified_at	string (date-time)	Returns the timestamp that identifies the most recent date and time that the profile was modified.
profile_id	string	Returns the unique, system-generated identifier for the profile. (pattern: <code>[a-zA-Z0-9_-]+</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_profile	select	region		Retrieves the details for the profile specified by the profile ID. A profile is the mechanism used to create the concept of a private network.
list_profiles	select	region		Lists the profiles associated with your Amazon Web Services account for your current or specified region. A profile is the mechanism used to create the concept of a private network.
create_profile	insert	region, name, phone, businessName, logging		Creates a customer profile. You can have up to five customer profiles, each representing a distinct private network. A profile is the mechanism used to create the concept of a private network.
update_profile	update	region, profileId		Updates the specified parameters for a profile. A profile is the mechanism used to create the concept of a private network.
delete_profile	delete	region		Deletes the specified profile. A profile is the mechanism used to create the concept of a private network.

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_profile

Retrieves the details for the profile specified by the profile ID. A profile is the mechanism used to create the concept of a private network.

SELECT
name,
business_name,
created_at,
email,
log_group_name,
logging,
modified_at,
phone,
profile_arn,
profile_id
FROM aws.b2bi.profiles
WHERE region = '{{ region }}' -- required
;

list_profiles

Lists the profiles associated with your Amazon Web Services account for your current or specified region. A profile is the mechanism used to create the concept of a private network.

SELECT
name,
business_name,
created_at,
log_group_name,
logging,
modified_at,
profile_id
FROM aws.b2bi.profiles
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_profile

Creates a customer profile. You can have up to five customer profiles, each representing a distinct private network. A profile is the mechanism used to create the concept of a private network.

INSERT INTO aws.b2bi.profiles (
name,
email,
phone,
businessName,
logging,
clientToken,
tags,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ email }}',
'{{ phone }}' /* required */,
'{{ businessName }}' /* required */,
'{{ logging }}' /* required */,
'{{ clientToken }}',
'{{ tags }}',
'{{ region }}'
RETURNING
name,
business_name,
created_at,
email,
log_group_name,
logging,
phone,
profile_arn,
profile_id
;

Manifest

# Description fields are for documentation purposes
- name: profiles
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the profiles resource.
  - name: name
    value: "{{ name }}"
    description: |
      Specifies the name of the profile.
  - name: email
    value: "{{ email }}"
    description: |
      Specifies the email address associated with this customer profile.
  - name: phone
    value: "{{ phone }}"
    description: |
      Specifies the phone number associated with the profile.
  - name: businessName
    value: "{{ businessName }}"
    description: |
      Specifies the name for the business associated with this profile.
  - name: logging
    value: "{{ logging }}"
    description: |
      Specifies whether or not logging is enabled for this profile.
    valid_values: ['ENABLED', 'DISABLED']
  - name: clientToken
    value: "{{ clientToken }}"
    description: |
      Reserved for future use.
  - name: tags
    description: |
      Specifies the key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to resources (capabilities, partnerships, and so on) for any purpose.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

UPDATE examples

update_profile

Updates the specified parameters for a profile. A profile is the mechanism used to create the concept of a private network.

UPDATE aws.b2bi.profiles
SET 
profileId = '{{ profileId }}',
name = '{{ name }}',
email = '{{ email }}',
phone = '{{ phone }}',
businessName = '{{ businessName }}'
WHERE 
region = '{{ region }}' --required
AND profileId = '{{ profileId }}' --required
RETURNING
name,
business_name,
created_at,
email,
log_group_name,
logging,
modified_at,
phone,
profile_arn,
profile_id;

DELETE examples

delete_profile

Deletes the specified profile. A profile is the mechanism used to create the concept of a private network.

DELETE FROM aws.b2bi.profiles
WHERE region = '{{ region }}' --required
;