UpdateAccountSettings
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 AWS account. TPS over 5 will initiate the
LimitExceededException.
Request Syntax
{
"MinimumThroughputBillingCommitment": {
"Status": "string"
}
}
Request Parameters
The request accepts the following data in JSON format.
- MinimumThroughputBillingCommitment
-
Specifies the minimum throughput billing commitment configuration for your account.
Type: MinimumThroughputBillingCommitmentInput object
Required: Yes
Response Syntax
{
"MinimumThroughputBillingCommitment": {
"EarliestAllowedEndAt": number,
"EndedAt": number,
"StartedAt": number,
"Status": "string"
}
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- MinimumThroughputBillingCommitment
-
The updated configuration of the minimum throughput billing commitment for your account.
Type: MinimumThroughputBillingCommitmentOutput object
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidArgumentException
-
A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.
- message
-
A message that provides information about the error.
HTTP Status Code: 400
- LimitExceededException
-
The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.
- message
-
A message that provides information about the error.
HTTP Status Code: 400
- ValidationException
-
Specifies that you tried to invoke this API for a data stream with the on-demand capacity mode. This API is only supported for data streams with the provisioned capacity mode.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: