You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::CostandUsageReportService::Client

Inherits:
Seahorse::Client::Base show all
Includes:
Aws::ClientStubs
Defined in:
gems/aws-sdk-costandusagereportservice/lib/aws-sdk-costandusagereportservice/client.rb

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from Aws::ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider)

    Your AWS credentials. This can be an instance of any one of the following classes:

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

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

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

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

    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 IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails to enable retries and extended timeouts.
  • :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 search 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)
  • :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.

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

  • :endpoint (String)

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test endpoints. This should be avalid HTTP(S) URI.

  • :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. Defaults to false.

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

  • :profile (String) — default: "default"

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :retry_base_delay (Float) — default: 0.3

    The base delay in seconds used by the default backoff function.

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

    @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 and auth errors from expired credentials.

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

  • :secret_access_key (String)
  • :session_token (String)
  • :simple_json (Boolean) — default: false

    Disables request parameter conversion, validation, and formatting. Also disable response data type conversions. 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.

    When :simple_json is enabled, the request parameters hash must be formatted exactly as the DynamoDB API expects.

  • :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 Aws::ClientStubs#stub_responses. See Aws::ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :validate_params (Boolean) — default: true

    When true, request parameters are validated before sending the request.



206
207
208
# File 'gems/aws-sdk-costandusagereportservice/lib/aws-sdk-costandusagereportservice/client.rb', line 206

def initialize(*args)
  super
end

Instance Method Details

#delete_report_definition(params = {}) ⇒ Types::DeleteReportDefinitionResponse

Delete a specified report definition

Examples:

Request syntax with placeholder values


resp = client.delete_report_definition({
  report_name: "ReportName",
})

Response structure


resp.response_message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :report_name (String)

    Preferred name for a report, it has to be unique. Must starts with a number/letter, case sensitive. Limited to 256 characters.

Returns:

See Also:



236
237
238
239
# File 'gems/aws-sdk-costandusagereportservice/lib/aws-sdk-costandusagereportservice/client.rb', line 236

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

#describe_report_definitions(params = {}) ⇒ Types::DescribeReportDefinitionsResponse

Describe a list of report definitions owned by the account

Examples:

Request syntax with placeholder values


resp = client.describe_report_definitions({
  max_results: 1,
  next_token: "GenericString",
})

Response structure


resp.report_definitions #=> Array
resp.report_definitions[0].report_name #=> String
resp.report_definitions[0].time_unit #=> String, one of "HOURLY", "DAILY"
resp.report_definitions[0].format #=> String, one of "textORcsv"
resp.report_definitions[0].compression #=> String, one of "ZIP", "GZIP"
resp.report_definitions[0].additional_schema_elements #=> Array
resp.report_definitions[0].additional_schema_elements[0] #=> String, one of "RESOURCES"
resp.report_definitions[0].s3_bucket #=> String
resp.report_definitions[0].s3_prefix #=> String
resp.report_definitions[0].s3_region #=> String, one of "us-east-1", "us-west-1", "us-west-2", "eu-central-1", "eu-west-1", "ap-southeast-1", "ap-southeast-2", "ap-northeast-1"
resp.report_definitions[0].additional_artifacts #=> Array
resp.report_definitions[0].additional_artifacts[0] #=> String, one of "REDSHIFT", "QUICKSIGHT"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer)

    The max number of results returned by the operation.

  • :next_token (String)

    A generic string.

Returns:

See Also:



281
282
283
284
# File 'gems/aws-sdk-costandusagereportservice/lib/aws-sdk-costandusagereportservice/client.rb', line 281

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

#put_report_definition(params = {}) ⇒ Struct

Create a new report definition

Examples:

Request syntax with placeholder values


resp = client.put_report_definition({
  report_definition: { # required
    report_name: "ReportName", # required
    time_unit: "HOURLY", # required, accepts HOURLY, DAILY
    format: "textORcsv", # required, accepts textORcsv
    compression: "ZIP", # required, accepts ZIP, GZIP
    additional_schema_elements: ["RESOURCES"], # required, accepts RESOURCES
    s3_bucket: "S3Bucket", # required
    s3_prefix: "S3Prefix", # required
    s3_region: "us-east-1", # required, accepts us-east-1, us-west-1, us-west-2, eu-central-1, eu-west-1, ap-southeast-1, ap-southeast-2, ap-northeast-1
    additional_artifacts: ["REDSHIFT"], # accepts REDSHIFT, QUICKSIGHT
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :report_definition (required, Types::ReportDefinition)

    The definition of AWS Cost and Usage Report. Customer can specify the report name, time unit, report format, compression format, S3 bucket and additional artifacts and schema elements in the definition.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



315
316
317
318
# File 'gems/aws-sdk-costandusagereportservice/lib/aws-sdk-costandusagereportservice/client.rb', line 315

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