Class: Aws::ApplicationInsights::Client

Inherits:

Seahorse::Client::Base

Object
Seahorse::Client::Base
Aws::ApplicationInsights::Client

show all

Includes:: ClientStubs

Defined in:: lib/aws-sdk-applicationinsights/client.rb,
sig/client.rbs

Overview

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

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

For details on configuring region and credentials see the developer guide.

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

Defined Under Namespace

Class Attribute Summary collapse

.identifier ⇒ Object readonly private

API Operations collapse

#add_workload(params = {}) ⇒ Types::AddWorkloadResponse
Adds a workload to a component.
#create_application(params = {}) ⇒ Types::CreateApplicationResponse
Adds an application that is created from a resource group.
#create_component(params = {}) ⇒ Struct
Creates a custom component by grouping similar standalone instances to monitor.
#create_log_pattern(params = {}) ⇒ Types::CreateLogPatternResponse
Adds an log pattern to a LogPatternSet.
#delete_application(params = {}) ⇒ Struct
Removes the specified application from monitoring.
#delete_component(params = {}) ⇒ Struct
Ungroups a custom component.
#delete_log_pattern(params = {}) ⇒ Struct
Removes the specified log pattern from a LogPatternSet.
#describe_application(params = {}) ⇒ Types::DescribeApplicationResponse
Describes the application.
#describe_component(params = {}) ⇒ Types::DescribeComponentResponse
Describes a component and lists the resources that are grouped together in a component.
#describe_component_configuration(params = {}) ⇒ Types::DescribeComponentConfigurationResponse
Describes the monitoring configuration of the component.
#describe_component_configuration_recommendation(params = {}) ⇒ Types::DescribeComponentConfigurationRecommendationResponse
Describes the recommended monitoring configuration of the component.
#describe_log_pattern(params = {}) ⇒ Types::DescribeLogPatternResponse
Describe a specific log pattern from a LogPatternSet.
#describe_observation(params = {}) ⇒ Types::DescribeObservationResponse
Describes an anomaly or error with the application.
#describe_problem(params = {}) ⇒ Types::DescribeProblemResponse
Describes an application problem.
#describe_problem_observations(params = {}) ⇒ Types::DescribeProblemObservationsResponse
Describes the anomalies or errors associated with the problem.
#describe_workload(params = {}) ⇒ Types::DescribeWorkloadResponse
Describes a workload and its configuration.
#list_applications(params = {}) ⇒ Types::ListApplicationsResponse
Lists the IDs of the applications that you are monitoring.
#list_components(params = {}) ⇒ Types::ListComponentsResponse
Lists the auto-grouped, standalone, and custom components of the application.
#list_configuration_history(params = {}) ⇒ Types::ListConfigurationHistoryResponse
Lists the INFO, WARN, and ERROR events for periodic configuration updates performed by Application Insights.
#list_log_pattern_sets(params = {}) ⇒ Types::ListLogPatternSetsResponse
Lists the log pattern sets in the specific application.
#list_log_patterns(params = {}) ⇒ Types::ListLogPatternsResponse
Lists the log patterns in the specific log LogPatternSet.
#list_problems(params = {}) ⇒ Types::ListProblemsResponse
Lists the problems with your application.
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Retrieve a list of the tags (keys and values) that are associated with a specified application.
#list_workloads(params = {}) ⇒ Types::ListWorkloadsResponse
Lists the workloads that are configured on a given component.
#remove_workload(params = {}) ⇒ Struct
Remove workload from a component.
#tag_resource(params = {}) ⇒ Struct
Add one or more tags (keys and values) to a specified application.
#untag_resource(params = {}) ⇒ Struct
Remove one or more tags (keys and values) from a specified application.
#update_application(params = {}) ⇒ Types::UpdateApplicationResponse
Updates the application.
#update_component(params = {}) ⇒ Struct
Updates the custom component name and/or the list of resources that make up the component.
#update_component_configuration(params = {}) ⇒ Struct
Updates the monitoring configurations for the component.
#update_log_pattern(params = {}) ⇒ Types::UpdateLogPatternResponse
Adds a log pattern to a LogPatternSet.
#update_problem(params = {}) ⇒ Struct
Updates the visibility of the problem or specifies the problem as RESOLVED.
#update_workload(params = {}) ⇒ Types::UpdateWorkloadResponse
Adds a workload to a component.

Class Method Summary collapse

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 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[:credentials]
- The :access_key_id, :secret_access_key, :session_token, and :account_id options.
- ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID'].
- ~/.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['AWS_EC2_METADATA_DISABLED'] 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[:region]
- ENV['AWS_REGION']
- ENV['AMAZON_REGION']
- ENV['AWS_DEFAULT_REGION']
- ~/.aws/credentials
- ~/.aws/config
: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['AWS_AUTH_SCHEME_PREFERENCE'] 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 https://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 the 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 - A retry mode that includes all the functionality of standard mode along with automatic client side throttling.
: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[:sigv4a_signing_region_set]
- ENV['AWS_SIGV4A_SIGNING_REGION_SET']
- ~/.aws/config
:simple_json (Boolean) — default: false —
Disables request parameter conversion, validation, and formatting. Also disables response data type conversions. The request parameters hash must be formatted exactly as the API expects.This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.
: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::ApplicationInsights::EndpointProvider) —
The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::ApplicationInsights::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 'http://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.



478
479
480

# File 'lib/aws-sdk-applicationinsights/client.rb', line 478

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.



2198
2199
2200

# File 'lib/aws-sdk-applicationinsights/client.rb', line 2198

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.



2201
2202
2203

# File 'lib/aws-sdk-applicationinsights/client.rb', line 2201

def errors_module
  Errors
end

.new ⇒ `Object`

https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ApplicationInsights/Client.html#initialize-instance_method

14	# File 'sig/client.rbs', line 14 def self.new: (

Instance Method Details

#add_workload(params = {}) ⇒ `Types::AddWorkloadResponse`

Adds a workload to a component. Each component can have at most five workloads.

Examples:

Request syntax with placeholder values


resp = client.add_workload({
  resource_group_name: "ResourceGroupName", # required
  component_name: "ComponentName", # required
  workload_configuration: { # required
    workload_name: "WorkloadName",
    tier: "CUSTOM", # accepts CUSTOM, DEFAULT, DOT_NET_CORE, DOT_NET_WORKER, DOT_NET_WEB_TIER, DOT_NET_WEB, SQL_SERVER, SQL_SERVER_ALWAYSON_AVAILABILITY_GROUP, MYSQL, POSTGRESQL, JAVA_JMX, ORACLE, SAP_HANA_MULTI_NODE, SAP_HANA_SINGLE_NODE, SAP_HANA_HIGH_AVAILABILITY, SAP_ASE_SINGLE_NODE, SAP_ASE_HIGH_AVAILABILITY, SQL_SERVER_FAILOVER_CLUSTER_INSTANCE, SHAREPOINT, ACTIVE_DIRECTORY, SAP_NETWEAVER_STANDARD, SAP_NETWEAVER_DISTRIBUTED, SAP_NETWEAVER_HIGH_AVAILABILITY
    configuration: "ComponentConfiguration",
  },
})

Response structure


resp.workload_id #=> String
resp.workload_configuration.workload_name #=> String
resp.workload_configuration.tier #=> String, one of "CUSTOM", "DEFAULT", "DOT_NET_CORE", "DOT_NET_WORKER", "DOT_NET_WEB_TIER", "DOT_NET_WEB", "SQL_SERVER", "SQL_SERVER_ALWAYSON_AVAILABILITY_GROUP", "MYSQL", "POSTGRESQL", "JAVA_JMX", "ORACLE", "SAP_HANA_MULTI_NODE", "SAP_HANA_SINGLE_NODE", "SAP_HANA_HIGH_AVAILABILITY", "SAP_ASE_SINGLE_NODE", "SAP_ASE_HIGH_AVAILABILITY", "SQL_SERVER_FAILOVER_CLUSTER_INSTANCE", "SHAREPOINT", "ACTIVE_DIRECTORY", "SAP_NETWEAVER_STANDARD", "SAP_NETWEAVER_DISTRIBUTED", "SAP_NETWEAVER_HIGH_AVAILABILITY"
resp.workload_configuration.configuration #=> String

Parameters:

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

Options Hash (params):

:resource_group_name (required, String) —
The name of the resource group.
:component_name (required, String) —
The name of the component.
:workload_configuration (required, Types::WorkloadConfiguration) —
The configuration settings of the workload. The value is the escaped JSON of the configuration.

Returns:

(Types::AddWorkloadResponse) —
Returns a response object which responds to the following methods:
- #workload_id => String
- #workload_configuration => Types::WorkloadConfiguration

See Also:

AWS API Documentation

88	# File 'sig/client.rbs', line 88 def add_workload: (

#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-applicationinsights/client.rb', line 2171

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

#create_application(params = {}) ⇒ `Types::CreateApplicationResponse`

Adds an application that is created from a resource group.

Examples:

Request syntax with placeholder values


resp = client.create_application({
  resource_group_name: "ResourceGroupName",
  ops_center_enabled: false,
  cwe_monitor_enabled: false,
  ops_item_sns_topic_arn: "OpsItemSNSTopicArn",
  sns_notification_arn: "SNSNotificationArn",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  auto_config_enabled: false,
  auto_create: false,
  grouping_type: "ACCOUNT_BASED", # accepts ACCOUNT_BASED
  attach_missing_permission: false,
})

Response structure


resp.application_info.account_id #=> String
resp.application_info.resource_group_name #=> String
resp.application_info.life_cycle #=> String
resp.application_info.ops_item_sns_topic_arn #=> String
resp.application_info.sns_notification_arn #=> String
resp.application_info.ops_center_enabled #=> Boolean
resp.application_info.cwe_monitor_enabled #=> Boolean
resp.application_info.remarks #=> String
resp.application_info.auto_config_enabled #=> Boolean
resp.application_info.discovery_type #=> String, one of "RESOURCE_GROUP_BASED", "ACCOUNT_BASED"
resp.application_info.attach_missing_permission #=> Boolean

Parameters:

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

Options Hash (params):

:resource_group_name (String) —
The name of the resource group.
:ops_center_enabled (Boolean) —
When set to true, creates opsItems for any problems detected on an application.
:cwe_monitor_enabled (Boolean) —
Indicates whether Application Insights can listen to CloudWatch events for the application resources, such as instance terminated, failed deployment, and others.
:ops_item_sns_topic_arn (String) —
The SNS topic provided to Application Insights that is associated to the created opsItem. Allows you to receive notifications for updates to the opsItem.
:sns_notification_arn (String) —
The SNS notification topic ARN.
:tags (Array<Types::Tag>) —
List of tags to add to the application. tag key (Key) and an associated tag value (Value). The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.
:auto_config_enabled (Boolean) —
Indicates whether Application Insights automatically configures unmonitored resources in the resource group.
:auto_create (Boolean) —
Configures all of the resources in the resource group by applying the recommended configurations.
:grouping_type (String) —
Application Insights can create applications based on a resource group or on an account. To create an account-based application using all of the resources in the account, set this parameter to ACCOUNT_BASED.
:attach_missing_permission (Boolean) —
If set to true, the managed policies for SSM and CW will be attached to the instance roles if they are missing.

Returns:

(Types::CreateApplicationResponse) —
Returns a response object which responds to the following methods:
- #application_info => Types::ApplicationInfo

See Also:

AWS API Documentation

104	# File 'sig/client.rbs', line 104 def create_application: (

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

Creates a custom component by grouping similar standalone instances to monitor.

Examples:

Request syntax with placeholder values


resp = client.create_component({
  resource_group_name: "ResourceGroupName", # required
  component_name: "CustomComponentName", # required
  resource_list: ["ResourceARN"], # required
})

Parameters:

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

Options Hash (params):

:resource_group_name (required, String) —
The name of the resource group.
:component_name (required, String) —
The name of the component.
:resource_list (required, Array<String>) —
The list of resource ARNs that belong to the component.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

127	# File 'sig/client.rbs', line 127 def create_component: (

#create_log_pattern(params = {}) ⇒ `Types::CreateLogPatternResponse`

Adds an log pattern to a LogPatternSet.

Examples:

Request syntax with placeholder values


resp = client.create_log_pattern({
  resource_group_name: "ResourceGroupName", # required
  pattern_set_name: "LogPatternSetName", # required
  pattern_name: "LogPatternName", # required
  pattern: "LogPatternRegex", # required
  rank: 1, # required
})

Response structure


resp.log_pattern.pattern_set_name #=> String
resp.log_pattern.pattern_name #=> String
resp.log_pattern.pattern #=> String
resp.log_pattern.rank #=> Integer
resp.resource_group_name #=> String

Parameters:

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

Options Hash (params):

:resource_group_name (required, String) —
The name of the resource group.
:pattern_set_name (required, String) —
The name of the log pattern set.
:pattern_name (required, String) —
The name of the log pattern.
:pattern (required, String) —
The log pattern. The pattern must be DFA compatible. Patterns that utilize forward lookahead or backreference constructions are not supported.
:rank (required, Integer) —
Rank of the log pattern. Must be a value between 1 and 1,000,000. The patterns are sorted by rank, so we recommend that you set your highest priority patterns with the lowest rank. A pattern of rank 1 will be the first to get matched to a log line. A pattern of rank 1,000,000 will be last to get matched. When you configure custom log patterns from the console, a Low severity pattern translates to a 750,000 rank. A Medium severity pattern translates to a 500,000 rank. And a High severity pattern translates to a 250,000 rank. Rank values less than 1 or greater than 1,000,000 are reserved for Amazon Web Services provided patterns.

Returns:

(Types::CreateLogPatternResponse) —
Returns a response object which responds to the following methods:
- #log_pattern => Types::LogPattern
- #resource_group_name => String

See Also:

AWS API Documentation

140	# File 'sig/client.rbs', line 140 def create_log_pattern: (

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

Removes the specified application from monitoring. Does not delete the application.

Examples:

Request syntax with placeholder values


resp = client.delete_application({
  resource_group_name: "ResourceGroupName", # required
})

Parameters:

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

Options Hash (params):

:resource_group_name (required, String) —
The name of the resource group.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

153	# File 'sig/client.rbs', line 153 def delete_application: (

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

Ungroups a custom component. When you ungroup custom components, all applicable monitors that are set up for the component are removed and the instances revert to their standalone status.

Examples:

Request syntax with placeholder values


resp = client.delete_component({
  resource_group_name: "ResourceGroupName", # required
  component_name: "CustomComponentName", # required
})

Parameters:

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

Options Hash (params):

:resource_group_name (required, String) —
The name of the resource group.
:component_name (required, String) —
The name of the component.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

162	# File 'sig/client.rbs', line 162 def delete_component: (

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

Removes the specified log pattern from a LogPatternSet.

Examples:

Request syntax with placeholder values


resp = client.delete_log_pattern({
  resource_group_name: "ResourceGroupName", # required
  pattern_set_name: "LogPatternSetName", # required
  pattern_name: "LogPatternName", # required
})

Parameters:

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

Options Hash (params):

:resource_group_name (required, String) —
The name of the resource group.
:pattern_set_name (required, String) —
The name of the log pattern set.
:pattern_name (required, String) —
The name of the log pattern.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

172	# File 'sig/client.rbs', line 172 def delete_log_pattern: (

#describe_application(params = {}) ⇒ `Types::DescribeApplicationResponse`

Describes the application.

Examples:

Request syntax with placeholder values


resp = client.describe_application({
  resource_group_name: "ResourceGroupName", # required
  account_id: "AccountId",
})

Response structure


resp.application_info.account_id #=> String
resp.application_info.resource_group_name #=> String
resp.application_info.life_cycle #=> String
resp.application_info.ops_item_sns_topic_arn #=> String
resp.application_info.sns_notification_arn #=> String
resp.application_info.ops_center_enabled #=> Boolean
resp.application_info.cwe_monitor_enabled #=> Boolean
resp.application_info.remarks #=> String
resp.application_info.auto_config_enabled #=> Boolean
resp.application_info.discovery_type #=> String, one of "RESOURCE_GROUP_BASED", "ACCOUNT_BASED"
resp.application_info.attach_missing_permission #=> Boolean

Parameters:

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

Options Hash (params):

:resource_group_name (required, String) —
The name of the resource group.
:account_id (String) —
The Amazon Web Services account ID for the resource group owner.

Returns:

(Types::DescribeApplicationResponse) —
Returns a response object which responds to the following methods:
- #application_info => Types::ApplicationInfo

See Also:

AWS API Documentation

184	# File 'sig/client.rbs', line 184 def describe_application: (

#describe_component(params = {}) ⇒ `Types::DescribeComponentResponse`

Describes a component and lists the resources that are grouped together in a component.

Examples:

Request syntax with placeholder values


resp = client.describe_component({
  resource_group_name: "ResourceGroupName", # required
  component_name: "ComponentName", # required
  account_id: "AccountId",
})

Response structure


resp.application_component.component_name #=> String
resp.application_component.component_remarks #=> String
resp.application_component.resource_type #=> String
resp.application_component.os_type #=> String, one of "WINDOWS", "LINUX"
resp.application_component.tier #=> String, one of "CUSTOM", "DEFAULT", "DOT_NET_CORE", "DOT_NET_WORKER", "DOT_NET_WEB_TIER", "DOT_NET_WEB", "SQL_SERVER", "SQL_SERVER_ALWAYSON_AVAILABILITY_GROUP", "MYSQL", "POSTGRESQL", "JAVA_JMX", "ORACLE", "SAP_HANA_MULTI_NODE", "SAP_HANA_SINGLE_NODE", "SAP_HANA_HIGH_AVAILABILITY", "SAP_ASE_SINGLE_NODE", "SAP_ASE_HIGH_AVAILABILITY", "SQL_SERVER_FAILOVER_CLUSTER_INSTANCE", "SHAREPOINT", "ACTIVE_DIRECTORY", "SAP_NETWEAVER_STANDARD", "SAP_NETWEAVER_DISTRIBUTED", "SAP_NETWEAVER_HIGH_AVAILABILITY"
resp.application_component.monitor #=> Boolean
resp.application_component.detected_workload #=> Hash
resp.application_component.detected_workload["Tier"] #=> Hash
resp.application_component.detected_workload["Tier"]["MetaDataKey"] #=> String
resp.resource_list #=> Array
resp.resource_list[0] #=> String

Parameters:

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

Options Hash (params):

:resource_group_name (required, String) —
The name of the resource group.
:component_name (required, String) —
The name of the component.
:account_id (String) —
The Amazon Web Services account ID for the resource group owner.

Returns:

(Types::DescribeComponentResponse) —
Returns a response object which responds to the following methods:
- #application_component => Types::ApplicationComponent
- #resource_list => Array<String>

See Also:

AWS API Documentation

196	# File 'sig/client.rbs', line 196 def describe_component: (

#describe_component_configuration(params = {}) ⇒ `Types::DescribeComponentConfigurationResponse`

Describes the monitoring configuration of the component.

Examples:

Request syntax with placeholder values


resp = client.describe_component_configuration({
  resource_group_name: "ResourceGroupName", # required
  component_name: "ComponentName", # required
  account_id: "AccountId",
})

Response structure


resp.monitor #=> Boolean
resp.tier #=> String, one of "CUSTOM", "DEFAULT", "DOT_NET_CORE", "DOT_NET_WORKER", "DOT_NET_WEB_TIER", "DOT_NET_WEB", "SQL_SERVER", "SQL_SERVER_ALWAYSON_AVAILABILITY_GROUP", "MYSQL", "POSTGRESQL", "JAVA_JMX", "ORACLE", "SAP_HANA_MULTI_NODE", "SAP_HANA_SINGLE_NODE", "SAP_HANA_HIGH_AVAILABILITY", "SAP_ASE_SINGLE_NODE", "SAP_ASE_HIGH_AVAILABILITY", "SQL_SERVER_FAILOVER_CLUSTER_INSTANCE", "SHAREPOINT", "ACTIVE_DIRECTORY", "SAP_NETWEAVER_STANDARD", "SAP_NETWEAVER_DISTRIBUTED", "SAP_NETWEAVER_HIGH_AVAILABILITY"
resp.component_configuration #=> String

Parameters:

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

Options Hash (params):

:resource_group_name (required, String) —
The name of the resource group.
:component_name (required, String) —
The name of the component.
:account_id (String) —
The Amazon Web Services account ID for the resource group owner.

Returns:

(Types::DescribeComponentConfigurationResponse) —
Returns a response object which responds to the following methods:
- #monitor => Boolean
- #tier => String
- #component_configuration => String

See Also:

AWS API Documentation

210	# File 'sig/client.rbs', line 210 def describe_component_configuration: (

#describe_component_configuration_recommendation(params = {}) ⇒ `Types::DescribeComponentConfigurationRecommendationResponse`

Describes the recommended monitoring configuration of the component.

Examples:

Request syntax with placeholder values


resp = client.describe_component_configuration_recommendation({
  resource_group_name: "ResourceGroupName", # required
  component_name: "ComponentName", # required
  tier: "CUSTOM", # required, accepts CUSTOM, DEFAULT, DOT_NET_CORE, DOT_NET_WORKER, DOT_NET_WEB_TIER, DOT_NET_WEB, SQL_SERVER, SQL_SERVER_ALWAYSON_AVAILABILITY_GROUP, MYSQL, POSTGRESQL, JAVA_JMX, ORACLE, SAP_HANA_MULTI_NODE, SAP_HANA_SINGLE_NODE, SAP_HANA_HIGH_AVAILABILITY, SAP_ASE_SINGLE_NODE, SAP_ASE_HIGH_AVAILABILITY, SQL_SERVER_FAILOVER_CLUSTER_INSTANCE, SHAREPOINT, ACTIVE_DIRECTORY, SAP_NETWEAVER_STANDARD, SAP_NETWEAVER_DISTRIBUTED, SAP_NETWEAVER_HIGH_AVAILABILITY
  workload_name: "WorkloadName",
  recommendation_type: "INFRA_ONLY", # accepts INFRA_ONLY, WORKLOAD_ONLY, ALL
})

Response structure


resp.component_configuration #=> String

Parameters:

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

Options Hash (params):

:resource_group_name (required, String) —
The name of the resource group.
:component_name (required, String) —
The name of the component.
:tier (required, String) —
The tier of the application component.
:workload_name (String) —
The name of the workload. The name of the workload is required when the tier of the application component is SAP_ASE_SINGLE_NODE or SAP_ASE_HIGH_AVAILABILITY.
:recommendation_type (String) —
The recommended configuration type.

Returns:

(Types::DescribeComponentConfigurationRecommendationResponse) —
Returns a response object which responds to the following methods:
- #component_configuration => String

See Also:

AWS API Documentation

222	# File 'sig/client.rbs', line 222 def describe_component_configuration_recommendation: (

#describe_log_pattern(params = {}) ⇒ `Types::DescribeLogPatternResponse`

Describe a specific log pattern from a LogPatternSet.

Examples:

Request syntax with placeholder values


resp = client.describe_log_pattern({
  resource_group_name: "ResourceGroupName", # required
  pattern_set_name: "LogPatternSetName", # required
  pattern_name: "LogPatternName", # required
  account_id: "AccountId",
})

Response structure


resp.resource_group_name #=> String
resp.account_id #=> String
resp.log_pattern.pattern_set_name #=> String
resp.log_pattern.pattern_name #=> String
resp.log_pattern.pattern #=> String
resp.log_pattern.rank #=> Integer

Parameters:

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

Options Hash (params):

:resource_group_name (required, String) —
The name of the resource group.
:pattern_set_name (required, String) —
The name of the log pattern set.
:pattern_name (required, String) —
The name of the log pattern.
:account_id (String) —
The Amazon Web Services account ID for the resource group owner.

Returns:

(Types::DescribeLogPatternResponse) —
Returns a response object which responds to the following methods:
- #resource_group_name => String
- #account_id => String
- #log_pattern => Types::LogPattern

See Also:

AWS API Documentation

238	# File 'sig/client.rbs', line 238 def describe_log_pattern: (

#describe_observation(params = {}) ⇒ `Types::DescribeObservationResponse`

Describes an anomaly or error with the application.

Examples:

Request syntax with placeholder values


resp = client.describe_observation({
  observation_id: "ObservationId", # required
  account_id: "AccountId",
})

Response structure


resp.observation.id #=> String
resp.observation.start_time #=> Time
resp.observation.end_time #=> Time
resp.observation.source_type #=> String
resp.observation.source_arn #=> String
resp.observation.log_group #=> String
resp.observation.line_time #=> Time
resp.observation.log_text #=> String
resp.observation.log_filter #=> String, one of "ERROR", "WARN", "INFO"
resp.observation.metric_namespace #=> String
resp.observation.metric_name #=> String
resp.observation.unit #=> String
resp.observation.value #=> Float
resp.observation.cloud_watch_event_id #=> String
resp.observation.cloud_watch_event_source #=> String, one of "EC2", "CODE_DEPLOY", "HEALTH", "RDS"
resp.observation.cloud_watch_event_detail_type #=> String
resp.observation.health_event_arn #=> String
resp.observation.health_service #=> String
resp.observation.health_event_type_code #=> String
resp.observation.health_event_type_category #=> String
resp.observation.health_event_description #=> String
resp.observation.code_deploy_deployment_id #=> String
resp.observation.code_deploy_deployment_group #=> String
resp.observation.code_deploy_state #=> String
resp.observation.code_deploy_application #=> String
resp.observation.code_deploy_instance_group_id #=> String
resp.observation.ec2_state #=> String
resp.observation.rds_event_categories #=> String
resp.observation.rds_event_message #=> String
resp.observation.s3_event_name #=> String
resp.observation.states_execution_arn #=> String
resp.observation.states_arn #=> String
resp.observation.states_status #=> String
resp.observation.states_input #=> String
resp.observation.ebs_event #=> String
resp.observation.ebs_result #=> String
resp.observation.ebs_cause #=> String
resp.observation.ebs_request_id #=> String
resp.observation.x_ray_fault_percent #=> Integer
resp.observation.x_ray_throttle_percent #=> Integer
resp.observation.x_ray_error_percent #=> Integer
resp.observation.x_ray_request_count #=> Integer
resp.observation.x_ray_request_average_latency #=> Integer
resp.observation.x_ray_node_name #=> String
resp.observation.x_ray_node_type #=> String

Parameters:

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

Options Hash (params):

:observation_id (required, String) —
The ID of the observation.
:account_id (String) —
The Amazon Web Services account ID for the resource group owner.

Returns:

(Types::DescribeObservationResponse) —
Returns a response object which responds to the following methods:
- #observation => Types::Observation

See Also:

AWS API Documentation

251	# File 'sig/client.rbs', line 251 def describe_observation: (

#describe_problem(params = {}) ⇒ `Types::DescribeProblemResponse`

Describes an application problem.

Examples:

Request syntax with placeholder values


resp = client.describe_problem({
  problem_id: "ProblemId", # required
  account_id: "AccountId",
})

Response structure


resp.problem.id #=> String
resp.problem.title #=> String
resp.problem.short_name #=> String
resp.problem.insights #=> String
resp.problem.status #=> String, one of "IGNORE", "RESOLVED", "PENDING", "RECURRING", "RECOVERING"
resp.problem.affected_resource #=> String
resp.problem.start_time #=> Time
resp.problem.end_time #=> Time
resp.problem.severity_level #=> String, one of "Informative", "Low", "Medium", "High"
resp.problem.account_id #=> String
resp.problem.resource_group_name #=> String
resp.problem.feedback #=> Hash
resp.problem.feedback["FeedbackKey"] #=> String, one of "NOT_SPECIFIED", "USEFUL", "NOT_USEFUL"
resp.problem.recurring_count #=> Integer
resp.problem.last_recurrence_time #=> Time
resp.problem.visibility #=> String, one of "IGNORED", "VISIBLE"
resp.problem.resolution_method #=> String, one of "MANUAL", "AUTOMATIC", "UNRESOLVED"
resp.sns_notification_arn #=> String

Parameters:

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

Options Hash (params):

:problem_id (required, String) —
The ID of the problem.
:account_id (String) —
The Amazon Web Services account ID for the owner of the resource group affected by the problem.

Returns:

(Types::DescribeProblemResponse) —
Returns a response object which responds to the following methods:
- #problem => Types::Problem
- #sns_notification_arn => String

See Also:

AWS API Documentation

263	# File 'sig/client.rbs', line 263 def describe_problem: (

#describe_problem_observations(params = {}) ⇒ `Types::DescribeProblemObservationsResponse`

Describes the anomalies or errors associated with the problem.

Examples:

Request syntax with placeholder values


resp = client.describe_problem_observations({
  problem_id: "ProblemId", # required
  account_id: "AccountId",
})

Response structure


resp.related_observations.observation_list #=> Array
resp.related_observations.observation_list[0].id #=> String
resp.related_observations.observation_list[0].start_time #=> Time
resp.related_observations.observation_list[0].end_time #=> Time
resp.related_observations.observation_list[0].source_type #=> String
resp.related_observations.observation_list[0].source_arn #=> String
resp.related_observations.observation_list[0].log_group #=> String
resp.related_observations.observation_list[0].line_time #=> Time
resp.related_observations.observation_list[0].log_text #=> String
resp.related_observations.observation_list[0].log_filter #=> String, one of "ERROR", "WARN", "INFO"
resp.related_observations.observation_list[0].metric_namespace #=> String
resp.related_observations.observation_list[0].metric_name #=> String
resp.related_observations.observation_list[0].unit #=> String
resp.related_observations.observation_list[0].value #=> Float
resp.related_observations.observation_list[0].cloud_watch_event_id #=> String
resp.related_observations.observation_list[0].cloud_watch_event_source #=> String, one of "EC2", "CODE_DEPLOY", "HEALTH", "RDS"
resp.related_observations.observation_list[0].cloud_watch_event_detail_type #=> String
resp.related_observations.observation_list[0].health_event_arn #=> String
resp.related_observations.observation_list[0].health_service #=> String
resp.related_observations.observation_list[0].health_event_type_code #=> String
resp.related_observations.observation_list[0].health_event_type_category #=> String
resp.related_observations.observation_list[0].health_event_description #=> String
resp.related_observations.observation_list[0].code_deploy_deployment_id #=> String
resp.related_observations.observation_list[0].code_deploy_deployment_group #=> String
resp.related_observations.observation_list[0].code_deploy_state #=> String
resp.related_observations.observation_list[0].code_deploy_application #=> String
resp.related_observations.observation_list[0].code_deploy_instance_group_id #=> String
resp.related_observations.observation_list[0].ec2_state #=> String
resp.related_observations.observation_list[0].rds_event_categories #=> String
resp.related_observations.observation_list[0].rds_event_message #=> String
resp.related_observations.observation_list[0].s3_event_name #=> String
resp.related_observations.observation_list[0].states_execution_arn #=> String
resp.related_observations.observation_list[0].states_arn #=> String
resp.related_observations.observation_list[0].states_status #=> String
resp.related_observations.observation_list[0].states_input #=> String
resp.related_observations.observation_list[0].ebs_event #=> String
resp.related_observations.observation_list[0].ebs_result #=> String
resp.related_observations.observation_list[0].ebs_cause #=> String
resp.related_observations.observation_list[0].ebs_request_id #=> String
resp.related_observations.observation_list[0].x_ray_fault_percent #=> Integer
resp.related_observations.observation_list[0].x_ray_throttle_percent #=> Integer
resp.related_observations.observation_list[0].x_ray_error_percent #=> Integer
resp.related_observations.observation_list[0].x_ray_request_count #=> Integer
resp.related_observations.observation_list[0].x_ray_request_average_latency #=> Integer
resp.related_observations.observation_list[0].x_ray_node_name #=> String
resp.related_observations.observation_list[0].x_ray_node_type #=> String

Parameters:

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

Options Hash (params):

:problem_id (required, String) —
The ID of the problem.
:account_id (String) —
The Amazon Web Services account ID for the resource group owner.

Returns:

(Types::DescribeProblemObservationsResponse) —
Returns a response object which responds to the following methods:
- #related_observations => Types::RelatedObservations

See Also:

AWS API Documentation

274	# File 'sig/client.rbs', line 274 def describe_problem_observations: (

#describe_workload(params = {}) ⇒ `Types::DescribeWorkloadResponse`

Describes a workload and its configuration.

Examples:

Request syntax with placeholder values


resp = client.describe_workload({
  resource_group_name: "ResourceGroupName", # required
  component_name: "ComponentName", # required
  workload_id: "WorkloadId", # required
  account_id: "AccountId",
})

Response structure


resp.workload_id #=> String
resp.workload_remarks #=> String
resp.workload_configuration.workload_name #=> String
resp.workload_configuration.tier #=> String, one of "CUSTOM", "DEFAULT", "DOT_NET_CORE", "DOT_NET_WORKER", "DOT_NET_WEB_TIER", "DOT_NET_WEB", "SQL_SERVER", "SQL_SERVER_ALWAYSON_AVAILABILITY_GROUP", "MYSQL", "POSTGRESQL", "JAVA_JMX", "ORACLE", "SAP_HANA_MULTI_NODE", "SAP_HANA_SINGLE_NODE", "SAP_HANA_HIGH_AVAILABILITY", "SAP_ASE_SINGLE_NODE", "SAP_ASE_HIGH_AVAILABILITY", "SQL_SERVER_FAILOVER_CLUSTER_INSTANCE", "SHAREPOINT", "ACTIVE_DIRECTORY", "SAP_NETWEAVER_STANDARD", "SAP_NETWEAVER_DISTRIBUTED", "SAP_NETWEAVER_HIGH_AVAILABILITY"
resp.workload_configuration.configuration #=> String

Parameters:

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

Options Hash (params):

:resource_group_name (required, String) —
The name of the resource group.
:component_name (required, String) —
The name of the component.
:workload_id (required, String) —
The ID of the workload.
:account_id (String) —
The Amazon Web Services account ID for the workload owner.

Returns:

(Types::DescribeWorkloadResponse) —
Returns a response object which responds to the following methods:
- #workload_id => String
- #workload_remarks => String
- #workload_configuration => Types::WorkloadConfiguration

See Also:

AWS API Documentation

287	# File 'sig/client.rbs', line 287 def describe_workload: (

#list_applications(params = {}) ⇒ `Types::ListApplicationsResponse`

Lists the IDs of the applications that you are monitoring.

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_applications({
  max_results: 1,
  next_token: "PaginationToken",
  account_id: "AccountId",
})

Response structure


resp.application_info_list #=> Array
resp.application_info_list[0].account_id #=> String
resp.application_info_list[0].resource_group_name #=> String
resp.application_info_list[0].life_cycle #=> String
resp.application_info_list[0].ops_item_sns_topic_arn #=> String
resp.application_info_list[0].sns_notification_arn #=> String
resp.application_info_list[0].ops_center_enabled #=> Boolean
resp.application_info_list[0].cwe_monitor_enabled #=> Boolean
resp.application_info_list[0].remarks #=> String
resp.application_info_list[0].auto_config_enabled #=> Boolean
resp.application_info_list[0].discovery_type #=> String, one of "RESOURCE_GROUP_BASED", "ACCOUNT_BASED"
resp.application_info_list[0].attach_missing_permission #=> Boolean
resp.next_token #=> String

Parameters:

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

Options Hash (params):

:max_results (Integer) —
The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.
:next_token (String) —
The token to request the next page of results.
:account_id (String) —
The Amazon Web Services account ID for the resource group owner.

Returns:

(Types::ListApplicationsResponse) —
Returns a response object which responds to the following methods:
- #application_info_list => Array<Types::ApplicationInfo>
- #next_token => String

See Also:

AWS API Documentation

301	# File 'sig/client.rbs', line 301 def list_applications: (

#list_components(params = {}) ⇒ `Types::ListComponentsResponse`

Lists the auto-grouped, standalone, and custom components of the application.

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_components({
  resource_group_name: "ResourceGroupName", # required
  max_results: 1,
  next_token: "PaginationToken",
  account_id: "AccountId",
})

Response structure


resp.application_component_list #=> Array
resp.application_component_list[0].component_name #=> String
resp.application_component_list[0].component_remarks #=> String
resp.application_component_list[0].resource_type #=> String
resp.application_component_list[0].os_type #=> String, one of "WINDOWS", "LINUX"
resp.application_component_list[0].tier #=> String, one of "CUSTOM", "DEFAULT", "DOT_NET_CORE", "DOT_NET_WORKER", "DOT_NET_WEB_TIER", "DOT_NET_WEB", "SQL_SERVER", "SQL_SERVER_ALWAYSON_AVAILABILITY_GROUP", "MYSQL", "POSTGRESQL", "JAVA_JMX", "ORACLE", "SAP_HANA_MULTI_NODE", "SAP_HANA_SINGLE_NODE", "SAP_HANA_HIGH_AVAILABILITY", "SAP_ASE_SINGLE_NODE", "SAP_ASE_HIGH_AVAILABILITY", "SQL_SERVER_FAILOVER_CLUSTER_INSTANCE", "SHAREPOINT", "ACTIVE_DIRECTORY", "SAP_NETWEAVER_STANDARD", "SAP_NETWEAVER_DISTRIBUTED", "SAP_NETWEAVER_HIGH_AVAILABILITY"
resp.application_component_list[0].monitor #=> Boolean
resp.application_component_list[0].detected_workload #=> Hash
resp.application_component_list[0].detected_workload["Tier"] #=> Hash
resp.application_component_list[0].detected_workload["Tier"]["MetaDataKey"] #=> String
resp.next_token #=> String

Parameters:

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

Options Hash (params):

:resource_group_name (required, String) —
The name of the resource group.
:max_results (Integer) —
The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.
:next_token (String) —
The token to request the next page of results.
:account_id (String) —
The Amazon Web Services account ID for the resource group owner.

Returns:

(Types::ListComponentsResponse) —
Returns a response object which responds to the following methods:
- #application_component_list => Array<Types::ApplicationComponent>
- #next_token => String

See Also:

AWS API Documentation

314	# File 'sig/client.rbs', line 314 def list_components: (

#list_configuration_history(params = {}) ⇒ `Types::ListConfigurationHistoryResponse`

Lists the INFO, WARN, and ERROR events for periodic configuration updates performed by Application Insights. Examples of events represented are:

INFO: creating a new alarm or updating an alarm threshold.
WARN: alarm not created due to insufficient data points used to predict thresholds.
ERROR: alarm not created due to permission errors or exceeding quotas.

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_configuration_history({
  resource_group_name: "ResourceGroupName",
  start_time: Time.now,
  end_time: Time.now,
  event_status: "INFO", # accepts INFO, WARN, ERROR
  max_results: 1,
  next_token: "PaginationToken",
  account_id: "AccountId",
})

Response structure


resp.event_list #=> Array
resp.event_list[0].resource_group_name #=> String
resp.event_list[0].account_id #=> String
resp.event_list[0].monitored_resource_arn #=> String
resp.event_list[0].event_status #=> String, one of "INFO", "WARN", "ERROR"
resp.event_list[0].event_resource_type #=> String, one of "CLOUDWATCH_ALARM", "CLOUDWATCH_LOG", "CLOUDFORMATION", "SSM_ASSOCIATION"
resp.event_list[0].event_time #=> Time
resp.event_list[0].event_detail #=> String
resp.event_list[0].event_resource_name #=> String
resp.next_token #=> String

Parameters:

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

Options Hash (params):

:resource_group_name (String) —
Resource group to which the application belongs.
:start_time (Time, DateTime, Date, Integer, String) —
The start time of the event.
:end_time (Time, DateTime, Date, Integer, String) —
The end time of the event.
:event_status (String) —
The status of the configuration update event. Possible values include INFO, WARN, and ERROR.
:max_results (Integer) —
The maximum number of results returned by ListConfigurationHistory in paginated output. When this parameter is used, ListConfigurationHistory returns only MaxResults in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another ListConfigurationHistory request with the returned NextToken value. If this parameter is not used, then ListConfigurationHistory returns all results.
:next_token (String) —
The NextToken value returned from a previous paginated ListConfigurationHistory request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.
:account_id (String) —
The Amazon Web Services account ID for the resource group owner.

Returns:

(Types::ListConfigurationHistoryResponse) —
Returns a response object which responds to the following methods:
- #event_list => Array<Types::ConfigurationEvent>
- #next_token => String

See Also:

AWS API Documentation

328	# File 'sig/client.rbs', line 328 def list_configuration_history: (

#list_log_pattern_sets(params = {}) ⇒ `Types::ListLogPatternSetsResponse`

Lists the log pattern sets in the specific application.

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_log_pattern_sets({
  resource_group_name: "ResourceGroupName", # required
  max_results: 1,
  next_token: "PaginationToken",
  account_id: "AccountId",
})

Response structure


resp.resource_group_name #=> String
resp.account_id #=> String
resp.log_pattern_sets #=> Array
resp.log_pattern_sets[0] #=> String
resp.next_token #=> String

Parameters:

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

Options Hash (params):

:resource_group_name (required, String) —
The name of the resource group.
:max_results (Integer) —
The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.
:next_token (String) —
The token to request the next page of results.
:account_id (String) —
The Amazon Web Services account ID for the resource group owner.

Returns:

(Types::ListLogPatternSetsResponse) —
Returns a response object which responds to the following methods:
- #resource_group_name => String
- #account_id => String
- #log_pattern_sets => Array<String>
- #next_token => String

See Also:

AWS API Documentation

347	# File 'sig/client.rbs', line 347 def list_log_pattern_sets: (

#list_log_patterns(params = {}) ⇒ `Types::ListLogPatternsResponse`

Lists the log patterns in the specific log LogPatternSet.

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_log_patterns({
  resource_group_name: "ResourceGroupName", # required
  pattern_set_name: "LogPatternSetName",
  max_results: 1,
  next_token: "PaginationToken",
  account_id: "AccountId",
})

Response structure


resp.resource_group_name #=> String
resp.account_id #=> String
resp.log_patterns #=> Array
resp.log_patterns[0].pattern_set_name #=> String
resp.log_patterns[0].pattern_name #=> String
resp.log_patterns[0].pattern #=> String
resp.log_patterns[0].rank #=> Integer
resp.next_token #=> String

Parameters:

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

Options Hash (params):

:resource_group_name (required, String) —
The name of the resource group.
:pattern_set_name (String) —
The name of the log pattern set.
:max_results (Integer) —
The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.
:next_token (String) —
The token to request the next page of results.
:account_id (String) —
The Amazon Web Services account ID for the resource group owner.

Returns:

(Types::ListLogPatternsResponse) —
Returns a response object which responds to the following methods:
- #resource_group_name => String
- #account_id => String
- #log_patterns => Array<Types::LogPattern>
- #next_token => String

See Also:

AWS API Documentation

363	# File 'sig/client.rbs', line 363 def list_log_patterns: (

#list_problems(params = {}) ⇒ `Types::ListProblemsResponse`

Lists the problems with your application.

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_problems({
  account_id: "AccountId",
  resource_group_name: "ResourceGroupName",
  start_time: Time.now,
  end_time: Time.now,
  max_results: 1,
  next_token: "PaginationToken",
  component_name: "ComponentName",
  visibility: "IGNORED", # accepts IGNORED, VISIBLE
})

Response structure


resp.problem_list #=> Array
resp.problem_list[0].id #=> String
resp.problem_list[0].title #=> String
resp.problem_list[0].short_name #=> String
resp.problem_list[0].insights #=> String
resp.problem_list[0].status #=> String, one of "IGNORE", "RESOLVED", "PENDING", "RECURRING", "RECOVERING"
resp.problem_list[0].affected_resource #=> String
resp.problem_list[0].start_time #=> Time
resp.problem_list[0].end_time #=> Time
resp.problem_list[0].severity_level #=> String, one of "Informative", "Low", "Medium", "High"
resp.problem_list[0].account_id #=> String
resp.problem_list[0].resource_group_name #=> String
resp.problem_list[0].feedback #=> Hash
resp.problem_list[0].feedback["FeedbackKey"] #=> String, one of "NOT_SPECIFIED", "USEFUL", "NOT_USEFUL"
resp.problem_list[0].recurring_count #=> Integer
resp.problem_list[0].last_recurrence_time #=> Time
resp.problem_list[0].visibility #=> String, one of "IGNORED", "VISIBLE"
resp.problem_list[0].resolution_method #=> String, one of "MANUAL", "AUTOMATIC", "UNRESOLVED"
resp.next_token #=> String
resp.resource_group_name #=> String
resp.account_id #=> String

Parameters:

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

Options Hash (params):

:account_id (String) —
The Amazon Web Services account ID for the resource group owner.
:resource_group_name (String) —
The name of the resource group.
:start_time (Time, DateTime, Date, Integer, String) —
The time when the problem was detected, in epoch seconds. If you don't specify a time frame for the request, problems within the past seven days are returned.
:end_time (Time, DateTime, Date, Integer, String) —
The time when the problem ended, in epoch seconds. If not specified, problems within the past seven days are returned.
:max_results (Integer) —
The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.
:next_token (String) —
The token to request the next page of results.
:component_name (String) —
The name of the component.
:visibility (String) —
Specifies whether or not you can view the problem. If not specified, visible and ignored problems are returned.

Returns:

(Types::ListProblemsResponse) —
Returns a response object which responds to the following methods:
- #problem_list => Array<Types::Problem>
- #next_token => String
- #resource_group_name => String
- #account_id => String

See Also:

AWS API Documentation

380	# File 'sig/client.rbs', line 380 def list_problems: (

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

Retrieve a list of the tags (keys and values) that are associated with a specified application. A tag is a label that you optionally define and associate with an application. Each tag consists of a required tag key and an optional associated tag value. A tag key is a general label that acts as a category for more specific tag values. A tag value acts as a descriptor within a tag key.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

Options Hash (params):

:resource_arn (required, String) —
The Amazon Resource Name (ARN) of the application that you want to retrieve tag information for.

Returns:

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

See Also:

AWS API Documentation

397	# File 'sig/client.rbs', line 397 def list_tags_for_resource: (

#list_workloads(params = {}) ⇒ `Types::ListWorkloadsResponse`

Lists the workloads that are configured on a given component.

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_workloads({
  resource_group_name: "ResourceGroupName", # required
  component_name: "ComponentName", # required
  max_results: 1,
  next_token: "PaginationToken",
  account_id: "AccountId",
})

Response structure


resp.workload_list #=> Array
resp.workload_list[0].workload_id #=> String
resp.workload_list[0].component_name #=> String
resp.workload_list[0].workload_name #=> String
resp.workload_list[0].tier #=> String, one of "CUSTOM", "DEFAULT", "DOT_NET_CORE", "DOT_NET_WORKER", "DOT_NET_WEB_TIER", "DOT_NET_WEB", "SQL_SERVER", "SQL_SERVER_ALWAYSON_AVAILABILITY_GROUP", "MYSQL", "POSTGRESQL", "JAVA_JMX", "ORACLE", "SAP_HANA_MULTI_NODE", "SAP_HANA_SINGLE_NODE", "SAP_HANA_HIGH_AVAILABILITY", "SAP_ASE_SINGLE_NODE", "SAP_ASE_HIGH_AVAILABILITY", "SQL_SERVER_FAILOVER_CLUSTER_INSTANCE", "SHAREPOINT", "ACTIVE_DIRECTORY", "SAP_NETWEAVER_STANDARD", "SAP_NETWEAVER_DISTRIBUTED", "SAP_NETWEAVER_HIGH_AVAILABILITY"
resp.workload_list[0].workload_remarks #=> String
resp.workload_list[0].missing_workload_config #=> Boolean
resp.next_token #=> String

Parameters:

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

Options Hash (params):

:resource_group_name (required, String) —
The name of the resource group.
:component_name (required, String) —
The name of the component.
:max_results (Integer) —
The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.
:next_token (String) —
The token to request the next page of results.
:account_id (String) —
The Amazon Web Services account ID of the owner of the workload.

Returns:

(Types::ListWorkloadsResponse) —
Returns a response object which responds to the following methods:
- #workload_list => Array<Types::Workload>
- #next_token => String

See Also:

AWS API Documentation

408	# File 'sig/client.rbs', line 408 def list_workloads: (

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

Remove workload from a component.

Examples:

Request syntax with placeholder values


resp = client.remove_workload({
  resource_group_name: "ResourceGroupName", # required
  component_name: "ComponentName", # required
  workload_id: "WorkloadId", # required
})

Parameters:

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

Options Hash (params):

:resource_group_name (required, String) —
The name of the resource group.
:component_name (required, String) —
The name of the component.
:workload_id (required, String) —
The ID of the workload.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

421	# File 'sig/client.rbs', line 421 def remove_workload: (

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

Add one or more tags (keys and values) to a specified application. A tag is a label that you optionally define and associate with an application. Tags can help you categorize and manage application in different ways, such as by purpose, owner, environment, or other criteria.

Each tag consists of a required tag key and an associated tag value, both of which you define. A tag key is a general label that acts as a category for more specific tag values. A tag value acts as a descriptor within a tag key.

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 Name (ARN) of the application that you want to add one or more tags to.
:tags (required, Array<Types::Tag>) —
A list of tags that to add to the application. A tag consists of a required tag key (Key) and an associated tag value (Value). The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

432	# File 'sig/client.rbs', line 432 def tag_resource: (

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

Remove one or more tags (keys and values) from a specified application.

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 Name (ARN) of the application that you want to remove one or more tags from.
:tag_keys (required, Array<String>) —
The tags (tag keys) that you want to remove from the resource. When you specify a tag key, the action removes both that key and its associated tag value.

To remove more than one tag from the application, append the TagKeys parameter and argument for each additional tag to remove, separated by an ampersand.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

447	# File 'sig/client.rbs', line 447 def untag_resource: (

#update_application(params = {}) ⇒ `Types::UpdateApplicationResponse`

Updates the application.

Examples:

Request syntax with placeholder values


resp = client.update_application({
  resource_group_name: "ResourceGroupName", # required
  ops_center_enabled: false,
  cwe_monitor_enabled: false,
  ops_item_sns_topic_arn: "OpsItemSNSTopicArn",
  sns_notification_arn: "SNSNotificationArn",
  remove_sns_topic: false,
  auto_config_enabled: false,
  attach_missing_permission: false,
})

Response structure


resp.application_info.account_id #=> String
resp.application_info.resource_group_name #=> String
resp.application_info.life_cycle #=> String
resp.application_info.ops_item_sns_topic_arn #=> String
resp.application_info.sns_notification_arn #=> String
resp.application_info.ops_center_enabled #=> Boolean
resp.application_info.cwe_monitor_enabled #=> Boolean
resp.application_info.remarks #=> String
resp.application_info.auto_config_enabled #=> Boolean
resp.application_info.discovery_type #=> String, one of "RESOURCE_GROUP_BASED", "ACCOUNT_BASED"
resp.application_info.attach_missing_permission #=> Boolean

Parameters:

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

Options Hash (params):

:resource_group_name (required, String) —
The name of the resource group.
:ops_center_enabled (Boolean) —
When set to true, creates opsItems for any problems detected on an application.
:cwe_monitor_enabled (Boolean) —
Indicates whether Application Insights can listen to CloudWatch events for the application resources, such as instance terminated, failed deployment, and others.
:ops_item_sns_topic_arn (String) —
The SNS topic provided to Application Insights that is associated to the created opsItem. Allows you to receive notifications for updates to the opsItem.
:sns_notification_arn (String) —
The SNS topic ARN. Allows you to receive SNS notifications for updates and issues with an application.
:remove_sns_topic (Boolean) —
Disassociates the SNS topic from the opsItem created for detected problems.
:auto_config_enabled (Boolean) —
Turns auto-configuration on or off.
:attach_missing_permission (Boolean) —
If set to true, the managed policies for SSM and CW will be attached to the instance roles if they are missing.

Returns:

(Types::UpdateApplicationResponse) —
Returns a response object which responds to the following methods:
- #application_info => Types::ApplicationInfo

See Also:

AWS API Documentation

458	# File 'sig/client.rbs', line 458 def update_application: (

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

Updates the custom component name and/or the list of resources that make up the component.

Examples:

Request syntax with placeholder values


resp = client.update_component({
  resource_group_name: "ResourceGroupName", # required
  component_name: "CustomComponentName", # required
  new_component_name: "CustomComponentName",
  resource_list: ["ResourceARN"],
})

Parameters:

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

Options Hash (params):

:resource_group_name (required, String) —
The name of the resource group.
:component_name (required, String) —
The name of the component.
:new_component_name (String) —
The new name of the component.
:resource_list (Array<String>) —
The list of resource ARNs that belong to the component.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

474	# File 'sig/client.rbs', line 474 def update_component: (

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

Updates the monitoring configurations for the component. The configuration input parameter is an escaped JSON of the configuration and should match the schema of what is returned by DescribeComponentConfigurationRecommendation.

Examples:

Request syntax with placeholder values


resp = client.update_component_configuration({
  resource_group_name: "ResourceGroupName", # required
  component_name: "ComponentName", # required
  monitor: false,
  tier: "CUSTOM", # accepts CUSTOM, DEFAULT, DOT_NET_CORE, DOT_NET_WORKER, DOT_NET_WEB_TIER, DOT_NET_WEB, SQL_SERVER, SQL_SERVER_ALWAYSON_AVAILABILITY_GROUP, MYSQL, POSTGRESQL, JAVA_JMX, ORACLE, SAP_HANA_MULTI_NODE, SAP_HANA_SINGLE_NODE, SAP_HANA_HIGH_AVAILABILITY, SAP_ASE_SINGLE_NODE, SAP_ASE_HIGH_AVAILABILITY, SQL_SERVER_FAILOVER_CLUSTER_INSTANCE, SHAREPOINT, ACTIVE_DIRECTORY, SAP_NETWEAVER_STANDARD, SAP_NETWEAVER_DISTRIBUTED, SAP_NETWEAVER_HIGH_AVAILABILITY
  component_configuration: "ComponentConfiguration",
  auto_config_enabled: false,
})

Parameters:

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

Options Hash (params):

:resource_group_name (required, String) —
The name of the resource group.
:component_name (required, String) —
The name of the component.
:monitor (Boolean) —
Indicates whether the application component is monitored.
:tier (String) —
The tier of the application component.
:component_configuration (String) —
The configuration settings of the component. The value is the escaped JSON of the configuration. For more information about the JSON format, see Working with JSON. You can send a request to DescribeComponentConfigurationRecommendation to see the recommended configuration for a component. For the complete format of the component configuration file, see Component Configuration.
:auto_config_enabled (Boolean) —
Automatically configures the component by applying the recommended configurations.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

486	# File 'sig/client.rbs', line 486 def update_component_configuration: (

#update_log_pattern(params = {}) ⇒ `Types::UpdateLogPatternResponse`

Adds a log pattern to a LogPatternSet.

Examples:

Request syntax with placeholder values


resp = client.update_log_pattern({
  resource_group_name: "ResourceGroupName", # required
  pattern_set_name: "LogPatternSetName", # required
  pattern_name: "LogPatternName", # required
  pattern: "LogPatternRegex",
  rank: 1,
})

Response structure


resp.resource_group_name #=> String
resp.log_pattern.pattern_set_name #=> String
resp.log_pattern.pattern_name #=> String
resp.log_pattern.pattern #=> String
resp.log_pattern.rank #=> Integer

Parameters:

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

Options Hash (params):

:resource_group_name (required, String) —
The name of the resource group.
:pattern_set_name (required, String) —
The name of the log pattern set.
:pattern_name (required, String) —
The name of the log pattern.
:pattern (String) —
The log pattern. The pattern must be DFA compatible. Patterns that utilize forward lookahead or backreference constructions are not supported.
:rank (Integer) —
Rank of the log pattern. Must be a value between 1 and 1,000,000. The patterns are sorted by rank, so we recommend that you set your highest priority patterns with the lowest rank. A pattern of rank 1 will be the first to get matched to a log line. A pattern of rank 1,000,000 will be last to get matched. When you configure custom log patterns from the console, a Low severity pattern translates to a 750,000 rank. A Medium severity pattern translates to a 500,000 rank. And a High severity pattern translates to a 250,000 rank. Rank values less than 1 or greater than 1,000,000 are reserved for Amazon Web Services provided patterns.

Returns:

(Types::UpdateLogPatternResponse) —
Returns a response object which responds to the following methods:
- #resource_group_name => String
- #log_pattern => Types::LogPattern

See Also:

AWS API Documentation

502	# File 'sig/client.rbs', line 502 def update_log_pattern: (

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

Updates the visibility of the problem or specifies the problem as RESOLVED.

Examples:

Request syntax with placeholder values


resp = client.update_problem({
  problem_id: "ProblemId", # required
  update_status: "RESOLVED", # accepts RESOLVED
  visibility: "IGNORED", # accepts IGNORED, VISIBLE
})

Parameters:

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

Options Hash (params):

:problem_id (required, String) —
The ID of the problem.
:update_status (String) —
The status of the problem. Arguments can be passed for only problems that show a status of RECOVERING.
:visibility (String) —
The visibility of a problem. When you pass a value of IGNORED, the problem is removed from the default view, and all notifications for the problem are suspended. When VISIBLE is passed, the IGNORED action is reversed.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

515	# File 'sig/client.rbs', line 515 def update_problem: (

#update_workload(params = {}) ⇒ `Types::UpdateWorkloadResponse`

Adds a workload to a component. Each component can have at most five workloads.

Examples:

Request syntax with placeholder values


resp = client.update_workload({
  resource_group_name: "ResourceGroupName", # required
  component_name: "ComponentName", # required
  workload_id: "WorkloadId",
  workload_configuration: { # required
    workload_name: "WorkloadName",
    tier: "CUSTOM", # accepts CUSTOM, DEFAULT, DOT_NET_CORE, DOT_NET_WORKER, DOT_NET_WEB_TIER, DOT_NET_WEB, SQL_SERVER, SQL_SERVER_ALWAYSON_AVAILABILITY_GROUP, MYSQL, POSTGRESQL, JAVA_JMX, ORACLE, SAP_HANA_MULTI_NODE, SAP_HANA_SINGLE_NODE, SAP_HANA_HIGH_AVAILABILITY, SAP_ASE_SINGLE_NODE, SAP_ASE_HIGH_AVAILABILITY, SQL_SERVER_FAILOVER_CLUSTER_INSTANCE, SHAREPOINT, ACTIVE_DIRECTORY, SAP_NETWEAVER_STANDARD, SAP_NETWEAVER_DISTRIBUTED, SAP_NETWEAVER_HIGH_AVAILABILITY
    configuration: "ComponentConfiguration",
  },
})

Response structure


resp.workload_id #=> String
resp.workload_configuration.workload_name #=> String
resp.workload_configuration.tier #=> String, one of "CUSTOM", "DEFAULT", "DOT_NET_CORE", "DOT_NET_WORKER", "DOT_NET_WEB_TIER", "DOT_NET_WEB", "SQL_SERVER", "SQL_SERVER_ALWAYSON_AVAILABILITY_GROUP", "MYSQL", "POSTGRESQL", "JAVA_JMX", "ORACLE", "SAP_HANA_MULTI_NODE", "SAP_HANA_SINGLE_NODE", "SAP_HANA_HIGH_AVAILABILITY", "SAP_ASE_SINGLE_NODE", "SAP_ASE_HIGH_AVAILABILITY", "SQL_SERVER_FAILOVER_CLUSTER_INSTANCE", "SHAREPOINT", "ACTIVE_DIRECTORY", "SAP_NETWEAVER_STANDARD", "SAP_NETWEAVER_DISTRIBUTED", "SAP_NETWEAVER_HIGH_AVAILABILITY"
resp.workload_configuration.configuration #=> String

Parameters:

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

Options Hash (params):

:resource_group_name (required, String) —
The name of the resource group.
:component_name (required, String) —
The name of the component.
:workload_id (String) —
The ID of the workload.
:workload_configuration (required, Types::WorkloadConfiguration) —
The configuration settings of the workload. The value is the escaped JSON of the configuration.

Returns:

(Types::UpdateWorkloadResponse) —
Returns a response object which responds to the following methods:
- #workload_id => String
- #workload_configuration => Types::WorkloadConfiguration

See Also:

AWS API Documentation

528	# File 'sig/client.rbs', line 528 def update_workload: (

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



2191
2192
2193

# File 'lib/aws-sdk-applicationinsights/client.rb', line 2191

def waiter_names
  []
end

Class: Aws::ApplicationInsights::Client

Overview

Defined Under Namespace

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

.new ⇒ Object

Instance Method Details

#add_workload(params = {}) ⇒ Types::AddWorkloadResponse

Examples:

Request syntax with placeholder values

Response structure

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

#create_application(params = {}) ⇒ Types::CreateApplicationResponse

Examples:

Request syntax with placeholder values

Response structure

#create_component(params = {}) ⇒ Struct

Examples:

Request syntax with placeholder values

#create_log_pattern(params = {}) ⇒ Types::CreateLogPatternResponse

Examples:

Request syntax with placeholder values

Response structure

#delete_application(params = {}) ⇒ Struct

Examples:

Request syntax with placeholder values

#delete_component(params = {}) ⇒ Struct

Examples:

Request syntax with placeholder values

#delete_log_pattern(params = {}) ⇒ Struct

Examples:

Request syntax with placeholder values

#describe_application(params = {}) ⇒ Types::DescribeApplicationResponse

Examples:

Request syntax with placeholder values

Response structure

#describe_component(params = {}) ⇒ Types::DescribeComponentResponse

Examples:

Request syntax with placeholder values

Response structure

#describe_component_configuration(params = {}) ⇒ Types::DescribeComponentConfigurationResponse

Examples:

Request syntax with placeholder values

Response structure

#describe_component_configuration_recommendation(params = {}) ⇒ Types::DescribeComponentConfigurationRecommendationResponse

Examples:

Request syntax with placeholder values

Response structure

#describe_log_pattern(params = {}) ⇒ Types::DescribeLogPatternResponse

Examples:

Request syntax with placeholder values

Response structure

#describe_observation(params = {}) ⇒ Types::DescribeObservationResponse

Examples:

Request syntax with placeholder values

Response structure

#describe_problem(params = {}) ⇒ Types::DescribeProblemResponse

Examples:

Request syntax with placeholder values

Response structure

#describe_problem_observations(params = {}) ⇒ Types::DescribeProblemObservationsResponse

Examples:

Request syntax with placeholder values

Response structure

#describe_workload(params = {}) ⇒ Types::DescribeWorkloadResponse

Examples:

Request syntax with placeholder values

Response structure

#list_applications(params = {}) ⇒ Types::ListApplicationsResponse

Examples:

Request syntax with placeholder values

Response structure

#initialize(options) ⇒ `Client`

.identifier ⇒ `Object` (readonly)

.errors_module ⇒ `Object`

.new ⇒ `Object`

#add_workload(params = {}) ⇒ `Types::AddWorkloadResponse`

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

#create_application(params = {}) ⇒ `Types::CreateApplicationResponse`

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

#create_log_pattern(params = {}) ⇒ `Types::CreateLogPatternResponse`

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

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

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

#describe_application(params = {}) ⇒ `Types::DescribeApplicationResponse`

#describe_component(params = {}) ⇒ `Types::DescribeComponentResponse`

#describe_component_configuration(params = {}) ⇒ `Types::DescribeComponentConfigurationResponse`

#describe_component_configuration_recommendation(params = {}) ⇒ `Types::DescribeComponentConfigurationRecommendationResponse`

#describe_log_pattern(params = {}) ⇒ `Types::DescribeLogPatternResponse`

#describe_observation(params = {}) ⇒ `Types::DescribeObservationResponse`

#describe_problem(params = {}) ⇒ `Types::DescribeProblemResponse`

#describe_problem_observations(params = {}) ⇒ `Types::DescribeProblemObservationsResponse`

#describe_workload(params = {}) ⇒ `Types::DescribeWorkloadResponse`

#list_applications(params = {}) ⇒ `Types::ListApplicationsResponse`

#list_components(params = {}) ⇒ `Types::ListComponentsResponse`

#list_configuration_history(params = {}) ⇒ `Types::ListConfigurationHistoryResponse`

#list_log_pattern_sets(params = {}) ⇒ `Types::ListLogPatternSetsResponse`

#list_log_patterns(params = {}) ⇒ `Types::ListLogPatternsResponse`

#list_problems(params = {}) ⇒ `Types::ListProblemsResponse`

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

#list_workloads(params = {}) ⇒ `Types::ListWorkloadsResponse`

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

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

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

#update_application(params = {}) ⇒ `Types::UpdateApplicationResponse`

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

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

#update_log_pattern(params = {}) ⇒ `Types::UpdateLogPatternResponse`

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

#update_workload(params = {}) ⇒ `Types::UpdateWorkloadResponse`

#waiter_names ⇒ `Object`