# Copyright 2019-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"). You
# may not use this file except in compliance with the License. A copy of
# the License is located at
#
# http://aws.amazon.com/apache2.0/
#
# or in the "license" file accompanying this file. This file is
# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
# ANY KIND, either express or implied. See the License for the specific
# language governing permissions and limitations under the License.
from typing import Any, Dict, NamedTuple
import boto3
[docs]class AwsSession(object):
"""Manage interactions with AWS services."""
S3DestinationFolder = NamedTuple("S3DestinationFolder", [("bucket", str), ("key", int)])
BRAKET_ENDPOINTS = {
"us-west-2": "https://7ko20bz2m2.execute-api.us-west-2.amazonaws.com/V3",
"us-west-1": "https://fdoco1n1x7.execute-api.us-west-1.amazonaws.com/V3",
# "us-west-2": "https://xe15dbdvw6.execute-api.us-west-2.amazonaws.com/V3",
# "us-west-2": "https://kpg9e8yzsg.execute-api.us-west-2.amazonaws.com/V3",
"us-east-1": "https://kqjovr0n70.execute-api.us-east-1.amazonaws.com/V3",
}
# similar to sagemaker sdk:
# https://github.com/aws/sagemaker-python-sdk/blob/master/src/sagemaker/session.py
def __init__(self, boto_session=None, braket_client=None):
"""
Args:
boto_session: A boto3 session object
braket_client: A boto3 Braket client
Raises:
ValueError: If Braket is not available in the Region used for the boto3 session.
"""
self.boto_session = boto_session or boto3.Session()
if braket_client:
self.braket_client = braket_client
else:
region = self.boto_session.region_name
endpoint = AwsSession.BRAKET_ENDPOINTS.get(region, None)
if not endpoint:
supported_regions = list(AwsSession.BRAKET_ENDPOINTS.keys())
raise ValueError(
f"No braket endpoint for {region}, supported Regions are {supported_regions}"
)
self.braket_client = self.boto_session.client("braket", endpoint_url=endpoint)
#
# Quantum Tasks
#
[docs] def cancel_quantum_task(self, arn: str) -> None:
"""
Cancel the quantum task.
Args:
arn (str): The ARN of the quantum task to cancel.
"""
self.braket_client.cancel_quantum_task(quantumTaskArn=arn)
[docs] def create_quantum_task(self, **boto3_kwargs) -> str:
"""
Create a quantum task.
Args:
**boto3_kwargs: Keyword arguments for the Amazon Braket `CreateQuantumTask` operation.
Returns:
str: The ARN of the quantum task.
"""
response = self.braket_client.create_quantum_task(**boto3_kwargs)
return response["quantumTaskArn"]
[docs] def get_quantum_task(self, arn: str) -> Dict[str, Any]:
"""
Gets the quantum task.
Args:
arn (str): The ARN of the quantum task to cancel.
Returns:
Dict[str, Any]: The response from the Amazon Braket `GetQuantumTask` operation.
"""
return self.braket_client.get_quantum_task(quantumTaskArn=arn)
[docs] def retrieve_s3_object_body(self, s3_bucket: str, s3_object_key: str) -> str:
"""
Retrieve the S3 object body
Args:
s3_bucket (str): The S3 bucket name
s3_object_key (str): The S3 object key within the `s3_bucket`
Returns:
str: The body of the S3 object
"""
s3 = self.boto_session.resource("s3")
obj = s3.Object(s3_bucket, s3_object_key)
return obj.get()["Body"].read().decode("utf-8")
# TODO: add in boto3 exception handling once we have exception types in API
# TODO: add in boto3 exception handling once we have exception types in API