Actions, resources, and condition keys for AWS Systems Manager Incident Manager Contacts

AWS Systems Manager Incident Manager Contacts (service prefix: ssm-contacts) 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 AWS Systems Manager Incident Manager Contacts
Resource types defined by AWS Systems Manager Incident Manager Contacts
Condition keys for AWS Systems Manager Incident Manager Contacts

Actions defined by AWS Systems Manager Incident Manager Contacts

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
AcceptPage	Grants permission to accept a page	Write	page*
ActivateContactChannel	Grants permission to activate a contact's contact channel	Write	contactchannel*
AssociateContact [permission only]	Grants permission to use a contact in an escalation plan	Permissions management	contact*
CreateContact	Grants permission to create a contact	Write	contact*		ssm-contacts:AssociateContact
CreateContact	Grants permission to create a contact	Write		aws:TagKeys aws:RequestTag/${TagKey}
CreateContactChannel	Grants permission to create a contact channel for a contact	Write	contact*
CreateRotation	Grants permission to create a rotation in an on-call schedule	Write	rotation*
CreateRotation		Write		aws:TagKeys aws:RequestTag/${TagKey}
CreateRotationOverride	Grants permission to create an override for a rotation in an on-call schedule	Write	rotation*
DeactivateContactChannel	Grants permission to deactivate a contact's contact channel	Write	contactchannel*
DeleteContact	Grants permission to delete a contact	Write	contact*
DeleteContactChannel	Grants permission to delete a contact's contact channel	Write	contactchannel*
DeleteRotation	Grants permission to delete a rotation	Write	rotation*
DeleteRotationOverride	Grants permission to delete a rotation's rotation override	Write	rotation*
DescribeEngagement	Grants permission to describe an engagement	Read	engagement*
DescribePage	Grants permission to describe a page	Read	page*
GetContact	Grants permission to get a contact	Read	contact*
GetContactChannel	Grants permission to get a contact's contact channel	Read	contactchannel*
GetContactPolicy	Grants permission to get a contact's resource policy	Read	contact*
GetRotation	Grants permission to retrieve information about an on-call rotation	Read	rotation*
GetRotationOverride	Grants permission to retrieve information about an override in an on-call rotation	Read	rotation*
ListContactChannels	Grants permission to list all of a contact's contact channels	List	contact*
ListContacts	Grants permission to list all contacts	List
ListEngagements	Grants permission to list all engagements	List
ListPageReceipts	Grants permission to list all receipts of a page	List	page*
ListPageResolutions	Grants permission to list the resolution path of an engagement	List	page*
ListPagesByContact	Grants permission to list all pages sent to a contact	List	contact*
ListPagesByEngagement	Grants permission to list all pages created in an engagement	List	engagement*
ListPreviewRotationShifts	Grants permission to retrieve a list of shifts based on rotation configuration parameters	List	rotation*
ListRotationOverrides	Grants permission to retrieve a list of overrides currently specified for an on-call rotation	List	rotation*
ListRotationShifts	Grants permission to retrieve a list of rotation shifts in an on-call schedule	List	rotation*
ListRotations	Grants permission to retrieve a list of on-call rotations	List
ListTagsForResource	Grants permission to view a list of resource tags for a specified resource	Read	contact
ListTagsForResource		Read	rotation
PutContactPolicy	Grants permission to add a resource policy to a contact	Write	contact*
SendActivationCode	Grants permission to send the activation code of a contact's contact channel	Write	contactchannel*
StartEngagement	Grants permission to start an engagement	Write	contact*
StopEngagement	Grants permission to stop an engagement	Write	engagement*
TagResource	Grants permission to add tags to the specified resource	Tagging	contact
			rotation
				aws:TagKeys aws:RequestTag/${TagKey}
UntagResource	Grants permission to remove tags from the specified resource	Tagging	contact
			rotation
				aws:TagKeys
UpdateContact	Grants permission to update a contact	Write	contact*		ssm-contacts:AssociateContact
UpdateContactChannel	Grants permission to update a contact's contact channel	Write	contactchannel*
UpdateRotation	Grants permission to update the information specified for an on-call rotation	Write	rotation*

Resource types defined by AWS Systems Manager Incident Manager Contacts

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
contact	`arn:${Partition}:ssm-contacts:${Region}:${Account}:contact/${ContactAlias}`	aws:ResourceTag/${TagKey}
contactchannel	`arn:${Partition}:ssm-contacts:${Region}:${Account}:contactchannel/${ContactAlias}/${ContactChannelId}`
engagement	`arn:${Partition}:ssm-contacts:${Region}:${Account}:engagement/${ContactAlias}/${EngagementId}`
page	`arn:${Partition}:ssm-contacts:${Region}:${Account}:page/${ContactAlias}/${PageId}`
rotation	`arn:${Partition}:ssm-contacts:${Region}:${Account}:rotation/${RotationId}`	aws:ResourceTag/${TagKey}

Condition keys for AWS Systems Manager Incident Manager Contacts

AWS Systems Manager Incident Manager Contacts 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

AWS Systems Manager Incident Manager

Tag Editor