profile_visibilities

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

Overview

Name	profile_visibilities
Type	Resource
Id	aws.partnercentral_account.profile_visibilities

Fields

The following fields are returned by SELECT queries:

get_profile_visibility

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the partner account. (pattern: <code>arn:[a-z-]+:partnercentral:[a-z0-9-]+:[0-9]{12}:catalog/[A-Za-z-_]+/partner/partner-[A-Za-z0-9]{13}</code>)
catalog	string	The catalog identifier for the partner account. (pattern: <code>[a-zA-Z0-9-]+</code>)
id	string	The unique identifier of the partner account. (pattern: <code>partner-[A-Za-z0-9]{13}</code>)
profile_id	string	The unique identifier of the partner profile. (pattern: <code>pprofile-[A-Za-z0-9]{13}</code>)
visibility	string	The visibility setting for the partner profile (public, private, restricted, etc.). (PRIVATE, PUBLIC)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_profile_visibility	select	region		Retrieves the visibility settings for a partner profile, determining who can see the profile information.
put_profile_visibility	replace	region, Identifier		Sets the visibility level for a partner profile, controlling who can view the profile information.

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_visibility

Retrieves the visibility settings for a partner profile, determining who can see the profile information.

SELECT
arn,
catalog,
id,
profile_id,
visibility
FROM aws.partnercentral_account.profile_visibilities
WHERE region = '{{ region }}' -- required
;

REPLACE examples

put_profile_visibility

Sets the visibility level for a partner profile, controlling who can view the profile information.

REPLACE aws.partnercentral_account.profile_visibilities
SET 
Catalog = '{{ Catalog }}',
Identifier = '{{ Identifier }}',
Visibility = '{{ Visibility }}'
WHERE 
region = '{{ region }}' --required
AND Identifier = '{{ Identifier }}' --required
RETURNING
arn,
catalog,
id,
profile_id,
visibility;