Class: Aws::Invoicing::Client

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

Overview

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

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

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

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

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

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

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

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

    A Bearer Token Provider. This can be an 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::Invoicing::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::Invoicing::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.



451
452
453
 
# File 'gems/aws-sdk-invoicing/lib/aws-sdk-invoicing/client.rb', line 451

def initialize(*args)
  super
end

Instance Method Details

#batch_get_invoice_profile(params = {}) ⇒ Types::BatchGetInvoiceProfileResponse

This gets the invoice profile associated with a set of accounts. The accounts must be linked accounts under the requester management account organization.

Examples:

Example: BatchGetInvoiceProfile


resp = client.batch_get_invoice_profile({
  account_ids: [
    "111111111111", 
  ], 
})

resp.to_h outputs the following:
{
  profiles: [
    {
      account_id: "111111111111", 
      issuer: "Test", 
      receiver_address: {
        address_line_1: "Test", 
        city: "Test", 
        country_code: "LU", 
        postal_code: "Test", 
        state_or_region: "Test", 
      }, 
      receiver_email: "test@amazon.com", 
      receiver_name: "TestAccount", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.batch_get_invoice_profile({
  account_ids: ["AccountIdString"], # required
})

Response structure


resp.profiles #=> Array
resp.profiles[0]. #=> String
resp.profiles[0].receiver_name #=> String
resp.profiles[0].receiver_address.address_line_1 #=> String
resp.profiles[0].receiver_address.address_line_2 #=> String
resp.profiles[0].receiver_address.address_line_3 #=> String
resp.profiles[0].receiver_address.district_or_county #=> String
resp.profiles[0].receiver_address.city #=> String
resp.profiles[0].receiver_address.state_or_region #=> String
resp.profiles[0].receiver_address.country_code #=> String
resp.profiles[0].receiver_address.company_name #=> String
resp.profiles[0].receiver_address.postal_code #=> String
resp.profiles[0].receiver_email #=> String
resp.profiles[0].issuer #=> String
resp.profiles[0].tax_registration_number #=> String

Parameters:

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

    ({})

Options Hash (params):

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

    Retrieves the corresponding invoice profile data for these account IDs.

Returns:

See Also:



525
526
527
528
 
# File 'gems/aws-sdk-invoicing/lib/aws-sdk-invoicing/client.rb', line 525

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

#create_invoice_unit(params = {}) ⇒ Types::CreateInvoiceUnitResponse

This creates a new invoice unit with the provided definition.

Examples:

Example: CreateInvoiceUnit


resp = client.create_invoice_unit({
  description: "Example Invoice Unit Description", 
  invoice_receiver: "111111111111", 
  name: "Example Invoice Unit", 
  resource_tags: [
    {
      key: "TagKey", 
      value: "TagValue", 
    }, 
  ], 
  rule: {
    linked_accounts: [
      "222222222222", 
    ], 
  }, 
  tax_inheritance_disabled: false, 
})

resp.to_h outputs the following:
{
  invoice_unit_arn: "arn:aws:invoicing::000000000000:invoice-unit/12345678", 
}

Request syntax with placeholder values


resp = client.create_invoice_unit({
  name: "InvoiceUnitName", # required
  invoice_receiver: "AccountIdString", # required
  description: "DescriptionString",
  tax_inheritance_disabled: false,
  rule: { # required
    linked_accounts: ["AccountIdString"],
  },
  resource_tags: [
    {
      key: "ResourceTagKey", # required
      value: "ResourceTagValue", # required
    },
  ],
})

Response structure


resp.invoice_unit_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    The unique name of the invoice unit that is shown on the generated invoice. This can't be changed once it is set. To change this name, you must delete the invoice unit recreate.

  • :invoice_receiver (required, String) —

    The Amazon Web Services account ID chosen to be the receiver of an invoice unit. All invoices generated for that invoice unit will be sent to this account ID.

  • :description (String) —

    The invoice unit's description. This can be changed at a later time.

  • :tax_inheritance_disabled (Boolean) —

    Whether the invoice unit based tax inheritance is/ should be enabled or disabled.

  • :rule (required, Types::InvoiceUnitRule) —

    The InvoiceUnitRule object used to create invoice units.

  • :resource_tags (Array<Types::ResourceTag>) —

    The tag structure that contains a tag key and value.

Returns:

See Also:



611
612
613
614
 
# File 'gems/aws-sdk-invoicing/lib/aws-sdk-invoicing/client.rb', line 611

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

#delete_invoice_unit(params = {}) ⇒ Types::DeleteInvoiceUnitResponse

This deletes an invoice unit with the provided invoice unit ARN.

Examples:

Example: DeleteInvoiceUnit


resp = client.delete_invoice_unit({
  invoice_unit_arn: "arn:aws:invoicing::000000000000:invoice-unit/12345678", 
})

resp.to_h outputs the following:
{
  invoice_unit_arn: "arn:aws:invoicing::000000000000:invoice-unit/12345678", 
}

Request syntax with placeholder values


resp = client.delete_invoice_unit({
  invoice_unit_arn: "InvoiceUnitArnString", # required
})

Response structure


resp.invoice_unit_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :invoice_unit_arn (required, String) —

    The ARN to identify an invoice unit. This information can't be modified or deleted.

Returns:

See Also:



652
653
654
655
 
# File 'gems/aws-sdk-invoicing/lib/aws-sdk-invoicing/client.rb', line 652

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

#get_invoice_unit(params = {}) ⇒ Types::GetInvoiceUnitResponse

This retrieves the invoice unit definition.

Examples:

Example: GetInvoiceUnit as of current time


resp = client.get_invoice_unit({
  invoice_unit_arn: "arn:aws:invoicing::000000000000:invoice-unit/12345678", 
})

resp.to_h outputs the following:
{
  description: "Description changed on 1733788800", 
  invoice_receiver: "111111111111", 
  invoice_unit_arn: "arn:aws:invoicing::000000000000:invoice-unit/12345678", 
  last_modified: Time.parse(1733788800), 
  name: "Example Invoice Unit A", 
  rule: {
    linked_accounts: [
      "222222222222", 
    ], 
  }, 
  tax_inheritance_disabled: false, 
}

Example: GetInvoiceUnit as of specified time


resp = client.get_invoice_unit({
  as_of: Time.parse(1733097600), 
  invoice_unit_arn: "arn:aws:invoicing::000000000000:invoice-unit/87654321", 
})

resp.to_h outputs the following:
{
  description: "Description changed on 1733011200", 
  invoice_receiver: "333333333333", 
  invoice_unit_arn: "arn:aws:invoicing::000000000000:invoice-unit/87654321", 
  last_modified: Time.parse(1733011200), 
  name: "Example Invoice Unit B", 
  rule: {
    linked_accounts: [
      "333333333333", 
    ], 
  }, 
  tax_inheritance_disabled: false, 
}

Request syntax with placeholder values


resp = client.get_invoice_unit({
  invoice_unit_arn: "InvoiceUnitArnString", # required
  as_of: Time.now,
})

Response structure


resp.invoice_unit_arn #=> String
resp.invoice_receiver #=> String
resp.name #=> String
resp.description #=> String
resp.tax_inheritance_disabled #=> Boolean
resp.rule.linked_accounts #=> Array
resp.rule.linked_accounts[0] #=> String
resp.last_modified #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :invoice_unit_arn (required, String) —

    The ARN to identify an invoice unit. This information can't be modified or deleted.

  • :as_of (Time, DateTime, Date, Integer, String) —

    The state of an invoice unit at a specified time. You can see legacy invoice units that are currently deleted if the AsOf time is set to before it was deleted. If an AsOf is not provided, the default value is the current time.

Returns:

See Also:



745
746
747
748
 
# File 'gems/aws-sdk-invoicing/lib/aws-sdk-invoicing/client.rb', line 745

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

#list_invoice_units(params = {}) ⇒ Types::ListInvoiceUnitsResponse

This fetches a list of all invoice unit definitions for a given account, as of the provided AsOf date.

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

Examples:

Example: ListInvoiceUnits without filters as of current time


resp = client.list_invoice_units({
})

resp.to_h outputs the following:
{
  invoice_units: [
    {
      description: "Description changed on 1733788800", 
      invoice_receiver: "111111111111", 
      invoice_unit_arn: "arn:aws:invoicing::000000000000:invoice-unit/12345678", 
      last_modified: Time.parse(1733788800), 
      name: "Example Invoice Unit A", 
      rule: {
        linked_accounts: [
          "222222222222", 
        ], 
      }, 
      tax_inheritance_disabled: false, 
    }, 
    {
      description: "Description changed on 1733788800", 
      invoice_receiver: "333333333333", 
      invoice_unit_arn: "arn:aws:invoicing::000000000000:invoice-unit/87654321", 
      last_modified: Time.parse(1733788800), 
      name: "Example Invoice Unit B", 
      rule: {
        linked_accounts: [
          "333333333333", 
        ], 
      }, 
      tax_inheritance_disabled: true, 
    }, 
  ], 
}

Example: ListInvoiceUnits with filters as of specified time


resp = client.list_invoice_units({
  as_of: Time.parse(1733097600), 
  filters: {
    invoice_receivers: [
      "333333333333", 
    ], 
  }, 
})

resp.to_h outputs the following:
{
  invoice_units: [
    {
      description: "Description changed on 1733011200", 
      invoice_receiver: "333333333333", 
      invoice_unit_arn: "arn:aws:invoicing::000000000000:invoice-unit/87654321", 
      last_modified: Time.parse(1733011200), 
      name: "Example Invoice Unit B", 
      rule: {
        linked_accounts: [
          "333333333333", 
        ], 
      }, 
      tax_inheritance_disabled: false, 
    }, 
  ], 
}

Example: ListInvoiceUnits with pagination - first page


resp = client.list_invoice_units({
  max_results: 1, 
})

resp.to_h outputs the following:
{
  invoice_units: [
    {
      description: "Description changed on 1733788800", 
      invoice_receiver: "111111111111", 
      invoice_unit_arn: "arn:aws:invoicing::000000000000:invoice-unit/12345678", 
      last_modified: Time.parse(1733788800), 
      name: "Example Invoice Unit A", 
      rule: {
        linked_accounts: [
          "222222222222", 
        ], 
      }, 
      tax_inheritance_disabled: false, 
    }, 
  ], 
  next_token: "nextTokenExample", 
}

Example: ListInvoiceUnits with pagination - second page


resp = client.list_invoice_units({
  max_results: 1, 
  next_token: "nextTokenExample", 
})

resp.to_h outputs the following:
{
  invoice_units: [
    {
      description: "Description changed on 1733788800", 
      invoice_receiver: "333333333333", 
      invoice_unit_arn: "arn:aws:invoicing::000000000000:invoice-unit/87654321", 
      last_modified: Time.parse(1733788800), 
      name: "Example Invoice Unit B", 
      rule: {
        linked_accounts: [
          "333333333333", 
        ], 
      }, 
      tax_inheritance_disabled: true, 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.list_invoice_units({
  filters: {
    names: ["InvoiceUnitName"],
    invoice_receivers: ["AccountIdString"],
    accounts: ["AccountIdString"],
  },
  next_token: "NextTokenString",
  max_results: 1,
  as_of: Time.now,
})

Response structure


resp.invoice_units #=> Array
resp.invoice_units[0].invoice_unit_arn #=> String
resp.invoice_units[0].invoice_receiver #=> String
resp.invoice_units[0].name #=> String
resp.invoice_units[0].description #=> String
resp.invoice_units[0].tax_inheritance_disabled #=> Boolean
resp.invoice_units[0].rule.linked_accounts #=> Array
resp.invoice_units[0].rule.linked_accounts[0] #=> String
resp.invoice_units[0].last_modified #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :filters (Types::Filters) —

    An optional input to the list API. If multiple filters are specified, the returned list will be a configuration that match all of the provided filters. Supported filter types are InvoiceReceivers, Names, and Accounts.

  • :next_token (String) —

    The next token used to indicate where the returned list should start from.

  • :max_results (Integer) —

    The maximum number of invoice units that can be returned.

  • :as_of (Time, DateTime, Date, Integer, String) —

    The state of an invoice unit at a specified time. You can see legacy invoice units that are currently deleted if the AsOf time is set to before it was deleted. If an AsOf is not provided, the default value is the current time.

Returns:

See Also:



929
930
931
932
 
# File 'gems/aws-sdk-invoicing/lib/aws-sdk-invoicing/client.rb', line 929

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

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

Lists the tags for a resource.

Examples:

Example: ListTagsForResource


resp = client.list_tags_for_resource({
  resource_arn: "arn:aws:invoicing::000000000000:invoice-unit/12345678", 
})

resp.to_h outputs the following:
{
  resource_tags: [
    {
      key: "TagKey", 
      value: "TagValue", 
    }, 
  ], 
}

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of tags to list.

Returns:

See Also:



976
977
978
979
 
# File 'gems/aws-sdk-invoicing/lib/aws-sdk-invoicing/client.rb', line 976

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

#tag_resource(params = {}) ⇒ Struct

Adds a tag to a resource.

Examples:

Example: TagResource


resp = client.tag_resource({
  resource_arn: "arn:aws:invoicing::000000000000:invoice-unit/12345678", 
  resource_tags: [
    {
      key: "TagKey", 
      value: "TagValue", 
    }, 
  ], 
})

resp.to_h outputs the following:
{
}

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "TagrisArn", # required
  resource_tags: [ # required
    {
      key: "ResourceTagKey", # required
      value: "ResourceTagValue", # required
    },
  ],
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the tags.

  • :resource_tags (required, Array<Types::ResourceTag>) —

    Adds a tag to a resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1024
1025
1026
1027
 
# File 'gems/aws-sdk-invoicing/lib/aws-sdk-invoicing/client.rb', line 1024

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

#untag_resource(params = {}) ⇒ Struct

Removes a tag from a resource.

Examples:

Example: UntagResource


resp = client.untag_resource({
  resource_arn: "arn:aws:invoicing::000000000000:invoice-unit/12345678", 
  resource_tag_keys: [
    "TagKey", 
  ], 
})

resp.to_h outputs the following:
{
}

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "TagrisArn", # required
  resource_tag_keys: ["ResourceTagKey"], # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) to untag.

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

    Keys for the tags to be removed.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1064
1065
1066
1067
 
# File 'gems/aws-sdk-invoicing/lib/aws-sdk-invoicing/client.rb', line 1064

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

#update_invoice_unit(params = {}) ⇒ Types::UpdateInvoiceUnitResponse

You can update the invoice unit configuration at any time, and Amazon Web Services will use the latest configuration at the end of the month.

Examples:

Example: UpdateInvoiceUnit with all updatable fields


resp = client.update_invoice_unit({
  description: "Updated IU description", 
  invoice_unit_arn: "arn:aws:invoicing::000000000000:invoice-unit/12345678", 
  rule: {
    linked_accounts: [
      "111111111111", 
      "222222222222", 
    ], 
  }, 
  tax_inheritance_disabled: false, 
})

resp.to_h outputs the following:
{
  invoice_unit_arn: "arn:aws:invoicing::000000000000:invoice-unit/12345678", 
}

Example: UpdateInvoiceUnit with specific fields


resp = client.update_invoice_unit({
  description: "Updated IU description. All other fields remain unchanged", 
  invoice_unit_arn: "arn:aws:invoicing::000000000000:invoice-unit/12345678", 
})

resp.to_h outputs the following:
{
  invoice_unit_arn: "arn:aws:invoicing::000000000000:invoice-unit/12345678", 
}

Request syntax with placeholder values


resp = client.update_invoice_unit({
  invoice_unit_arn: "InvoiceUnitArnString", # required
  description: "DescriptionString",
  tax_inheritance_disabled: false,
  rule: {
    linked_accounts: ["AccountIdString"],
  },
})

Response structure


resp.invoice_unit_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :invoice_unit_arn (required, String) —

    The ARN to identify an invoice unit. This information can't be modified or deleted.

  • :description (String) —

    The assigned description for an invoice unit. This information can't be modified or deleted.

  • :tax_inheritance_disabled (Boolean) —

    Whether the invoice unit based tax inheritance is/ should be enabled or disabled.

  • :rule (Types::InvoiceUnitRule) —

    The InvoiceUnitRule object used to update invoice units.

Returns:

See Also:



1143
1144
1145
1146
 
# File 'gems/aws-sdk-invoicing/lib/aws-sdk-invoicing/client.rb', line 1143

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