aws-iam-policy-types/dist/cjs/actions/xray.d.ts

Autogenerated Typescript types for AWS IAM Policy and enums for all policy actions

/**
 * All IAM policy actions for AWS X-Ray (XRAY)
 *
 * Extracted by `aws-iam-policy` from
 * https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsx-ray.html
 *
 * 2025-02-24T21:50:13.522Z
 */
export declare enum AwsXrayActions {
    /**
     * Grants permission to retrieve metadata for a list of traces specified by ID
     *
     * See https://docs.aws.amazon.com/xray/latest/devguide/security_iam_id-based-policy-examples.html#security_iam_id-based-policy-examples-console
     */
    BatchGetTraceSummaryById = "xray:BatchGetTraceSummaryById",
    /**
     * Grants permission to retrieve a list of traces specified by ID. Each trace is a
     * collection of segment documents that originates from a single request. Use GetT
     * raceSummaries to get a list of trace IDs
     *
     * See https://docs.aws.amazon.com/xray/latest/api/API_BatchGetTraces.html
     */
    BatchGetTraces = "xray:BatchGetTraces",
    /**
     * Grants permission to cancel an ongoing trace retrieval job initiated by StartTr
     * aceRetrieval using the provided RetrievalToken. A successful cancellation will
     * return an HTTP 200 response
     *
     * See API_CancelTraceRetrieval.html
     */
    CancelTraceRetrieval = "xray:CancelTraceRetrieval",
    /**
     * Grants permission to create a group resource with a name and a filter expressio
     * n
     *
     * See https://docs.aws.amazon.com/xray/latest/api/API_CreateGroup.html
     */
    CreateGroup = "xray:CreateGroup",
    /**
     * Grants permission to create a rule to control sampling behavior for instrumente
     * d applications
     *
     * See https://docs.aws.amazon.com/xray/latest/api/API_CreateSamplingRule.html
     */
    CreateSamplingRule = "xray:CreateSamplingRule",
    /**
     * Grants permission to delete a group resource
     *
     * See https://docs.aws.amazon.com/xray/latest/api/API_DeleteGroup.html
     */
    DeleteGroup = "xray:DeleteGroup",
    /**
     * Grants permission to delete resource policies
     *
     * See https://docs.aws.amazon.com/xray/latest/api/API_DeleteResourcePolicy.html
     */
    DeleteResourcePolicy = "xray:DeleteResourcePolicy",
    /**
     * Grants permission to delete a sampling rule
     *
     * See https://docs.aws.amazon.com/xray/latest/api/API_DeleteSamplingRule.html
     */
    DeleteSamplingRule = "xray:DeleteSamplingRule",
    /**
     * Grants permission to retrieve distinct service graphs for one or more specific
     * trace IDs
     *
     * See https://docs.aws.amazon.com/xray/latest/devguide/security_iam_id-based-policy-examples.html#security_iam_id-based-policy-examples-console
     */
    GetDistinctTraceGraphs = "xray:GetDistinctTraceGraphs",
    /**
     * Grants permission to retrieve the current encryption configuration for X-Ray da
     * ta
     *
     * See https://docs.aws.amazon.com/xray/latest/api/API_GetEncryptionConfig.html
     */
    GetEncryptionConfig = "xray:GetEncryptionConfig",
    /**
     * Grants permission to retrieve group resource details
     *
     * See https://docs.aws.amazon.com/xray/latest/api/API_GetGroup.html
     */
    GetGroup = "xray:GetGroup",
    /**
     * Grants permission to retrieve all active group details
     *
     * See https://docs.aws.amazon.com/xray/latest/api/API_GetGroups.html
     */
    GetGroups = "xray:GetGroups",
    /**
     * Grants permission to retrieve all indexing rules. Indexing rules are used to de
     * termine the server-side sampling rate for spans ingested through the CloudWatch
     * Logs destination and indexed by X-Ray
     *
     * See https://docs.aws.amazon.com/xray/latest/api/API_GetIndexingRules.html
     */
    GetIndexingRules = "xray:GetIndexingRules",
    /**
     * Grants permission to retrieve the details of a specific insight
     *
     * See https://docs.aws.amazon.com/xray/latest/api/API_GetInsight.html
     */
    GetInsight = "xray:GetInsight",
    /**
     * Grants permission to retrieve the events of a specific insight
     *
     * See https://docs.aws.amazon.com/xray/latest/api/API_GetInsightEvents.html
     */
    GetInsightEvents = "xray:GetInsightEvents",
    /**
     * Grants permission to retrieve the part of the service graph which is impacted f
     * or a specific insight
     *
     * See https://docs.aws.amazon.com/xray/latest/api/API_GetInsightImpactGraph.html
     */
    GetInsightImpactGraph = "xray:GetInsightImpactGraph",
    /**
     * Grants permission to retrieve the summary of all insights for a group and time
     * range with optional filters
     *
     * See https://docs.aws.amazon.com/xray/latest/api/API_GetInsightSummaries.html
     */
    GetInsightSummaries = "xray:GetInsightSummaries",
    /**
     * Grants permission to retrieve a service graph for traces based on the specified
     * RetrievalToken from the Transaction Search CloudWatch log group
     *
     * See API_GetRetrievedTracesGraph.html
     */
    GetRetrievedTracesGraph = "xray:GetRetrievedTracesGraph",
    /**
     * Grants permission to retrieve all sampling rules
     *
     * See https://docs.aws.amazon.com/xray/latest/api/API_GetSamplingRules.html
     */
    GetSamplingRules = "xray:GetSamplingRules",
    /**
     * Grants permission to retrieve information about recent sampling results for all
     * sampling rules
     *
     * See https://docs.aws.amazon.com/xray/latest/api/API_GetSamplingStatisticSummaries.html
     */
    GetSamplingStatisticSummaries = "xray:GetSamplingStatisticSummaries",
    /**
     * Grants permission to request a sampling quota for rules that the service is usi
     * ng to sample requests
     *
     * See https://docs.aws.amazon.com/xray/latest/api/API_GetSamplingTargets.html
     */
    GetSamplingTargets = "xray:GetSamplingTargets",
    /**
     * Grants permission to retrieve a document that describes services that process i
     * ncoming requests, and downstream services that they call as a result
     *
     * See https://docs.aws.amazon.com/xray/latest/api/API_GetServiceGraph.html
     */
    GetServiceGraph = "xray:GetServiceGraph",
    /**
     * Grants permission to retrieve an aggregation of service statistics defined by a
     * specific time range bucketed into time intervals
     *
     * See https://docs.aws.amazon.com/xray/latest/api/API_GetTimeSeriesServiceStatistics.html
     */
    GetTimeSeriesServiceStatistics = "xray:GetTimeSeriesServiceStatistics",
    /**
     * Grants permission to retrieve a service graph for one or more specific trace ID
     * s
     *
     * See https://docs.aws.amazon.com/xray/latest/api/API_GetTraceGraph.html
     */
    GetTraceGraph = "xray:GetTraceGraph",
    /**
     * Grants permission to retrieve the current destination of data sent to PutTraceS
     * egments and OpenTelemetry API
     *
     * See https://docs.aws.amazon.com/xray/latest/api/API_GetTraceSegmentDestination.html
     */
    GetTraceSegmentDestination = "xray:GetTraceSegmentDestination",
    /**
     * Grants permission to retrieve IDs and metadata for traces available for a speci
     * fied time frame using an optional filter. To get the full traces, pass the trac
     * e IDs to BatchGetTraces
     *
     * See https://docs.aws.amazon.com/xray/latest/api/API_GetTraceSummaries.html
     */
    GetTraceSummaries = "xray:GetTraceSummaries",
    /**
     * Grants permission to share X-Ray resources with a monitoring account
     *
     * See https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account-Setup.html#CloudWatch-Unified-Cross-Account-Setup-permissions
     */
    Link = "xray:Link",
    /**
     * Grants permission to list resource policies
     *
     * See https://docs.aws.amazon.com/xray/latest/api/API_ListResourcePolicies.html
     */
    ListResourcePolicies = "xray:ListResourcePolicies",
    /**
     * Grants permission to retrieve a list of traces for a given RetrievalToken from
     * the Transaction Search CloudWatch log group
     *
     * See API_ListRetrievedTraces.html
     */
    ListRetrievedTraces = "xray:ListRetrievedTraces",
    /**
     * Grants permission to list tags for an X-Ray resource
     *
     * See https://docs.aws.amazon.com/xray/latest/api/API_ListTagsForResource.html
     */
    ListTagsForResource = "xray:ListTagsForResource",
    /**
     * Grants permission to update the encryption configuration for X-Ray data
     *
     * See https://docs.aws.amazon.com/xray/latest/api/API_PutEncryptionConfig.html
     */
    PutEncryptionConfig = "xray:PutEncryptionConfig",
    /**
     * Grants permission to create or update resource policies
     *
     * See https://docs.aws.amazon.com/xray/latest/api/API_PutResourcePolicy.html
     */
    PutResourcePolicy = "xray:PutResourcePolicy",
    /**
     * Grants permission to upload OpenTelemetry spans to AWS X-Ray
     *
     * See https://docs.aws.amazon.com/xray/latest/api/API_PutSpans.html
     */
    PutSpans = "xray:PutSpans",
    /**
     * Grants permission to upload spans to AWS X-Ray to be indexed
     *
     * See https://docs.aws.amazon.com/xray/latest/devguide/security_iam_id-based-policy-examples.html#security_iam_id-based-policy-examples-console
     */
    PutSpansForIndexing = "xray:PutSpansForIndexing",
    /**
     * Grants permission to send AWS X-Ray daemon telemetry to the service
     *
     * See https://docs.aws.amazon.com/xray/latest/api/API_PutTelemetryRecords.html
     */
    PutTelemetryRecords = "xray:PutTelemetryRecords",
    /**
     * Grants permission to upload segment documents to AWS X-Ray. The X-Ray SDK gener
     * ates segment documents and sends them to the X-Ray daemon, which uploads them i
     * n batches
     *
     * See https://docs.aws.amazon.com/xray/latest/api/API_PutTraceSegments.html
     */
    PutTraceSegments = "xray:PutTraceSegments",
    /**
     * Grants permission to initiate a trace retrieval process using the specified tim
     * e range and for the given trace IDs on the Transaction Search CloudWatch log gr
     * oup
     *
     * See API_StartTraceRetrieval
     */
    StartTraceRetrieval = "xray:StartTraceRetrieval",
    /**
     * Grants permission to add tags to an X-Ray resource
     *
     * See https://docs.aws.amazon.com/xray/latest/api/API_TagResource.html
     */
    TagResource = "xray:TagResource",
    /**
     * Grants permission to remove tags from an X-Ray resource
     *
     * See https://docs.aws.amazon.com/xray/latest/api/API_UntagResource.html
     */
    UntagResource = "xray:UntagResource",
    /**
     * Grants permission to update a group resource
     *
     * See https://docs.aws.amazon.com/xray/latest/api/API_UpdateGroup.html
     */
    UpdateGroup = "xray:UpdateGroup",
    /**
     * Grants permission to modify an indexing rule's configuration
     *
     * See https://docs.aws.amazon.com/xray/latest/api/API_UpdateIndexingRule.html
     */
    UpdateIndexingRule = "xray:UpdateIndexingRule",
    /**
     * Grants permission to modify a sampling rule's configuration
     *
     * See https://docs.aws.amazon.com/xray/latest/api/API_UpdateSamplingRule.html
     */
    UpdateSamplingRule = "xray:UpdateSamplingRule",
    /**
     * Grants permission to modify the destination of data sent to PutTraceSegments an
     * d OpenTelemetry API
     *
     * See https://docs.aws.amazon.com/xray/latest/api/API_UpdateTraceSegmentDestination.html
     */
    UpdateTraceSegmentDestination = "xray:UpdateTraceSegmentDestination"
}