Skip to content

Create Spending Limit

braket_create_spending_limit R Documentation

Creates a spending limit for a specified quantum device

Description

Creates a spending limit for a specified quantum device. Spending limits help you control costs by setting maximum amounts that can be spent on quantum computing tasks within a specified time period. Simulators do not support spending limits.

Usage

braket_create_spending_limit(clientToken, deviceArn, spendingLimit,
  timePeriod, tags)

Arguments

clientToken

[required] A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, Amazon Braket ignores the request, but does not return an error.

deviceArn

[required] The Amazon Resource Name (ARN) of the quantum device to apply the spending limit to.

spendingLimit

[required] The maximum amount that can be spent on the specified device, in USD.

timePeriod

The time period during which the spending limit is active, including start and end dates.

tags

The tags to apply to the spending limit. Each tag consists of a key and an optional value.

Value

A list with the following syntax:

list(
  spendingLimitArn = "string"
)

Request syntax

svc$create_spending_limit(
  clientToken = "string",
  deviceArn = "string",
  spendingLimit = "string",
  timePeriod = list(
    startAt = as.POSIXct(
      "2015-01-01"
    ),
    endAt = as.POSIXct(
      "2015-01-01"
    )
  ),
  tags = list(
    "string"
  )
)