100 Days of DevOps — Day 99- AWS  Boto3

What is Boto3?

Boto3 is the Amazon Web Services (AWS) SDK for Python. It enables Python developers to create, configure, and manage AWS services, such as EC2 and S3. Boto3 provides an easy to use, object-oriented API, as well as low-level access to AWS services.

Boto3 is built on the top of a library called Botocore, which is shared by the AWS CLI. Botocore provides the low level clients, session and credentials and configuration data. Boto3 built on the top of Botocore by providing its own session, resources, collections, waiters and paginators.

Botocore is the basis for the aws-cli.

https://github.com/boto/boto3

https://github.com/boto/botocore

Installing boto3

$ pip3 install boto3 --user

• --user makes pip install packages in your home directory instead, which doesn’t require any special privileges.

$ aws configure
AWS Access Key ID [****************XXXX]:
AWS Secret Access Key [****************XXXX]:
Default region name [us-west-2]:
Default output format [json]:

Configure your aws credentials
To test it
$ aws sts get-caller-identity
{
"Account": "1234567889",
"UserId": "XXXXXXXXX",
"Arn": "arn:aws:iam::1234567889:user/plakhera"
}

Some key terms

• Session: A session manages the state about a particular configuration. A default session is created for when needed but we can create our own session. A typical session looks like this

>>> session=boto3.session.Session(profile_name=“<profile>”)

• profile name is the created using aws configure command, else default profile is selected

>>> aws configure --profile <profile>

* As you can see profile usually contains

Credentials
Region

• Resources: Resources represent an object-oriented interface to AWS services. It provides a higher-level abstraction than the raw, low-level calls made by service clients

>>> ec2_con_resource=session_resource(service_name=“ec2”,
region_name=“us-west-2”)

* Not all aws services supports resources
>>> session=boto3.session.Session(profile_name=“<profile>”)

>>> session.get_available_resources()
['cloudformation', 'cloudwatch', 'dynamodb', 'ec2', 
'glacier', 'iam', 'opsworks', 's3', 'sns', 'sqs']
>>> s3 = boto3.resource('s3')

• Clients: Clients provides a low-level interface to AWS whose methods map close to 1:1 with service API. Clients are generated from a JSON service definition file.
• The important point to remember all service operations are supported by clients.

>>> session=boto3.session.Session(profile_name=“<profile>”)
>>> session.get_available_services()
['acm', 'acm-pca', 'alexaforbusiness', 'amplify', 'apigateway', 'apigatewaymanagementapi', 'apigatewayv2', 'application-autoscaling', 'appmesh', 'appstream', 'appsync', 'athena', 'autoscaling', 'autoscaling-plans', 'backup', 'batch', 'budgets', 'ce', 'chime', 'cloud9', 'clouddirectory', 'cloudformation', 'cloudfront', 'cloudhsm', 'cloudhsmv2', 'cloudsearch', 'cloudsearchdomain', 'cloudtrail', 'cloudwatch', 'codebuild', 'codecommit', 'codedeploy', 'codepipeline', 'codestar', 'cognito-identity', 'cognito-idp', 'cognito-sync', 'comprehend', 'comprehendmedical', 'config', 'connect', 'cur', 'datapipeline', 'datasync', 'dax', 'devicefarm', 'directconnect', 'discovery', 'dlm', 'dms', 'docdb', 'ds', 'dynamodb', 'dynamodbstreams', 'ec2', 'ecr', 'ecs', 'efs', 'eks', 'elasticache', 'elasticbeanstalk', 'elastictranscoder', 'elb', 'elbv2', 'emr', 'es', 'events', 'firehose', 'fms', 'fsx', 'gamelift', 'glacier', 'globalaccelerator', 'glue', 'greengrass', 'guardduty', 'health', 'iam', 'importexport', 'inspector', 'iot', 'iot-data', 'iot-jobs-data', 'iot1click-devices', 'iot1click-projects', 'iotanalytics', 'kafka', 'kinesis', 'kinesis-video-archived-media', 'kinesis-video-media', 'kinesisanalytics', 'kinesisanalyticsv2', 'kinesisvideo', 'kms', 'lambda', 'lex-models', 'lex-runtime', 'license-manager', 'lightsail', 'logs', 'machinelearning', 'macie', 'marketplace-entitlement', 'marketplacecommerceanalytics', 'mediaconnect', 'mediaconvert', 'medialive', 'mediapackage', 'mediastore', 'mediastore-data', 'mediatailor', 'meteringmarketplace', 'mgh', 'mobile', 'mq', 'mturk', 'neptune', 'opsworks', 'opsworkscm', 'organizations', 'pi', 'pinpoint', 'pinpoint-email', 'pinpoint-sms-voice', 'polly', 'pricing', 'quicksight', 'ram', 'rds', 'rds-data', 'redshift', 'rekognition', 'resource-groups', 'resourcegroupstaggingapi', 'robomaker', 'route53', 'route53domains', 'route53resolver', 's3', 's3control', 'sagemaker', 'sagemaker-runtime', 'sdb', 'secretsmanager', 'securityhub', 'serverlessrepo', 'servicecatalog', 'servicediscovery', 'ses', 'shield', 'signer', 'sms', 'sms-voice', 'snowball', 'sns', 'sqs', 'ssm', 'stepfunctions', 'storagegateway', 'sts', 'support', 'swf', 'textract', 'transcribe', 'transfer', 'translate', 'waf', 'waf-regional', 'workdocs', 'worklink', 'workmail', 'workspaces', 'xray']
>>> sqs = boto3.client('sqs')

Task1: List out all S3 buckets using Boto3

>>> import boto3

# Create high level resource using boto3
>>> s3 = boto3.resource('s3') 

# Print all the bucket name
>>> for bucket in s3.buckets.all(): 

...     print(bucket.name)

• Resources represent an object-oriented interface to AWS services. They provide a higher-level abstraction than the raw low level calls made by service clients.

Task2: Create an EC2 instance using Boto3

import boto3

# Create a low-level client with the service name
ec2 = boto3.client('ec2')

# When we invoke client we always got response back
response = ec2.run_instances(
    ImageId='ami-01ed306a12b7d1c96',
    InstanceType='t2.micro',
    KeyName='testkey',
    MinCount=1,
    MaxCount=1
)
print(response)

• Clients provide a low level interface to AWS whose methods map close to 1:1 with services API. All service operations are supported by clients. Clients are generated from a JSON service definition file.

https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ec2.html#EC2.Client.run_instances

GitHub Link https://github.com/100daysofdevops/100daysofdevops/tree/master/boto3

Reference

https://boto3.amazonaws.com/v1/documentation/api/latest/index.html

https://aws.amazon.com/sdk-for-python/