Actions, resources, and condition keys for Amazon Connect Customer Profiles

Amazon Connect Customer Profiles (service prefix: profile) provides the following service-specific resources, actions, and condition context keys for use in IAM permission policies.

References:

Learn how to configure this service.
View a list of the API operations available for this service.
Learn how to secure this service and its resources by using IAM permission policies.

Topics

Actions defined by Amazon Connect Customer Profiles
Resource types defined by Amazon Connect Customer Profiles
Condition keys for Amazon Connect Customer Profiles

Actions defined by Amazon Connect Customer Profiles

You can specify the following actions in the Action element of an IAM policy statement. Use policies to grant permissions to perform an operation in AWS. When you use an action in a policy, you usually allow or deny access to the API operation or CLI command with the same name. However, in some cases, a single action controls access to more than one operation. Alternatively, some operations require several different actions.

The Access level column of the Actions table describes how the action is classified (List, Read, Permissions management, or Tagging). This classification can help you understand the level of access that an action grants when you use it in a policy. For more information about access levels, see Access levels in policy summaries.

The Resource types column of the Actions table indicates whether each action supports resource-level permissions. If there is no value for this column, you must specify all resources ("*") to which the policy applies in the Resource element of your policy statement. If the column includes a resource type, then you can specify an ARN of that type in a statement with that action. If the action has one or more required resources, the caller must have permission to use the action with those resources. Required resources are indicated in the table with an asterisk (*). If you limit resource access with the Resource element in an IAM policy, you must include an ARN or pattern for each required resource type. Some actions support multiple resource types. If the resource type is optional (not indicated as required), then you can choose to use one of the optional resource types.

The Condition keys column of the Actions table includes keys that you can specify in a policy statement's Condition element. For more information on the condition keys that are associated with resources for the service, see the Condition keys column of the Resource types table.

Note

Resource condition keys are listed in the Resource types table. You can find a link to the resource type that applies to an action in the Resource types (*required) column of the Actions table. The resource type in the Resource types table includes the Condition keys column, which are the resource condition keys that apply to an action in the Actions table.

For details about the columns in the following table, see Actions table.

Actions	Description	Access level	Resource types (*required)	Condition keys	Dependent actions
AddProfileKey	Grants permission to add a profile key	Write	domains*
BatchGetCalculatedAttributeForProfile	Grants permission to retrieve a calculated attribute for the specific profiles in the domain	Read	calculated-attributes*
BatchGetCalculatedAttributeForProfile		Read	domains*
BatchGetProfile	Grants permission to get profiles in the domain	Read	domains*
CreateCalculatedAttributeDefinition	Grants permission to create a calculated attribute definition in the domain	Write	calculated-attributes*	aws:RequestTag/${TagKey} aws:TagKeys
CreateCalculatedAttributeDefinition		Write	domains*
CreateDomain	Grants permission to create a Domain	Write	domains*	aws:RequestTag/${TagKey} aws:TagKeys	iam:CreateServiceLinkedRole
CreateDomainLayout	Grants permission to create a layout in the domain	Write	domains*
CreateDomainLayout	Grants permission to create a layout in the domain	Write	layouts*	aws:RequestTag/${TagKey} aws:TagKeys
CreateEventStream	Grants permission to put an event stream in a domain	Write	domains*		iam:PutRolePolicy kinesis:DescribeStreamSummary
CreateEventStream	Grants permission to put an event stream in a domain	Write	event-streams*	aws:RequestTag/${TagKey} aws:TagKeys
CreateEventTrigger	Grants permission to create an event trigger in the domain	Write	domains*
CreateEventTrigger	Grants permission to create an event trigger in the domain	Write	event-triggers*	aws:RequestTag/${TagKey} aws:TagKeys
CreateIntegrationWorkflow	Grants permission to create an integration workflow in a domain	Write	domains*
CreateIntegrationWorkflow		Write	integrations*	aws:RequestTag/${TagKey} aws:TagKeys
CreateProfile	Grants permission to create a profile in the domain	Write	domains*
CreateSegmentDefinition	Grants permission to create a segment definition in the domain	Write	domains*
CreateSegmentDefinition		Write	segment-definitions*	aws:RequestTag/${TagKey} aws:TagKeys
CreateSegmentEstimate	Grants permission to create a segment estimate in the domain	Write	domains*
CreateSegmentSnapshot	Grants permission to create a segment snapshot in the domain	Write	domains*
CreateSegmentSnapshot		Write	segment-definitions*
CreateSnapshot [permission only]	Grants permission to create a snapshot in the domain	Write	domains*
CreateUploadJob	Grants permission to create an upload job in the domain	Write	domains*
DeleteCalculatedAttributeDefinition	Grants permission to delete a calculated attribute definition in the domain	Write	calculated-attributes*
DeleteCalculatedAttributeDefinition		Write	domains*
DeleteDomain	Grants permission to delete a Domain	Write	domains*
DeleteDomainLayout	Grants permission to delete a layout in the domain	Write	domains*
DeleteDomainLayout	Grants permission to delete a layout in the domain	Write	layouts*
DeleteEventStream	Grants permission to delete an event stream in a domain	Write	domains*		iam:DeleteRolePolicy
DeleteEventStream	Grants permission to delete an event stream in a domain	Write	event-streams*
DeleteEventTrigger	Grants permission to delete an event trigger in the domain	Write	domains*
DeleteEventTrigger	Grants permission to delete an event trigger in the domain	Write	event-triggers*
DeleteIntegration	Grants permission to delete a integration in a domain	Write	domains*
DeleteIntegration	Grants permission to delete a integration in a domain	Write	integrations*
DeleteProfile	Grants permission to delete a profile	Write	domains*
DeleteProfileKey	Grants permission to delete a profile key	Write	domains*
DeleteProfileObject	Grants permission to delete a profile object	Write	domains*
DeleteProfileObject	Grants permission to delete a profile object	Write	object-types*
DeleteProfileObjectType	Grants permission to delete a specific profile object type in the domain	Write	domains*
DeleteProfileObjectType		Write	object-types*
DeleteSegmentDefinition	Grants permission to delete a segment definition in the domain	Write	domains*
DeleteSegmentDefinition		Write	segment-definitions*
DeleteWorkflow	Grants permission to delete a workflow in a domain	Write	domains*
DetectProfileObjectType	Grants permission to auto detect object type	Read	domains*
GetAutoMergingPreview	Grants permission to get a preview of auto merging in a domain	Read	domains*
GetCalculatedAttributeDefinition	Grants permission to get a calculated attribute definition in the domain	Read	calculated-attributes*
GetCalculatedAttributeDefinition		Read	domains*
GetCalculatedAttributeForProfile	Grants permission to retrieve a calculated attribute for a specific profile in the domain	Read	calculated-attributes*
GetCalculatedAttributeForProfile		Read	domains*
GetDomain	Grants permission to get a specific domain in an account	Read	domains*
GetDomainLayout	Grants permission to get a layout in the domain	Read	domains*
GetDomainLayout	Grants permission to get a layout in the domain	Read	layouts*
GetEventStream	Grants permission to get a specific event stream in a domain	Read	domains*		kinesis:DescribeStreamSummary
GetEventStream		Read	event-streams*
GetEventTrigger	Grants permission to get an event trigger in the domain	Read	domains*
GetEventTrigger	Grants permission to get an event trigger in the domain	Read	event-triggers*
GetIdentityResolutionJob	Grants permission to get an identity resolution job in a domain	Read	domains*
GetIntegration	Grants permission to get a specific integrations in a domain	Read	domains*
GetIntegration		Read	integrations*
GetMatches	Grants permission to get profile matches in a domain	List	domains*
GetProfileObjectType	Grants permission to get a specific profile object type in the domain	Read	domains*
GetProfileObjectType		Read	object-types*
GetProfileObjectTypeTemplate	Grants permission to get a specific object type template	Read
GetSegmentDefinition	Grants permission to get a segment definition in the domain	Read	domains*
GetSegmentDefinition	Grants permission to get a segment definition in the domain	Read	segment-definitions*
GetSegmentEstimate	Grants permission to get a segment estimate in the domain	Read	domains*
GetSegmentMembership	Grants permission to determine if the given profiles are part of a segment in the domain	Read	domains*
GetSegmentMembership		Read	segment-definitions*
GetSegmentSnapshot	Grants permission to get a segment snapshot in the domain	Read	domains*
GetSegmentSnapshot	Grants permission to get a segment snapshot in the domain	Read	segment-definitions*
GetSimilarProfiles	Grants permission to get all the similar profiles in the domain	List	domains*
GetSnapshot [permission only]	Grants permission to get a snapshot in the domain	Read	domains*
GetUploadJob	Grants permission to get details of an upload job in the domain	Read	domains*
GetUploadJobPath	Grants permission to get a pre-signed URL to upload file for an upload job	Read	domains*
GetWorkflow	Grants permission to get workflow details in a domain	Read	domains*
GetWorkflowSteps	Grants permission to get workflow step details in a domain	Read	domains*
ListAccountIntegrations	Grants permission to list all the integrations in the account	List
ListCalculatedAttributeDefinitions	Grants permission to list all the calculated attribute definitions in the domain	List	domains*
ListCalculatedAttributesForProfile	Grants permission to list all calculated attributes for a specific profile in the domain	List	domains*
ListDomainLayouts	Grants permission to list all the layouts in the domain	List	domains*
ListDomains	Grants permission to list all the domains in an account	List
ListEventStreams	Grants permission to list all the event streams in a specific domain	List	domains*
ListEventTriggers	Grants permission to list all the event triggers in the domain	List	domains*
ListIdentityResolutionJobs	Grants permission to list identity resolution jobs in a domain	List	domains*
ListIntegrations	Grants permission to list all the integrations in a specific domain	List	domains*
ListObjectTypeAttributes	Grants permission to list all the attributes of a specific object type in the domain	List	domains*
ListObjectTypeAttributes		List	object-types*
ListProfileAttributeValues	Grants permission to list all the values of a profile attribute in the domain	List	domains*
ListProfileObjectTypeTemplates	Grants permission to list all the profile object type templates in the account	List
ListProfileObjectTypes	Grants permission to list all the profile object types in the domain	List	domains*
ListProfileObjects	Grants permission to list all the profile objects for a profile	List	domains*
ListProfileObjects		List	object-types*
ListRuleBasedMatches	Grants permission to list all the rule-based matching result in the domain	List	domains*
ListSegmentDefinitions	Grants permission to list all the segment definitions in the domain	List	domains*
ListTagsForResource	Grants permission to list tags for a resource	Read	calculated-attributes
			domains
			event-streams
			event-triggers
			integrations
			layouts
			object-types
			segment-definitions
ListUploadJobs	Grants permission to list all upload jobs in the domain	List	domains*
ListWorkflows	Grants permission to list all the workflows in a specific domain	List	domains*
MergeProfiles	Grants permission to merge profiles in a domain	Write	domains*
PutIntegration	Grants permission to put a integration in a domain	Write	domains*
PutIntegration	Grants permission to put a integration in a domain	Write	integrations*	aws:RequestTag/${TagKey} aws:TagKeys
PutProfileObject	Grants permission to put an object for a profile	Write	domains*
PutProfileObject	Grants permission to put an object for a profile	Write	object-types*
PutProfileObjectType	Grants permission to put a specific profile object type in the domain	Write	domains*
PutProfileObjectType		Write	object-types*	aws:RequestTag/${TagKey} aws:TagKeys
SearchProfiles	Grants permission to search for profiles in a domain	Read	domains*
StartUploadJob	Grants permission to start an upload job in the domain	Write	domains*
StopUploadJob	Grants permission to stop an upload job in the domain	Write	domains*
TagResource	Grants permission to adds tags to a resource	Tagging	calculated-attributes
			domains
			event-streams
			event-triggers
			integrations
			layouts
			object-types
			segment-definitions
				aws:RequestTag/${TagKey} aws:TagKeys
UntagResource	Grants permission to remove tags from a resource	Tagging	calculated-attributes
			domains
			event-streams
			event-triggers
			integrations
			layouts
			object-types
			segment-definitions
				aws:TagKeys
UpdateCalculatedAttributeDefinition	Grants permission to update a calculated attribute definition in the domain	Write	calculated-attributes*
UpdateCalculatedAttributeDefinition		Write	domains*
UpdateDomain	Grants permission to update a Domain	Write	domains*		iam:CreateServiceLinkedRole
UpdateDomainLayout	Grants permission to update a layout in the domain	Write	domains*
UpdateDomainLayout	Grants permission to update a layout in the domain	Write	layouts*
UpdateEventTrigger	Grants permission to update an event trigger in the domain	Write	domains*
UpdateEventTrigger	Grants permission to update an event trigger in the domain	Write	event-triggers*
UpdateProfile	Grants permission to update a profile in the domain	Write	domains*

Resource types defined by Amazon Connect Customer Profiles

The following resource types are defined by this service and can be used in the Resource element of IAM permission policy statements. Each action in the Actions table identifies the resource types that can be specified with that action. A resource type can also define which condition keys you can include in a policy. These keys are displayed in the last column of the Resource types table. For details about the columns in the following table, see Resource types table.

Resource types	ARN	Condition keys
domains	`arn:${Partition}:profile:${Region}:${Account}:domains/${DomainName}`	aws:ResourceTag/${TagKey}
object-types	`arn:${Partition}:profile:${Region}:${Account}:domains/${DomainName}/object-types/${ObjectTypeName}`	aws:ResourceTag/${TagKey}
integrations	`arn:${Partition}:profile:${Region}:${Account}:domains/${DomainName}/integrations/${Uri}`	aws:ResourceTag/${TagKey}
event-streams	`arn:${Partition}:profile:${Region}:${Account}:domains/${DomainName}/event-streams/${EventStreamName}`	aws:ResourceTag/${TagKey}
calculated-attributes	`arn:${Partition}:profile:${Region}:${Account}:domains/${DomainName}/calculated-attributes/${CalculatedAttributeName}`	aws:ResourceTag/${TagKey}
segment-definitions	`arn:${Partition}:profile:${Region}:${Account}:domains/${DomainName}/segment-definitions/${SegmentDefinitionName}`	aws:ResourceTag/${TagKey}
event-triggers	`arn:${Partition}:profile:${Region}:${Account}:domains/${DomainName}/event-triggers/${EventTriggerName}`	aws:ResourceTag/${TagKey}
layouts	`arn:${Partition}:profile:${Region}:${Account}:domains/${DomainName}/layouts/${LayoutDefinitionName}`	aws:ResourceTag/${TagKey}

Condition keys for Amazon Connect Customer Profiles

Amazon Connect Customer Profiles defines the following condition keys that can be used in the Condition element of an IAM policy. You can use these keys to further refine the conditions under which the policy statement applies. For details about the columns in the following table, see Condition keys table.

To view the global condition keys that are available to all services, see AWS global condition context keys.

Condition keys	Description	Type
aws:RequestTag/${TagKey}	Filters access by a key that is present in the request the user makes to the customer profile service	String
aws:ResourceTag/${TagKey}	Filters access by a tag key and value pair	String
aws:TagKeys	Filters access by the list of all the tag key names present in the request the user makes to the customer profile service	ArrayOfString

Warning Javascript is disabled or is unavailable in your browser.

To use the Amazon Web Services Documentation, Javascript must be enabled. Please refer to your browser's Help pages for instructions.

Document Conventions

Amazon Connect Cases

Amazon Connect Outbound Campaigns