Skip to content

AWS

AwsBackendPreferences

Bases: BackendPreferences

AWS-specific backend preferences for quantum computing tasks using Amazon Braket.

This class contains configuration options specific to Amazon Braket, including the AWS role ARN, S3 bucket details, and the folder path within the S3 bucket. It extends the base BackendPreferences class to provide additional properties required for interaction with Amazon Braket.

Attributes:

Name Type Description
backend_service_provider AMAZON_BRAKET

The service provider for the backend, which is Amazon Braket.

aws_role_arn PydanticAwsRoleArn

The Amazon Resource Name (ARN) of the role that will be assumed for execution on your Braket account. This is a required field and should be provided to allow secure and authorized access to AWS resources.

s3_bucket_name str

The name of the S3 bucket where results and other related data will be stored. This field should contain a valid S3 bucket name under your AWS account.

s3_folder PydanticS3BucketKey

The folder path within the specified S3 bucket. This allows for organizing results and data under a specific directory within the S3 bucket.

For more details, refer to: AwsBackendPreferences examples

Attributes:

Name Type Description
aws_role_arn Optional[str]
backend_service_provider AMAZON_BRAKET
run_through_classiq bool
s3_bucket_name Optional[str]
s3_folder Optional[str]

aws_role_arn

aws_role_arn: Optional[str] = Field(
    default=None,
    description="ARN of the role to be assumed for execution on your Braket account.",
)

backend_service_provider

backend_service_provider: AMAZON_BRAKET = Field(
    default=AMAZON_BRAKET
)

run_through_classiq

run_through_classiq: bool = Field(
    default=False,
    description="Run through Classiq's credentials while using user's allocated budget.",
)

s3_bucket_name

s3_bucket_name: Optional[str] = Field(
    default=None, description="S3 Bucket Name"
)

s3_folder

s3_folder: Optional[str] = Field(
    default=None,
    description="S3 Folder Path Within The S3 Bucket",
)