BatchGetTraces

$result = $client->batchGetTraces([/* ... */]);
$promise = $client->batchGetTracesAsync([/* ... */]);

You cannot find traces through this API if Transaction Search is enabled since trace is not indexed in X-Ray.

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.

Parameter Syntax

$result = $client->batchGetTraces([
    'NextToken' => '<string>',
    'TraceIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Traces' => [
        [
            'Duration' => <float>,
            'Id' => '<string>',
            'LimitExceeded' => true || false,
            'Segments' => [
                [
                    'Document' => '<string>',
                    'Id' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'UnprocessedTraceIds' => ['<string>', ...],
]

Result Details

Errors

InvalidRequestException:

The request is missing required parameters or has invalid parameters.

ThrottledException:

The request exceeds the maximum number of requests per second.

CancelTraceRetrieval

$result = $client->cancelTraceRetrieval([/* ... */]);
$promise = $client->cancelTraceRetrievalAsync([/* ... */]);

Cancels an ongoing trace retrieval job initiated by StartTraceRetrieval using the provided RetrievalToken. A successful cancellation will return an HTTP 200 response.

Parameter Syntax

$result = $client->cancelTraceRetrieval([
    'RetrievalToken' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

The request is missing required parameters or has invalid parameters.

ThrottledException:

The request exceeds the maximum number of requests per second.

ResourceNotFoundException:

The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is correct.

CreateGroup

$result = $client->createGroup([/* ... */]);
$promise = $client->createGroupAsync([/* ... */]);

Creates a group resource with a name and a filter expression.

Parameter Syntax

$result = $client->createGroup([
    'FilterExpression' => '<string>',
    'GroupName' => '<string>', // REQUIRED
    'InsightsConfiguration' => [
        'InsightsEnabled' => true || false,
        'NotificationsEnabled' => true || false,
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'Group' => [
        'FilterExpression' => '<string>',
        'GroupARN' => '<string>',
        'GroupName' => '<string>',
        'InsightsConfiguration' => [
            'InsightsEnabled' => true || false,
            'NotificationsEnabled' => true || false,
        ],
    ],
]

Result Details

Errors

InvalidRequestException:

The request is missing required parameters or has invalid parameters.

ThrottledException:

The request exceeds the maximum number of requests per second.

CreateSamplingRule

$result = $client->createSamplingRule([/* ... */]);
$promise = $client->createSamplingRuleAsync([/* ... */]);

Creates a rule to control sampling behavior for instrumented applications. Services retrieve rules with GetSamplingRules, and evaluate each rule in ascending order of priority for each request. If a rule matches, the service records a trace, borrowing it from the reservoir size. After 10 seconds, the service reports back to X-Ray with GetSamplingTargets to get updated versions of each in-use rule. The updated rule contains a trace quota that the service can use instead of borrowing from the reservoir.

Parameter Syntax

$result = $client->createSamplingRule([
    'SamplingRule' => [ // REQUIRED
        'Attributes' => ['<string>', ...],
        'FixedRate' => <float>, // REQUIRED
        'HTTPMethod' => '<string>', // REQUIRED
        'Host' => '<string>', // REQUIRED
        'Priority' => <integer>, // REQUIRED
        'ReservoirSize' => <integer>, // REQUIRED
        'ResourceARN' => '<string>', // REQUIRED
        'RuleARN' => '<string>',
        'RuleName' => '<string>',
        'ServiceName' => '<string>', // REQUIRED
        'ServiceType' => '<string>', // REQUIRED
        'URLPath' => '<string>', // REQUIRED
        'Version' => <integer>, // REQUIRED
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'SamplingRuleRecord' => [
        'CreatedAt' => <DateTime>,
        'ModifiedAt' => <DateTime>,
        'SamplingRule' => [
            'Attributes' => ['<string>', ...],
            'FixedRate' => <float>,
            'HTTPMethod' => '<string>',
            'Host' => '<string>',
            'Priority' => <integer>,
            'ReservoirSize' => <integer>,
            'ResourceARN' => '<string>',
            'RuleARN' => '<string>',
            'RuleName' => '<string>',
            'ServiceName' => '<string>',
            'ServiceType' => '<string>',
            'URLPath' => '<string>',
            'Version' => <integer>,
        ],
    ],
]

Result Details

Errors

InvalidRequestException:

The request is missing required parameters or has invalid parameters.

ThrottledException:

The request exceeds the maximum number of requests per second.

RuleLimitExceededException:

You have reached the maximum number of sampling rules.

DeleteGroup

$result = $client->deleteGroup([/* ... */]);
$promise = $client->deleteGroupAsync([/* ... */]);

Deletes a group resource.

Parameter Syntax

$result = $client->deleteGroup([
    'GroupARN' => '<string>',
    'GroupName' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

The request is missing required parameters or has invalid parameters.

ThrottledException:

The request exceeds the maximum number of requests per second.

DeleteResourcePolicy

$result = $client->deleteResourcePolicy([/* ... */]);
$promise = $client->deleteResourcePolicyAsync([/* ... */]);

Deletes a resource policy from the target Amazon Web Services account.

Parameter Syntax

$result = $client->deleteResourcePolicy([
    'PolicyName' => '<string>', // REQUIRED
    'PolicyRevisionId' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

The request is missing required parameters or has invalid parameters.

InvalidPolicyRevisionIdException:

A policy revision id was provided which does not match the latest policy revision. This exception is also if a policy revision id of 0 is provided via PutResourcePolicy and a policy with the same name already exists.

ThrottledException:

The request exceeds the maximum number of requests per second.

DeleteSamplingRule

$result = $client->deleteSamplingRule([/* ... */]);
$promise = $client->deleteSamplingRuleAsync([/* ... */]);

Deletes a sampling rule.

Parameter Syntax

$result = $client->deleteSamplingRule([
    'RuleARN' => '<string>',
    'RuleName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'SamplingRuleRecord' => [
        'CreatedAt' => <DateTime>,
        'ModifiedAt' => <DateTime>,
        'SamplingRule' => [
            'Attributes' => ['<string>', ...],
            'FixedRate' => <float>,
            'HTTPMethod' => '<string>',
            'Host' => '<string>',
            'Priority' => <integer>,
            'ReservoirSize' => <integer>,
            'ResourceARN' => '<string>',
            'RuleARN' => '<string>',
            'RuleName' => '<string>',
            'ServiceName' => '<string>',
            'ServiceType' => '<string>',
            'URLPath' => '<string>',
            'Version' => <integer>,
        ],
    ],
]

Result Details

Errors

InvalidRequestException:

The request is missing required parameters or has invalid parameters.

ThrottledException:

The request exceeds the maximum number of requests per second.

GetEncryptionConfig

$result = $client->getEncryptionConfig([/* ... */]);
$promise = $client->getEncryptionConfigAsync([/* ... */]);

Retrieves the current encryption configuration for X-Ray data.

Parameter Syntax

$result = $client->getEncryptionConfig([
]);

Parameter Details

Result Syntax

[
    'EncryptionConfig' => [
        'KeyId' => '<string>',
        'Status' => 'UPDATING|ACTIVE',
        'Type' => 'NONE|KMS',
    ],
]

Result Details

Errors

InvalidRequestException:

The request is missing required parameters or has invalid parameters.

ThrottledException:

The request exceeds the maximum number of requests per second.

GetGroup

$result = $client->getGroup([/* ... */]);
$promise = $client->getGroupAsync([/* ... */]);

Retrieves group resource details.

Parameter Syntax

$result = $client->getGroup([
    'GroupARN' => '<string>',
    'GroupName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Group' => [
        'FilterExpression' => '<string>',
        'GroupARN' => '<string>',
        'GroupName' => '<string>',
        'InsightsConfiguration' => [
            'InsightsEnabled' => true || false,
            'NotificationsEnabled' => true || false,
        ],
    ],
]

Result Details

Errors

InvalidRequestException:

The request is missing required parameters or has invalid parameters.

ThrottledException:

The request exceeds the maximum number of requests per second.

GetGroups

$result = $client->getGroups([/* ... */]);
$promise = $client->getGroupsAsync([/* ... */]);

Retrieves all active group details.

Parameter Syntax

$result = $client->getGroups([
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Groups' => [
        [
            'FilterExpression' => '<string>',
            'GroupARN' => '<string>',
            'GroupName' => '<string>',
            'InsightsConfiguration' => [
                'InsightsEnabled' => true || false,
                'NotificationsEnabled' => true || false,
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The request is missing required parameters or has invalid parameters.

ThrottledException:

The request exceeds the maximum number of requests per second.

GetIndexingRules

$result = $client->getIndexingRules([/* ... */]);
$promise = $client->getIndexingRulesAsync([/* ... */]);

Retrieves all indexing rules.

Indexing rules are used to determine the server-side sampling rate for spans ingested through the CloudWatchLogs destination and indexed by X-Ray. For more information, see Transaction Search.

Parameter Syntax

$result = $client->getIndexingRules([
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'IndexingRules' => [
        [
            'ModifiedAt' => <DateTime>,
            'Name' => '<string>',
            'Rule' => [
                'Probabilistic' => [
                    'ActualSamplingPercentage' => <float>,
                    'DesiredSamplingPercentage' => <float>,
                ],
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The request is missing required parameters or has invalid parameters.

ThrottledException:

The request exceeds the maximum number of requests per second.

GetInsight

$result = $client->getInsight([/* ... */]);
$promise = $client->getInsightAsync([/* ... */]);

Retrieves the summary information of an insight. This includes impact to clients and root cause services, the top anomalous services, the category, the state of the insight, and the start and end time of the insight.

Parameter Syntax

$result = $client->getInsight([
    'InsightId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Insight' => [
        'Categories' => ['<string>', ...],
        'ClientRequestImpactStatistics' => [
            'FaultCount' => <integer>,
            'OkCount' => <integer>,
            'TotalCount' => <integer>,
        ],
        'EndTime' => <DateTime>,
        'GroupARN' => '<string>',
        'GroupName' => '<string>',
        'InsightId' => '<string>',
        'RootCauseServiceId' => [
            'AccountId' => '<string>',
            'Name' => '<string>',
            'Names' => ['<string>', ...],
            'Type' => '<string>',
        ],
        'RootCauseServiceRequestImpactStatistics' => [
            'FaultCount' => <integer>,
            'OkCount' => <integer>,
            'TotalCount' => <integer>,
        ],
        'StartTime' => <DateTime>,
        'State' => 'ACTIVE|CLOSED',
        'Summary' => '<string>',
        'TopAnomalousServices' => [
            [
                'ServiceId' => [
                    'AccountId' => '<string>',
                    'Name' => '<string>',
                    'Names' => ['<string>', ...],
                    'Type' => '<string>',
                ],
            ],
            // ...
        ],
    ],
]

Result Details

Errors

InvalidRequestException:

The request is missing required parameters or has invalid parameters.

ThrottledException:

The request exceeds the maximum number of requests per second.

GetInsightEvents

$result = $client->getInsightEvents([/* ... */]);
$promise = $client->getInsightEventsAsync([/* ... */]);

X-Ray reevaluates insights periodically until they're resolved, and records each intermediate state as an event. You can review an insight's events in the Impact Timeline on the Inspect page in the X-Ray console.

Parameter Syntax

$result = $client->getInsightEvents([
    'InsightId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'InsightEvents' => [
        [
            'ClientRequestImpactStatistics' => [
                'FaultCount' => <integer>,
                'OkCount' => <integer>,
                'TotalCount' => <integer>,
            ],
            'EventTime' => <DateTime>,
            'RootCauseServiceRequestImpactStatistics' => [
                'FaultCount' => <integer>,
                'OkCount' => <integer>,
                'TotalCount' => <integer>,
            ],
            'Summary' => '<string>',
            'TopAnomalousServices' => [
                [
                    'ServiceId' => [
                        'AccountId' => '<string>',
                        'Name' => '<string>',
                        'Names' => ['<string>', ...],
                        'Type' => '<string>',
                    ],
                ],
                // ...
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The request is missing required parameters or has invalid parameters.

ThrottledException:

The request exceeds the maximum number of requests per second.

GetInsightImpactGraph

$result = $client->getInsightImpactGraph([/* ... */]);
$promise = $client->getInsightImpactGraphAsync([/* ... */]);

Retrieves a service graph structure filtered by the specified insight. The service graph is limited to only structural information. For a complete service graph, use this API with the GetServiceGraph API.

Parameter Syntax

$result = $client->getInsightImpactGraph([
    'EndTime' => <integer || string || DateTime>, // REQUIRED
    'InsightId' => '<string>', // REQUIRED
    'NextToken' => '<string>',
    'StartTime' => <integer || string || DateTime>, // REQUIRED
]);

Parameter Details

Result Syntax

[
    'EndTime' => <DateTime>,
    'InsightId' => '<string>',
    'NextToken' => '<string>',
    'ServiceGraphEndTime' => <DateTime>,
    'ServiceGraphStartTime' => <DateTime>,
    'Services' => [
        [
            'AccountId' => '<string>',
            'Edges' => [
                [
                    'ReferenceId' => <integer>,
                ],
                // ...
            ],
            'Name' => '<string>',
            'Names' => ['<string>', ...],
            'ReferenceId' => <integer>,
            'Type' => '<string>',
        ],
        // ...
    ],
    'StartTime' => <DateTime>,
]

Result Details

Errors

InvalidRequestException:

The request is missing required parameters or has invalid parameters.

ThrottledException:

The request exceeds the maximum number of requests per second.

GetInsightSummaries

$result = $client->getInsightSummaries([/* ... */]);
$promise = $client->getInsightSummariesAsync([/* ... */]);

Retrieves the summaries of all insights in the specified group matching the provided filter values.

Parameter Syntax

$result = $client->getInsightSummaries([
    'EndTime' => <integer || string || DateTime>, // REQUIRED
    'GroupARN' => '<string>',
    'GroupName' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'StartTime' => <integer || string || DateTime>, // REQUIRED
    'States' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'InsightSummaries' => [
        [
            'Categories' => ['<string>', ...],
            'ClientRequestImpactStatistics' => [
                'FaultCount' => <integer>,
                'OkCount' => <integer>,
                'TotalCount' => <integer>,
            ],
            'EndTime' => <DateTime>,
            'GroupARN' => '<string>',
            'GroupName' => '<string>',
            'InsightId' => '<string>',
            'LastUpdateTime' => <DateTime>,
            'RootCauseServiceId' => [
                'AccountId' => '<string>',
                'Name' => '<string>',
                'Names' => ['<string>', ...],
                'Type' => '<string>',
            ],
            'RootCauseServiceRequestImpactStatistics' => [
                'FaultCount' => <integer>,
                'OkCount' => <integer>,
                'TotalCount' => <integer>,
            ],
            'StartTime' => <DateTime>,
            'State' => 'ACTIVE|CLOSED',
            'Summary' => '<string>',
            'TopAnomalousServices' => [
                [
                    'ServiceId' => [
                        'AccountId' => '<string>',
                        'Name' => '<string>',
                        'Names' => ['<string>', ...],
                        'Type' => '<string>',
                    ],
                ],
                // ...
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The request is missing required parameters or has invalid parameters.

ThrottledException:

The request exceeds the maximum number of requests per second.

GetRetrievedTracesGraph

$result = $client->getRetrievedTracesGraph([/* ... */]);
$promise = $client->getRetrievedTracesGraphAsync([/* ... */]);

Retrieves a service graph for traces based on the specified RetrievalToken from the CloudWatch log group generated by Transaction Search. This API does not initiate a retrieval job. You must first execute StartTraceRetrieval to obtain the required RetrievalToken.

The trace graph describes services that process incoming requests and any downstream services they call, which may include Amazon Web Services resources, external APIs, or databases.

The response is empty until the RetrievalStatus is COMPLETE. Retry the request after the status changes from RUNNING or SCHEDULED to COMPLETE to access the full service graph.

When CloudWatch log is the destination, this API can support cross-account observability and service graph retrieval across linked accounts.

For retrieving graphs from X-Ray directly as opposed to the Transaction-Search Log group, see GetTraceGraph.

Parameter Syntax

$result = $client->getRetrievedTracesGraph([
    'NextToken' => '<string>',
    'RetrievalToken' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'RetrievalStatus' => 'SCHEDULED|RUNNING|COMPLETE|FAILED|CANCELLED|TIMEOUT',
    'Services' => [
        [
            'Links' => [
                [
                    'DestinationTraceIds' => ['<string>', ...],
                    'ReferenceType' => '<string>',
                    'SourceTraceId' => '<string>',
                ],
                // ...
            ],
            'Service' => [
                'AccountId' => '<string>',
                'DurationHistogram' => [
                    [
                        'Count' => <integer>,
                        'Value' => <float>,
                    ],
                    // ...
                ],
                'Edges' => [
                    [
                        'Aliases' => [
                            [
                                'Name' => '<string>',
                                'Names' => ['<string>', ...],
                                'Type' => '<string>',
                            ],
                            // ...
                        ],
                        'EdgeType' => '<string>',
                        'EndTime' => <DateTime>,
                        'ReceivedEventAgeHistogram' => [
                            [
                                'Count' => <integer>,
                                'Value' => <float>,
                            ],
                            // ...
                        ],
                        'ReferenceId' => <integer>,
                        'ResponseTimeHistogram' => [
                            [
                                'Count' => <integer>,
                                'Value' => <float>,
                            ],
                            // ...
                        ],
                        'StartTime' => <DateTime>,
                        'SummaryStatistics' => [
                            'ErrorStatistics' => [
                                'OtherCount' => <integer>,
                                'ThrottleCount' => <integer>,
                                'TotalCount' => <integer>,
                            ],
                            'FaultStatistics' => [
                                'OtherCount' => <integer>,
                                'TotalCount' => <integer>,
                            ],
                            'OkCount' => <integer>,
                            'TotalCount' => <integer>,
                            'TotalResponseTime' => <float>,
                        ],
                    ],
                    // ...
                ],
                'EndTime' => <DateTime>,
                'Name' => '<string>',
                'Names' => ['<string>', ...],
                'ReferenceId' => <integer>,
                'ResponseTimeHistogram' => [
                    [
                        'Count' => <integer>,
                        'Value' => <float>,
                    ],
                    // ...
                ],
                'Root' => true || false,
                'StartTime' => <DateTime>,
                'State' => '<string>',
                'SummaryStatistics' => [
                    'ErrorStatistics' => [
                        'OtherCount' => <integer>,
                        'ThrottleCount' => <integer>,
                        'TotalCount' => <integer>,
                    ],
                    'FaultStatistics' => [
                        'OtherCount' => <integer>,
                        'TotalCount' => <integer>,
                    ],
                    'OkCount' => <integer>,
                    'TotalCount' => <integer>,
                    'TotalResponseTime' => <float>,
                ],
                'Type' => '<string>',
            ],
        ],
        // ...
    ],
]

Result Details

Errors

InvalidRequestException:

The request is missing required parameters or has invalid parameters.

ThrottledException:

The request exceeds the maximum number of requests per second.

ResourceNotFoundException:

The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is correct.

GetSamplingRules

$result = $client->getSamplingRules([/* ... */]);
$promise = $client->getSamplingRulesAsync([/* ... */]);

Retrieves all sampling rules.

Parameter Syntax

$result = $client->getSamplingRules([
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'SamplingRuleRecords' => [
        [
            'CreatedAt' => <DateTime>,
            'ModifiedAt' => <DateTime>,
            'SamplingRule' => [
                'Attributes' => ['<string>', ...],
                'FixedRate' => <float>,
                'HTTPMethod' => '<string>',
                'Host' => '<string>',
                'Priority' => <integer>,
                'ReservoirSize' => <integer>,
                'ResourceARN' => '<string>',
                'RuleARN' => '<string>',
                'RuleName' => '<string>',
                'ServiceName' => '<string>',
                'ServiceType' => '<string>',
                'URLPath' => '<string>',
                'Version' => <integer>,
            ],
        ],
        // ...
    ],
]

Result Details

Errors

InvalidRequestException:

The request is missing required parameters or has invalid parameters.

ThrottledException:

The request exceeds the maximum number of requests per second.

GetSamplingStatisticSummaries

$result = $client->getSamplingStatisticSummaries([/* ... */]);
$promise = $client->getSamplingStatisticSummariesAsync([/* ... */]);

Retrieves information about recent sampling results for all sampling rules.

Parameter Syntax

$result = $client->getSamplingStatisticSummaries([
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'SamplingStatisticSummaries' => [
        [
            'BorrowCount' => <integer>,
            'RequestCount' => <integer>,
            'RuleName' => '<string>',
            'SampledCount' => <integer>,
            'Timestamp' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

InvalidRequestException:

The request is missing required parameters or has invalid parameters.

ThrottledException:

The request exceeds the maximum number of requests per second.

GetSamplingTargets

$result = $client->getSamplingTargets([/* ... */]);
$promise = $client->getSamplingTargetsAsync([/* ... */]);

Requests a sampling quota for rules that the service is using to sample requests.

Parameter Syntax

$result = $client->getSamplingTargets([
    'SamplingStatisticsDocuments' => [ // REQUIRED
        [
            'BorrowCount' => <integer>,
            'ClientID' => '<string>', // REQUIRED
            'RequestCount' => <integer>, // REQUIRED
            'RuleName' => '<string>', // REQUIRED
            'SampledCount' => <integer>, // REQUIRED
            'Timestamp' => <integer || string || DateTime>, // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'LastRuleModification' => <DateTime>,
    'SamplingTargetDocuments' => [
        [
            'FixedRate' => <float>,
            'Interval' => <integer>,
            'ReservoirQuota' => <integer>,
            'ReservoirQuotaTTL' => <DateTime>,
            'RuleName' => '<string>',
        ],
        // ...
    ],
    'UnprocessedStatistics' => [
        [
            'ErrorCode' => '<string>',
            'Message' => '<string>',
            'RuleName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidRequestException:

The request is missing required parameters or has invalid parameters.

ThrottledException:

The request exceeds the maximum number of requests per second.

GetServiceGraph

$result = $client->getServiceGraph([/* ... */]);
$promise = $client->getServiceGraphAsync([/* ... */]);

Retrieves a document that describes services that process incoming requests, and downstream services that they call as a result. Root services process incoming requests and make calls to downstream services. Root services are applications that use the Amazon Web Services X-Ray SDK. Downstream services can be other applications, Amazon Web Services resources, HTTP web APIs, or SQL databases.

Parameter Syntax

$result = $client->getServiceGraph([
    'EndTime' => <integer || string || DateTime>, // REQUIRED
    'GroupARN' => '<string>',
    'GroupName' => '<string>',
    'NextToken' => '<string>',
    'StartTime' => <integer || string || DateTime>, // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ContainsOldGroupVersions' => true || false,
    'EndTime' => <DateTime>,
    'NextToken' => '<string>',
    'Services' => [
        [
            'AccountId' => '<string>',
            'DurationHistogram' => [
                [
                    'Count' => <integer>,
                    'Value' => <float>,
                ],
                // ...
            ],
            'Edges' => [
                [
                    'Aliases' => [
                        [
                            'Name' => '<string>',
                            'Names' => ['<string>', ...],
                            'Type' => '<string>',
                        ],
                        // ...
                    ],
                    'EdgeType' => '<string>',
                    'EndTime' => <DateTime>,
                    'ReceivedEventAgeHistogram' => [
                        [
                            'Count' => <integer>,
                            'Value' => <float>,
                        ],
                        // ...
                    ],
                    'ReferenceId' => <integer>,
                    'ResponseTimeHistogram' => [
                        [
                            'Count' => <integer>,
                            'Value' => <float>,
                        ],
                        // ...
                    ],
                    'StartTime' => <DateTime>,
                    'SummaryStatistics' => [
                        'ErrorStatistics' => [
                            'OtherCount' => <integer>,
                            'ThrottleCount' => <integer>,
                            'TotalCount' => <integer>,
                        ],
                        'FaultStatistics' => [
                            'OtherCount' => <integer>,
                            'TotalCount' => <integer>,
                        ],
                        'OkCount' => <integer>,
                        'TotalCount' => <integer>,
                        'TotalResponseTime' => <float>,
                    ],
                ],
                // ...
            ],
            'EndTime' => <DateTime>,
            'Name' => '<string>',
            'Names' => ['<string>', ...],
            'ReferenceId' => <integer>,
            'ResponseTimeHistogram' => [
                [
                    'Count' => <integer>,
                    'Value' => <float>,
                ],
                // ...
            ],
            'Root' => true || false,
            'StartTime' => <DateTime>,
            'State' => '<string>',
            'SummaryStatistics' => [
                'ErrorStatistics' => [
                    'OtherCount' => <integer>,
                    'ThrottleCount' => <integer>,
                    'TotalCount' => <integer>,
                ],
                'FaultStatistics' => [
                    'OtherCount' => <integer>,
                    'TotalCount' => <integer>,
                ],
                'OkCount' => <integer>,
                'TotalCount' => <integer>,
                'TotalResponseTime' => <float>,
            ],
            'Type' => '<string>',
        ],
        // ...
    ],
    'StartTime' => <DateTime>,
]

Result Details

Errors

InvalidRequestException:

The request is missing required parameters or has invalid parameters.

ThrottledException:

The request exceeds the maximum number of requests per second.

GetTimeSeriesServiceStatistics

$result = $client->getTimeSeriesServiceStatistics([/* ... */]);
$promise = $client->getTimeSeriesServiceStatisticsAsync([/* ... */]);

Get an aggregation of service statistics defined by a specific time range.

Parameter Syntax

$result = $client->getTimeSeriesServiceStatistics([
    'EndTime' => <integer || string || DateTime>, // REQUIRED
    'EntitySelectorExpression' => '<string>',
    'ForecastStatistics' => true || false,
    'GroupARN' => '<string>',
    'GroupName' => '<string>',
    'NextToken' => '<string>',
    'Period' => <integer>,
    'StartTime' => <integer || string || DateTime>, // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ContainsOldGroupVersions' => true || false,
    'NextToken' => '<string>',
    'TimeSeriesServiceStatistics' => [
        [
            'EdgeSummaryStatistics' => [
                'ErrorStatistics' => [
                    'OtherCount' => <integer>,
                    'ThrottleCount' => <integer>,
                    'TotalCount' => <integer>,
                ],
                'FaultStatistics' => [
                    'OtherCount' => <integer>,
                    'TotalCount' => <integer>,
                ],
                'OkCount' => <integer>,
                'TotalCount' => <integer>,
                'TotalResponseTime' => <float>,
            ],
            'ResponseTimeHistogram' => [
                [
                    'Count' => <integer>,
                    'Value' => <float>,
                ],
                // ...
            ],
            'ServiceForecastStatistics' => [
                'FaultCountHigh' => <integer>,
                'FaultCountLow' => <integer>,
            ],
            'ServiceSummaryStatistics' => [
                'ErrorStatistics' => [
                    'OtherCount' => <integer>,
                    'ThrottleCount' => <integer>,
                    'TotalCount' => <integer>,
                ],
                'FaultStatistics' => [
                    'OtherCount' => <integer>,
                    'TotalCount' => <integer>,
                ],
                'OkCount' => <integer>,
                'TotalCount' => <integer>,
                'TotalResponseTime' => <float>,
            ],
            'Timestamp' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

InvalidRequestException:

The request is missing required parameters or has invalid parameters.

ThrottledException:

The request exceeds the maximum number of requests per second.

GetTraceGraph

$result = $client->getTraceGraph([/* ... */]);
$promise = $client->getTraceGraphAsync([/* ... */]);

Retrieves a service graph for one or more specific trace IDs.

Parameter Syntax

$result = $client->getTraceGraph([
    'NextToken' => '<string>',
    'TraceIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Services' => [
        [
            'AccountId' => '<string>',
            'DurationHistogram' => [
                [
                    'Count' => <integer>,
                    'Value' => <float>,
                ],
                // ...
            ],
            'Edges' => [
                [
                    'Aliases' => [
                        [
                            'Name' => '<string>',
                            'Names' => ['<string>', ...],
                            'Type' => '<string>',
                        ],
                        // ...
                    ],
                    'EdgeType' => '<string>',
                    'EndTime' => <DateTime>,
                    'ReceivedEventAgeHistogram' => [
                        [
                            'Count' => <integer>,
                            'Value' => <float>,
                        ],
                        // ...
                    ],
                    'ReferenceId' => <integer>,
                    'ResponseTimeHistogram' => [
                        [
                            'Count' => <integer>,
                            'Value' => <float>,
                        ],
                        // ...
                    ],
                    'StartTime' => <DateTime>,
                    'SummaryStatistics' => [
                        'ErrorStatistics' => [
                            'OtherCount' => <integer>,
                            'ThrottleCount' => <integer>,
                            'TotalCount' => <integer>,
                        ],
                        'FaultStatistics' => [
                            'OtherCount' => <integer>,
                            'TotalCount' => <integer>,
                        ],
                        'OkCount' => <integer>,
                        'TotalCount' => <integer>,
                        'TotalResponseTime' => <float>,
                    ],
                ],
                // ...
            ],
            'EndTime' => <DateTime>,
            'Name' => '<string>',
            'Names' => ['<string>', ...],
            'ReferenceId' => <integer>,
            'ResponseTimeHistogram' => [
                [
                    'Count' => <integer>,
                    'Value' => <float>,
                ],
                // ...
            ],
            'Root' => true || false,
            'StartTime' => <DateTime>,
            'State' => '<string>',
            'SummaryStatistics' => [
                'ErrorStatistics' => [
                    'OtherCount' => <integer>,
                    'ThrottleCount' => <integer>,
                    'TotalCount' => <integer>,
                ],
                'FaultStatistics' => [
                    'OtherCount' => <integer>,
                    'TotalCount' => <integer>,
                ],
                'OkCount' => <integer>,
                'TotalCount' => <integer>,
                'TotalResponseTime' => <float>,
            ],
            'Type' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidRequestException:

The request is missing required parameters or has invalid parameters.

ThrottledException:

The request exceeds the maximum number of requests per second.

GetTraceSegmentDestination

$result = $client->getTraceSegmentDestination([/* ... */]);
$promise = $client->getTraceSegmentDestinationAsync([/* ... */]);

Retrieves the current destination of data sent to PutTraceSegments and OpenTelemetry API. The Transaction Search feature requires a CloudWatchLogs destination. For more information, see Transaction Search and OpenTelemetry.

Parameter Syntax

$result = $client->getTraceSegmentDestination([
]);

Parameter Details

Result Syntax

[
    'Destination' => 'XRay|CloudWatchLogs',
    'Status' => 'PENDING|ACTIVE',
]

Result Details

Errors

InvalidRequestException:

The request is missing required parameters or has invalid parameters.

ThrottledException:

The request exceeds the maximum number of requests per second.

GetTraceSummaries

$result = $client->getTraceSummaries([/* ... */]);
$promise = $client->getTraceSummariesAsync([/* ... */]);

Retrieves IDs and annotations for traces available for a specified time frame using an optional filter. To get the full traces, pass the trace IDs to BatchGetTraces.

A filter expression can target traced requests that hit specific service nodes or edges, have errors, or come from a known user. For example, the following filter expression targets traces that pass through api.example.com:

service("api.example.com")

This filter expression finds traces that have an annotation named account with the value 12345:

annotation.account = "12345"

For a full list of indexed fields and keywords that you can use in filter expressions, see Use filter expressions in the Amazon Web Services X-Ray Developer Guide.

Parameter Syntax

$result = $client->getTraceSummaries([
    'EndTime' => <integer || string || DateTime>, // REQUIRED
    'FilterExpression' => '<string>',
    'NextToken' => '<string>',
    'Sampling' => true || false,
    'SamplingStrategy' => [
        'Name' => 'PartialScan|FixedRate',
        'Value' => <float>,
    ],
    'StartTime' => <integer || string || DateTime>, // REQUIRED
    'TimeRangeType' => 'TraceId|Event|Service',
]);

Parameter Details

Result Syntax

[
    'ApproximateTime' => <DateTime>,
    'NextToken' => '<string>',
    'TraceSummaries' => [
        [
            'Annotations' => [
                '<AnnotationKey>' => [
                    [
                        'AnnotationValue' => [
                            'BooleanValue' => true || false,
                            'NumberValue' => <float>,
                            'StringValue' => '<string>',
                        ],
                        'ServiceIds' => [
                            [
                                'AccountId' => '<string>',
                                'Name' => '<string>',
                                'Names' => ['<string>', ...],
                                'Type' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
                // ...
            ],
            'AvailabilityZones' => [
                [
                    'Name' => '<string>',
                ],
                // ...
            ],
            'Duration' => <float>,
            'EntryPoint' => [
                'AccountId' => '<string>',
                'Name' => '<string>',
                'Names' => ['<string>', ...],
                'Type' => '<string>',
            ],
            'ErrorRootCauses' => [
                [
                    'ClientImpacting' => true || false,
                    'Services' => [
                        [
                            'AccountId' => '<string>',
                            'EntityPath' => [
                                [
                                    'Exceptions' => [
                                        [
                                            'Message' => '<string>',
                                            'Name' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'Name' => '<string>',
                                    'Remote' => true || false,
                                ],
                                // ...
                            ],
                            'Inferred' => true || false,
                            'Name' => '<string>',
                            'Names' => ['<string>', ...],
                            'Type' => '<string>',
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
            'FaultRootCauses' => [
                [
                    'ClientImpacting' => true || false,
                    'Services' => [
                        [
                            'AccountId' => '<string>',
                            'EntityPath' => [
                                [
                                    'Exceptions' => [
                                        [
                                            'Message' => '<string>',
                                            'Name' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'Name' => '<string>',
                                    'Remote' => true || false,
                                ],
                                // ...
                            ],
                            'Inferred' => true || false,
                            'Name' => '<string>',
                            'Names' => ['<string>', ...],
                            'Type' => '<string>',
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
            'HasError' => true || false,
            'HasFault' => true || false,
            'HasThrottle' => true || false,
            'Http' => [
                'ClientIp' => '<string>',
                'HttpMethod' => '<string>',
                'HttpStatus' => <integer>,
                'HttpURL' => '<string>',
                'UserAgent' => '<string>',
            ],
            'Id' => '<string>',
            'InstanceIds' => [
                [
                    'Id' => '<string>',
                ],
                // ...
            ],
            'IsPartial' => true || false,
            'MatchedEventTime' => <DateTime>,
            'ResourceARNs' => [
                [
                    'ARN' => '<string>',
                ],
                // ...
            ],
            'ResponseTime' => <float>,
            'ResponseTimeRootCauses' => [
                [
                    'ClientImpacting' => true || false,
                    'Services' => [
                        [
                            'AccountId' => '<string>',
                            'EntityPath' => [
                                [
                                    'Coverage' => <float>,
                                    'Name' => '<string>',
                                    'Remote' => true || false,
                                ],
                                // ...
                            ],
                            'Inferred' => true || false,
                            'Name' => '<string>',
                            'Names' => ['<string>', ...],
                            'Type' => '<string>',
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
            'Revision' => <integer>,
            'ServiceIds' => [
                [
                    'AccountId' => '<string>',
                    'Name' => '<string>',
                    'Names' => ['<string>', ...],
                    'Type' => '<string>',
                ],
                // ...
            ],
            'StartTime' => <DateTime>,
            'Users' => [
                [
                    'ServiceIds' => [
                        [
                            'AccountId' => '<string>',
                            'Name' => '<string>',
                            'Names' => ['<string>', ...],
                            'Type' => '<string>',
                        ],
                        // ...
                    ],
                    'UserName' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'TracesProcessedCount' => <integer>,
]

Result Details

Errors

InvalidRequestException:

The request is missing required parameters or has invalid parameters.

ThrottledException:

The request exceeds the maximum number of requests per second.

ListResourcePolicies

$result = $client->listResourcePolicies([/* ... */]);
$promise = $client->listResourcePoliciesAsync([/* ... */]);

Returns the list of resource policies in the target Amazon Web Services account.

Parameter Syntax

$result = $client->listResourcePolicies([
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'ResourcePolicies' => [
        [
            'LastUpdatedTime' => <DateTime>,
            'PolicyDocument' => '<string>',
            'PolicyName' => '<string>',
            'PolicyRevisionId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidRequestException:

The request is missing required parameters or has invalid parameters.

ThrottledException:

The request exceeds the maximum number of requests per second.

ListRetrievedTraces

$result = $client->listRetrievedTraces([/* ... */]);
$promise = $client->listRetrievedTracesAsync([/* ... */]);

Retrieves a list of traces for a given RetrievalToken from the CloudWatch log group generated by Transaction Search. For information on what each trace returns, see BatchGetTraces.

This API does not initiate a retrieval job. To start a trace retrieval, use StartTraceRetrieval, which generates the required RetrievalToken.

When the RetrievalStatus is not COMPLETE, the API will return an empty response. Retry the request once the retrieval has completed to access the full list of traces.

For cross-account observability, this API can retrieve traces from linked accounts when CloudWatch log is the destination across relevant accounts. For more details, see CloudWatch cross-account observability.

For retrieving data from X-Ray directly as opposed to the Transaction-Search Log group, see BatchGetTraces.

Parameter Syntax

$result = $client->listRetrievedTraces([
    'NextToken' => '<string>',
    'RetrievalToken' => '<string>', // REQUIRED
    'TraceFormat' => 'XRAY|OTEL',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'RetrievalStatus' => 'SCHEDULED|RUNNING|COMPLETE|FAILED|CANCELLED|TIMEOUT',
    'TraceFormat' => 'XRAY|OTEL',
    'Traces' => [
        [
            'Duration' => <float>,
            'Id' => '<string>',
            'Spans' => [
                [
                    'Document' => '<string>',
                    'Id' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Errors

InvalidRequestException:

The request is missing required parameters or has invalid parameters.

ThrottledException:

The request exceeds the maximum number of requests per second.

ResourceNotFoundException:

The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is correct.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Returns a list of tags that are applied to the specified Amazon Web Services X-Ray group or sampling rule.

Parameter Syntax

$result = $client->listTagsForResource([
    'NextToken' => '<string>',
    'ResourceARN' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidRequestException:

The request is missing required parameters or has invalid parameters.

ThrottledException:

The request exceeds the maximum number of requests per second.

ResourceNotFoundException:

The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is correct.

PutEncryptionConfig

$result = $client->putEncryptionConfig([/* ... */]);
$promise = $client->putEncryptionConfigAsync([/* ... */]);

Updates the encryption configuration for X-Ray data.

Parameter Syntax

$result = $client->putEncryptionConfig([
    'KeyId' => '<string>',
    'Type' => 'NONE|KMS', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'EncryptionConfig' => [
        'KeyId' => '<string>',
        'Status' => 'UPDATING|ACTIVE',
        'Type' => 'NONE|KMS',
    ],
]

Result Details

Errors

InvalidRequestException:

The request is missing required parameters or has invalid parameters.

ThrottledException:

The request exceeds the maximum number of requests per second.

PutResourcePolicy

$result = $client->putResourcePolicy([/* ... */]);
$promise = $client->putResourcePolicyAsync([/* ... */]);

Sets the resource policy to grant one or more Amazon Web Services services and accounts permissions to access X-Ray. Each resource policy will be associated with a specific Amazon Web Services account. Each Amazon Web Services account can have a maximum of 5 resource policies, and each policy name must be unique within that account. The maximum size of each resource policy is 5KB.

Parameter Syntax

$result = $client->putResourcePolicy([
    'BypassPolicyLockoutCheck' => true || false,
    'PolicyDocument' => '<string>', // REQUIRED
    'PolicyName' => '<string>', // REQUIRED
    'PolicyRevisionId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'ResourcePolicy' => [
        'LastUpdatedTime' => <DateTime>,
        'PolicyDocument' => '<string>',
        'PolicyName' => '<string>',
        'PolicyRevisionId' => '<string>',
    ],
]

Result Details

Errors

MalformedPolicyDocumentException:

Invalid policy document provided in request.

LockoutPreventionException:

The provided resource policy would prevent the caller of this request from calling PutResourcePolicy in the future.

InvalidPolicyRevisionIdException:

A policy revision id was provided which does not match the latest policy revision. This exception is also if a policy revision id of 0 is provided via PutResourcePolicy and a policy with the same name already exists.

PolicySizeLimitExceededException:

Exceeded the maximum size for a resource policy.

PolicyCountLimitExceededException:

Exceeded the maximum number of resource policies for a target Amazon Web Services account.

ThrottledException:

The request exceeds the maximum number of requests per second.

PutTelemetryRecords

$result = $client->putTelemetryRecords([/* ... */]);
$promise = $client->putTelemetryRecordsAsync([/* ... */]);

Used by the Amazon Web Services X-Ray daemon to upload telemetry.

Parameter Syntax

$result = $client->putTelemetryRecords([
    'EC2InstanceId' => '<string>',
    'Hostname' => '<string>',
    'ResourceARN' => '<string>',
    'TelemetryRecords' => [ // REQUIRED
        [
            'BackendConnectionErrors' => [
                'ConnectionRefusedCount' => <integer>,
                'HTTPCode4XXCount' => <integer>,
                'HTTPCode5XXCount' => <integer>,
                'OtherCount' => <integer>,
                'TimeoutCount' => <integer>,
                'UnknownHostCount' => <integer>,
            ],
            'SegmentsReceivedCount' => <integer>,
            'SegmentsRejectedCount' => <integer>,
            'SegmentsSentCount' => <integer>,
            'SegmentsSpilloverCount' => <integer>,
            'Timestamp' => <integer || string || DateTime>, // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

The request is missing required parameters or has invalid parameters.

ThrottledException:

The request exceeds the maximum number of requests per second.

PutTraceSegments

$result = $client->putTraceSegments([/* ... */]);
$promise = $client->putTraceSegmentsAsync([/* ... */]);

Uploads segment documents to Amazon Web Services X-Ray. A segment document can be a completed segment, an in-progress segment, or an array of subsegments.

Segments must include the following fields. For the full segment document schema, see Amazon Web Services X-Ray Segment Documents in the Amazon Web Services X-Ray Developer Guide.

Required segment document fields

• name - The name of the service that handled the request.

• id - A 64-bit identifier for the segment, unique among segments in the same trace, in 16 hexadecimal digits.

• trace_id - A unique identifier that connects all segments and subsegments originating from a single client request.

• start_time - Time the segment or subsegment was created, in floating point seconds in epoch time, accurate to milliseconds. For example, 1480615200.010 or 1.480615200010E9.

• end_time - Time the segment or subsegment was closed. For example, 1480615200.090 or 1.480615200090E9. Specify either an end_time or in_progress.

• in_progress - Set to true instead of specifying an end_time to record that a segment has been started, but is not complete. Send an in-progress segment when your application receives a request that will take a long time to serve, to trace that the request was received. When the response is sent, send the complete segment to overwrite the in-progress segment.

A trace_id consists of three numbers separated by hyphens. For example, 1-58406520-a006649127e371903a2de979. For trace IDs created by an X-Ray SDK, or by Amazon Web Services services integrated with X-Ray, a trace ID includes:

Trace ID Format

• The version number, for instance, 1.

• The time of the original request, in Unix epoch time, in 8 hexadecimal digits. For example, 10:00AM December 2nd, 2016 PST in epoch time is 1480615200 seconds, or 58406520 in hexadecimal.

• A 96-bit identifier for the trace, globally unique, in 24 hexadecimal digits.

Parameter Syntax

$result = $client->putTraceSegments([
    'TraceSegmentDocuments' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'UnprocessedTraceSegments' => [
        [
            'ErrorCode' => '<string>',
            'Id' => '<string>',
            'Message' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidRequestException:

The request is missing required parameters or has invalid parameters.

ThrottledException:

The request exceeds the maximum number of requests per second.

StartTraceRetrieval

$result = $client->startTraceRetrieval([/* ... */]);
$promise = $client->startTraceRetrievalAsync([/* ... */]);

Initiates a trace retrieval process using the specified time range and for the give trace IDs on Transaction Search generated by the CloudWatch log group. For more information, see Transaction Search.

API returns a RetrievalToken, which can be used with ListRetrievedTraces or GetRetrievedTracesGraph to fetch results. Retrievals will time out after 60 minutes. To execute long time ranges, consider segmenting into multiple retrievals.

If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account to retrieve data from a linked source account, as long as both accounts have transaction search enabled.

For retrieving data from X-Ray directly as opposed to the Transaction-Search Log group, see BatchGetTraces.

Parameter Syntax

$result = $client->startTraceRetrieval([
    'EndTime' => <integer || string || DateTime>, // REQUIRED
    'StartTime' => <integer || string || DateTime>, // REQUIRED
    'TraceIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'RetrievalToken' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The request is missing required parameters or has invalid parameters.

ThrottledException:

The request exceeds the maximum number of requests per second.

ResourceNotFoundException:

The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is correct.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Applies tags to an existing Amazon Web Services X-Ray group or sampling rule.

Parameter Syntax

$result = $client->tagResource([
    'ResourceARN' => '<string>', // REQUIRED
    'Tags' => [ // REQUIRED
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

The request is missing required parameters or has invalid parameters.

ThrottledException:

The request exceeds the maximum number of requests per second.

ResourceNotFoundException:

The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is correct.

TooManyTagsException:

You have exceeded the maximum number of tags you can apply to this resource.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes tags from an Amazon Web Services X-Ray group or sampling rule. You cannot edit or delete system tags (those with an aws: prefix).

Parameter Syntax

$result = $client->untagResource([
    'ResourceARN' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

The request is missing required parameters or has invalid parameters.

ThrottledException:

The request exceeds the maximum number of requests per second.

ResourceNotFoundException:

The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is correct.

UpdateGroup

$result = $client->updateGroup([/* ... */]);
$promise = $client->updateGroupAsync([/* ... */]);

Updates a group resource.

Parameter Syntax

$result = $client->updateGroup([
    'FilterExpression' => '<string>',
    'GroupARN' => '<string>',
    'GroupName' => '<string>',
    'InsightsConfiguration' => [
        'InsightsEnabled' => true || false,
        'NotificationsEnabled' => true || false,
    ],
]);

Parameter Details

Result Syntax

[
    'Group' => [
        'FilterExpression' => '<string>',
        'GroupARN' => '<string>',
        'GroupName' => '<string>',
        'InsightsConfiguration' => [
            'InsightsEnabled' => true || false,
            'NotificationsEnabled' => true || false,
        ],
    ],
]

Result Details

Errors

InvalidRequestException:

The request is missing required parameters or has invalid parameters.

ThrottledException:

The request exceeds the maximum number of requests per second.

UpdateIndexingRule

$result = $client->updateIndexingRule([/* ... */]);
$promise = $client->updateIndexingRuleAsync([/* ... */]);

Modifies an indexing rule’s configuration.

Indexing rules are used for determining the sampling rate for spans indexed from CloudWatch Logs. For more information, see Transaction Search.

Parameter Syntax

$result = $client->updateIndexingRule([
    'Name' => '<string>', // REQUIRED
    'Rule' => [ // REQUIRED
        'Probabilistic' => [
            'DesiredSamplingPercentage' => <float>, // REQUIRED
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'IndexingRule' => [
        'ModifiedAt' => <DateTime>,
        'Name' => '<string>',
        'Rule' => [
            'Probabilistic' => [
                'ActualSamplingPercentage' => <float>,
                'DesiredSamplingPercentage' => <float>,
            ],
        ],
    ],
]

Result Details

Errors

InvalidRequestException:

The request is missing required parameters or has invalid parameters.

ThrottledException:

The request exceeds the maximum number of requests per second.

ResourceNotFoundException:

The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is correct.

UpdateSamplingRule

$result = $client->updateSamplingRule([/* ... */]);
$promise = $client->updateSamplingRuleAsync([/* ... */]);

Modifies a sampling rule's configuration.

Parameter Syntax

$result = $client->updateSamplingRule([
    'SamplingRuleUpdate' => [ // REQUIRED
        'Attributes' => ['<string>', ...],
        'FixedRate' => <float>,
        'HTTPMethod' => '<string>',
        'Host' => '<string>',
        'Priority' => <integer>,
        'ReservoirSize' => <integer>,
        'ResourceARN' => '<string>',
        'RuleARN' => '<string>',
        'RuleName' => '<string>',
        'ServiceName' => '<string>',
        'ServiceType' => '<string>',
        'URLPath' => '<string>',
    ],
]);

Parameter Details

Result Syntax

[
    'SamplingRuleRecord' => [
        'CreatedAt' => <DateTime>,
        'ModifiedAt' => <DateTime>,
        'SamplingRule' => [
            'Attributes' => ['<string>', ...],
            'FixedRate' => <float>,
            'HTTPMethod' => '<string>',
            'Host' => '<string>',
            'Priority' => <integer>,
            'ReservoirSize' => <integer>,
            'ResourceARN' => '<string>',
            'RuleARN' => '<string>',
            'RuleName' => '<string>',
            'ServiceName' => '<string>',
            'ServiceType' => '<string>',
            'URLPath' => '<string>',
            'Version' => <integer>,
        ],
    ],
]

Result Details

Errors

InvalidRequestException:

The request is missing required parameters or has invalid parameters.

ThrottledException:

The request exceeds the maximum number of requests per second.

UpdateTraceSegmentDestination

$result = $client->updateTraceSegmentDestination([/* ... */]);
$promise = $client->updateTraceSegmentDestinationAsync([/* ... */]);

Modifies the destination of data sent to PutTraceSegments. The Transaction Search feature requires the CloudWatchLogs destination. For more information, see Transaction Search.

Parameter Syntax

$result = $client->updateTraceSegmentDestination([
    'Destination' => 'XRay|CloudWatchLogs',
]);

Parameter Details

Result Syntax

[
    'Destination' => 'XRay|CloudWatchLogs',
    'Status' => 'PENDING|ACTIVE',
]

Result Details

Errors

InvalidRequestException:

The request is missing required parameters or has invalid parameters.

ThrottledException:

The request exceeds the maximum number of requests per second.