Actions, resources, and condition keys for Amazon Pinpoint SMS Voice V2

Amazon Pinpoint SMS Voice V2 (service prefix: sms-voice) 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 Pinpoint SMS Voice V2
Resource types defined by Amazon Pinpoint SMS Voice V2
Condition keys for Amazon Pinpoint SMS Voice V2

Actions defined by Amazon Pinpoint SMS Voice V2

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
AssociateOriginationIdentity	Grants permission to associate an origination phone number or sender ID to a pool	Write	Pool*
			PhoneNumber
			SenderId
AssociateProtectConfiguration	Grants permission to associate a protect configuration to a configuration set	Write	ConfigurationSet*
AssociateProtectConfiguration		Write	ProtectConfiguration*
CreateConfigurationSet	Grants permission to create a configuration set	Write		aws:RequestTag/${TagKey} aws:TagKeys	sms-voice:TagResource
CreateEventDestination	Grants permission to create an event destination within a configuration set	Write	ConfigurationSet*		iam:PassRole
CreateOptOutList	Grants permission to create an opt-out list	Write		aws:RequestTag/${TagKey} aws:TagKeys	sms-voice:TagResource
CreatePool	Grants permission to create a pool	Write	PhoneNumber		sms-voice:TagResource
			SenderId
				aws:RequestTag/${TagKey} aws:TagKeys
CreateProtectConfiguration	Grants permission to create a protect configuration	Write		aws:RequestTag/${TagKey} aws:TagKeys	sms-voice:TagResource
CreateRegistration	Grants permission to create a registration	Write		aws:RequestTag/${TagKey} aws:TagKeys	sms-voice:TagResource
CreateRegistrationAssociation	Grants permission to associate a registration with a phone number or another registration	Write	Registration*
CreateRegistrationAssociation		Write	PhoneNumber
CreateRegistrationAttachment	Grants permission to create a registration attachment	Write		aws:RequestTag/${TagKey} aws:TagKeys	sms-voice:TagResource
CreateRegistrationVersion	Grants permission to create a registration version	Write	Registration*
CreateVerifiedDestinationNumber	Grants permission to create a verified destination number	Write		aws:RequestTag/${TagKey} aws:TagKeys	sms-voice:TagResource
DeleteAccountDefaultProtectConfiguration	Grants permission to delete the account default protect configuration	Write
DeleteConfigurationSet	Grants permission to delete a configuration set	Write	ConfigurationSet*
DeleteDefaultMessageType	Grants permission to delete the default message type for a configuration set	Write	ConfigurationSet*
DeleteDefaultSenderId	Grants permission to delete the default sender ID for a configuration set	Write	ConfigurationSet*
DeleteEventDestination	Grants permission to delete an event destination within a configuration set	Write	ConfigurationSet*
DeleteKeyword	Grants permission to delete a keyword for a pool or origination phone number	Write	PhoneNumber
DeleteKeyword		Write	Pool
DeleteMediaMessageSpendLimitOverride	Grants permission to delete an override for your account's media messaging monthly spend limit	Write
DeleteOptOutList	Grants permission to delete an opt-out list	Write	OptOutList*
DeleteOptedOutNumber	Grants permission to delete a destination phone number from an opt-out list	Write	OptOutList*
DeletePool	Grants permission to delete a pool	Write	Pool*
DeleteProtectConfiguration	Grants permission to delete a protect configuration	Write	ProtectConfiguration*
DeleteRegistration	Grants permission to delete a registration	Write	Registration*
DeleteRegistrationAttachment	Grants permission to delete a registration attachment	Write	RegistrationAttachment*
DeleteRegistrationFieldValue	Grants permission to delete an optional registration field value	Write	Registration*
DeleteTextMessageSpendLimitOverride	Grants permission to delete an override for your account's text messaging monthly spend limit	Write
DeleteVerifiedDestinationNumber	Grants permission to delete a verified destination number	Write	VerifiedDestinationNumber*
DeleteVoiceMessageSpendLimitOverride	Grants permission to delete an override for your account's voice messaging monthly spend limit	Write
DescribeAccountAttributes	Grants permission to describe the attributes of your account	Read
DescribeAccountLimits	Grants permission to describe the service quotas for your account	Read
DescribeConfigurationSets	Grants permission to describe the configuration sets in your account	Read	ConfigurationSet
DescribeKeywords	Grants permission to describe the keywords for a pool or origination phone number	Read	PhoneNumber
DescribeKeywords		Read	Pool
DescribeOptOutLists	Grants permission to describe the opt-out lists in your account	Read	OptOutList
DescribeOptedOutNumbers	Grants permission to describe the destination phone numbers in an opt-out list	Read	OptOutList*
DescribePhoneNumbers	Grants permission to describe the origination phone numbers in your account	Read	PhoneNumber
DescribePools	Grants permission to describe the pools in your account	Read	Pool
DescribeProtectConfigurations	Grants permission to describe the protect configurations in your account	Read	ProtectConfiguration
DescribeRegistrationAttachments	Grants permission to describe the registration attachments in your account	Read	RegistrationAttachment
DescribeRegistrationFieldDefinitions	Grants permission to describe the field definitions for a given registration type	Read
DescribeRegistrationFieldValues	Grants permission to describe the field values for a given registration	Read	Registration*
DescribeRegistrationSectionDefinitions	Grants permission to describe the section definitions for a given registration type	Read
DescribeRegistrationTypeDefinitions	Grants permission to describe the registration types supported by the service	Read
DescribeRegistrationVersions	Grants permission to describe the versions for a given registration	Read	Registration*
DescribeRegistrations	Grants permission to describe the registrations in your account	Read	Registration
DescribeSenderIds	Grants permission to describe the sender IDs in your account	Read	SenderId
DescribeSpendLimits	Grants permission to describe the monthly spend limits for your account	Read
DescribeVerifiedDestinationNumbers	Grants permission to describe the verified destination numbers in your account	Read	VerifiedDestinationNumber
DisassociateOriginationIdentity	Grants permission to disassociate an origination phone number or sender ID from a pool	Write	Pool*
			PhoneNumber
			SenderId
DisassociateProtectConfiguration	Grants permission to disassociate a protect configuration from a configuration set	Write	ConfigurationSet*
DisassociateProtectConfiguration		Write	ProtectConfiguration*
DiscardRegistrationVersion	Grants permission to discard the latest version of a given registration	Write	Registration*
GetProtectConfigurationCountryRuleSet	Grants permission to get the country rule set for a protect configuration	Read	ProtectConfiguration*
ListPoolOriginationIdentities	Grants permission to list all origination phone numbers and sender IDs associated to a pool	Read	Pool*
ListRegistrationAssociations	Grants permission to list all resources associated to a registration	Read	Registration*
ListTagsForResource	Grants permission to list the tags for a resource	Read	ConfigurationSet
			OptOutList
			PhoneNumber
			Pool
			ProtectConfiguration
			Registration
			RegistrationAttachment
			SenderId
			VerifiedDestinationNumber
PutKeyword	Grants permission to create or update a keyword for a pool or origination phone number	Write	PhoneNumber
PutKeyword		Write	Pool
PutOptedOutNumber	Grants permission to put a destination phone number into an opt-out list	Write	OptOutList*
PutRegistrationFieldValue	Grants permission to put a registration field value	Write	Registration*
ReleasePhoneNumber	Grants permission to release an origination phone number	Write	PhoneNumber*
ReleaseSenderId	Grants permission to release a sender ID	Write	SenderId*
RequestPhoneNumber	Grants permission to request an origination phone number	Write	Pool		sms-voice:AssociateOriginationIdentity sms-voice:TagResource
RequestPhoneNumber	Grants permission to request an origination phone number	Write		aws:RequestTag/${TagKey} aws:TagKeys
RequestSenderId	Grants permission to request an unregistered sender ID	Write		aws:RequestTag/${TagKey} aws:TagKeys	sms-voice:TagResource
SendDestinationNumberVerificationCode	Grants permission to send a text or voice message containing a verification code to a destination phone number	Write	PhoneNumber		sms-voice:SendTextMessage sms-voice:SendVoiceMessage
			Pool
			SenderId
SendMediaMessage	Grants permission to send a media message to a destination phone number	Write	PhoneNumber
SendMediaMessage		Write	Pool
SendTextMessage	Grants permission to send a text message to a destination phone number	Write	PhoneNumber
			Pool
			SenderId
SendVoiceMessage	Grants permission to send a voice message to a destination phone number	Write	PhoneNumber
SendVoiceMessage		Write	Pool
SetAccountDefaultProtectConfiguration	Grants permission to set a default protect configuration for the account	Write	ProtectConfiguration*
SetDefaultMessageType	Grants permission to set the default message type for a configuration set	Write	ConfigurationSet*
SetDefaultSenderId	Grants permission to set the default sender ID for a configuration set	Write	ConfigurationSet*
SetMediaMessageSpendLimitOverride	Grants permission to set an override for your account's media messaging monthly spend limit	Write
SetTextMessageSpendLimitOverride	Grants permission to set an override for your account's text messaging monthly spend limit	Write
SetVoiceMessageSpendLimitOverride	Grants permission to set an override for your account's voice messaging monthly spend limit	Write
SubmitRegistrationVersion	Grants permission to submit the latest version of a given registration	Write	Registration*
TagResource	Grants permission to add tags to a resource	Tagging	ConfigurationSet
			OptOutList
			PhoneNumber
			Pool
			ProtectConfiguration
			Registration
			RegistrationAttachment
			SenderId
			VerifiedDestinationNumber
				aws:RequestTag/${TagKey} aws:TagKeys
UntagResource	Grants permission to remove tags from a resource	Tagging	ConfigurationSet
			OptOutList
			PhoneNumber
			Pool
			ProtectConfiguration
			Registration
			RegistrationAttachment
			SenderId
			VerifiedDestinationNumber
				aws:TagKeys
UpdateEventDestination	Grants permission to update an event destination within a configuration set	Write	ConfigurationSet*		iam:PassRole
UpdatePhoneNumber	Grants permission to update an origination phone number's configuration	Write	PhoneNumber*		iam:PassRole
UpdatePool	Grants permission to update a pool's configuration	Write	Pool*		iam:PassRole
UpdateProtectConfiguration	Grants permission to update a protect configuration	Write	ProtectConfiguration*
UpdateProtectConfigurationCountryRuleSet	Grants permission to update a country rule set for a protect configuration	Write	ProtectConfiguration*
UpdateSenderId	Grants permission to update a sender ID's configuration	Write	SenderId*
VerifyDestinationNumber	Grants permission to verify a destination phone number	Write	VerifiedDestinationNumber*

Resource types defined by Amazon Pinpoint SMS Voice V2

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
ConfigurationSet	`arn:${Partition}:sms-voice:${Region}:${Account}:configuration-set/${ConfigurationSetName}`	aws:ResourceTag/${TagKey}
OptOutList	`arn:${Partition}:sms-voice:${Region}:${Account}:opt-out-list/${OptOutListName}`	aws:ResourceTag/${TagKey}
PhoneNumber	`arn:${Partition}:sms-voice:${Region}:${Account}:phone-number/${PhoneNumberId}`	aws:ResourceTag/${TagKey}
Pool	`arn:${Partition}:sms-voice:${Region}:${Account}:pool/${PoolId}`	aws:ResourceTag/${TagKey}
ProtectConfiguration	`arn:${Partition}:sms-voice:${Region}:${Account}:protect-configuration/${ProtectConfigurationId}`	aws:ResourceTag/${TagKey}
SenderId	`arn:${Partition}:sms-voice:${Region}:${Account}:sender-id/${SenderId}/${IsoCountryCode}`	aws:ResourceTag/${TagKey}
Registration	`arn:${Partition}:sms-voice:${Region}:${Account}:registration/${RegistrationId}`	aws:ResourceTag/${TagKey}
RegistrationAttachment	`arn:${Partition}:sms-voice:${Region}:${Account}:registration-attachment/${RegistrationAttachmentId}`	aws:ResourceTag/${TagKey}
VerifiedDestinationNumber	`arn:${Partition}:sms-voice:${Region}:${Account}:verified-destination-number/${VerifiedDestinationNumberId}`	aws:ResourceTag/${TagKey}

Condition keys for Amazon Pinpoint SMS Voice V2

Amazon Pinpoint SMS Voice V2 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 access by the tags that are passed in the request	String
aws:ResourceTag/${TagKey}	Filters access by the tags associated with the resource	String
aws:TagKeys	Filters access by the tag keys that are passed in the request	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 Pinpoint SMS and Voice Service

Amazon Polly