Actions, resources, and condition keys for High-volume outbound communications - Service Authorization Reference

Actions, resources, and condition keys for High-volume outbound communications

High-volume outbound communications (service prefix: connect-campaigns) provides the following service-specific resources, actions, and condition context keys for use in IAM permission policies.

References:

Actions defined by High-volume outbound communications

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 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
CreateCampaign Grants permission to create a campaign Write

campaign*

aws:TagKeys

aws:RequestTag/${TagKey}

DeleteCampaign Grants permission to delete a campaign Write

campaign*

DeleteConnectInstanceConfig Grants permission to remove configuration information for an Amazon Connect instance Write
DeleteInstanceOnboardingJob Grants permission to remove onboarding job for an Amazon Connect instance Write
DescribeCampaign Grants permission to describe a specific campaign Read

campaign*

aws:RequestTag/${TagKey}

GetCampaignState Grants permission to get state of a campaign Read

campaign*

aws:RequestTag/${TagKey}

GetCampaignStateBatch Grants permission to get state of campaigns Read

campaign*

aws:RequestTag/${TagKey}

GetConnectInstanceConfig Grants permission to get configuration information for an Amazon Connect instance Read
GetInstanceOnboardingJobStatus Grants permission to get onboarding job status for an Amazon Connect instance Read
ListCampaigns Grants permission to provide summary of all campaigns List

aws:RequestTag/${TagKey}

ListTagsForResource Grants permission to list tags for a resource Read

campaign

aws:ResourceTag/${TagKey}

PauseCampaign Grants permission to pause a campaign Write

campaign*

PutDialRequestBatch Grants permission to create dial requests for the specified campaign Write

campaign*

ResumeCampaign Grants permission to resume a campaign Write

campaign*

StartCampaign Grants permission to start a campaign Write

campaign*

StartInstanceOnboardingJob Grants permission to start onboarding job for an Amazon Connect instance Write
StopCampaign Grants permission to stop a campaign Write

campaign*

TagResource Grants permission to tag a resource Tagging

campaign

aws:TagKeys

aws:RequestTag/${TagKey}

UntagResource Grants permission to untag a resource Tagging

campaign

aws:TagKeys

aws:RequestTag/${TagKey}

UpdateCampaignDialerConfig Grants permission to update the dialer configuration of a campaign Write

campaign*

UpdateCampaignName Grants permission to update the name of a campaign Write

campaign*

UpdateCampaignOutboundCallConfig Grants permission to update the outbound call configuration of a campaign Write

campaign*

Resource types defined by High-volume outbound communications

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
campaign arn:${Partition}:connect-campaigns:${Region}:${Account}:campaign/${CampaignId}

aws:ResourceTag/${TagKey}

Condition keys for High-volume outbound communications

High-volume outbound communications 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 Available global condition keys.

Condition keys Description Type
aws:RequestTag/${TagKey} Filters actions based on the presence of tag key-value pairs in the request String
aws:ResourceTag/${TagKey} Filters actions based on tag key-value pairs attached to the resource String
aws:TagKeys Filters actions based on the presence of tag keys in the request ArrayOfString