AWSAccess¶
- class awsimple.aws.AWSAccess(resource_name: str | None = None, profile_name: str | None = None, aws_access_key_id: str | None = None, aws_secret_access_key: str | None = None, region_name: str | None = None)¶
Bases:
objectAWSAccess - takes care of basic AWS access (e.g. session, client, resource), getting some basic AWS information, and mock support for testing.
- Parameters:
resource_name – AWS resource name (e.g. s3, dynamodb, sqs, sns, etc.). Can be None if just testing the connection.
# Provide either: profile name or access key ID/secret access key pair
- Parameters:
profile_name – AWS profile name
aws_access_key_id – AWS access key (required if secret_access_key given)
aws_secret_access_key – AWS secret access key (required if access_key_id given)
region_name – AWS region (may be optional - see AWS docs)
- clear_most_recent_error()¶
- get_access_key() str | None¶
Get current access key string
- Returns:
access key
- get_account_id()¶
Get AWS account ID * HAS BEEN REMOVED *
- Returns:
account ID
- get_region() str | None¶
Get current selected AWS region
- Returns:
region string
- is_mocked() bool¶
Return True if currently mocking the AWS interface (e.g. for testing).
- Returns:
True if mocked
- test() bool¶
Basic connection/credentials test. Calls STS GetCallerIdentity, which requires no special permissions but does require valid credentials. Returns False if the credentials are invalid. Configuration errors (e.g. botocore’s ProfileNotFound) still raise.
- Returns:
True if connection OK, False if the credentials are invalid
- awsimple.aws.boto_error_to_string(boto_error) str | None¶