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

Overview

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

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

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 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)
  • :active_endpoint_cache (Boolean) — default: false

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

  • :adaptive_retry_wait_to_fill (Boolean) — default: true

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: ""

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1"

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :disable_host_prefix_injection (Boolean) — default: false

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

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

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

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

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

  • :http_proxy (URI::HTTP, String)

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_open_timeout (Float) — default: 15

    The number of seconds to wait when opening a HTTP session before raising a Timeout::Error.

  • :http_read_timeout (Integer) — default: 60

    The default number of seconds to wait for response data. 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_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_wire_trace (Boolean) — default: false

    When true, HTTP debug output will be sent to the :logger.

  • :ssl_verify_peer (Boolean) — default: true

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

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



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

def initialize(*args)
  super
end

Instance Method Details

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

Deletes the specified report.

Examples:

Example: To delete the AWS Cost and Usage report named ExampleReport.


# The following example deletes the AWS Cost and Usage report named ExampleReport.

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

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)

    The name of the report that you want to create. The name must be unique, is case sensitive, and can't include spaces.

Returns:

See Also:



354
355
356
357
# File 'gems/aws-sdk-costandusagereportservice/lib/aws-sdk-costandusagereportservice/client.rb', line 354

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

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

Lists the AWS Cost and Usage reports available to this account.

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

Examples:

Example: To list the AWS Cost and Usage reports for the account.


# The following example lists the AWS Cost and Usage reports for the account.

resp = client.describe_report_definitions({
  max_results: 5, 
})

resp.to_h outputs the following:
{
  report_definitions: [
    {
      additional_artifacts: [
        "QUICKSIGHT", 
      ], 
      additional_schema_elements: [
        "RESOURCES", 
      ], 
      compression: "GZIP", 
      format: "textORcsv", 
      report_name: "ExampleReport", 
      s3_bucket: "example-s3-bucket", 
      s3_prefix: "exampleprefix", 
      s3_region: "us-east-1", 
      time_unit: "HOURLY", 
    }, 
    {
      additional_artifacts: [
        "QUICKSIGHT", 
      ], 
      additional_schema_elements: [
        "RESOURCES", 
      ], 
      compression: "GZIP", 
      format: "textORcsv", 
      report_name: "ExampleReport2", 
      s3_bucket: "example-s3-bucket", 
      s3_prefix: "exampleprefix", 
      s3_region: "us-east-1", 
      time_unit: "HOURLY", 
    }, 
  ], 
}

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", "Parquet"
resp.report_definitions[0].compression #=> String, one of "ZIP", "GZIP", "Parquet"
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", "eu-north-1", "ap-northeast-3", "ap-east-1"
resp.report_definitions[0].additional_artifacts #=> Array
resp.report_definitions[0].additional_artifacts[0] #=> String, one of "REDSHIFT", "QUICKSIGHT", "ATHENA"
resp.report_definitions[0].refresh_closed_reports #=> Boolean
resp.report_definitions[0].report_versioning #=> String, one of "CREATE_NEW_REPORT", "OVERWRITE_REPORT"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer)

    The maximum number of results that AWS returns for the operation.

  • :next_token (String)

    A generic string.

Returns:

See Also:



448
449
450
451
# File 'gems/aws-sdk-costandusagereportservice/lib/aws-sdk-costandusagereportservice/client.rb', line 448

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

#modify_report_definition(params = {}) ⇒ Struct

Allows you to programatically update your report preferences.

Examples:

Request syntax with placeholder values


resp = client.modify_report_definition({
  report_name: "ReportName", # required
  report_definition: { # required
    report_name: "ReportName", # required
    time_unit: "HOURLY", # required, accepts HOURLY, DAILY
    format: "textORcsv", # required, accepts textORcsv, Parquet
    compression: "ZIP", # required, accepts ZIP, GZIP, Parquet
    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, eu-north-1, ap-northeast-3, ap-east-1
    additional_artifacts: ["REDSHIFT"], # accepts REDSHIFT, QUICKSIGHT, ATHENA
    refresh_closed_reports: false,
    report_versioning: "CREATE_NEW_REPORT", # accepts CREATE_NEW_REPORT, OVERWRITE_REPORT
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :report_name (required, String)

    The name of the report that you want to create. The name must be unique, is case sensitive, and can't include spaces.

  • :report_definition (required, Types::ReportDefinition)

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

Returns:

  • (Struct)

    Returns an empty response.

See Also:



489
490
491
492
# File 'gems/aws-sdk-costandusagereportservice/lib/aws-sdk-costandusagereportservice/client.rb', line 489

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

#put_report_definition(params = {}) ⇒ Struct

Creates a new report using the description that you provide.

Examples:

Example: To create a report named ExampleReport.


# The following example creates a AWS Cost and Usage report named ExampleReport.

resp = client.put_report_definition({
  report_definition: {
    additional_artifacts: [
      "REDSHIFT", 
      "QUICKSIGHT", 
    ], 
    additional_schema_elements: [
      "RESOURCES", 
    ], 
    compression: "ZIP", 
    format: "textORcsv", 
    report_name: "ExampleReport", 
    s3_bucket: "example-s3-bucket", 
    s3_prefix: "exampleprefix", 
    s3_region: "us-east-1", 
    time_unit: "DAILY", 
  }, 
})

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, Parquet
    compression: "ZIP", # required, accepts ZIP, GZIP, Parquet
    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, eu-north-1, ap-northeast-3, ap-east-1
    additional_artifacts: ["REDSHIFT"], # accepts REDSHIFT, QUICKSIGHT, ATHENA
    refresh_closed_reports: false,
    report_versioning: "CREATE_NEW_REPORT", # accepts CREATE_NEW_REPORT, OVERWRITE_REPORT
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :report_definition (required, Types::ReportDefinition)

    Represents the output of the PutReportDefinition operation. The content consists of the detailed metadata and data file information.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



548
549
550
551
# File 'gems/aws-sdk-costandusagereportservice/lib/aws-sdk-costandusagereportservice/client.rb', line 548

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