Class: Aws::OAM::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
ClientStubs
Defined in:
lib/aws-sdk-oam/client.rb

Overview

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

client = Aws::OAM::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

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

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 used for authentication. This can be any class that includes and implements ‘Aws::CredentialProvider`, or 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`, `:session_token`, and `:account_id` options.

    • ‘ENV`, `ENV`, `ENV`, and `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::InstanceProfileCredentials` 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:

  • :access_key_id (String)
  • :account_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.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: ‘sigv4`, `sigv4a`, `httpBearerAuth`, and `noAuth`. When set using `ENV` or in shared config as `auth_scheme_preference`, the value should be a comma-separated list.

  • :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 —

    When ‘true`, the SDK will not prepend the modeled host prefix to the endpoint.

  • :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_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • ‘when_supported` - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the `httpChecksum` trait where `requestChecksumRequired` is `true` and/or a `requestAlgorithmMember` is modeled.

    • ‘when_required` - When set, a checksum will only be calculated for request payloads of operations modeled with the `httpChecksum` trait where `requestChecksumRequired` is `true` or where a `requestAlgorithmMember` is modeled and supplied.

  • :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.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • ‘when_supported` - (default) When set, checksum validation is performed on all response payloads of operations modeled with the `httpChecksum` trait where `responseAlgorithms` is modeled, except when no modeled checksum algorithms are supported.

    • ‘when_required` - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the `requestValidationModeMember` member is set to `ENABLED`.

  • :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:

  • :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) —

    Your Bearer token used for authentication. This can be any class that includes and implements ‘Aws::TokenProvider`, or 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::OAM::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to ‘#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::OAM::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_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :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.



473
474
475
 
# File 'lib/aws-sdk-oam/client.rb', line 473

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. 



1368
1369
1370
 
# File 'lib/aws-sdk-oam/client.rb', line 1368

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. 



1371
1372
1373
 
# File 'lib/aws-sdk-oam/client.rb', line 1371

def errors_module
  Errors
end

Instance Method Details

#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: {}) 


1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
 
# File 'lib/aws-sdk-oam/client.rb', line 1341

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::OAM')
  )
  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-oam'
  context[:gem_version] = '1.43.0'
  Seahorse::Client::Request.new(handlers, context)
end

#create_link(params = {}) ⇒ Types::CreateLinkOutput

Creates a link between a source account and a sink that you have created in a monitoring account. After the link is created, data is sent from the source account to the monitoring account. When you create a link, you can optionally specify filters that specify which metric namespaces and which log groups are shared from the source account to the monitoring account.

Before you create a link, you must create a sink in the monitoring account and create a sink policy in that account. The sink policy must permit the source account to link to it. You can grant permission to source accounts by granting permission to an entire organization or to individual accounts.

For more information, see [CreateSink] and [PutSinkPolicy].

Each monitoring account can be linked to as many as 100,000 source accounts.

Each source account can be linked to as many as five monitoring accounts.

[1]: docs.aws.amazon.com/OAM/latest/APIReference/API_CreateSink.html [2]: docs.aws.amazon.com/OAM/latest/APIReference/API_PutSinkPolicy.html

Examples:

Request syntax with placeholder values


resp = client.create_link({
  label_template: "LabelTemplate", # required
  link_configuration: {
    log_group_configuration: {
      filter: "LogsFilter", # required
    },
    metric_configuration: {
      filter: "MetricsFilter", # required
    },
  },
  resource_types: ["AWS::CloudWatch::Metric"], # required, accepts AWS::CloudWatch::Metric, AWS::Logs::LogGroup, AWS::XRay::Trace, AWS::ApplicationInsights::Application, AWS::InternetMonitor::Monitor, AWS::ApplicationSignals::Service, AWS::ApplicationSignals::ServiceLevelObjective
  sink_identifier: "ResourceIdentifier", # required
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.arn #=> String
resp.id #=> String
resp.label #=> String
resp.label_template #=> String
resp.link_configuration.log_group_configuration.filter #=> String
resp.link_configuration.metric_configuration.filter #=> String
resp.resource_types #=> Array
resp.resource_types[0] #=> String
resp.sink_arn #=> String
resp.tags #=> Hash
resp.tags["String"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :label_template (required, String) —

    Specify a friendly human-readable name to use to identify this source account when you are viewing data from it in the monitoring account.

    You can use a custom label or use the following variables:

    • ‘$AccountName` is the name of the account

    • ‘$AccountEmail` is the globally unique email address of the account

    • ‘$AccountEmailNoDomain` is the email address of the account without the domain name

    <note markdown=“1”> In the Amazon Web Services GovCloud (US-East) and Amazon Web Services GovCloud (US-West) Regions, the only supported option is to use custom labels, and the ‘$AccountName`, `$AccountEmail`, and `$AccountEmailNoDomain` variables all resolve as account-id instead of the specified variable.

    </note>
  • :link_configuration (Types::LinkConfiguration) —

    Use this structure to optionally create filters that specify that only some metric namespaces or log groups are to be shared from the source account to the monitoring account.

  • :resource_types (required, Array<String>) —

    An array of strings that define which types of data that the source account shares with the monitoring account.

  • :sink_identifier (required, String) —

    The ARN of the sink to use to create this link. You can use

    ListSinks][1

    to find the ARNs of sinks.

    For more information about sinks, see [CreateSink].

    [1]: docs.aws.amazon.com/OAM/latest/APIReference/API_ListSinks.html [2]: docs.aws.amazon.com/OAM/latest/APIReference/API_CreateSink.html

  • :tags (Hash<String,String>) —

    Assigns one or more tags (key-value pairs) to the link.

    Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

    For more information about using tags to control access, see [Controlling access to Amazon Web Services resources using tags].

    [1]: docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html

Returns:

See Also:



608
609
610
611
 
# File 'lib/aws-sdk-oam/client.rb', line 608

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

#create_sink(params = {}) ⇒ Types::CreateSinkOutput

Use this to create a sink in the current account, so that it can be used as a monitoring account in CloudWatch cross-account observability. A sink is a resource that represents an attachment point in a monitoring account. Source accounts can link to the sink to send observability data.

After you create a sink, you must create a sink policy that allows source accounts to attach to it. For more information, see [PutSinkPolicy].

Each account can contain one sink per Region. If you delete a sink, you can then create a new one in that Region.

[1]: docs.aws.amazon.com/OAM/latest/APIReference/API_PutSinkPolicy.html

Examples:

Request syntax with placeholder values


resp = client.create_sink({
  name: "SinkName", # required
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.arn #=> String
resp.id #=> String
resp.name #=> String
resp.tags #=> Hash
resp.tags["String"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    A name for the sink.

  • :tags (Hash<String,String>) —

    Assigns one or more tags (key-value pairs) to the link.

    Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

    For more information about using tags to control access, see [Controlling access to Amazon Web Services resources using tags].

    [1]: docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html

Returns:

See Also:



675
676
677
678
 
# File 'lib/aws-sdk-oam/client.rb', line 675

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

#delete_link(params = {}) ⇒ Struct

Deletes a link between a monitoring account sink and a source account. You must run this operation in the source account.

Examples:

Request syntax with placeholder values


resp = client.delete_link({
  identifier: "ResourceIdentifier", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :identifier (required, String) —

    The ARN of the link to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



698
699
700
701
 
# File 'lib/aws-sdk-oam/client.rb', line 698

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

#delete_sink(params = {}) ⇒ Struct

Deletes a sink. You must delete all links to a sink before you can delete that sink.

Examples:

Request syntax with placeholder values


resp = client.delete_sink({
  identifier: "ResourceIdentifier", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :identifier (required, String) —

    The ARN of the sink to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



721
722
723
724
 
# File 'lib/aws-sdk-oam/client.rb', line 721

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

#get_link(params = {}) ⇒ Types::GetLinkOutput

Returns complete information about one link.

To use this operation, provide the link ARN. To retrieve a list of link ARNs, use [ListLinks].

[1]: docs.aws.amazon.com/OAM/latest/APIReference/API_ListLinks.html

Examples:

Request syntax with placeholder values


resp = client.get_link({
  identifier: "ResourceIdentifier", # required
  include_tags: false,
})

Response structure


resp.arn #=> String
resp.id #=> String
resp.label #=> String
resp.label_template #=> String
resp.link_configuration.log_group_configuration.filter #=> String
resp.link_configuration.metric_configuration.filter #=> String
resp.resource_types #=> Array
resp.resource_types[0] #=> String
resp.sink_arn #=> String
resp.tags #=> Hash
resp.tags["String"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :identifier (required, String) —

    The ARN of the link to retrieve information for.

  • :include_tags (Boolean) —

    Specifies whether to include the tags associated with the link in the response. When ‘IncludeTags` is set to `true` and the caller has the required permission, `oam:ListTagsForResource`, the API will return the tags for the specified resource. If the caller doesn’t have the required permission, ‘oam:ListTagsForResource`, the API will raise an exception.

    The default value is ‘false`.

Returns:

See Also:



784
785
786
787
 
# File 'lib/aws-sdk-oam/client.rb', line 784

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

#get_sink(params = {}) ⇒ Types::GetSinkOutput

Returns complete information about one monitoring account sink.

To use this operation, provide the sink ARN. To retrieve a list of sink ARNs, use [ListSinks].

[1]: docs.aws.amazon.com/OAM/latest/APIReference/API_ListSinks.html

Examples:

Request syntax with placeholder values


resp = client.get_sink({
  identifier: "ResourceIdentifier", # required
  include_tags: false,
})

Response structure


resp.arn #=> String
resp.id #=> String
resp.name #=> String
resp.tags #=> Hash
resp.tags["String"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :identifier (required, String) —

    The ARN of the sink to retrieve information for.

  • :include_tags (Boolean) —

    Specifies whether to include the tags associated with the sink in the response. When ‘IncludeTags` is set to `true` and the caller has the required permission, `oam:ListTagsForResource`, the API will return the tags for the specified resource. If the caller doesn’t have the required permission, ‘oam:ListTagsForResource`, the API will raise an exception.

    The default value is ‘false`.

Returns:

See Also:



837
838
839
840
 
# File 'lib/aws-sdk-oam/client.rb', line 837

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

#get_sink_policy(params = {}) ⇒ Types::GetSinkPolicyOutput

Returns the current sink policy attached to this sink. The sink policy specifies what accounts can attach to this sink as source accounts, and what types of data they can share.

Examples:

Request syntax with placeholder values


resp = client.get_sink_policy({
  sink_identifier: "ResourceIdentifier", # required
})

Response structure


resp.policy #=> String
resp.sink_arn #=> String
resp.sink_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :sink_identifier (required, String) —

    The ARN of the sink to retrieve the policy of.

Returns:

See Also:



871
872
873
874
 
# File 'lib/aws-sdk-oam/client.rb', line 871

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

#list_attached_links(params = {}) ⇒ Types::ListAttachedLinksOutput

Returns a list of source account links that are linked to this monitoring account sink.

To use this operation, provide the sink ARN. To retrieve a list of sink ARNs, use [ListSinks].

To find a list of links for one source account, use [ListLinks].

[1]: docs.aws.amazon.com/OAM/latest/APIReference/API_ListSinks.html [2]: docs.aws.amazon.com/OAM/latest/APIReference/API_ListLinks.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.list_attached_links({
  max_results: 1,
  next_token: "NextToken",
  sink_identifier: "ResourceIdentifier", # required
})

Response structure


resp.items #=> Array
resp.items[0].label #=> String
resp.items[0].link_arn #=> String
resp.items[0].resource_types #=> Array
resp.items[0].resource_types[0] #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    Limits the number of returned links to the specified number.

  • :next_token (String) —

    The token for the next set of items to return. You received this token from a previous call.

  • :sink_identifier (required, String) —

    The ARN of the sink that you want to retrieve links for.

Returns:

See Also:



927
928
929
930
 
# File 'lib/aws-sdk-oam/client.rb', line 927

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

#list_links(params = {}) ⇒ Types::ListLinksOutput

Use this operation in a source account to return a list of links to monitoring account sinks that this source account has.

To find a list of links for one monitoring account sink, use

ListAttachedLinks][1

from within the monitoring account.

[1]: docs.aws.amazon.com/OAM/latest/APIReference/API_ListAttachedLinks.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.list_links({
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.items #=> Array
resp.items[0].arn #=> String
resp.items[0].id #=> String
resp.items[0].label #=> String
resp.items[0].resource_types #=> Array
resp.items[0].resource_types[0] #=> String
resp.items[0].sink_arn #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    Limits the number of returned links to the specified number.

  • :next_token (String) —

    The token for the next set of items to return. You received this token from a previous call.

Returns:

See Also:



978
979
980
981
 
# File 'lib/aws-sdk-oam/client.rb', line 978

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

#list_sinks(params = {}) ⇒ Types::ListSinksOutput

Use this operation in a monitoring account to return the list of sinks created in that 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_sinks({
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.items #=> Array
resp.items[0].arn #=> String
resp.items[0].id #=> String
resp.items[0].name #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    Limits the number of returned links to the specified number.

  • :next_token (String) —

    The token for the next set of items to return. You received this token from a previous call.

Returns:

See Also:



1019
1020
1021
1022
 
# File 'lib/aws-sdk-oam/client.rb', line 1019

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

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

Displays the tags associated with a resource. Both sinks and links support tagging.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "Arn", # required
})

Response structure


resp.tags #=> Hash
resp.tags["String"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the resource that you want to view tags for.

    The ARN format of a sink is ‘arn:aws:oam:Region:account-id:sink/sink-id `

    The ARN format of a link is ‘arn:aws:oam:Region:account-id:link/link-id `

    For more information about ARN format, see [CloudWatch Logs resources and operations].

    Unlike tagging permissions in other Amazon Web Services services, to retrieve the list of tags for links or sinks you must have the ‘oam:RequestTag` permission. The `aws:ReguestTag` permission does not allow you to tag and untag links and sinks.

    [1]: docs.aws.amazon.com/AmazonCloudWatch/latest/logs/iam-access-control-overview-cwl.html

Returns:

See Also:



1067
1068
1069
1070
 
# File 'lib/aws-sdk-oam/client.rb', line 1067

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

#put_sink_policy(params = {}) ⇒ Types::PutSinkPolicyOutput

Creates or updates the resource policy that grants permissions to source accounts to link to the monitoring account sink. When you create a sink policy, you can grant permissions to all accounts in an organization or to individual accounts.

You can also use a sink policy to limit the types of data that is shared. The six types of services with their respective resource types that you can allow or deny are:

  • Metrics - Specify with ‘AWS::CloudWatch::Metric`

  • **Log groups** - Specify with ‘AWS::Logs::LogGroup`

  • Traces - Specify with ‘AWS::XRay::Trace`

  • **Application Insights - Applications** - Specify with ‘AWS::ApplicationInsights::Application`

  • **Internet Monitor** - Specify with ‘AWS::InternetMonitor::Monitor`

  • **Application Signals** - Specify with ‘AWS::ApplicationSignals::Service` and `AWS::ApplicationSignals::ServiceLevelObjective`

See the examples in this section to see how to specify permitted source accounts and data types.

Examples:

Request syntax with placeholder values


resp = client.put_sink_policy({
  policy: "SinkPolicy", # required
  sink_identifier: "ResourceIdentifier", # required
})

Response structure


resp.policy #=> String
resp.sink_arn #=> String
resp.sink_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :policy (required, String) —

    The JSON policy to use. If you are updating an existing policy, the entire existing policy is replaced by what you specify here.

    The policy must be in JSON string format with quotation marks escaped and no newlines.

    For examples of different types of policies, see the Examples section on this page.

  • :sink_identifier (required, String) —

    The ARN of the sink to attach this policy to.

Returns:

See Also:



1135
1136
1137
1138
 
# File 'lib/aws-sdk-oam/client.rb', line 1135

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

#tag_resource(params = {}) ⇒ Struct

Assigns one or more tags (key-value pairs) to the specified resource. Both sinks and links can be tagged.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

Tags don’t have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.

You can use the ‘TagResource` action with a resource that already has tags. If you specify a new tag key for the alarm, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces the previous value for that tag.

You can associate as many as 50 tags with a resource.

Unlike tagging permissions in other Amazon Web Services services, to tag or untag links and sinks you must have the ‘oam:ResourceTag` permission. The `iam:ResourceTag` permission does not allow you to tag and untag links and sinks.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "Arn", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the resource that you’re adding tags to.

    The ARN format of a sink is ‘arn:aws:oam:Region:account-id:sink/sink-id `

    The ARN format of a link is ‘arn:aws:oam:Region:account-id:link/link-id `

    For more information about ARN format, see [CloudWatch Logs resources and operations].

    [1]: docs.aws.amazon.com/AmazonCloudWatch/latest/logs/iam-access-control-overview-cwl.html

  • :tags (required, Hash<String,String>) —

    The list of key-value pairs to associate with the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1197
1198
1199
1200
 
# File 'lib/aws-sdk-oam/client.rb', line 1197

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

#untag_resource(params = {}) ⇒ Struct

Removes one or more tags from the specified resource.

Unlike tagging permissions in other Amazon Web Services services, to tag or untag links and sinks you must have the ‘oam:ResourceTag` permission. The `iam:TagResource` permission does not allow you to tag and untag links and sinks.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the resource that you’re removing tags from.

    The ARN format of a sink is ‘arn:aws:oam:Region:account-id:sink/sink-id `

    The ARN format of a link is ‘arn:aws:oam:Region:account-id:link/link-id `

    For more information about ARN format, see [CloudWatch Logs resources and operations].

    [1]: docs.aws.amazon.com/AmazonCloudWatch/latest/logs/iam-access-control-overview-cwl.html

  • :tag_keys (required, Array<String>) —

    The list of tag keys to remove from the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1241
1242
1243
1244
 
# File 'lib/aws-sdk-oam/client.rb', line 1241

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

#update_link(params = {}) ⇒ Types::UpdateLinkOutput

Use this operation to change what types of data are shared from a source account to its linked monitoring account sink. You can’t change the sink or change the monitoring account with this operation.

When you update a link, you can optionally specify filters that specify which metric namespaces and which log groups are shared from the source account to the monitoring account.

To update the list of tags associated with the sink, use [TagResource].

[1]: docs.aws.amazon.com/OAM/latest/APIReference/API_TagResource.html

Examples:

Request syntax with placeholder values


resp = client.update_link({
  identifier: "ResourceIdentifier", # required
  include_tags: false,
  link_configuration: {
    log_group_configuration: {
      filter: "LogsFilter", # required
    },
    metric_configuration: {
      filter: "MetricsFilter", # required
    },
  },
  resource_types: ["AWS::CloudWatch::Metric"], # required, accepts AWS::CloudWatch::Metric, AWS::Logs::LogGroup, AWS::XRay::Trace, AWS::ApplicationInsights::Application, AWS::InternetMonitor::Monitor, AWS::ApplicationSignals::Service, AWS::ApplicationSignals::ServiceLevelObjective
})

Response structure


resp.arn #=> String
resp.id #=> String
resp.label #=> String
resp.label_template #=> String
resp.link_configuration.log_group_configuration.filter #=> String
resp.link_configuration.metric_configuration.filter #=> String
resp.resource_types #=> Array
resp.resource_types[0] #=> String
resp.sink_arn #=> String
resp.tags #=> Hash
resp.tags["String"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :identifier (required, String) —

    The ARN of the link that you want to update.

  • :include_tags (Boolean) —

    Specifies whether to include the tags associated with the link in the response after the update operation. When ‘IncludeTags` is set to `true` and the caller has the required permission, `oam:ListTagsForResource`, the API will return the tags for the specified resource. If the caller doesn’t have the required permission, ‘oam:ListTagsForResource`, the API will raise an exception.

    The default value is ‘false`.

  • :link_configuration (Types::LinkConfiguration) —

    Use this structure to filter which metric namespaces and which log groups are to be shared from the source account to the monitoring account.

  • :resource_types (required, Array<String>) —

    An array of strings that define which types of data that the source account will send to the monitoring account.

    Your input here replaces the current set of data types that are shared.

Returns:

See Also:



1332
1333
1334
1335
 
# File 'lib/aws-sdk-oam/client.rb', line 1332

def update_link(params = {}, options = {})
  req = build_request(:update_link, 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. 


1361
1362
1363
 
# File 'lib/aws-sdk-oam/client.rb', line 1361

def waiter_names
  []
end