profiles

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

Overview

Name	profiles
Type	Resource
Id	aws.transfer.profiles

Fields

The following fields are returned by SELECT queries:

describe_profile

Name	Datatype	Description
arn	string	The unique Amazon Resource Name (ARN) for the profile. (pattern: <code>arn:\S+</code>)
as_2_id	string	The As2Id is the AS2-name, as defined in the RFC 4130. For inbound transfers, this is the AS2-From header for the AS2 messages sent from the partner. For outbound connectors, this is the AS2-To header for the AS2 messages sent to the partner using the StartFileTransfer API operation. This ID cannot include spaces. (pattern: <code>[\u0020-\u007E\s]*</code>)
certificate_ids	array	An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.
profile_id	string	A unique identifier for the local or partner AS2 profile. (pattern: <code>p-([0-9a-f]{17})</code>)
profile_type	string	Indicates whether to list only LOCAL type profiles or only PARTNER type profiles. If not supplied in the request, the command lists all types of profiles. (LOCAL, PARTNER)
tags	array	Key-value pairs that can be used to group and search for profiles.

list_profiles

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the specified profile. (pattern: <code>arn:\S+</code>)
as_2_id	string	The As2Id is the AS2-name, as defined in the RFC 4130. For inbound transfers, this is the AS2-From header for the AS2 messages sent from the partner. For outbound connectors, this is the AS2-To header for the AS2 messages sent to the partner using the StartFileTransfer API operation. This ID cannot include spaces. (pattern: <code>[\u0020-\u007E\s]*</code>)
profile_id	string	A unique identifier for the local or partner AS2 profile. (pattern: <code>p-([0-9a-f]{17})</code>)
profile_type	string	Indicates whether to list only LOCAL type profiles or only PARTNER type profiles. If not supplied in the request, the command lists all types of profiles. (LOCAL, PARTNER)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_profile	select	region		Returns the details of the profile that's specified by the ProfileId.
list_profiles	select	region		Returns a list of the profiles for your system. If you want to limit the results to a certain number, supply a value for the MaxResults parameter. If you ran the command previously and received a value for NextToken, you can supply that value to continue listing profiles from where you left off.
create_profile	insert	region, As2Id, ProfileType		Creates the local or partner profile to use for AS2 transfers.
update_profile	update	region, ProfileId		Updates some of the parameters for an existing profile. Provide the ProfileId for the profile that you want to update, along with the new values for the parameters to update.
delete_profile	delete	region		Deletes the profile that's specified in the ProfileId parameter.

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_profile

Returns the details of the profile that's specified by the ProfileId.

SELECT
arn,
as_2_id,
certificate_ids,
profile_id,
profile_type,
tags
FROM aws.transfer.profiles
WHERE region = '{{ region }}' -- required
;

list_profiles

Returns a list of the profiles for your system. If you want to limit the results to a certain number, supply a value for the MaxResults parameter. If you ran the command previously and received a value for NextToken, you can supply that value to continue listing profiles from where you left off.

SELECT
arn,
as_2_id,
profile_id,
profile_type
FROM aws.transfer.profiles
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_profile

Creates the local or partner profile to use for AS2 transfers.

INSERT INTO aws.transfer.profiles (
As2Id,
ProfileType,
CertificateIds,
Tags,
region
)
SELECT 
'{{ As2Id }}' /* required */,
'{{ ProfileType }}' /* required */,
'{{ CertificateIds }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
profile_id
;

Manifest

# Description fields are for documentation purposes
- name: profiles
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the profiles resource.
  - name: As2Id
    value: "{{ As2Id }}"
    description: |
      The As2Id is the AS2-name, as defined in the RFC 4130. For inbound transfers, this is the AS2-From header for the AS2 messages sent from the partner. For outbound connectors, this is the AS2-To header for the AS2 messages sent to the partner using the StartFileTransfer API operation. This ID cannot include spaces.
  - name: ProfileType
    value: "{{ ProfileType }}"
    description: |
      Determines the type of profile to create: Specify LOCAL to create a local profile. A local profile represents the AS2-enabled Transfer Family server organization or party. Specify PARTNER to create a partner profile. A partner profile represents a remote organization, external to Transfer Family.
    valid_values: ['LOCAL', 'PARTNER']
  - name: CertificateIds
    value:
      - "{{ CertificateIds }}"
    description: |
      An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.
  - name: Tags
    description: |
      Key-value pairs that can be used to group and search for AS2 profiles.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

UPDATE examples

update_profile

Updates some of the parameters for an existing profile. Provide the ProfileId for the profile that you want to update, along with the new values for the parameters to update.

UPDATE aws.transfer.profiles
SET 
ProfileId = '{{ ProfileId }}',
CertificateIds = '{{ CertificateIds }}'
WHERE 
region = '{{ region }}' --required
AND ProfileId = '{{ ProfileId }}' --required
RETURNING
profile_id;

DELETE examples

delete_profile

Deletes the profile that's specified in the ProfileId parameter.

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