braket: Braket

In paws: Amazon Web Services Software Development Kit

Braket

Description

The Amazon Braket API Reference provides information about the operations and structures supported in Amazon Braket.

Additional Resources:

• Amazon Braket Developer Guide

Usage

braket(config = list(), credentials = list(), endpoint = NULL, region = NULL)

Arguments

config	Optional configuration of credentials, endpoint, and/or region. credentials: creds: access_key_id: AWS access key ID secret_access_key: AWS secret access key session_token: AWS temporary session token profile: The name of a profile to use. If not given, then the default profile is used. anonymous: Set anonymous credentials. endpoint: The complete URL to use for the constructed client. region: The AWS Region used in instantiating the client. close_connection: Immediately close all HTTP connections. timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds. s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠. sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html
credentials	Optional credentials shorthand for the config parameter creds: access_key_id: AWS access key ID secret_access_key: AWS secret access key session_token: AWS temporary session token profile: The name of a profile to use. If not given, then the default profile is used. anonymous: Set anonymous credentials.
endpoint	Optional shorthand for complete URL to use for the constructed client.
region	Optional shorthand for AWS Region used in instantiating the client.

Value

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax

svc <- braket(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations

cancel_job	Cancels an Amazon Braket job
cancel_quantum_task	Cancels the specified task
create_job	Creates an Amazon Braket job
create_quantum_task	Creates a quantum task
get_device	Retrieves the devices available in Amazon Braket
get_job	Retrieves the specified Amazon Braket job
get_quantum_task	Retrieves the specified quantum task
list_tags_for_resource	Shows the tags associated with this resource
search_devices	Searches for devices using the specified filters
search_jobs	Searches for Amazon Braket jobs that match the specified filter values
search_quantum_tasks	Searches for tasks that match the specified filter values
tag_resource	Add a tag to the specified resource
untag_resource	Remove tags from a resource

Examples

## Not run: 
svc <- braket()
svc$cancel_job(
  Foo = 123
)

## End(Not run)

paws documentation built on Sept. 17, 2024, 5:07 p.m.