AWS Identity and Access Management
User Guide

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

Actions, Resources, and Condition Keys for AWS X-Ray

AWS X-Ray (service prefix: xray) provides the following service-specific resources, actions, and condition context keys for use in IAM permission policies.


Actions Defined by AWS X-Ray

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 column indicates whether each action supports resource-level permissions. If there is no value for this column, you must specify all resources ("*") 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. Required resources are indicated in the table with an asterisk (*). If you specify a resource-level permission ARN in a statement using this action, then it must be of this type. Some actions support multiple resource types. If the resource type is optional (not indicated as required), then you can choose to use one but not the other.

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

Actions Description Access Level Resource Types (*required) Condition Keys Dependent Actions
BatchGetTraces Retrieves a list of traces specified by ID. Each trace is a collection of segment documents that originates from a single request. Use GetTraceSummaries to get a list of trace IDs. Read
CreateGroup Creates a group resource with a name and a filter expression. Write


CreateSamplingRule Creates a rule to control sampling behavior for instrumented applications. Write


DeleteGroup Deletes a group resource. Write


DeleteSamplingRule Deletes a sampling rule. Write


GetEncryptionConfig Retrieves the current encryption configuration for X-Ray data. Permissions management
GetGroup Retrieves group resource details. Read


GetGroups Retrieves all active group details. Read
GetSamplingRules Retrieves all sampling rules. Read
GetSamplingStatisticSummaries Retrieves information about recent sampling results for all sampling rules. Read
GetSamplingTargets Requests a sampling quota for rules that the service is using to sample requests. Read
GetServiceGraph Retrieves a document that describes services that process incoming requests, and downstream services that they call as a result. Read
GetTimeSeriesServiceStatistics Get an aggregation of service statistics defined by a specific time range bucketed into time intervals. Read
GetTraceGraph Retrieves a service graph for one or more specific trace IDs. Read
GetTraceSummaries Retrieves IDs and metadata for traces available for a specified time frame using an optional filter. To get the full traces, pass the trace IDs to BatchGetTraces. Read
PutEncryptionConfig Updates the encryption configuration for X-Ray data. Permissions management
PutTelemetryRecords Used by the AWS X-Ray daemon to send telemetry to the service. Write
PutTraceSegments Uploads segment documents to AWS X-Ray. The X-Ray SDK generates segment documents and sends them to the X-Ray daemon, which uploads them in batches. Write
UpdateGroup Updates a group resource. Write


UpdateSamplingRule Modifies a sampling rule's configuration. Write


Resources Defined by AWS X-Ray

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 table. For details about the columns in the following table, see The Resource Types Table.

Resource Types ARN Condition Keys
group arn:${Partition}:xray:${Region}:${Account}:group/${GroupName}/${Id}
sampling-rule arn:${Partition}:xray:${Region}:${Account}:sampling-rule/${SamplingRuleName}

Condition Keys for AWS X-Ray

X-Ray has no service-specific context keys that can be used in the Condition element of policy statements. For the list of the global context keys that are available to all services, see Available Keys for Conditions in the IAM Policy Reference.