Update Account Settings

kinesis_update_account_settings

R Documentation

Updates the account-level settings for Amazon Kinesis Data Streams¶

Description¶

Updates the account-level settings for Amazon Kinesis Data Streams.

Updating account settings is a synchronous operation. Upon receiving the request, Kinesis Data Streams will return immediately with your account’s updated settings.

API limits

Certain account configurations have minimum commitment windows. Attempting to update your settings prior to the end of the minimum commitment window might have certain restrictions.
This API has a call limit of 5 transactions per second (TPS) for each Amazon Web Services account. TPS over 5 will initiate the LimitExceededException.

Usage¶

kinesis_update_account_settings(MinimumThroughputBillingCommitment)

Arguments¶

MinimumThroughputBillingCommitment

[required] Specifies the minimum throughput billing commitment configuration for your account.

Value¶

A list with the following syntax:

list(
  MinimumThroughputBillingCommitment = list(
    Status = "ENABLED"|"DISABLED"|"ENABLED_UNTIL_EARLIEST_ALLOWED_END",
    StartedAt = as.POSIXct(
      "2015-01-01"
    ),
    EndedAt = as.POSIXct(
      "2015-01-01"
    ),
    EarliestAllowedEndAt = as.POSIXct(
      "2015-01-01"
    )
  )
)

Request syntax¶

svc$update_account_settings(
  MinimumThroughputBillingCommitment = list(
    Status = "ENABLED"|"DISABLED"
  )
)