Class: Aws::XRay::Client

Inherits:

Seahorse::Client::Base

Object
Seahorse::Client::Base
Aws::XRay::Client

show all

Includes:: ClientStubs

Defined in:: lib/aws-sdk-xray/client.rb

Overview

An API client for XRay. To construct a client, you need to configure a ‘:region` and `:credentials`.

client = Aws::XRay::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).

See #initialize for a full list of supported configuration options.

Class Attribute Summary collapse

.identifier ⇒ Object readonly private

API Operations collapse

#batch_get_traces(params = {}) ⇒ Types::BatchGetTracesResult

Retrieves a list of traces specified by ID.
#create_group(params = {}) ⇒ Types::CreateGroupResult

Creates a group resource with a name and a filter expression.
#create_sampling_rule(params = {}) ⇒ Types::CreateSamplingRuleResult

Creates a rule to control sampling behavior for instrumented applications.
#delete_group(params = {}) ⇒ Struct

Deletes a group resource.
#delete_resource_policy(params = {}) ⇒ Struct

Deletes a resource policy from the target Amazon Web Services account.
#delete_sampling_rule(params = {}) ⇒ Types::DeleteSamplingRuleResult

Deletes a sampling rule.
#get_encryption_config(params = {}) ⇒ Types::GetEncryptionConfigResult

Retrieves the current encryption configuration for X-Ray data.
#get_group(params = {}) ⇒ Types::GetGroupResult

Retrieves group resource details.
#get_groups(params = {}) ⇒ Types::GetGroupsResult

Retrieves all active group details.
#get_insight(params = {}) ⇒ Types::GetInsightResult

Retrieves the summary information of an insight.
#get_insight_events(params = {}) ⇒ Types::GetInsightEventsResult

X-Ray reevaluates insights periodically until they’re resolved, and records each intermediate state as an event.
#get_insight_impact_graph(params = {}) ⇒ Types::GetInsightImpactGraphResult

Retrieves a service graph structure filtered by the specified insight.
#get_insight_summaries(params = {}) ⇒ Types::GetInsightSummariesResult

Retrieves the summaries of all insights in the specified group matching the provided filter values.
#get_sampling_rules(params = {}) ⇒ Types::GetSamplingRulesResult

Retrieves all sampling rules.
#get_sampling_statistic_summaries(params = {}) ⇒ Types::GetSamplingStatisticSummariesResult

Retrieves information about recent sampling results for all sampling rules.
#get_sampling_targets(params = {}) ⇒ Types::GetSamplingTargetsResult

Requests a sampling quota for rules that the service is using to sample requests.
#get_service_graph(params = {}) ⇒ Types::GetServiceGraphResult

Retrieves a document that describes services that process incoming requests, and downstream services that they call as a result.
#get_time_series_service_statistics(params = {}) ⇒ Types::GetTimeSeriesServiceStatisticsResult

Get an aggregation of service statistics defined by a specific time range.
#get_trace_graph(params = {}) ⇒ Types::GetTraceGraphResult

Retrieves a service graph for one or more specific trace IDs.
#get_trace_summaries(params = {}) ⇒ Types::GetTraceSummariesResult

Retrieves IDs and annotations for traces available for a specified time frame using an optional filter.
#list_resource_policies(params = {}) ⇒ Types::ListResourcePoliciesResult

Returns the list of resource policies in the target Amazon Web Services account.
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Returns a list of tags that are applied to the specified Amazon Web Services X-Ray group or sampling rule.
#put_encryption_config(params = {}) ⇒ Types::PutEncryptionConfigResult

Updates the encryption configuration for X-Ray data.
#put_resource_policy(params = {}) ⇒ Types::PutResourcePolicyResult

Sets the resource policy to grant one or more Amazon Web Services services and accounts permissions to access X-Ray.
#put_telemetry_records(params = {}) ⇒ Struct

Used by the Amazon Web Services X-Ray daemon to upload telemetry.
#put_trace_segments(params = {}) ⇒ Types::PutTraceSegmentsResult

Uploads segment documents to Amazon Web Services X-Ray.
#tag_resource(params = {}) ⇒ Struct

Applies tags to an existing Amazon Web Services X-Ray group or sampling rule.
#untag_resource(params = {}) ⇒ Struct

Removes tags from an Amazon Web Services X-Ray group or sampling rule.
#update_group(params = {}) ⇒ Types::UpdateGroupResult

Updates a group resource.
#update_sampling_rule(params = {}) ⇒ Types::UpdateSamplingRuleResult

Modifies a sampling rule’s configuration.

Class Method Summary collapse

.errors_module ⇒ Object private

Instance Method Summary collapse

#build_request(operation_name, params = {}) ⇒ Object private
#initialize(options) ⇒ Client constructor

A new instance of Client.
#waiter_names ⇒ Object deprecated private Deprecated.

Constructor Details

#initialize(options) ⇒ `Client`

Returns a new instance of Client.

Parameters:

options (Hash)

Options Hash (options):

:plugins (Array<Seahorse::Client::Plugin>) — default: []] —

A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.
:credentials (required, Aws::CredentialProvider) —
Your AWS credentials. This can be an instance of any one of the following classes:
- ‘Aws::Credentials` - Used for configuring static, non-refreshing credentials.
- ‘Aws::SharedCredentials` - Used for loading static credentials from a shared file, such as `~/.aws/config`.
- ‘Aws::AssumeRoleCredentials` - Used when you need to assume a role.
- ‘Aws::AssumeRoleWebIdentityCredentials` - Used when you need to assume a role after providing credentials via the web.
- ‘Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an access token generated from `aws login`.
- ‘Aws::ProcessCredentials` - Used for loading credentials from a process that outputs to stdout.
- ‘Aws::InstanceProfileCredentials` - Used for loading credentials from an EC2 IMDS on an EC2 instance.
- ‘Aws::ECSCredentials` - Used for loading credentials from instances running in ECS.
- ‘Aws::CognitoIdentityCredentials` - Used for loading credentials from the Cognito Identity service.
When ‘:credentials` are not configured directly, the following locations will be searched for credentials:
- ‘Aws.config`
- The ‘:access_key_id`, `:secret_access_key`, and `:session_token` options.
- ENV, ENV
- ‘~/.aws/credentials`
- ‘~/.aws/config`
- EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of ‘Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV to true.
:region (required, String) —
The AWS region to connect to. The configured ‘:region` is used to determine the service `:endpoint`. When not passed, a default `:region` is searched for in the following locations:
- ‘Aws.config`
- ‘ENV`
- ‘ENV`
- ‘ENV`
- ‘~/.aws/credentials`
- ‘~/.aws/config`
:access_key_id (String)
:active_endpoint_cache (Boolean) — default: false —

When set to ‘true`, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to `false`.
:adaptive_retry_wait_to_fill (Boolean) — default: true —

Used only in ‘adaptive` retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a `RetryCapacityNotAvailableError` and will not retry instead of sleeping.
:client_side_monitoring (Boolean) — default: false —

When ‘true`, client-side metrics will be collected for all API requests from this client.
:client_side_monitoring_client_id (String) — default: "" —

Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.
:client_side_monitoring_host (String) — default: "127.0.0.1" —

Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.
:client_side_monitoring_port (Integer) — default: 31000 —

Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.
:client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.
:convert_params (Boolean) — default: true —

When ‘true`, an attempt is made to coerce request parameters into the required types.
:correct_clock_skew (Boolean) — default: true —

Used only in ‘standard` and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.
:defaults_mode (String) — default: "legacy" —

See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.
:disable_host_prefix_injection (Boolean) — default: false —

Set to true to disable SDK automatically adding host prefix to default service endpoint when available.
:disable_request_compression (Boolean) — default: false —

When set to ‘true’ the request body will not be compressed for supported operations.
:endpoint (String, URI::HTTPS, URI::HTTP) —
Normally you should not configure the ‘:endpoint` option directly. This is normally constructed from the `:region` option. Configuring `:endpoint` is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:
```
'http://example.com'
'https://example.com'
'http://example.com:123'
```
:endpoint_cache_max_entries (Integer) — default: 1000 —

Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.
:endpoint_cache_max_threads (Integer) — default: 10 —

Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
:endpoint_cache_poll_interval (Integer) — default: 60 —

When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.
:endpoint_discovery (Boolean) — default: false —

When set to ‘true`, endpoint discovery will be enabled for operations when available.
:ignore_configured_endpoint_urls (Boolean) —

Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.
:log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

The log formatter.
:log_level (Symbol) — default: :info —

The log level to send messages to the ‘:logger` at.
:logger (Logger) —

The Logger instance to send log messages to. If this option is not set, logging will be disabled.
:max_attempts (Integer) — default: 3 —

An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in ‘standard` and `adaptive` retry modes.
:profile (String) — default: "default" —

Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, ‘default’ is used.
:request_min_compression_size_bytes (Integer) — default: 10240 —

The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.
:retry_backoff (Proc) —

A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the ‘legacy` retry mode.
:retry_base_delay (Float) — default: 0.3 —

The base delay in seconds used by the default backoff function. This option is only used in the ‘legacy` retry mode.
:retry_jitter (Symbol) — default: :none —

A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the ‘legacy` retry mode.

@see www.awsarchitectureblog.com/2015/03/backoff.html
:retry_limit (Integer) — default: 3 —

The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the ‘legacy` retry mode.
:retry_max_delay (Integer) — default: 0 —

The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the ‘legacy` retry mode.
:retry_mode (String) — default: "legacy" —
Specifies which retry algorithm to use. Values are:
- ‘legacy` - The pre-existing retry behavior. This is default value if no retry mode is provided.
- ‘standard` - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.
- ‘adaptive` - An experimental retry mode that includes all the functionality of `standard` mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.
:sdk_ua_app_id (String) —

A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.
:secret_access_key (String)
:session_token (String)
:sigv4a_signing_region_set (Array) —
A list of regions that should be signed with SigV4a signing. When not passed, a default ‘:sigv4a_signing_region_set` is searched for in the following locations:
- ‘Aws.config`
- ‘ENV`
- ‘~/.aws/config`
:stub_responses (Boolean) — default: false —

Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

** Please note ** When response stubbing is enabled, no HTTP requests are made, and retries are disabled.
:telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —
Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses ‘NoOpTelemetryProvider` which will not record or emit any telemetry data. The SDK supports the following telemetry providers:
- OpenTelemetry (OTel) - To use the OTel provider, install and require the
‘opentelemetry-sdk` gem and then, pass in an instance of a `Aws::Telemetry::OTelProvider` for telemetry provider.
:token_provider (Aws::TokenProvider) —
A Bearer Token Provider. This can be an instance of any one of the following classes:
- ‘Aws::StaticTokenProvider` - Used for configuring static, non-refreshing tokens.
- ‘Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an access token generated from `aws login`.
When ‘:token_provider` is not configured directly, the `Aws::TokenProviderChain` will be used to search for tokens configured for your profile in shared configuration files.
:use_dualstack_endpoint (Boolean) —

When set to ‘true`, dualstack enabled endpoints (with `.aws` TLD) will be used if available.
:use_fips_endpoint (Boolean) —

When set to ‘true`, fips compatible endpoints will be used if available. When a `fips` region is used, the region is normalized and this config is set to `true`.
:validate_params (Boolean) — default: true —

When ‘true`, request parameters are validated before sending the request.
:endpoint_provider (Aws::XRay::EndpointProvider) —

The endpoint provider used to resolve endpoints. Any object that responds to ‘#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::XRay::EndpointParameters`
:http_continue_timeout (Float) — default: 1 —

The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has “Expect” header set to “100-continue”. Defaults to ‘nil` which disables this behaviour. This value can safely be set per request on the session.
:http_idle_timeout (Float) — default: 5 —

The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.
:http_open_timeout (Float) — default: 15 —

The default number of seconds to wait for response data. This value can safely be set per-request on the session.
:http_proxy (URI::HTTP, String) —

A proxy to send requests through. Formatted like ‘proxy.com:123’.
:http_read_timeout (Float) — default: 60 —

The default number of seconds to wait for response data. This value can safely be set per-request on the session.
:http_wire_trace (Boolean) — default: false —

When ‘true`, HTTP debug output will be sent to the `:logger`.
:on_chunk_received (Proc) —

When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a ‘content-length`).
:on_chunk_sent (Proc) —

When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.
:raise_response_errors (Boolean) — default: true —

When ‘true`, response errors are raised.
:ssl_ca_bundle (String) —

Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.
:ssl_ca_directory (String) —

Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.
:ssl_ca_store (String) —

Sets the X509::Store to verify peer certificate.
:ssl_timeout (Float) —

Sets the SSL timeout in seconds
:ssl_verify_peer (Boolean) — default: true —

When ‘true`, SSL peer certificates are verified when establishing a connection.



434
435
436

# File 'lib/aws-sdk-xray/client.rb', line 434

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ `Object` (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



2298
2299
2300

# File 'lib/aws-sdk-xray/client.rb', line 2298

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ `Object`

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



2301
2302
2303

# File 'lib/aws-sdk-xray/client.rb', line 2301

def errors_module
  Errors
end

Instance Method Details

#batch_get_traces(params = {}) ⇒ `Types::BatchGetTracesResult`

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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.batch_get_traces({
  trace_ids: ["TraceId"], # required
  next_token: "String",
})

Response structure


resp.traces #=> Array
resp.traces[0].id #=> String
resp.traces[0].duration #=> Float
resp.traces[0].limit_exceeded #=> Boolean
resp.traces[0].segments #=> Array
resp.traces[0].segments[0].id #=> String
resp.traces[0].segments[0].document #=> String
resp.unprocessed_trace_ids #=> Array
resp.unprocessed_trace_ids[0] #=> String
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:trace_ids (required, Array<String>) —

Specify the trace IDs of requests for which to retrieve segments.
:next_token (String) —

Pagination token.

Returns:

(Types::BatchGetTracesResult) —
Returns a response object which responds to the following methods:
- #traces => Array<Types::Trace>
- #unprocessed_trace_ids => Array<String>
- #next_token => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-xray/client.rb', line 482

def batch_get_traces(params = {}, options = {})
  req = build_request(:batch_get_traces, params)
  req.send_request(options)
end

#build_request(operation_name, params = {}) ⇒ `Object`

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

params ({}) (defaults to: {})

# File 'lib/aws-sdk-xray/client.rb', line 2271

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  tracer = config.telemetry_provider.tracer_provider.tracer(
    Aws::Telemetry.module_to_tracer_name('Aws::XRay')
  )
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config,
    tracer: tracer
  )
  context[:gem_name] = 'aws-sdk-xray'
  context[:gem_version] = '1.71.0'
  Seahorse::Client::Request.new(handlers, context)
end

#create_group(params = {}) ⇒ `Types::CreateGroupResult`

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

Examples:

Request syntax with placeholder values


resp = client.create_group({
  group_name: "GroupName", # required
  filter_expression: "FilterExpression",
  insights_configuration: {
    insights_enabled: false,
    notifications_enabled: false,
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.group.group_name #=> String
resp.group.group_arn #=> String
resp.group.filter_expression #=> String
resp.group.insights_configuration.insights_enabled #=> Boolean
resp.group.insights_configuration.notifications_enabled #=> Boolean

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:group_name (required, String) —

The case-sensitive name of the new group. Default is a reserved name and names must be unique.
:filter_expression (String) —

The filter expression defining criteria by which to group traces.
:insights_configuration (Types::InsightsConfiguration) —
The structure containing configurations related to insights.
- The InsightsEnabled boolean can be set to true to enable insights for the new group or false to disable insights for the new group.
- The NotificationsEnabled boolean can be set to true to enable insights notifications for the new group. Notifications may only be enabled on a group with InsightsEnabled set to true.
:tags (Array<Types::Tag>) —
A map that contains one or more tag keys and tag values to attach to an X-Ray group. For more information about ways to use tags, see

Tagging Amazon Web Services resources][1

in the *Amazon Web Services

General Reference*.

The following restrictions apply to tags:
- Maximum number of user-applied tags per resource: 50
- Maximum tag key length: 128 Unicode characters
- Maximum tag value length: 256 Unicode characters
- Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: _ . : / = + - and @
- Tag keys and values are case sensitive.
- Don’t use ‘aws:` as a prefix for keys; it’s reserved for Amazon Web Services use.
[1]: docs.aws.amazon.com/general/latest/gr/aws_tagging.html

Returns:

(Types::CreateGroupResult) —
Returns a response object which responds to the following methods:
- #group => Types::Group

See Also:

AWS API Documentation

# File 'lib/aws-sdk-xray/client.rb', line 565

def create_group(params = {}, options = {})
  req = build_request(:create_group, params)
  req.send_request(options)
end

#create_sampling_rule(params = {}) ⇒ `Types::CreateSamplingRuleResult`

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.

[1]: docs.aws.amazon.com/xray/latest/api/API_GetSamplingRules.html [2]: docs.aws.amazon.com/xray/latest/api/API_GetSamplingTargets.html

Examples:

Request syntax with placeholder values


resp = client.create_sampling_rule({
  sampling_rule: { # required
    rule_name: "RuleName",
    rule_arn: "String",
    resource_arn: "ResourceARN", # required
    priority: 1, # required
    fixed_rate: 1.0, # required
    reservoir_size: 1, # required
    service_name: "ServiceName", # required
    service_type: "ServiceType", # required
    host: "Host", # required
    http_method: "HTTPMethod", # required
    url_path: "URLPath", # required
    version: 1, # required
    attributes: {
      "AttributeKey" => "AttributeValue",
    },
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.sampling_rule_record.sampling_rule.rule_name #=> String
resp.sampling_rule_record.sampling_rule.rule_arn #=> String
resp.sampling_rule_record.sampling_rule.resource_arn #=> String
resp.sampling_rule_record.sampling_rule.priority #=> Integer
resp.sampling_rule_record.sampling_rule.fixed_rate #=> Float
resp.sampling_rule_record.sampling_rule.reservoir_size #=> Integer
resp.sampling_rule_record.sampling_rule.service_name #=> String
resp.sampling_rule_record.sampling_rule.service_type #=> String
resp.sampling_rule_record.sampling_rule.host #=> String
resp.sampling_rule_record.sampling_rule.http_method #=> String
resp.sampling_rule_record.sampling_rule.url_path #=> String
resp.sampling_rule_record.sampling_rule.version #=> Integer
resp.sampling_rule_record.sampling_rule.attributes #=> Hash
resp.sampling_rule_record.sampling_rule.attributes["AttributeKey"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
resp.sampling_rule_record.created_at #=> Time
resp.sampling_rule_record.modified_at #=> Time

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:sampling_rule (required, Types::SamplingRule) —

The rule definition.
:tags (Array<Types::Tag>) —
A map that contains one or more tag keys and tag values to attach to an X-Ray sampling rule. For more information about ways to use tags, see [Tagging Amazon Web Services resources] in the *Amazon Web Services General Reference*.

The following restrictions apply to tags:
- Maximum number of user-applied tags per resource: 50
- Maximum tag key length: 128 Unicode characters
- Maximum tag value length: 256 Unicode characters
- Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: _ . : / = + - and @
- Tag keys and values are case sensitive.
- Don’t use ‘aws:` as a prefix for keys; it’s reserved for Amazon Web Services use.
[1]: docs.aws.amazon.com/general/latest/gr/aws_tagging.html

Returns:

(Types::CreateSamplingRuleResult) —
Returns a response object which responds to the following methods:
- #sampling_rule_record => Types::SamplingRuleRecord

See Also:

AWS API Documentation

# File 'lib/aws-sdk-xray/client.rb', line 668

def create_sampling_rule(params = {}, options = {})
  req = build_request(:create_sampling_rule, params)
  req.send_request(options)
end

#delete_group(params = {}) ⇒ `Struct`

Deletes a group resource.

Examples:

Request syntax with placeholder values


resp = client.delete_group({
  group_name: "GroupName",
  group_arn: "GroupARN",
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:group_name (String) —

The case-sensitive name of the group.
:group_arn (String) —

The ARN of the group that was generated on creation.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-xray/client.rb', line 694

def delete_group(params = {}, options = {})
  req = build_request(:delete_group, params)
  req.send_request(options)
end

#delete_resource_policy(params = {}) ⇒ `Struct`

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

Examples:

Request syntax with placeholder values


resp = client.delete_resource_policy({
  policy_name: "PolicyName", # required
  policy_revision_id: "PolicyRevisionId",
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:policy_name (required, String) —

The name of the resource policy to delete.
:policy_revision_id (String) —

Specifies a specific policy revision to delete. Provide a ‘PolicyRevisionId` to ensure an atomic delete operation. If the provided revision id does not match the latest policy revision id, an `InvalidPolicyRevisionIdException` exception is returned.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-xray/client.rb', line 723

def delete_resource_policy(params = {}, options = {})
  req = build_request(:delete_resource_policy, params)
  req.send_request(options)
end

#delete_sampling_rule(params = {}) ⇒ `Types::DeleteSamplingRuleResult`

Deletes a sampling rule.

Examples:

Request syntax with placeholder values


resp = client.delete_sampling_rule({
  rule_name: "String",
  rule_arn: "String",
})

Response structure


resp.sampling_rule_record.sampling_rule.rule_name #=> String
resp.sampling_rule_record.sampling_rule.rule_arn #=> String
resp.sampling_rule_record.sampling_rule.resource_arn #=> String
resp.sampling_rule_record.sampling_rule.priority #=> Integer
resp.sampling_rule_record.sampling_rule.fixed_rate #=> Float
resp.sampling_rule_record.sampling_rule.reservoir_size #=> Integer
resp.sampling_rule_record.sampling_rule.service_name #=> String
resp.sampling_rule_record.sampling_rule.service_type #=> String
resp.sampling_rule_record.sampling_rule.host #=> String
resp.sampling_rule_record.sampling_rule.http_method #=> String
resp.sampling_rule_record.sampling_rule.url_path #=> String
resp.sampling_rule_record.sampling_rule.version #=> Integer
resp.sampling_rule_record.sampling_rule.attributes #=> Hash
resp.sampling_rule_record.sampling_rule.attributes["AttributeKey"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
resp.sampling_rule_record.created_at #=> Time
resp.sampling_rule_record.modified_at #=> Time

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:rule_name (String) —

The name of the sampling rule. Specify a rule by either name or ARN, but not both.
:rule_arn (String) —

The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.

Returns:

(Types::DeleteSamplingRuleResult) —
Returns a response object which responds to the following methods:
- #sampling_rule_record => Types::SamplingRuleRecord

See Also:

AWS API Documentation

# File 'lib/aws-sdk-xray/client.rb', line 772

def delete_sampling_rule(params = {}, options = {})
  req = build_request(:delete_sampling_rule, params)
  req.send_request(options)
end

#get_encryption_config(params = {}) ⇒ `Types::GetEncryptionConfigResult`

Retrieves the current encryption configuration for X-Ray data.

Examples:

Response structure


resp.encryption_config.key_id #=> String
resp.encryption_config.status #=> String, one of "UPDATING", "ACTIVE"
resp.encryption_config.type #=> String, one of "NONE", "KMS"

Parameters:

params (Hash) (defaults to: {}) —

({})

Returns:

(Types::GetEncryptionConfigResult) —
Returns a response object which responds to the following methods:
- #encryption_config => Types::EncryptionConfig

See Also:

AWS API Documentation

# File 'lib/aws-sdk-xray/client.rb', line 793

def get_encryption_config(params = {}, options = {})
  req = build_request(:get_encryption_config, params)
  req.send_request(options)
end

#get_group(params = {}) ⇒ `Types::GetGroupResult`

Retrieves group resource details.

Examples:

Request syntax with placeholder values


resp = client.get_group({
  group_name: "GroupName",
  group_arn: "GroupARN",
})

Response structure


resp.group.group_name #=> String
resp.group.group_arn #=> String
resp.group.filter_expression #=> String
resp.group.insights_configuration.insights_enabled #=> Boolean
resp.group.insights_configuration.notifications_enabled #=> Boolean

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:group_name (String) —

The case-sensitive name of the group.
:group_arn (String) —

The ARN of the group that was generated on creation.

Returns:

(Types::GetGroupResult) —
Returns a response object which responds to the following methods:
- #group => Types::Group

See Also:

AWS API Documentation

# File 'lib/aws-sdk-xray/client.rb', line 829

def get_group(params = {}, options = {})
  req = build_request(:get_group, params)
  req.send_request(options)
end

#get_groups(params = {}) ⇒ `Types::GetGroupsResult`

Retrieves all active group details.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_groups({
  next_token: "GetGroupsNextToken",
})

Response structure


resp.groups #=> Array
resp.groups[0].group_name #=> String
resp.groups[0].group_arn #=> String
resp.groups[0].filter_expression #=> String
resp.groups[0].insights_configuration.insights_enabled #=> Boolean
resp.groups[0].insights_configuration.notifications_enabled #=> Boolean
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:next_token (String) —

Pagination token.

Returns:

(Types::GetGroupsResult) —
Returns a response object which responds to the following methods:
- #groups => Array<Types::GroupSummary>
- #next_token => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-xray/client.rb', line 866

def get_groups(params = {}, options = {})
  req = build_request(:get_groups, params)
  req.send_request(options)
end

#get_insight(params = {}) ⇒ `Types::GetInsightResult`

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.

Examples:

Request syntax with placeholder values


resp = client.get_insight({
  insight_id: "InsightId", # required
})

Response structure


resp.insight.insight_id #=> String
resp.insight.group_arn #=> String
resp.insight.group_name #=> String
resp.insight.root_cause_service_id.name #=> String
resp.insight.root_cause_service_id.names #=> Array
resp.insight.root_cause_service_id.names[0] #=> String
resp.insight.root_cause_service_id.account_id #=> String
resp.insight.root_cause_service_id.type #=> String
resp.insight.categories #=> Array
resp.insight.categories[0] #=> String, one of "FAULT"
resp.insight.state #=> String, one of "ACTIVE", "CLOSED"
resp.insight.start_time #=> Time
resp.insight.end_time #=> Time
resp.insight.summary #=> String
resp.insight.client_request_impact_statistics.fault_count #=> Integer
resp.insight.client_request_impact_statistics.ok_count #=> Integer
resp.insight.client_request_impact_statistics.total_count #=> Integer
resp.insight.root_cause_service_request_impact_statistics.fault_count #=> Integer
resp.insight.root_cause_service_request_impact_statistics.ok_count #=> Integer
resp.insight.root_cause_service_request_impact_statistics.total_count #=> Integer
resp.insight.top_anomalous_services #=> Array
resp.insight.top_anomalous_services[0].service_id.name #=> String
resp.insight.top_anomalous_services[0].service_id.names #=> Array
resp.insight.top_anomalous_services[0].service_id.names[0] #=> String
resp.insight.top_anomalous_services[0].service_id.account_id #=> String
resp.insight.top_anomalous_services[0].service_id.type #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:insight_id (required, String) —

The insight’s unique identifier. Use the GetInsightSummaries action to retrieve an InsightId.

Returns:

(Types::GetInsightResult) —
Returns a response object which responds to the following methods:
- #insight => Types::Insight

See Also:

AWS API Documentation

# File 'lib/aws-sdk-xray/client.rb', line 923

def get_insight(params = {}, options = {})
  req = build_request(:get_insight, params)
  req.send_request(options)
end

#get_insight_events(params = {}) ⇒ `Types::GetInsightEventsResult`

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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_insight_events({
  insight_id: "InsightId", # required
  max_results: 1,
  next_token: "Token",
})

Response structure


resp.insight_events #=> Array
resp.insight_events[0].summary #=> String
resp.insight_events[0].event_time #=> Time
resp.insight_events[0].client_request_impact_statistics.fault_count #=> Integer
resp.insight_events[0].client_request_impact_statistics.ok_count #=> Integer
resp.insight_events[0].client_request_impact_statistics.total_count #=> Integer
resp.insight_events[0].root_cause_service_request_impact_statistics.fault_count #=> Integer
resp.insight_events[0].root_cause_service_request_impact_statistics.ok_count #=> Integer
resp.insight_events[0].root_cause_service_request_impact_statistics.total_count #=> Integer
resp.insight_events[0].top_anomalous_services #=> Array
resp.insight_events[0].top_anomalous_services[0].service_id.name #=> String
resp.insight_events[0].top_anomalous_services[0].service_id.names #=> Array
resp.insight_events[0].top_anomalous_services[0].service_id.names[0] #=> String
resp.insight_events[0].top_anomalous_services[0].service_id.account_id #=> String
resp.insight_events[0].top_anomalous_services[0].service_id.type #=> String
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:insight_id (required, String) —

The insight’s unique identifier. Use the GetInsightSummaries action to retrieve an InsightId.
:max_results (Integer) —

Used to retrieve at most the specified value of events.
:next_token (String) —

Specify the pagination token returned by a previous request to retrieve the next page of events.

Returns:

(Types::GetInsightEventsResult) —
Returns a response object which responds to the following methods:
- #insight_events => Array<Types::InsightEvent>
- #next_token => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-xray/client.rb', line 982

def get_insight_events(params = {}, options = {})
  req = build_request(:get_insight_events, params)
  req.send_request(options)
end

#get_insight_impact_graph(params = {}) ⇒ `Types::GetInsightImpactGraphResult`

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.

Examples:

Request syntax with placeholder values


resp = client.get_insight_impact_graph({
  insight_id: "InsightId", # required
  start_time: Time.now, # required
  end_time: Time.now, # required
  next_token: "Token",
})

Response structure


resp.insight_id #=> String
resp.start_time #=> Time
resp.end_time #=> Time
resp.service_graph_start_time #=> Time
resp.service_graph_end_time #=> Time
resp.services #=> Array
resp.services[0].reference_id #=> Integer
resp.services[0].type #=> String
resp.services[0].name #=> String
resp.services[0].names #=> Array
resp.services[0].names[0] #=> String
resp.services[0].account_id #=> String
resp.services[0].edges #=> Array
resp.services[0].edges[0].reference_id #=> Integer
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:insight_id (required, String) —

The insight’s unique identifier. Use the GetInsightSummaries action to retrieve an InsightId.
:start_time (required, Time, DateTime, Date, Integer, String) —

The estimated start time of the insight, in Unix time seconds. The StartTime is inclusive of the value provided and can’t be more than 30 days old.
:end_time (required, Time, DateTime, Date, Integer, String) —

The estimated end time of the insight, in Unix time seconds. The EndTime is exclusive of the value provided. The time range between the start time and end time can’t be more than six hours.
:next_token (String) —

Specify the pagination token returned by a previous request to retrieve the next page of results.

Returns:

(Types::GetInsightImpactGraphResult) —
Returns a response object which responds to the following methods:
- #insight_id => String
- #start_time => Time
- #end_time => Time
- #service_graph_start_time => Time
- #service_graph_end_time => Time
- #services => Array<Types::InsightImpactGraphService>
- #next_token => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-xray/client.rb', line 1050

def get_insight_impact_graph(params = {}, options = {})
  req = build_request(:get_insight_impact_graph, params)
  req.send_request(options)
end

#get_insight_summaries(params = {}) ⇒ `Types::GetInsightSummariesResult`

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_insight_summaries({
  states: ["ACTIVE"], # accepts ACTIVE, CLOSED
  group_arn: "GroupARN",
  group_name: "GroupName",
  start_time: Time.now, # required
  end_time: Time.now, # required
  max_results: 1,
  next_token: "Token",
})

Response structure


resp.insight_summaries #=> Array
resp.insight_summaries[0].insight_id #=> String
resp.insight_summaries[0].group_arn #=> String
resp.insight_summaries[0].group_name #=> String
resp.insight_summaries[0].root_cause_service_id.name #=> String
resp.insight_summaries[0].root_cause_service_id.names #=> Array
resp.insight_summaries[0].root_cause_service_id.names[0] #=> String
resp.insight_summaries[0].root_cause_service_id.account_id #=> String
resp.insight_summaries[0].root_cause_service_id.type #=> String
resp.insight_summaries[0].categories #=> Array
resp.insight_summaries[0].categories[0] #=> String, one of "FAULT"
resp.insight_summaries[0].state #=> String, one of "ACTIVE", "CLOSED"
resp.insight_summaries[0].start_time #=> Time
resp.insight_summaries[0].end_time #=> Time
resp.insight_summaries[0].summary #=> String
resp.insight_summaries[0].client_request_impact_statistics.fault_count #=> Integer
resp.insight_summaries[0].client_request_impact_statistics.ok_count #=> Integer
resp.insight_summaries[0].client_request_impact_statistics.total_count #=> Integer
resp.insight_summaries[0].root_cause_service_request_impact_statistics.fault_count #=> Integer
resp.insight_summaries[0].root_cause_service_request_impact_statistics.ok_count #=> Integer
resp.insight_summaries[0].root_cause_service_request_impact_statistics.total_count #=> Integer
resp.insight_summaries[0].top_anomalous_services #=> Array
resp.insight_summaries[0].top_anomalous_services[0].service_id.name #=> String
resp.insight_summaries[0].top_anomalous_services[0].service_id.names #=> Array
resp.insight_summaries[0].top_anomalous_services[0].service_id.names[0] #=> String
resp.insight_summaries[0].top_anomalous_services[0].service_id.account_id #=> String
resp.insight_summaries[0].top_anomalous_services[0].service_id.type #=> String
resp.insight_summaries[0].last_update_time #=> Time
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:states (Array<String>) —

The list of insight states.
:group_arn (String) —

The Amazon Resource Name (ARN) of the group. Required if the GroupName isn’t provided.
:group_name (String) —

The name of the group. Required if the GroupARN isn’t provided.
:start_time (required, Time, DateTime, Date, Integer, String) —

The beginning of the time frame in which the insights started. The start time can’t be more than 30 days old.
:end_time (required, Time, DateTime, Date, Integer, String) —

The end of the time frame in which the insights ended. The end time can’t be more than 30 days old.
:max_results (Integer) —

The maximum number of results to display.
:next_token (String) —

Pagination token.

Returns:

(Types::GetInsightSummariesResult) —
Returns a response object which responds to the following methods:
- #insight_summaries => Array<Types::InsightSummary>
- #next_token => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-xray/client.rb', line 1137

def get_insight_summaries(params = {}, options = {})
  req = build_request(:get_insight_summaries, params)
  req.send_request(options)
end

#get_sampling_rules(params = {}) ⇒ `Types::GetSamplingRulesResult`

Retrieves all sampling rules.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_sampling_rules({
  next_token: "String",
})

Response structure


resp.sampling_rule_records #=> Array
resp.sampling_rule_records[0].sampling_rule.rule_name #=> String
resp.sampling_rule_records[0].sampling_rule.rule_arn #=> String
resp.sampling_rule_records[0].sampling_rule.resource_arn #=> String
resp.sampling_rule_records[0].sampling_rule.priority #=> Integer
resp.sampling_rule_records[0].sampling_rule.fixed_rate #=> Float
resp.sampling_rule_records[0].sampling_rule.reservoir_size #=> Integer
resp.sampling_rule_records[0].sampling_rule.service_name #=> String
resp.sampling_rule_records[0].sampling_rule.service_type #=> String
resp.sampling_rule_records[0].sampling_rule.host #=> String
resp.sampling_rule_records[0].sampling_rule.http_method #=> String
resp.sampling_rule_records[0].sampling_rule.url_path #=> String
resp.sampling_rule_records[0].sampling_rule.version #=> Integer
resp.sampling_rule_records[0].sampling_rule.attributes #=> Hash
resp.sampling_rule_records[0].sampling_rule.attributes["AttributeKey"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
resp.sampling_rule_records[0].created_at #=> Time
resp.sampling_rule_records[0].modified_at #=> Time
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:next_token (String) —

Pagination token.

Returns:

(Types::GetSamplingRulesResult) —
Returns a response object which responds to the following methods:
- #sampling_rule_records => Array<Types::SamplingRuleRecord>
- #next_token => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-xray/client.rb', line 1185

def get_sampling_rules(params = {}, options = {})
  req = build_request(:get_sampling_rules, params)
  req.send_request(options)
end

#get_sampling_statistic_summaries(params = {}) ⇒ `Types::GetSamplingStatisticSummariesResult`

Retrieves information about recent sampling results for all sampling rules.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_sampling_statistic_summaries({
  next_token: "String",
})

Response structure


resp.sampling_statistic_summaries #=> Array
resp.sampling_statistic_summaries[0].rule_name #=> String
resp.sampling_statistic_summaries[0].timestamp #=> Time
resp.sampling_statistic_summaries[0].request_count #=> Integer
resp.sampling_statistic_summaries[0].borrow_count #=> Integer
resp.sampling_statistic_summaries[0].sampled_count #=> Integer
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:next_token (String) —

Pagination token.

Returns:

(Types::GetSamplingStatisticSummariesResult) —
Returns a response object which responds to the following methods:
- #sampling_statistic_summaries => Array<Types::SamplingStatisticSummary>
- #next_token => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-xray/client.rb', line 1223

def get_sampling_statistic_summaries(params = {}, options = {})
  req = build_request(:get_sampling_statistic_summaries, params)
  req.send_request(options)
end

#get_sampling_targets(params = {}) ⇒ `Types::GetSamplingTargetsResult`

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

Examples:

Request syntax with placeholder values


resp = client.get_sampling_targets({
  sampling_statistics_documents: [ # required
    {
      rule_name: "RuleName", # required
      client_id: "ClientID", # required
      timestamp: Time.now, # required
      request_count: 1, # required
      sampled_count: 1, # required
      borrow_count: 1,
    },
  ],
})

Response structure


resp.sampling_target_documents #=> Array
resp.sampling_target_documents[0].rule_name #=> String
resp.sampling_target_documents[0].fixed_rate #=> Float
resp.sampling_target_documents[0].reservoir_quota #=> Integer
resp.sampling_target_documents[0].reservoir_quota_ttl #=> Time
resp.sampling_target_documents[0].interval #=> Integer
resp.last_rule_modification #=> Time
resp.unprocessed_statistics #=> Array
resp.unprocessed_statistics[0].rule_name #=> String
resp.unprocessed_statistics[0].error_code #=> String
resp.unprocessed_statistics[0].message #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:sampling_statistics_documents (required, Array<Types::SamplingStatisticsDocument>) —

Information about rules that the service is using to sample requests.

Returns:

(Types::GetSamplingTargetsResult) —
Returns a response object which responds to the following methods:
- #sampling_target_documents => Array<Types::SamplingTargetDocument>
- #last_rule_modification => Time
- #unprocessed_statistics => Array<Types::UnprocessedStatistics>

See Also:

AWS API Documentation

# File 'lib/aws-sdk-xray/client.rb', line 1273

def get_sampling_targets(params = {}, options = {})
  req = build_request(:get_sampling_targets, params)
  req.send_request(options)
end

#get_service_graph(params = {}) ⇒ `Types::GetServiceGraphResult`

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.

[1]: docs.aws.amazon.com/xray/index.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_service_graph({
  start_time: Time.now, # required
  end_time: Time.now, # required
  group_name: "GroupName",
  group_arn: "GroupARN",
  next_token: "String",
})

Response structure


resp.start_time #=> Time
resp.end_time #=> Time
resp.services #=> Array
resp.services[0].reference_id #=> Integer
resp.services[0].name #=> String
resp.services[0].names #=> Array
resp.services[0].names[0] #=> String
resp.services[0].root #=> Boolean
resp.services[0].account_id #=> String
resp.services[0].type #=> String
resp.services[0].state #=> String
resp.services[0].start_time #=> Time
resp.services[0].end_time #=> Time
resp.services[0].edges #=> Array
resp.services[0].edges[0].reference_id #=> Integer
resp.services[0].edges[0].start_time #=> Time
resp.services[0].edges[0].end_time #=> Time
resp.services[0].edges[0].summary_statistics.ok_count #=> Integer
resp.services[0].edges[0].summary_statistics.error_statistics.throttle_count #=> Integer
resp.services[0].edges[0].summary_statistics.error_statistics.other_count #=> Integer
resp.services[0].edges[0].summary_statistics.error_statistics.total_count #=> Integer
resp.services[0].edges[0].summary_statistics.fault_statistics.other_count #=> Integer
resp.services[0].edges[0].summary_statistics.fault_statistics.total_count #=> Integer
resp.services[0].edges[0].summary_statistics.total_count #=> Integer
resp.services[0].edges[0].summary_statistics.total_response_time #=> Float
resp.services[0].edges[0].response_time_histogram #=> Array
resp.services[0].edges[0].response_time_histogram[0].value #=> Float
resp.services[0].edges[0].response_time_histogram[0].count #=> Integer
resp.services[0].edges[0].aliases #=> Array
resp.services[0].edges[0].aliases[0].name #=> String
resp.services[0].edges[0].aliases[0].names #=> Array
resp.services[0].edges[0].aliases[0].names[0] #=> String
resp.services[0].edges[0].aliases[0].type #=> String
resp.services[0].edges[0].edge_type #=> String
resp.services[0].edges[0].received_event_age_histogram #=> Array
resp.services[0].edges[0].received_event_age_histogram[0].value #=> Float
resp.services[0].edges[0].received_event_age_histogram[0].count #=> Integer
resp.services[0].summary_statistics.ok_count #=> Integer
resp.services[0].summary_statistics.error_statistics.throttle_count #=> Integer
resp.services[0].summary_statistics.error_statistics.other_count #=> Integer
resp.services[0].summary_statistics.error_statistics.total_count #=> Integer
resp.services[0].summary_statistics.fault_statistics.other_count #=> Integer
resp.services[0].summary_statistics.fault_statistics.total_count #=> Integer
resp.services[0].summary_statistics.total_count #=> Integer
resp.services[0].summary_statistics.total_response_time #=> Float
resp.services[0].duration_histogram #=> Array
resp.services[0].duration_histogram[0].value #=> Float
resp.services[0].duration_histogram[0].count #=> Integer
resp.services[0].response_time_histogram #=> Array
resp.services[0].response_time_histogram[0].value #=> Float
resp.services[0].response_time_histogram[0].count #=> Integer
resp.contains_old_group_versions #=> Boolean
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:start_time (required, Time, DateTime, Date, Integer, String) —

The start of the time frame for which to generate a graph.
:end_time (required, Time, DateTime, Date, Integer, String) —

The end of the timeframe for which to generate a graph.
:group_name (String) —

The name of a group based on which you want to generate a graph.
:group_arn (String) —

The Amazon Resource Name (ARN) of a group based on which you want to generate a graph.
:next_token (String) —

Pagination token.

Returns:

(Types::GetServiceGraphResult) —
Returns a response object which responds to the following methods:
- #start_time => Time
- #end_time => Time
- #services => Array<Types::Service>
- #contains_old_group_versions => Boolean
- #next_token => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-xray/client.rb', line 1385

def get_service_graph(params = {}, options = {})
  req = build_request(:get_service_graph, params)
  req.send_request(options)
end

#get_time_series_service_statistics(params = {}) ⇒ `Types::GetTimeSeriesServiceStatisticsResult`

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_time_series_service_statistics({
  start_time: Time.now, # required
  end_time: Time.now, # required
  group_name: "GroupName",
  group_arn: "GroupARN",
  entity_selector_expression: "EntitySelectorExpression",
  period: 1,
  forecast_statistics: false,
  next_token: "String",
})

Response structure


resp.time_series_service_statistics #=> Array
resp.time_series_service_statistics[0].timestamp #=> Time
resp.time_series_service_statistics[0].edge_summary_statistics.ok_count #=> Integer
resp.time_series_service_statistics[0].edge_summary_statistics.error_statistics.throttle_count #=> Integer
resp.time_series_service_statistics[0].edge_summary_statistics.error_statistics.other_count #=> Integer
resp.time_series_service_statistics[0].edge_summary_statistics.error_statistics.total_count #=> Integer
resp.time_series_service_statistics[0].edge_summary_statistics.fault_statistics.other_count #=> Integer
resp.time_series_service_statistics[0].edge_summary_statistics.fault_statistics.total_count #=> Integer
resp.time_series_service_statistics[0].edge_summary_statistics.total_count #=> Integer
resp.time_series_service_statistics[0].edge_summary_statistics.total_response_time #=> Float
resp.time_series_service_statistics[0].service_summary_statistics.ok_count #=> Integer
resp.time_series_service_statistics[0].service_summary_statistics.error_statistics.throttle_count #=> Integer
resp.time_series_service_statistics[0].service_summary_statistics.error_statistics.other_count #=> Integer
resp.time_series_service_statistics[0].service_summary_statistics.error_statistics.total_count #=> Integer
resp.time_series_service_statistics[0].service_summary_statistics.fault_statistics.other_count #=> Integer
resp.time_series_service_statistics[0].service_summary_statistics.fault_statistics.total_count #=> Integer
resp.time_series_service_statistics[0].service_summary_statistics.total_count #=> Integer
resp.time_series_service_statistics[0].service_summary_statistics.total_response_time #=> Float
resp.time_series_service_statistics[0].service_forecast_statistics.fault_count_high #=> Integer
resp.time_series_service_statistics[0].service_forecast_statistics.fault_count_low #=> Integer
resp.time_series_service_statistics[0].response_time_histogram #=> Array
resp.time_series_service_statistics[0].response_time_histogram[0].value #=> Float
resp.time_series_service_statistics[0].response_time_histogram[0].count #=> Integer
resp.contains_old_group_versions #=> Boolean
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:start_time (required, Time, DateTime, Date, Integer, String) —

The start of the time frame for which to aggregate statistics.
:end_time (required, Time, DateTime, Date, Integer, String) —

The end of the time frame for which to aggregate statistics.
:group_name (String) —

The case-sensitive name of the group for which to pull statistics from.
:group_arn (String) —

The Amazon Resource Name (ARN) of the group for which to pull statistics from.
:entity_selector_expression (String) —

A filter expression defining entities that will be aggregated for statistics. Supports ID, service, and edge functions. If no selector expression is specified, edge statistics are returned.
:period (Integer) —

Aggregation period in seconds.
:forecast_statistics (Boolean) —

The forecasted high and low fault count values. Forecast enabled requests require the EntitySelectorExpression ID be provided.
:next_token (String) —

Pagination token.

Returns:

(Types::GetTimeSeriesServiceStatisticsResult) —
Returns a response object which responds to the following methods:
- #time_series_service_statistics => Array<Types::TimeSeriesServiceStatistics>
- #contains_old_group_versions => Boolean
- #next_token => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-xray/client.rb', line 1475

def get_time_series_service_statistics(params = {}, options = {})
  req = build_request(:get_time_series_service_statistics, params)
  req.send_request(options)
end

#get_trace_graph(params = {}) ⇒ `Types::GetTraceGraphResult`

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_trace_graph({
  trace_ids: ["TraceId"], # required
  next_token: "String",
})

Response structure


resp.services #=> Array
resp.services[0].reference_id #=> Integer
resp.services[0].name #=> String
resp.services[0].names #=> Array
resp.services[0].names[0] #=> String
resp.services[0].root #=> Boolean
resp.services[0].account_id #=> String
resp.services[0].type #=> String
resp.services[0].state #=> String
resp.services[0].start_time #=> Time
resp.services[0].end_time #=> Time
resp.services[0].edges #=> Array
resp.services[0].edges[0].reference_id #=> Integer
resp.services[0].edges[0].start_time #=> Time
resp.services[0].edges[0].end_time #=> Time
resp.services[0].edges[0].summary_statistics.ok_count #=> Integer
resp.services[0].edges[0].summary_statistics.error_statistics.throttle_count #=> Integer
resp.services[0].edges[0].summary_statistics.error_statistics.other_count #=> Integer
resp.services[0].edges[0].summary_statistics.error_statistics.total_count #=> Integer
resp.services[0].edges[0].summary_statistics.fault_statistics.other_count #=> Integer
resp.services[0].edges[0].summary_statistics.fault_statistics.total_count #=> Integer
resp.services[0].edges[0].summary_statistics.total_count #=> Integer
resp.services[0].edges[0].summary_statistics.total_response_time #=> Float
resp.services[0].edges[0].response_time_histogram #=> Array
resp.services[0].edges[0].response_time_histogram[0].value #=> Float
resp.services[0].edges[0].response_time_histogram[0].count #=> Integer
resp.services[0].edges[0].aliases #=> Array
resp.services[0].edges[0].aliases[0].name #=> String
resp.services[0].edges[0].aliases[0].names #=> Array
resp.services[0].edges[0].aliases[0].names[0] #=> String
resp.services[0].edges[0].aliases[0].type #=> String
resp.services[0].edges[0].edge_type #=> String
resp.services[0].edges[0].received_event_age_histogram #=> Array
resp.services[0].edges[0].received_event_age_histogram[0].value #=> Float
resp.services[0].edges[0].received_event_age_histogram[0].count #=> Integer
resp.services[0].summary_statistics.ok_count #=> Integer
resp.services[0].summary_statistics.error_statistics.throttle_count #=> Integer
resp.services[0].summary_statistics.error_statistics.other_count #=> Integer
resp.services[0].summary_statistics.error_statistics.total_count #=> Integer
resp.services[0].summary_statistics.fault_statistics.other_count #=> Integer
resp.services[0].summary_statistics.fault_statistics.total_count #=> Integer
resp.services[0].summary_statistics.total_count #=> Integer
resp.services[0].summary_statistics.total_response_time #=> Float
resp.services[0].duration_histogram #=> Array
resp.services[0].duration_histogram[0].value #=> Float
resp.services[0].duration_histogram[0].count #=> Integer
resp.services[0].response_time_histogram #=> Array
resp.services[0].response_time_histogram[0].value #=> Float
resp.services[0].response_time_histogram[0].count #=> Integer
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:trace_ids (required, Array<String>) —

Trace IDs of requests for which to generate a service graph.
:next_token (String) —

Pagination token.

Returns:

(Types::GetTraceGraphResult) —
Returns a response object which responds to the following methods:
- #services => Array<Types::Service>
- #next_token => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-xray/client.rb', line 1559

def get_trace_graph(params = {}, options = {})
  req = build_request(:get_trace_graph, params)
  req.send_request(options)
end

#get_trace_summaries(params = {}) ⇒ `Types::GetTraceSummariesResult`

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 [Using Filter Expressions] in the *Amazon Web Services X-Ray Developer Guide*.

[1]: docs.aws.amazon.com/xray/latest/devguide/xray-console-filters.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_trace_summaries({
  start_time: Time.now, # required
  end_time: Time.now, # required
  time_range_type: "TraceId", # accepts TraceId, Event, Service
  sampling: false,
  sampling_strategy: {
    name: "PartialScan", # accepts PartialScan, FixedRate
    value: 1.0,
  },
  filter_expression: "FilterExpression",
  next_token: "String",
})

Response structure


resp.trace_summaries #=> Array
resp.trace_summaries[0].id #=> String
resp.trace_summaries[0].start_time #=> Time
resp.trace_summaries[0].duration #=> Float
resp.trace_summaries[0].response_time #=> Float
resp.trace_summaries[0].has_fault #=> Boolean
resp.trace_summaries[0].has_error #=> Boolean
resp.trace_summaries[0].has_throttle #=> Boolean
resp.trace_summaries[0].is_partial #=> Boolean
resp.trace_summaries[0].http.http_url #=> String
resp.trace_summaries[0].http.http_status #=> Integer
resp.trace_summaries[0].http.http_method #=> String
resp.trace_summaries[0].http.user_agent #=> String
resp.trace_summaries[0].http.client_ip #=> String
resp.trace_summaries[0].annotations #=> Hash
resp.trace_summaries[0].annotations["AnnotationKey"] #=> Array
resp.trace_summaries[0].annotations["AnnotationKey"][0].annotation_value.number_value #=> Float
resp.trace_summaries[0].annotations["AnnotationKey"][0].annotation_value.boolean_value #=> Boolean
resp.trace_summaries[0].annotations["AnnotationKey"][0].annotation_value.string_value #=> String
resp.trace_summaries[0].annotations["AnnotationKey"][0].service_ids #=> Array
resp.trace_summaries[0].annotations["AnnotationKey"][0].service_ids[0].name #=> String
resp.trace_summaries[0].annotations["AnnotationKey"][0].service_ids[0].names #=> Array
resp.trace_summaries[0].annotations["AnnotationKey"][0].service_ids[0].names[0] #=> String
resp.trace_summaries[0].annotations["AnnotationKey"][0].service_ids[0].account_id #=> String
resp.trace_summaries[0].annotations["AnnotationKey"][0].service_ids[0].type #=> String
resp.trace_summaries[0].users #=> Array
resp.trace_summaries[0].users[0].user_name #=> String
resp.trace_summaries[0].users[0].service_ids #=> Array
resp.trace_summaries[0].users[0].service_ids[0].name #=> String
resp.trace_summaries[0].users[0].service_ids[0].names #=> Array
resp.trace_summaries[0].users[0].service_ids[0].names[0] #=> String
resp.trace_summaries[0].users[0].service_ids[0].account_id #=> String
resp.trace_summaries[0].users[0].service_ids[0].type #=> String
resp.trace_summaries[0].service_ids #=> Array
resp.trace_summaries[0].service_ids[0].name #=> String
resp.trace_summaries[0].service_ids[0].names #=> Array
resp.trace_summaries[0].service_ids[0].names[0] #=> String
resp.trace_summaries[0].service_ids[0].account_id #=> String
resp.trace_summaries[0].service_ids[0].type #=> String
resp.trace_summaries[0].resource_arns #=> Array
resp.trace_summaries[0].resource_arns[0].arn #=> String
resp.trace_summaries[0].instance_ids #=> Array
resp.trace_summaries[0].instance_ids[0].id #=> String
resp.trace_summaries[0].availability_zones #=> Array
resp.trace_summaries[0].availability_zones[0].name #=> String
resp.trace_summaries[0].entry_point.name #=> String
resp.trace_summaries[0].entry_point.names #=> Array
resp.trace_summaries[0].entry_point.names[0] #=> String
resp.trace_summaries[0].entry_point.account_id #=> String
resp.trace_summaries[0].entry_point.type #=> String
resp.trace_summaries[0].fault_root_causes #=> Array
resp.trace_summaries[0].fault_root_causes[0].services #=> Array
resp.trace_summaries[0].fault_root_causes[0].services[0].name #=> String
resp.trace_summaries[0].fault_root_causes[0].services[0].names #=> Array
resp.trace_summaries[0].fault_root_causes[0].services[0].names[0] #=> String
resp.trace_summaries[0].fault_root_causes[0].services[0].type #=> String
resp.trace_summaries[0].fault_root_causes[0].services[0].account_id #=> String
resp.trace_summaries[0].fault_root_causes[0].services[0].entity_path #=> Array
resp.trace_summaries[0].fault_root_causes[0].services[0].entity_path[0].name #=> String
resp.trace_summaries[0].fault_root_causes[0].services[0].entity_path[0].exceptions #=> Array
resp.trace_summaries[0].fault_root_causes[0].services[0].entity_path[0].exceptions[0].name #=> String
resp.trace_summaries[0].fault_root_causes[0].services[0].entity_path[0].exceptions[0].message #=> String
resp.trace_summaries[0].fault_root_causes[0].services[0].entity_path[0].remote #=> Boolean
resp.trace_summaries[0].fault_root_causes[0].services[0].inferred #=> Boolean
resp.trace_summaries[0].fault_root_causes[0].client_impacting #=> Boolean
resp.trace_summaries[0].error_root_causes #=> Array
resp.trace_summaries[0].error_root_causes[0].services #=> Array
resp.trace_summaries[0].error_root_causes[0].services[0].name #=> String
resp.trace_summaries[0].error_root_causes[0].services[0].names #=> Array
resp.trace_summaries[0].error_root_causes[0].services[0].names[0] #=> String
resp.trace_summaries[0].error_root_causes[0].services[0].type #=> String
resp.trace_summaries[0].error_root_causes[0].services[0].account_id #=> String
resp.trace_summaries[0].error_root_causes[0].services[0].entity_path #=> Array
resp.trace_summaries[0].error_root_causes[0].services[0].entity_path[0].name #=> String
resp.trace_summaries[0].error_root_causes[0].services[0].entity_path[0].exceptions #=> Array
resp.trace_summaries[0].error_root_causes[0].services[0].entity_path[0].exceptions[0].name #=> String
resp.trace_summaries[0].error_root_causes[0].services[0].entity_path[0].exceptions[0].message #=> String
resp.trace_summaries[0].error_root_causes[0].services[0].entity_path[0].remote #=> Boolean
resp.trace_summaries[0].error_root_causes[0].services[0].inferred #=> Boolean
resp.trace_summaries[0].error_root_causes[0].client_impacting #=> Boolean
resp.trace_summaries[0].response_time_root_causes #=> Array
resp.trace_summaries[0].response_time_root_causes[0].services #=> Array
resp.trace_summaries[0].response_time_root_causes[0].services[0].name #=> String
resp.trace_summaries[0].response_time_root_causes[0].services[0].names #=> Array
resp.trace_summaries[0].response_time_root_causes[0].services[0].names[0] #=> String
resp.trace_summaries[0].response_time_root_causes[0].services[0].type #=> String
resp.trace_summaries[0].response_time_root_causes[0].services[0].account_id #=> String
resp.trace_summaries[0].response_time_root_causes[0].services[0].entity_path #=> Array
resp.trace_summaries[0].response_time_root_causes[0].services[0].entity_path[0].name #=> String
resp.trace_summaries[0].response_time_root_causes[0].services[0].entity_path[0].coverage #=> Float
resp.trace_summaries[0].response_time_root_causes[0].services[0].entity_path[0].remote #=> Boolean
resp.trace_summaries[0].response_time_root_causes[0].services[0].inferred #=> Boolean
resp.trace_summaries[0].response_time_root_causes[0].client_impacting #=> Boolean
resp.trace_summaries[0].revision #=> Integer
resp.trace_summaries[0].matched_event_time #=> Time
resp.approximate_time #=> Time
resp.traces_processed_count #=> Integer
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:start_time (required, Time, DateTime, Date, Integer, String) —

The start of the time frame for which to retrieve traces.
:end_time (required, Time, DateTime, Date, Integer, String) —

The end of the time frame for which to retrieve traces.
:time_range_type (String) —

A parameter to indicate whether to query trace summaries by TraceId, Event (trace update time), or Service (segment end time).
:sampling (Boolean) —

Set to ‘true` to get summaries for only a subset of available traces.
:sampling_strategy (Types::SamplingStrategy) —

A parameter to indicate whether to enable sampling on trace summaries. Input parameters are Name and Value.
:filter_expression (String) —

Specify a filter expression to retrieve trace summaries for services or requests that meet certain requirements.
:next_token (String) —

Specify the pagination token returned by a previous request to retrieve the next page of results.

Returns:

(Types::GetTraceSummariesResult) —
Returns a response object which responds to the following methods:
- #trace_summaries => Array<Types::TraceSummary>
- #approximate_time => Time
- #traces_processed_count => Integer
- #next_token => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-xray/client.rb', line 1742

def get_trace_summaries(params = {}, options = {})
  req = build_request(:get_trace_summaries, params)
  req.send_request(options)
end

#list_resource_policies(params = {}) ⇒ `Types::ListResourcePoliciesResult`

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_resource_policies({
  next_token: "ResourcePolicyNextToken",
})

Response structure


resp.resource_policies #=> Array
resp.resource_policies[0].policy_name #=> String
resp.resource_policies[0].policy_document #=> String
resp.resource_policies[0].policy_revision_id #=> String
resp.resource_policies[0].last_updated_time #=> Time
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:next_token (String) —

Not currently supported.

Returns:

(Types::ListResourcePoliciesResult) —
Returns a response object which responds to the following methods:
- #resource_policies => Array<Types::ResourcePolicy>
- #next_token => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-xray/client.rb', line 1779

def list_resource_policies(params = {}, options = {})
  req = build_request(:list_resource_policies, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ `Types::ListTagsForResourceResponse`

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "AmazonResourceName", # required
  next_token: "String",
})

Response structure


resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:resource_arn (required, String) —

The Amazon Resource Number (ARN) of an X-Ray group or sampling rule.
:next_token (String) —

A pagination token. If multiple pages of results are returned, use the ‘NextToken` value returned with the current page of results as the value of this parameter to get the next page of results.

Returns:

(Types::ListTagsForResourceResponse) —
Returns a response object which responds to the following methods:
- #tags => Array<Types::Tag>
- #next_token => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-xray/client.rb', line 1820

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#put_encryption_config(params = {}) ⇒ `Types::PutEncryptionConfigResult`

Updates the encryption configuration for X-Ray data.

Examples:

Request syntax with placeholder values


resp = client.put_encryption_config({
  key_id: "EncryptionKeyId",
  type: "NONE", # required, accepts NONE, KMS
})

Response structure


resp.encryption_config.key_id #=> String
resp.encryption_config.status #=> String, one of "UPDATING", "ACTIVE"
resp.encryption_config.type #=> String, one of "NONE", "KMS"

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:key_id (String) —
An Amazon Web Services KMS key in one of the following formats:
- Alias - The name of the key. For example, ‘alias/MyKey`.
- **Key ID** - The KMS key ID of the key. For example, ‘ae4aa6d49-a4d8-9df9-a475-4ff6d7898456`. Amazon Web Services X-Ray does not support asymmetric KMS keys.
- ARN - The full Amazon Resource Name of the key ID or alias. For example, ‘arn:aws:kms:us-east-2:123456789012:key/ae4aa6d49-a4d8-9df9-a475-4ff6d7898456`. Use this format to specify a key in a different account.
Omit this key if you set ‘Type` to `NONE`.
:type (required, String) —

The type of encryption. Set to ‘KMS` to use your own key for encryption. Set to `NONE` for default encryption.

Returns:

(Types::PutEncryptionConfigResult) —
Returns a response object which responds to the following methods:
- #encryption_config => Types::EncryptionConfig

See Also:

AWS API Documentation

# File 'lib/aws-sdk-xray/client.rb', line 1868

def put_encryption_config(params = {}, options = {})
  req = build_request(:put_encryption_config, params)
  req.send_request(options)
end

#put_resource_policy(params = {}) ⇒ `Types::PutResourcePolicyResult`

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.

Examples:

Request syntax with placeholder values


resp = client.put_resource_policy({
  policy_name: "PolicyName", # required
  policy_document: "PolicyDocument", # required
  policy_revision_id: "PolicyRevisionId",
  bypass_policy_lockout_check: false,
})

Response structure


resp.resource_policy.policy_name #=> String
resp.resource_policy.policy_document #=> String
resp.resource_policy.policy_revision_id #=> String
resp.resource_policy.last_updated_time #=> Time

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:policy_name (required, String) —

The name of the resource policy. Must be unique within a specific Amazon Web Services account.
:policy_document (required, String) —

The resource policy document, which can be up to 5kb in size.
:policy_revision_id (String) —

Specifies a specific policy revision, to ensure an atomic create operation. By default the resource policy is created if it does not exist, or updated with an incremented revision id. The revision id is unique to each policy in the account.

If the policy revision id does not match the latest revision id, the operation will fail with an ‘InvalidPolicyRevisionIdException` exception. You can also provide a `PolicyRevisionId` of 0. In this case, the operation will fail with an `InvalidPolicyRevisionIdException` exception if a resource policy with the same name already exists.
:bypass_policy_lockout_check (Boolean) —

A flag to indicate whether to bypass the resource policy lockout safety check.

Setting this value to true increases the risk that the policy becomes unmanageable. Do not set this value to true indiscriminately.

Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent ‘PutResourcePolicy` request.

The default value is false.

Returns:

(Types::PutResourcePolicyResult) —
Returns a response object which responds to the following methods:
- #resource_policy => Types::ResourcePolicy

See Also:

AWS API Documentation

# File 'lib/aws-sdk-xray/client.rb', line 1937

def put_resource_policy(params = {}, options = {})
  req = build_request(:put_resource_policy, params)
  req.send_request(options)
end

#put_telemetry_records(params = {}) ⇒ `Struct`

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

Examples:

Request syntax with placeholder values


resp = client.put_telemetry_records({
  telemetry_records: [ # required
    {
      timestamp: Time.now, # required
      segments_received_count: 1,
      segments_sent_count: 1,
      segments_spillover_count: 1,
      segments_rejected_count: 1,
      backend_connection_errors: {
        timeout_count: 1,
        connection_refused_count: 1,
        http_code_4_xx_count: 1,
        http_code_5_xx_count: 1,
        unknown_host_count: 1,
        other_count: 1,
      },
    },
  ],
  ec2_instance_id: "EC2InstanceId",
  hostname: "Hostname",
  resource_arn: "ResourceARN",
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:telemetry_records (required, Array<Types::TelemetryRecord>)
:ec2_instance_id (String)
:hostname (String)
:resource_arn (String)

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-xray/client.rb', line 1983

def put_telemetry_records(params = {}, options = {})
  req = build_request(:put_telemetry_records, params)
  req.send_request(options)
end

#put_trace_segments(params = {}) ⇒ `Types::PutTraceSegmentsResult`

Uploads segment documents to Amazon Web Services X-Ray. The [X-Ray SDK] generates segment documents and sends them to the X-Ray daemon, which uploads them in batches. 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. This 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.

[1]: docs.aws.amazon.com/xray/index.html [2]: docs.aws.amazon.com/xray/latest/devguide/xray-api-segmentdocuments.html

Examples:

Request syntax with placeholder values


resp = client.put_trace_segments({
  trace_segment_documents: ["TraceSegmentDocument"], # required
})

Response structure


resp.unprocessed_trace_segments #=> Array
resp.unprocessed_trace_segments[0].id #=> String
resp.unprocessed_trace_segments[0].error_code #=> String
resp.unprocessed_trace_segments[0].message #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:trace_segment_documents (required, Array<String>) —

A string containing a JSON document defining one or more segments or subsegments.

Returns:

(Types::PutTraceSegmentsResult) —
Returns a response object which responds to the following methods:
- #unprocessed_trace_segments => Array<Types::UnprocessedTraceSegment>

See Also:

AWS API Documentation

# File 'lib/aws-sdk-xray/client.rb', line 2066

def put_trace_segments(params = {}, options = {})
  req = build_request(:put_trace_segments, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ `Struct`

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

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "AmazonResourceName", # required
  tags: [ # required
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:resource_arn (required, String) —

The Amazon Resource Number (ARN) of an X-Ray group or sampling rule.
:tags (required, Array<Types::Tag>) —
A map that contains one or more tag keys and tag values to attach to an X-Ray group or sampling rule. For more information about ways to use tags, see [Tagging Amazon Web Services resources] in the *Amazon Web Services General Reference*.

The following restrictions apply to tags:
- Maximum number of user-applied tags per resource: 50
- Maximum tag key length: 128 Unicode characters
- Maximum tag value length: 256 Unicode characters
- Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: _ . : / = + - and @
- Tag keys and values are case sensitive.
- Don’t use ‘aws:` as a prefix for keys; it’s reserved for Amazon Web Services use. You cannot edit or delete system tags.
[1]: docs.aws.amazon.com/general/latest/gr/aws_tagging.html

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-xray/client.rb', line 2121

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ `Struct`

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).

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "AmazonResourceName", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:resource_arn (required, String) —

The Amazon Resource Number (ARN) of an X-Ray group or sampling rule.
:tag_keys (required, Array<String>) —

Keys for one or more tags that you want to remove from an X-Ray group or sampling rule.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-xray/client.rb', line 2149

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_group(params = {}) ⇒ `Types::UpdateGroupResult`

Updates a group resource.

Examples:

Request syntax with placeholder values


resp = client.update_group({
  group_name: "GroupName",
  group_arn: "GroupARN",
  filter_expression: "FilterExpression",
  insights_configuration: {
    insights_enabled: false,
    notifications_enabled: false,
  },
})

Response structure


resp.group.group_name #=> String
resp.group.group_arn #=> String
resp.group.filter_expression #=> String
resp.group.insights_configuration.insights_enabled #=> Boolean
resp.group.insights_configuration.notifications_enabled #=> Boolean

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:group_name (String) —

The case-sensitive name of the group.
:group_arn (String) —

The ARN that was generated upon creation.
:filter_expression (String) —

The updated filter expression defining criteria by which to group traces.
:insights_configuration (Types::InsightsConfiguration) —
The structure containing configurations related to insights.
- The InsightsEnabled boolean can be set to true to enable insights for the group or false to disable insights for the group.
- The NotificationsEnabled boolean can be set to true to enable insights notifications for the group. Notifications can only be enabled on a group with InsightsEnabled set to true.

Returns:

(Types::UpdateGroupResult) —
Returns a response object which responds to the following methods:
- #group => Types::Group

See Also:

AWS API Documentation

# File 'lib/aws-sdk-xray/client.rb', line 2204

def update_group(params = {}, options = {})
  req = build_request(:update_group, params)
  req.send_request(options)
end

#update_sampling_rule(params = {}) ⇒ `Types::UpdateSamplingRuleResult`

Modifies a sampling rule’s configuration.

Examples:

Request syntax with placeholder values


resp = client.update_sampling_rule({
  sampling_rule_update: { # required
    rule_name: "RuleName",
    rule_arn: "String",
    resource_arn: "ResourceARN",
    priority: 1,
    fixed_rate: 1.0,
    reservoir_size: 1,
    host: "Host",
    service_name: "ServiceName",
    service_type: "ServiceType",
    http_method: "HTTPMethod",
    url_path: "URLPath",
    attributes: {
      "AttributeKey" => "AttributeValue",
    },
  },
})

Response structure


resp.sampling_rule_record.sampling_rule.rule_name #=> String
resp.sampling_rule_record.sampling_rule.rule_arn #=> String
resp.sampling_rule_record.sampling_rule.resource_arn #=> String
resp.sampling_rule_record.sampling_rule.priority #=> Integer
resp.sampling_rule_record.sampling_rule.fixed_rate #=> Float
resp.sampling_rule_record.sampling_rule.reservoir_size #=> Integer
resp.sampling_rule_record.sampling_rule.service_name #=> String
resp.sampling_rule_record.sampling_rule.service_type #=> String
resp.sampling_rule_record.sampling_rule.host #=> String
resp.sampling_rule_record.sampling_rule.http_method #=> String
resp.sampling_rule_record.sampling_rule.url_path #=> String
resp.sampling_rule_record.sampling_rule.version #=> Integer
resp.sampling_rule_record.sampling_rule.attributes #=> Hash
resp.sampling_rule_record.sampling_rule.attributes["AttributeKey"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
resp.sampling_rule_record.created_at #=> Time
resp.sampling_rule_record.modified_at #=> Time

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:sampling_rule_update (required, Types::SamplingRuleUpdate) —

The rule and fields to change.

Returns:

(Types::UpdateSamplingRuleResult) —
Returns a response object which responds to the following methods:
- #sampling_rule_record => Types::SamplingRuleRecord

See Also:

AWS API Documentation

# File 'lib/aws-sdk-xray/client.rb', line 2262

def update_sampling_rule(params = {}, options = {})
  req = build_request(:update_sampling_rule, params)
  req.send_request(options)
end

#waiter_names ⇒ `Object`

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated.



2291
2292
2293

# File 'lib/aws-sdk-xray/client.rb', line 2291

def waiter_names
  []
end

Class: Aws::XRay::Client

Overview

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Class Attribute Details

.identifier ⇒ Object (readonly)

Class Method Details

.errors_module ⇒ Object

Instance Method Details

#batch_get_traces(params = {}) ⇒ Types::BatchGetTracesResult

#build_request(operation_name, params = {}) ⇒ Object

#create_group(params = {}) ⇒ Types::CreateGroupResult

#create_sampling_rule(params = {}) ⇒ Types::CreateSamplingRuleResult

#delete_group(params = {}) ⇒ Struct

#delete_resource_policy(params = {}) ⇒ Struct

#delete_sampling_rule(params = {}) ⇒ Types::DeleteSamplingRuleResult

#get_encryption_config(params = {}) ⇒ Types::GetEncryptionConfigResult

#get_group(params = {}) ⇒ Types::GetGroupResult

#get_groups(params = {}) ⇒ Types::GetGroupsResult

#get_insight(params = {}) ⇒ Types::GetInsightResult

#get_insight_events(params = {}) ⇒ Types::GetInsightEventsResult

#get_insight_impact_graph(params = {}) ⇒ Types::GetInsightImpactGraphResult

#get_insight_summaries(params = {}) ⇒ Types::GetInsightSummariesResult

#get_sampling_rules(params = {}) ⇒ Types::GetSamplingRulesResult

#get_sampling_statistic_summaries(params = {}) ⇒ Types::GetSamplingStatisticSummariesResult

#get_sampling_targets(params = {}) ⇒ Types::GetSamplingTargetsResult

#get_service_graph(params = {}) ⇒ Types::GetServiceGraphResult

#get_time_series_service_statistics(params = {}) ⇒ Types::GetTimeSeriesServiceStatisticsResult

#get_trace_graph(params = {}) ⇒ Types::GetTraceGraphResult

#get_trace_summaries(params = {}) ⇒ Types::GetTraceSummariesResult

#list_resource_policies(params = {}) ⇒ Types::ListResourcePoliciesResult

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

#put_encryption_config(params = {}) ⇒ Types::PutEncryptionConfigResult

#put_resource_policy(params = {}) ⇒ Types::PutResourcePolicyResult

#put_telemetry_records(params = {}) ⇒ Struct

#put_trace_segments(params = {}) ⇒ Types::PutTraceSegmentsResult

#tag_resource(params = {}) ⇒ Struct

#untag_resource(params = {}) ⇒ Struct

#update_group(params = {}) ⇒ Types::UpdateGroupResult

#update_sampling_rule(params = {}) ⇒ Types::UpdateSamplingRuleResult

#waiter_names ⇒ Object

#initialize(options) ⇒ `Client`

.identifier ⇒ `Object` (readonly)

.errors_module ⇒ `Object`

#batch_get_traces(params = {}) ⇒ `Types::BatchGetTracesResult`

#build_request(operation_name, params = {}) ⇒ `Object`

#create_group(params = {}) ⇒ `Types::CreateGroupResult`

#create_sampling_rule(params = {}) ⇒ `Types::CreateSamplingRuleResult`

#delete_group(params = {}) ⇒ `Struct`

#delete_resource_policy(params = {}) ⇒ `Struct`

#delete_sampling_rule(params = {}) ⇒ `Types::DeleteSamplingRuleResult`

#get_encryption_config(params = {}) ⇒ `Types::GetEncryptionConfigResult`

#get_group(params = {}) ⇒ `Types::GetGroupResult`

#get_groups(params = {}) ⇒ `Types::GetGroupsResult`

#get_insight(params = {}) ⇒ `Types::GetInsightResult`

#get_insight_events(params = {}) ⇒ `Types::GetInsightEventsResult`

#get_insight_impact_graph(params = {}) ⇒ `Types::GetInsightImpactGraphResult`

#get_insight_summaries(params = {}) ⇒ `Types::GetInsightSummariesResult`

#get_sampling_rules(params = {}) ⇒ `Types::GetSamplingRulesResult`

#get_sampling_statistic_summaries(params = {}) ⇒ `Types::GetSamplingStatisticSummariesResult`

#get_sampling_targets(params = {}) ⇒ `Types::GetSamplingTargetsResult`

#get_service_graph(params = {}) ⇒ `Types::GetServiceGraphResult`

#get_time_series_service_statistics(params = {}) ⇒ `Types::GetTimeSeriesServiceStatisticsResult`

#get_trace_graph(params = {}) ⇒ `Types::GetTraceGraphResult`

#get_trace_summaries(params = {}) ⇒ `Types::GetTraceSummariesResult`

#list_resource_policies(params = {}) ⇒ `Types::ListResourcePoliciesResult`

#list_tags_for_resource(params = {}) ⇒ `Types::ListTagsForResourceResponse`

#put_encryption_config(params = {}) ⇒ `Types::PutEncryptionConfigResult`

#put_resource_policy(params = {}) ⇒ `Types::PutResourcePolicyResult`

#put_telemetry_records(params = {}) ⇒ `Struct`

#put_trace_segments(params = {}) ⇒ `Types::PutTraceSegmentsResult`

#tag_resource(params = {}) ⇒ `Struct`

#untag_resource(params = {}) ⇒ `Struct`

#update_group(params = {}) ⇒ `Types::UpdateGroupResult`

#update_sampling_rule(params = {}) ⇒ `Types::UpdateSamplingRuleResult`

#waiter_names ⇒ `Object`