class Aws::ApplicationCostProfiler::Client

@api private

# File lib/aws-sdk-applicationcostprofiler/client.rb, line 613
def errors_module
  Errors
end

@overload initialize(options)

@param [Hash] options
@option options [required, Aws::CredentialProvider] :credentials
  Your AWS credentials. This can be an instance of any one of the
  following classes:

  * `Aws::Credentials` - Used for configuring static, non-refreshing
    credentials.

  * `Aws::SharedCredentials` - Used for loading static credentials from a
    shared file, such as `~/.aws/config`.

  * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.

  * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
    assume a role after providing credentials via the web.

  * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
    access token generated from `aws login`.

  * `Aws::ProcessCredentials` - Used for loading credentials from a
    process that outputs to stdout.

  * `Aws::InstanceProfileCredentials` - Used for loading credentials
    from an EC2 IMDS on an EC2 instance.

  * `Aws::ECSCredentials` - Used for loading credentials from
    instances running in ECS.

  * `Aws::CognitoIdentityCredentials` - Used for loading credentials
    from the Cognito Identity service.

  When `:credentials` are not configured directly, the following
  locations will be searched for credentials:

  * `Aws.config[:credentials]`
  * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
  * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
  * `~/.aws/credentials`
  * `~/.aws/config`
  * EC2/ECS IMDS instance profile - When used by default, the timeouts
    are very aggressive. Construct and pass an instance of
    `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
    enable retries and extended timeouts.

@option options [required, String] :region
  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`

@option options [String] :access_key_id

@option options [Boolean] :active_endpoint_cache (false)
  When set to `true`, a thread polling for endpoints will be running in
  the background every 60 secs (default). Defaults to `false`.

@option options [Boolean] :adaptive_retry_wait_to_fill (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.

@option options [Boolean] :client_side_monitoring (false)
  When `true`, client-side metrics will be collected for all API requests from
  this client.

@option options [String] :client_side_monitoring_client_id ("")
  Allows you to provide an identifier for this client which will be attached to
  all generated client side metrics. Defaults to an empty string.

@option options [String] :client_side_monitoring_host ("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.

@option options [Integer] :client_side_monitoring_port (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.

@option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
  Allows you to provide a custom client-side monitoring publisher class. By default,
  will use the Client Side Monitoring Agent Publisher.

@option options [Boolean] :convert_params (true)
  When `true`, an attempt is made to coerce request parameters into
  the required types.

@option options [Boolean] :correct_clock_skew (true)
  Used only in `standard` and adaptive retry modes. Specifies whether to apply
  a clock skew correction and retry requests with skewed client clocks.

@option options [Boolean] :disable_host_prefix_injection (false)
  Set to true to disable SDK automatically adding host prefix
  to default service endpoint when available.

@option options [String] :endpoint
  The client endpoint is normally constructed from the `:region`
  option. You should only configure an `:endpoint` when connecting
  to test or custom endpoints. This should be a valid HTTP(S) URI.

@option options [Integer] :endpoint_cache_max_entries (1000)
  Used for the maximum size limit of the LRU cache storing endpoints data
  for endpoint discovery enabled operations. Defaults to 1000.

@option options [Integer] :endpoint_cache_max_threads (10)
  Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

@option options [Integer] :endpoint_cache_poll_interval (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.

@option options [Boolean] :endpoint_discovery (false)
  When set to `true`, endpoint discovery will be enabled for operations when available.

@option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
  The log formatter.

@option options [Symbol] :log_level (:info)
  The log level to send messages to the `:logger` at.

@option options [Logger] :logger
  The Logger instance to send log messages to.  If this option
  is not set, logging will be disabled.

@option options [Integer] :max_attempts (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.

@option options [String] :profile ("default")
  Used when loading credentials from the shared credentials file
  at HOME/.aws/credentials.  When not specified, 'default' is used.

@option options [Proc] :retry_backoff
  A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
  This option is only used in the `legacy` retry mode.

@option options [Float] :retry_base_delay (0.3)
  The base delay in seconds used by the default backoff function. This option
  is only used in the `legacy` retry mode.

@option options [Symbol] :retry_jitter (: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

@option options [Integer] :retry_limit (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.

@option options [Integer] :retry_max_delay (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.

@option options [String] :retry_mode ("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.

@option options [String] :secret_access_key

@option options [String] :session_token

@option options [Boolean] :stub_responses (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.

@option options [Boolean] :validate_params (true)
  When `true`, request parameters are validated before
  sending the request.

@option options [URI::HTTP,String] :http_proxy A proxy to send
  requests through.  Formatted like 'http://proxy.com:123'.

@option options [Float] :http_open_timeout (15) The number of
  seconds to wait when opening a HTTP session before raising a
  `Timeout::Error`.

@option options [Integer] :http_read_timeout (60) The default
  number of seconds to wait for response data.  This value can
  safely be set per-request on the session.

@option options [Float] :http_idle_timeout (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.

@option options [Float] :http_continue_timeout (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.

@option options [Boolean] :http_wire_trace (false) When `true`,
  HTTP debug output will be sent to the `:logger`.

@option options [Boolean] :ssl_verify_peer (true) When `true`,
  SSL peer certificates are verified when establishing a
  connection.

@option options [String] :ssl_ca_bundle 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.

@option options [String] :ssl_ca_directory 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.

# File lib/aws-sdk-applicationcostprofiler/client.rb, line 324
def initialize(*args)
  super
end

@param params ({}) @api private

# File lib/aws-sdk-applicationcostprofiler/client.rb, line 588
def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config)
  context[:gem_name] = 'aws-sdk-applicationcostprofiler'
  context[:gem_version] = '1.3.0'
  Seahorse::Client::Request.new(handlers, context)
end

Deletes the specified report definition in AWS Application Cost Profiler. This stops the report from being generated.

@option params [required, String] :report_id

Required. ID of the report to delete.

@return [Types::DeleteReportDefinitionResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::DeleteReportDefinitionResult#report_id #report_id} => String

@example Request syntax with placeholder values

resp = client.delete_report_definition({
  report_id: "ReportId", # required
})

@example Response structure

resp.report_id #=> String

@see docs.aws.amazon.com/goto/WebAPI/AWSApplicationCostProfiler-2020-09-10/DeleteReportDefinition AWS API Documentation

@overload delete_report_definition(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-applicationcostprofiler/client.rb, line 354
def delete_report_definition(params = {}, options = {})
  req = build_request(:delete_report_definition, params)
  req.send_request(options)
end

Retrieves the definition of a report already configured in AWS Application Cost Profiler.

@option params [required, String] :report_id

ID of the report to retrieve.

@return [Types::GetReportDefinitionResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::GetReportDefinitionResult#report_id #report_id} => String
* {Types::GetReportDefinitionResult#report_description #report_description} => String
* {Types::GetReportDefinitionResult#report_frequency #report_frequency} => String
* {Types::GetReportDefinitionResult#format #format} => String
* {Types::GetReportDefinitionResult#destination_s3_location #destination_s3_location} => Types::S3Location
* {Types::GetReportDefinitionResult#created_at #created_at} => Time
* {Types::GetReportDefinitionResult#last_updated #last_updated} => Time

@example Request syntax with placeholder values

resp = client.get_report_definition({
  report_id: "ReportId", # required
})

@example Response structure

resp.report_id #=> String
resp.report_description #=> String
resp.report_frequency #=> String, one of "MONTHLY", "DAILY", "ALL"
resp.format #=> String, one of "CSV", "PARQUET"
resp.destination_s3_location.bucket #=> String
resp.destination_s3_location.prefix #=> String
resp.created_at #=> Time
resp.last_updated #=> Time

@see docs.aws.amazon.com/goto/WebAPI/AWSApplicationCostProfiler-2020-09-10/GetReportDefinition AWS API Documentation

@overload get_report_definition(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-applicationcostprofiler/client.rb, line 396
def get_report_definition(params = {}, options = {})
  req = build_request(:get_report_definition, params)
  req.send_request(options)
end

Ingests application usage data from Amazon Simple Storage Service (Amazon S3).

The data must already exist in the S3 location. As part of the action, AWS Application Cost Profiler copies the object from your S3 bucket to an S3 bucket owned by Amazon for processing asynchronously.

@option params [required, Types::SourceS3Location] :source_s3_location

Amazon S3 location to import application usage data from.

@return [Types::ImportApplicationUsageResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::ImportApplicationUsageResult#import_id #import_id} => String

@example Request syntax with placeholder values

resp = client.import_application_usage({
  source_s3_location: { # required
    bucket: "S3Bucket", # required
    key: "S3Key", # required
    region: "ap-east-1", # accepts ap-east-1, me-south-1, eu-south-1, af-south-1
  },
})

@example Response structure

resp.import_id #=> String

@see docs.aws.amazon.com/goto/WebAPI/AWSApplicationCostProfiler-2020-09-10/ImportApplicationUsage AWS API Documentation

@overload import_application_usage(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-applicationcostprofiler/client.rb, line 433
def import_application_usage(params = {}, options = {})
  req = build_request(:import_application_usage, params)
  req.send_request(options)
end

Retrieves a list of all reports and their configurations for your AWS account.

The maximum number of reports is one.

@option params [String] :next_token

The token value from a previous call to access the next page of
results.

@option params [Integer] :max_results

The maximum number of results to return.

@return [Types::ListReportDefinitionsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::ListReportDefinitionsResult#report_definitions #report_definitions} => Array<Types::ReportDefinition>
* {Types::ListReportDefinitionsResult#next_token #next_token} => String

The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.

@example Request syntax with placeholder values

resp = client.list_report_definitions({
  next_token: "Token",
  max_results: 1,
})

@example Response structure

resp.report_definitions #=> Array
resp.report_definitions[0].report_id #=> String
resp.report_definitions[0].report_description #=> String
resp.report_definitions[0].report_frequency #=> String, one of "MONTHLY", "DAILY", "ALL"
resp.report_definitions[0].format #=> String, one of "CSV", "PARQUET"
resp.report_definitions[0].destination_s3_location.bucket #=> String
resp.report_definitions[0].destination_s3_location.prefix #=> String
resp.report_definitions[0].created_at #=> Time
resp.report_definitions[0].last_updated_at #=> Time
resp.next_token #=> String

@see docs.aws.amazon.com/goto/WebAPI/AWSApplicationCostProfiler-2020-09-10/ListReportDefinitions AWS API Documentation

@overload list_report_definitions(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-applicationcostprofiler/client.rb, line 481
def list_report_definitions(params = {}, options = {})
  req = build_request(:list_report_definitions, params)
  req.send_request(options)
end

Creates the report definition for a report in Application Cost Profiler.

@option params [required, String] :report_id

Required. ID of the report. You can choose any valid string matching
the pattern for the ID.

@option params [required, String] :report_description

Required. Description of the report.

@option params [required, String] :report_frequency

Required. The cadence to generate the report.

@option params [required, String] :format

Required. The format to use for the generated report.

@option params [required, Types::S3Location] :destination_s3_location

Required. Amazon Simple Storage Service (Amazon S3) location where
Application Cost Profiler uploads the report.

@return [Types::PutReportDefinitionResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::PutReportDefinitionResult#report_id #report_id} => String

@example Request syntax with placeholder values

resp = client.put_report_definition({
  report_id: "ReportId", # required
  report_description: "ReportDescription", # required
  report_frequency: "MONTHLY", # required, accepts MONTHLY, DAILY, ALL
  format: "CSV", # required, accepts CSV, PARQUET
  destination_s3_location: { # required
    bucket: "S3Bucket", # required
    prefix: "S3Prefix", # required
  },
})

@example Response structure

resp.report_id #=> String

@see docs.aws.amazon.com/goto/WebAPI/AWSApplicationCostProfiler-2020-09-10/PutReportDefinition AWS API Documentation

@overload put_report_definition(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-applicationcostprofiler/client.rb, line 531
def put_report_definition(params = {}, options = {})
  req = build_request(:put_report_definition, params)
  req.send_request(options)
end

Updates existing report in AWS Application Cost Profiler.

@option params [required, String] :report_id

Required. ID of the report to update.

@option params [required, String] :report_description

Required. Description of the report.

@option params [required, String] :report_frequency

Required. The cadence to generate the report.

@option params [required, String] :format

Required. The format to use for the generated report.

@option params [required, Types::S3Location] :destination_s3_location

Required. Amazon Simple Storage Service (Amazon S3) location where
Application Cost Profiler uploads the report.

@return [Types::UpdateReportDefinitionResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::UpdateReportDefinitionResult#report_id #report_id} => String

@example Request syntax with placeholder values

resp = client.update_report_definition({
  report_id: "ReportId", # required
  report_description: "ReportDescription", # required
  report_frequency: "MONTHLY", # required, accepts MONTHLY, DAILY, ALL
  format: "CSV", # required, accepts CSV, PARQUET
  destination_s3_location: { # required
    bucket: "S3Bucket", # required
    prefix: "S3Prefix", # required
  },
})

@example Response structure

resp.report_id #=> String

@see docs.aws.amazon.com/goto/WebAPI/AWSApplicationCostProfiler-2020-09-10/UpdateReportDefinition AWS API Documentation

@overload update_report_definition(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-applicationcostprofiler/client.rb, line 579
def update_report_definition(params = {}, options = {})
  req = build_request(:update_report_definition, params)
  req.send_request(options)
end

@api private @deprecated

# File lib/aws-sdk-applicationcostprofiler/client.rb, line 603
def waiter_names
  []
end