Home

AWS Command Line Interface User Guide

1. Remote Files The AWS CLI also supports loading parameters from a file hosted on the Internet with an http or https URL The following example references a file in an Amazon S3 bucket This allows you to access parameter files from any computer but requires the file to be stored in a publically accessible location 33 AWS Command Line Interface User Guide Generate CLI Skeleton aws ec2 run instances image id ami al3d6891 block device mappings ht tp my bucket s3 amazonaws com filename json In the preceding examples the filename json file contains the following JSON data DeviceName dev sdb Ebs VolumeSize 20 DeleteOnTermination false VolumeType standard For another example referencing a file containing more complex JSON formatted parameters see Set an IAM Policy for an IAM User p 67 Generate CLI Skeleton and CLI Input JSON Parameters Most AWS CLI commands support generate cli skeleton and cli input json parameters that you can use to store parameters in JSON and read them from a file instead of typing them at the command line Generate CLI Skeleton outputs JSON that outlines all of the parameters that can be specified for the operation To use generate cli skeleton with aws ec2 run instances 1 Execute the run instances command with the generate cli skeleton option to view the JSON skeleton aws ec2 r
2. For details about custom ACLs see PUT Bucket acl The s3api ACL commands such as put bucket acl use the same shorthand argument notation Logging Policy The API command put bucket logging configures bucket logging policy The following example sets the logging policy for MyBucket The AWS user user example com will have full control over the log files and all users will have access to them Note that the put bucket acl command is required to grant Amazon S3 s log delivery system the necessary permissions write and read acp S aws s3api put bucket acl bucket MyBucket grant write URI ht tp acs amazonaws com groups s3 LogDelivery grant read acp URI ht tp acs amazonaws com groups s3 LogDelivery aws s3api put bucket logging bucket MyBucket bucket logging status file logging json logging json LoggingEnabled TargetBucket MyBucket TargetPrefix MyBucketLogs TargetGrants Grantee Type AmazonCustomerByEmail EmailAddress user example com he Permission FULL CONTROL 74 AWS Command Line Interface User Guide Amazon SNS Grantee Type Group URI http acs amazonaws com groups global AllUsers Permission READ Using the AWS Command Line Interface with Amazon SNS This section describes some common tasks related to Amazon Simple Notification Service Amazon SNS
3. AccessKey SecretAccessKey je7MtGbClwBF 2Z2p9Utk h3yCo8nvbEXAMPLEKEY Status Active CreateDate 2013 01 02T22 44 12 8972 UserName MyUser AccessKeyId AKIAT44QH8DHBEXAMPLE Use the delete access key command to delete a set of credentials for an IAM user Specify which credentials to delete by using the access key ID aws iam delete access key user name MyUser access key id AKIAI44QH8DH BEXAMP LE This command should return with no output Using Amazon S3 with the AWS Command Line Interface The AWS CLI provides two tiers of commands for accessing Amazon S3 The first tier named s3 consists of high level commands for frequently used operations such as creating manipulating and deleting objects and buckets The second tier named s3api exposes all Amazon S3 operations including modifying a bucket access control list ACL using cross origin resource sharing CORS or logging policies It allows you to carry out advanced operations that may not be possible with the high level commands alone 68 AWS Command Line Interface User Guide Using High Level s3 Commands To get a list of all commands available in each tier use the help argument with the aws s3 or aws s3api commands aws s3 help or aws s3api help Note The AWS CLI supports copying moving and syncing from Amazon S3 to Amazon S3 These operations use the
4. Delete s3 my bucket MyFolder and all of its contents aws s3 rm s3 my bucket MyFolder recursive 73 AWS Command Line Interface User Guide Using API Level s3api Commands When the recursive option is used on a directory folder with cp mv or rm the command walks the directory tree including all subdirectories These commands also accept the xclude include and ac1 options as the sync command does Using API Level s3api Commands with the AWS Command Line Interface The API level commands contained in the s3api command set provide direct access to the Amazon S3 APIs and enable some operations not exposed in the high level commands This section describes the API level commands and provides a few examples For more Amazon S3 examples see the s3api command line reference and choose an available command from the list Custom ACLs With high level commands you can use the ac1 option to apply pre defined access control lists ACLs on Amazon S3 objects but you cannot set bucket wide ACLs You can do this with the API level command put bucket acl The following example grants full control to two AWS users user1 Qexample com and user2 example com and read permission to everyone aws s3api put bucket acl bucket MyBucket grant full control emailad dress userl8example com emailaddress user2 example com grant read uri http acs amazonaws com groups global AllUsers
5. aws swf list domains registration status REGISTERED output text Note If the output format is specified in multiple ways the usual AWS CLI precedence rules p 17 apply For example using the aws DEFAULT OUTPUT environment variable overrides any value set in the config file with output and a value passed to an AWS CLI command with output overrides any value set in the environment or in the config file JSON is best for handling the output programmatically via various languages or jq a command line JSON processor The table format is easy for humans to read and text format works well with traditional Unix text processing tools such as sed grep and awk as well as Windows PowerShell scripts How to Filter the Output with the Option The AWS CLI provides built in output filtering capabilities with the query option To demonstrate how it works we ll first start with the default JSON output below which describes three EBS Elastic Block Storage volumes attached to separate EC2 instances aws ec2 describe volumes Volumes AvailabilityZone us west 2a Attachments AttachTime 2013 09 17T00 55 03 0002 InstanceId i a071c394 VolumeId vol e11a5288 State attached DeleteOnTermination true Device dev sdal 1 VolumeType standard VolumeId vol ella5288 State in use SnapshotId snap f23eclc8 CreateTime 2013 09
6. This is equivalent to the following example formatted in JSON aws ec2 stop instances instance ids i 1486157a i 1286157c i ec3a7e87 Next is an example of the Amazon EC2 create tags command which takes a list of non nested structures for the tags option The resources option specifies the ID of the instance to be tagged aws ec2 create tags resources i 1286157c tags Key MylstTag Value Valuel Key My2ndTag Value Value2 Key My3rdTag Value Value3 This is equivalent to the following example formatted in JSON The JSON parameter is written in multiple lines for readability S aws ec2 create tags resources i 1286157c tags Key MylstTag Value Valuel Key My2ndTag Value Value2 Key My3rdTag Value Value3 1 45 AWS Command Line Interface User Guide DynamoDB Working with Amazon Web Services This section provides examples of using the AWS Command Line Interface to access AWS services These examples are intended to demonstrate how to use the AWS CLI to perform administrative tasks For a complete reference to all of the available commands for each service see the AWS Command Line Interface Reference or use the built in command line help For more information see Getting Help with the AWS Command Line Interface p 27 Topics Using Amazon DynamoDB with the AWS Command Line Interface p 46 Using Amazon
7. Once you ve signed up for AWS you can proceed with the following sections to install configure and use the AWS CLI Installing the AWS CLI p 4 Configuring the AWS CLI p 11 Using the AWS CLI p 27 22 AWS Command Line Interface User Guide Install the AWS CLI Deploying a Development Environment in Amazon EC2 Using the AWS Command Line Interface This tutorial details how to set up a development environment in Amazon EC2 using the AWS CLI It includes a short version of the installation and configuration instructions and it can be run start to finish on Windows Linux OS X or Unix For complete installation and configuration instructions see the Getting Set Up p 3 section of this guide More information on the commands used to call Amazon EC2 is available under Working with Services p 46 Topics Install the AWS CLI p 23 Configure the CLI and Launch an EC2 Instance p 24 Install the AWS CLI You can install the AWS CLI with an installer Windows or by using pip a package manager for Python Windows 1 Download the appropriate MSI installer Download the AWS CLI MSI installer for Windows 64 bit Download the AWS CLI MSI installer for Windows 32 bit 2 Runthe downloaded MSI installer 3 Follow the instructions that appear 23 AWS Command Line Interface User Guide Linux OS X or Unix Linux OS X or Unix These steps require that you have a working installation
8. AWS Command Line Interface User Guide alas ug amazon web services saan T AWS Command Line Interface User Guide AWS Command Line Interface User Guide Copyright 2015 Amazon Web Services Inc and or its affiliates All rights reserved AWS Command Line Interface User Guide Table of Contents Wliatilssthe AWS CLIP nt aaa 1 How to Use This Guide isese eriein nenna 1 Supported Services sara ere xod ee mn Ei 1 AWS Command Line Interface on GitHub 0 0 0 en enter 1 About Amazon Web Services 0 00 nenna arnar 1 Getting Set Up EE 3 Sign Up for Amazon Web Services 0 0 nenna arnar ara 3 Installing the AWS OLLI ei ia Ef seinen ncn 4 Choose an Installation Method sess HH 5 Install the AWS CLI Using the MSI Installer Windows eee 5 Install the AWS CLI Using Pip sssssenm Hmmm emere 6 Install the AWS CLI Using the Bundled Installer Linux OS X or Unix esseessssss 8 Test the AWS CLI Installation 0 00 0 e0eae nenna 10 Where to Go from Mer E 10 Uninstalling the AWS GEI ass a a Raa 10 Configuring the AWS CLI 00 00 000 0nr nenna 11 Usingan ARON an 11 Assuming a Lm iii ass a nee 12 Command Completion ceccee arnar 14 Quick Configuration saa a 16 Configuration Set
9. eor reet ade EAEE EAEE EEE ve dei 63 AWS Identity and Access Management sss eme emen meme mem nennen nenne 65 Create New IAM Users and Groups ssssssssse Hee hehe hene heres 65 Set an IAM Policy for an IAM User sssssssn HH mme mener 67 Set an Initial Password for an IAM User 00 ceeceee eect cnet eee memes 67 Create Security Credentials for an IAM User 0 00 nennt 68 Amazon S3 EE 68 Using High Level s3 Commands 0 0ne renn 69 Using API Level s3api Commands 0 e0renre nr 74 AMAZON SNORRA ba Ra A LAG Ra ja a nr 75 Create a Topic mn 75 Subscibe LOA TOPIC siss octet ta ta aga tasted weet 75 Publishto a TOpiC c LE 76 Unsubscribe from a TOPIC Tesiri ss na im ete Sene Fa a aaa Seay cage tet ots Dose po BAK outed nage Meo iic dee 76 Delete a TOPi E M onai n e e dee T aN E a a a eee ede ed 77 AMAZON SWE esana aa a N aE a uestes A a A A ARNE 77 List of Amazon SWF Commands 0 02 0e0nr enter nr 77 Working with Amazon SWF Domains 0 ccceee cece cece eee ce ee meme hehe herein rennes 80 Document HIStory e cm 84 AWS Command Line Interface User Guide How to Use This Guide What Is the AWS Command Line Interface The AWS Command Line Interface is a unified tool to manage your AWS services With just one tool to download and configure you can control multiple AWS services from the command line and automate them
10. l 36 AWS Command Line Interface User Guide Controlling Command Output InstanceType t2 micro Monitoring Enabled true 7 Runthe run instances command again to launch an instance aws ec2 run instances cli input json file ec2runinst json OwnerId 123456789012 ReservationId r d94a2bl Groups Instances Controlling Command Output from the AWS Command Line Interface This section describes the different ways that you can control the output from the AWS CLI Topics How to Select the Output Format p 37 How to Filter the Output with the query Option p 38 JSON Output Format p 40 Text Output Format p 41 Table Output Format p 42 How to Select the Output Format The AWS CLI supports three different output formats JSON json Tab delimited text text ASCII formatted table table As explained in the configuration p 11 topic the output format can be specified in three different ways Using the output option in the configuration file The following example sets the output to cext default output text e Using the AWS DEFAULT OUTPUT environment variable For example export AWS DEFAULT OUTPUT table 37 AWS Command Line Interface User Guide How to Filter the Output with the query Option Using the output option on the command line For example
11. 67 Create Security Credentials for an IAM User p 68 Create New IAM Users and Groups This section describes how to create a new IAM group and a new IAM user and then add the user to the group To create an IAM group and add a new IAM user to it 1 First use the create group command to create the group aws iam create group group name MylamGroup The following is example output Group GroupName MyIamGroup CreateDate 2012 12 20T03 03 52 8342 GroupId AKIAIA440H8DHBEXAMPLE Arn arn aws iam 123456789012 group MyIamGroup Path t 2 Next use the create user command to create the user 65 AWS Command Line Interface User Guide Create New IAM Users and Groups aws iam create user user name MyUser The following is example output User UserName MyUser Paths Wem CreateDate 2012 12 20T03 13 02 5812 UserId AKIAIOSFODNN7EXAMPLE Arn arn aws iam 123456789012 user MyUser 3 Finally use the add user to group command to add the user to the group aws iam add user to group user name MyUser group name MylamGroup This command should return with no output 4 To verify that the MyramGroup group contains the MyUser use the get group command aws iam get group group name MylamGroup The following is example output Group GroupName MyI
12. OwnerId 123456789012 GroupId sg 903004f8 Deleting Your Security Group To delete a security group use the delete security group command Note that you can t delete a security group if it s currently in use EC2 Classic The following command deletes the security group named MySecurityGroup aws ec2 delete security group group name MySecurityGroup The following is example output 54 AWS Command Line Interface User Guide Using Instances return true EC2 VPC The following command deletes the security group with the ID sg 903004f8 aws ec2 delete security group group id sg 903004f8 The following is example output return true Using Amazon EC2 Instances You can use the AWS CLI to launch list and terminate instances You ll need a key pair and a security group for information about creating these through the AWS CLI see Using Key Pairs p 48 and Using Security Groups p 50 You ll also need to select an Amazon Machine Image AMI and note its AMI ID For more information see Finding a Suitable AMI in the Amazon EC2 User Guide for Linux Instances If you launch an instance that is not within the Free Usage Tier you are billed after you launch the instance and charged for the time that the instance is running even if it remains idle Note Before you try the example command set your default credentials Topics Laun
13. SWF Domains Using the AWS Command Line Interface p 80 Workflow Execution Management request cancel workflow execution terminate workflow execution Visibility Commands Although you can perform visibility actions from the Amazon SWF console you can use the commands in this section to build your own console or administrative tools Activity Visibility list activity types describe activity type Workflow Visibility list workflow types describe workflow type Workflow Execution Visibility describe workflow execution list open workflow executions list closed workflow executions count open workflow executions count closed workflow executions get workflow execution history Domain Visibility list domains describe domain For more information and examples of these domain visibility commands see Working with Amazon SWF Domains Using the AWS Command Line Interface p 80 Task List Visibility count pending activity tasks count pending decision tasks 79 AWS Command Line Interface User Guide Working with Amazon SWF Domains Working with Amazon SWF Domains Using the AWS Command Line Interface This section describes how to perform common Amazon SWF domain tasks using the AWS CLI Topics Listing Your Domains p 80 Getting Information About a Domain p 81 Registering a Domain p 81 Deprecating a Domain p 82 See Also p 83 Listing Your Domains To list the Amazon SWF
14. The next sections contains more information on the files that aws configure creates additional settings and named profiles Configuration Settings and Precedence The AWS CLI uses a provider chain to look for AWS credentials in a number of different places including System or user environment variables and local AWS configuration files The AWS CLI looks for credentials and configuration settings in the following order 1 Command Line Options region output format and profile can be specified as command options to override default settings 2 Environment Variables AWS ACCESS KEY ID AWS SECRET ACCESS KEY etc 3 The AWS credentials file located at aws credentials on Linux OS X or Unix or at C Users USERNAME N awsNcredentials on Windows This file can contain multiple named profiles in addition to a default profile 4 The CLI configuration file typically located at aws config on Linux OS X or Unix or at C Users USERNAME aws config on Windows This file can contain a default profile named profiles and CLI specific configuration parameters for each 5 Instance profile credentials these credentials can be used on EC2 instances with an assigned instance role and are delivered through the Amazon EC2 metadata service 17 AWS Command Line Interface User Guide Configuration and Credential Files Configuration and Credential Files The CLI stores credenti
15. attribute definitions AttributeName Artist AttributeType S AttributeName SongTitle Attribute Type S key schema AttributeName Artist KeyType HASH AttributeName SongTitle Key Type RANGE provisioned throughput ReadCapacityUnits 1 WriteCapacityUnits 1 The following commands will add new items to the table These example use a combination of shorthand syntax and JSON aws dynamodb put item table name MusicCollection item Artist S No One You Know SongTitle S Call Me Today AlbumTitle S Somewhat Famous return consumed capacity TOTAL S aws dynamodb put item table name MusicCollection item Artist S Acme Band SongTitle S Happy Day AlbumTitle S Songs About Life return consumed capacity TOTAL On the command line it can be difficult to compose valid JSON however the AWS CLI can read JSON files For example consider the following JSON snippet which is stored in a file named key conditions json Artist AttributeValueList S No One You Know l ComparisonOperator EQ SongTitle AttributeValueList S Call Me Today I ComparisonOperator EQ You can now issue a Query request using the AWS CLI In this example the contents of the key conditions json file are used for the key conditions parameter 47 AWS Comm
16. l IsTruncated false Additional Resources For more information see Resources for Learning About Permissions and Policies This topic provides links to an overview of permissions and policies and links to examples of policies for accessing Amazon S3 Amazon EC2 and other services Set an Initial Password for an IAM User The following example demonstrates how to use the create login profile command to set an initial password for an IAM user aws iam create login profil user name MyUser password My UserlLogin8P ss word 67 AWS Command Line Interface User Guide Create Security Credentials for an IAM User The following is example output LoginProfile UserName MyUser CreateDate 2013 01 02T21 10 54 3392 MustChangePassword false Use the update login profile command to update the password for an IAM user Create Security Credentials for an IAM User The following example uses the create access key command to create security credentials for an IAM user A set of security credentials comprises an access key ID and a secret key Note that an IAM user can have no more than two sets of credentials at any given time If you attempt to create a third set the create access key command will return a LimitExceeded error aws iam create access key user name MyUser The following is example output
17. use the delete key pair command as follows aws ec2 delete key pair key name MyKeyPair The following is example output return true Using Security Groups You create a security group for use in either EC2 Classic or EC2 VPC For more information about EC2 Classic and EC2 VPC see Supported Platforms in the Amazon EC2 User Guide for Linux Instances You can use the AWS CLI to create add rules to and delete your security groups Note Before you try the example commands set your default credentials Topics Creating a Security Group p 50 Adding Rules to Your Security Group p 52 Deleting Your Security Group p 54 Creating a Security Group To create a security group named MySecurityGroup use the create security group command 50 AWS Command Line Interface User Guide Using Security Groups EC2 Classic The following command creates a security group named MySecurityGroup for EC2 Classic S aws ec2 create security group group name MySecurityGroup description My security group The following is example output return true GroupId sg 903004f8 To view the initial information for MySecurityGroup use the describe security groups command as follows aws ec2 describe security groups group names MySecurityGroup The following is example output SecurityGroups IpPermissionsEgress Descript
18. 1024 x 1024 bytes of random data Linux OS X or Unix dd if dev urandom of largefile bs 3145728 count 1 1 0 records in 1 0 records out 3145728 bytes 3 1 MB copied 0 205813 s 15 3 MB s dd is a utility that copies a number of bytes from an input file to an output file The above example uses the device file dev urandom as a source of random data sut il performs a similar function in Windows Windows C temp gt fsutil file createnew largefile 3145728 File C temp largefile is created Next split the file into 1 MiB 1048576 byte chunks split bytes 1048576 verbose largefile chunk creating file chunkaa creating file chunkab creating file chunkac Note HJ Split is a free file splitter for Windows and many other platforms Initiate a Multipart Upload and Upload Files Create a multipart upload in Amazon Glacier by using the aws glacier initiate multipart upload command aws glacier initiate multipart upload account id archive description multipart upload test part size 1048576 vault name myvault uploadId 19gaRezEXAMPLES6Ry5YYdqthHOC kGRCTO3L9yetr220UmPtBYKk OssZtLqy Fu7sYl lR7vgFuJV6NtcV5zpsJ location 123456789012 vaults myvault multipart up loads 19gaRezEXAMPLES6Ry5YYdqthHOC kGRCTO3L9yetr220UmPtBYKk OssZtLqyFu7sYl lR7vg FuJV6NtcV5zpsJ Amazon Glacier requires the size of each part in bytes 1 MiB in thi
19. 17T00 55 03 0002 Size 30 an AvailabilityZone us west 2a Attachments AttachTime 2013 09 18T20 26 16 0002 InstanceId i 4b4la37c VolumeId vol 2e410a47 State attached DeleteOnTermination true Device dev sdal 38 AWS Command Line Interface User Guide How to Filter the Output with the query Option VolumeType standard VolumeId vol 2e410a47 State in use SnapshotId snap 708e8348 CreateTime 2013 09 18T20 26 15 0002 Size 8 First we can display only the first volume from the volumes list with the following command aws ec2 describe volumes query Volumes 0 AvailabilityZone us west 2a Attachments AttachTime 2013 09 17T00 55 03 0002 InstanceId i a071c394 VolumeId vol e11a5288 State attached DeleteOnTermination true Device dev sdal r VolumeType standard VolumeId vol e11a5288 State in use SnapshotId snap f23eclc8 CreateTime 2013 09 17T00 55 03 0002 Size 30 Now we use the wildcard notation to iterate over the entire list and also filter out three elements VolumeId AvailabilityZone and Size Note that the dictionary notation requires that you provide an alias for each key like this Alias1 Key1 Alias2 Key2 A dictionary is inherently unordered so the ordering of the key aliases within a structure may not be consi
20. 69 AWS Command Line Interface User Guide Using High Level s3 Commands aws s3 rb s3 bucket name force This will first delete all objects and subfolders in the bucket and then remove the bucket Note If you are using a versioned bucket that contains previously deleted but retained objects this command will not allow you to remove the bucket Listing Buckets To list all buckets or their contents use the aws s3 1s command Here are some examples of common usage The following command lists all buckets aws s3 ls CreationTime Bucket 2013 07 11 17 08 50 my bucket 2013 07 24 14 55 44 my bucket2 The following command lists all objects and folders prefixes in a bucket aws s3 ls s3 bucket name Bucket my bucket Prefix LastWriteTime Length Name PRE MyFolder 2013 09 04 19 05 48 3 MyFilel txt The following command lists the objects in bucket name MyFolder in other words objects in bucket name filtered by the prefix MyFolder S aws s3 ls s3 bucket name MyFolder Bucket my bucket Prefix MyFolder LastWriteTime Length Name 2013 09 06 18 59 32 3 MyFile2 txt Managing Objects The high level aws s3 commands make it convenient to manage Amazon S3 objects as well The object commands include aws s3 cp aws s3 ls aws s3 mv aws s3 rm and sync The cp 1s mv and rm commands work similarly to their Unix counterparts and enable you to wor
21. AttachTime 2013 07 19702 42 39 0002 58 AWS Command Line Interface User Guide Using Instances l Architecture x86 64 StateReason Message pending Code pending RootDeviceName dev sdal VirtualizationType hvm RootDeviceType ebs Tags Value MyInstance Key Name l AmiLaunchIndex 0 Adding a Block Device Mapping to Your Instance Each instance that you launch has an associated root device volume You can use block device mapping to specify additional EBS volumes or instance store volumes to attach to an instance when it s launched To add a block device mapping to your instance specify the block device mappings option when you use run instances The following example adds a standard Amazon EBS volume mapped to dev sdf that s 20 GB in size block device mappings DeviceName dev sdf Ebs VolumeS ize 20 DeleteOnTermination false The following example adds an Amazon EBS volume mapped to dev sdf based on a snapshot When you specify a snapshot it isn t necessary to specify a volume size but if you do it must be greater than or equal to the size of the snapshot block device mappings DeviceName dev sdf Ebs Snapshot Td snap xxxxxxxx The following example adds two instance store volumes Note that the number of instance store volumes avai
22. Groups and Roles in the AWS Identity and Access Management User Guide Using Multifactor Authentication For additional security you can require users to provide a one time key generated from a multifactor authentication device or mobile app when they attempt to make a call using the role profile First modify the trust relationship on the role to require multifactor authentication 13 AWS Command Line Interface User Guide Command Completion Version 2012 10 17 Statement St Ws Effect Allow Principal AWS arn aws iam 123456789012 user jonsmith Action sts AssumeRole Condition Bool aws MultiFactorAuthPresent true Next add a line to the role profile that specifies the ARN of the user s MFA device profile marketingadmin role_arn arn aws iam 123456789012 role marketingadmin source_profile default mfa serial arn aws iam 123456789012 mfa jonsmith The role requires MFA in order to be assumed by any user but the actual MFA device ARN is specified in the role profile s configuration on the user s machine and varies between users This allows many users to assume the same role using their individual MFA devices Cross Account Roles You can enable IAM users to assume roles that belong to different accounts by configuring the role as a cross account role During role creation set the role type to one of the options under Role for Cros
23. and how to perform them using the AWS Command Line Interface Topics Create a Topic p 75 Subscribe to a Topic p 75 Publish to a Topic p 76 Unsubscribe from a Topic p 76 Delete a Topic p 77 Create a Topic The following command creates a topic aws sns create topic name MyTopic The topic Amazon Resource Name ARN is returned TopicArn arn aws sns us west 2 123456789012 MyTopic Make a note of the TopicArn which you will use later to publish a message Subscribe to a Topic The following command subscribes to a topic using the email protocol and an email address for the notification endpoint aws sns subscribe topic arn arn aws sns us west 2 123456789012 MyTopic protocol email notification endpoint emailusername example com The pending confirmation message for the SubscriptionArn is returned 75 AWS Command Line Interface User Guide Publish to a Topic SubscriptionArn pending confirmation An email message will be sent to the email address listed in the subscribe command The email message will have the following text You have chosen to subscribe to the topic arn aws sns us west 2 123456789012 MyTopic To confirm this subscription click or visit the following link If this was in error no action is necessary Confirm subscription After clicking Confirm subscription a Subscription confirmed notifica
24. b options use the h option awscli bundle install h Install the AWS CLI Without Sudo Linux OS X or Unix If you don t have sudo permissions or want to install the AWS CLI only for the current user you can use a modified version of the above commands curl https s3 amazonaws com aws cli awscli bundle zip o awscli bundle zip AWS Command Line Interface User Guide Test the AWS CLI Installation unzip awscli bundle zip awscli bundle install b bin aws This will install the AWS CLI to the default location local lib aws and create a symbolic link symlink at bin aws Make sure that bin is in your PATH environment variable for the symlink to work echo PATH grep bin See if SPATH contains bin output will be empty if it doesn t export PATH bin PATH Add bin to SPATH if necessary Tip To ensure that your PATH settings are retained between sessions add the export line to your shell profile profile bash profile etc Test the AWS CLI Installation Confirm that the CLI is installed correctly by viewing the help file aws help Where to Go from Here Once you have the AWS CLI installed you should configure it for use with AWS p 11 Uninstalling the AWS CLI Uninstall the AWS CLI using the method that matches the way you installed it Pip Run the following command to uninstall the AWS CLI using pip
25. domains that you have registered for your account you can use swf list domains There is only one required parameter registration status Which you can set to either REGISTERED Or DEPRECATED Here s a minimal example aws swf list domains registration status REGISTERED domainInfos Status REGISTERED name ExampleDomain f status REGISTERED name mytest Note For an example of using DEPRECATED see Deprecating a Domain p 82 As you might guess it returns any deprecated domains you have Setting a Page Size to Limit Results If you have many domains you can set the maximum page size parameter to limit the number of results returned If you get more results than the maximum number that you specified you will receive a nextPageToken that you can send to the next call to 11st domains to retrieve additional entries Here s an example of using maximum page size aws swf list domains registration status REGISTERED maximum page size 1 domainInfos status REGISTERED name ExampleDomain 80 AWS Command Line Interface User Guide Working with Amazon SWF Domains E nextPageToken ANeXAMPLEtOKENiSpRETTYlONG Note The nextPageToken thatis returned to you will be much longer This value is mer
26. format This format can be either json text or table If you don t specify an output format json will be used Step 2 Create a Security Group Key Pair and Role for the EC2 Instance Your next step is set up prerequisites for launching an EC2 instance that can be accessed using SSH For more information about Amazon EC2 features go to the Amazon EC2 User Guide for Linux Instances 24 AWS Command Line Interface User Guide Step 3 Launch and Connect to the Instance To create a security group key pair and role 1 First create a new security group and add a rule that allows incoming traffic over port 22 for SSH aws ec2 create security group group name devenv sg description security group for development environment in EC2 GroupId sg b018ced5 aws ec2 authorize security group ingress group name devenv sg protocol tcp port 22 cidr 0 0 0 0 0 Replace the CIDR range in the above with the one that you will connect from for more security You can use the aws ec2 describe security groups command to admire your handiwork Next create a key pair which allows you to connect to the instance aws ec2 create key pair key name devenv key query KeyMaterial output text devenv key pem This command saves the contents of the key to a file called Gevenv key pem Windows In the Windows Command Processor enclose queries with double quotes instead of single quotes
27. in shorthand aws dynamodb update table provisioned throughput ReadCapacityUnits 15 Write CapacityUnits 10 table name MyDDBTable This is equivalent to the following example formatted in JSON aws dynamodb update table provisioned throughput ReadCapacity Units 15 WriteCapacityUnits 10 table name MyDDBTable The shorthand syntax currently does not support nested structures A nested structure has one or more structures as a value or values within itself Nested structures must be specified in JSON 44 AWS Command Line Interface User Guide List Parameters List Parameters Input parameters in a list form can be specified in two ways JSON and shorthand The AWS CLI s shorthand syntax is designed to make it easier to pass in lists with number string or non nested structures The basic format is shown here where values in the list are separated by a single space option valuel value2 value3 This is equivalent to the following example formatted in JSON option valuel value2 value3 As previously mentioned you can specify a list of numbers a list of strings or a list of non nested structures in shorthand The following is an example of the stop instances command for Amazon EC2 where the input parameter list of strings for the instance ids option is specified in shorthand aws ec2 stop instances instance ids i 1486157a i 1286157c i ec3a7e87
28. locate the executable and then invoke it directly by using an absolute path when installing the AWS CLI which pip usr local bin pip sudo usr local bin pip install awscli To upgrade an existing AWS CLI installation use the upgrade option sudo pip install upgrade awscli Pip installs the aws executable to usr bin aws The awsc1i library which does the actual work is installed to the site packages folder in Python s installation directory Install the AWS CLI Using the Bundled Installer Linux OS X or Unix If you are on Linux OS X or Unix you can also use the bundled installer to install the AWS CLI The bundled installer handles all the details in setting up an isolated environment for the AWS CLI and its dependencies You don t have to be fluent in advanced pip virtualenv usage nor do you have to worry about installing pip Prerequisites Linux OS X or Unix Python 2 version 2 6 5 or Python 3 version 3 34 Check your Python installation AWS Command Line Interface User Guide Install the AWS CLI Using the Bundled Installer Linux OS X or Unix python version If your computer doesn t already have Python installed or you would like to install a different version of Python follow the procedure in Install Python p 6 Install the AWS CLI Using the Bundled Installer Follow these steps from the command line to install the AWS CLI using the bun
29. of Python 2 version 2 6 5 or Python 3 version 3 3 If you encounter any issues using the following steps see the full installation instructions in the AWS Command Line Interface User Guide 1 Download and run the installation script from the pip website curl https bootstrap pypa io get pip py o get pip py sudo python get pip py 2 Install the AWS CLI Using pip sudo pip install awscli Configure the CLI and Launch an EC2 Instance This section describes how to launch an EC2 instance running Ubuntu 14 04 from the command line using the AWS CLI Step 1 Configure the AWS CLI Run aws configure atthe command line to set up your credentials and settings aws configure AWS Access Key ID None AKIAIOSFODNN7EXAMPLE AWS Secret Access Key None wJalrXUtnFEMI K7MDENG bPxRfiCYEXAMPLEKEY Default region name None us west 2 Default output format None json The AWS CLI will prompt you for the following information AWS Access Key ID and AWS Secret Access Key These are your account credentials If you don t have keys see How Do Get Security Credentials in the Amazon Web Services General Reference Default region name This is the name of the region you want to make calls against by default Note Use us west 2 for this tutorial the AMI we will use is specific to this region You can change the default region later by running aws configure again Default output
30. open when you ran the installer close it and open a new one to pick up the updated path information gt aws version aws cli 1 7 36 Python 2 7 9 Windows 7 AWS Command Line Interface User Guide Install the AWS CLI Using Pip Don t include the prompt symbol gt above when you type a command These are included in program listings to differentiate commands that you type from output returned by the CLI The rest of this guide uses the generic prompt symbol except in cases where a command is Windows specific Updating an MSI Installation The AWS CLI is updated regularly Check out the Releases page on GitHub to see when the latest version was released To update to the latest version download and run the MSI installer again as detailed above Install the AWS CLI Using Pip Pip is a Python based tool that offers convenient ways to install upgrade and remove Python packages and their dependencies Pip is the recommended method of installing the CLI on Mac and Linux Prerequisites Windows Linux OS X or Unix Python 2 version 2 6 5 or Python 3 version 3 34 e Pip First check to see if you already have Python installed python version If you don t have Python installed follow the procedure at Install Python p 6 to set it up Next check pip pip help If you don t have pip installed follow the procedure at Install pip p 7 Install Python If you don t hav
31. sudo pip uninstall awscli Bundled Installer The bundled installer does not put anything outside of the installation directory except the optional symlink so uninstalling is as simple as deleting those two items sudo rm rf usr local aws sudo rm usr local bin aws Windows To uninstall the AWS CLI in Windows open the Control Panel and select Programs and Features Select the entry named AWS Command Line Interface and click Uninstall to launch the uninstaller Confirm that you wish to uninstall the AWS CLI when prompted You can also launch the Programs and Features menu from the command line with the following command 10 AWS Command Line Interface User Guide Configuring the AWS CLI gt appwiz cpl Configuring the AWS Command Line Interface This section explains how to configure settings that the AWS Command Line Interface uses when interacting with AWS such as your security credentials and the default region Note The AWS CLI signs requests on your behalf and includes a date in the signature Ensure that your computer s date and time are set correctly if not the date in the signature may not match the date of the request and AWS rejects the request Using an HTTP Proxy If you need to access AWS through proxy servers you should configure the HTTP PROXY and HTTPS PROXY environment variables with the IP addresses for your proxy servers Linux OS X or Unix ex
32. the following examples Linux OS X or Unix Read from a file in the current directory aws ec2 describe instances filters file filter json Read from a file in tmp aws ec2 describe instances filters file tmp filter json Windows Read from a file in C temp gt aws ec2 describe instances filters file C temp filter json The file prefix option supports Unix style expansions including and On Windows the l expression expands to C NUsersNUser Name Binary Files For commands that take binary data as a parameter specify that the data is binary content by using the fileb prefix Commands that accept binary data include e aws ec2 run instances user data parameter aws s3api put object sse customer key parameter aws kms decrypt ciphertext blob parameter The following example generates a binary 256 bit AES key using a Linux command line tool and then provides it to Amazon S3 to encrypt an uploaded file server side dd if dev urandom bs 1 count 32 sse key 3210 records in 3210 records out 32 bytes 32 B copied 0 000164441 s 195 kB s aws s3api put object bucket my bucket key test txt body test txt sse customer key fileb sse key Sse customer algorithm AES256 SSECustomerKeyMD5 iVg80Wa8sy714 FjtesrJg SSECustomerAlgorithm AES256 ETag a6118e84b76cf98bf04bbel 4b6045c6c
33. through scripts How to Use This Guide Getting Set Up p 3 describes how to install and configure the AWS CLI Using the AWS CLI p 27 introduces the common features and calling patterns used throughout the AWS CLI Working with Services p 46 includes examples of using the AWS CLI to perform common AWS tasks with different services Document History p 84 provides information about major updates to the AWS CLI User Guide Supported Services For a list of the available services you can use with AWS Command Line Interface see Available Services in the AWS CLI Command Reference AWS Command Line Interface on GitHub You can view and fork the source code for the AWS CLI on GitHub in the https github com aws aws cli project About Amazon Web Services Amazon Web Services AWS is a collection of digital infrastructure services that developers can leverage when developing their applications The services include computing storage database and application AWS Command Line Interface User Guide About Amazon Web Services synchronization messaging and queuing AWS uses a pay as you go service model You are charged only for the services that you or your applications use Also to make AWS more approachable as a platform for prototyping and experimentation AWS offers a free usage tier On this tier services are free below a certain level of usage For more information about AWS costs and the Free Tier see T
34. west 1 DescribeInstances aws ec2 describe instances output table region us west 2 DescribeInstances Reservations sa OwnerId 012345678901 Reservationld r abcdefgh Instances AmiLaunchIndex 0 Architecture x86 64 Command line option parameter types string boolean etc are discussed in detail in the Specifying Parameter Values for the AWS Command Line Interface p 29 section later in this guide 21 AWS Command Line Interface User Guide Instance Metadata Instance Metadata To use the CLI from an EC2 instance create a role that has access to the resources needed and assign that role to the instance when it is launched Launch the instance and check to see if the AWS CLI is already installed it comes pre installed on Amazon Linux Install the AWS CLI if necessary and configure a default region to avoid having to specify it in every command You can set the region using aws configure without entering credentials by pressing enter twice to skip the first two prompts aws configure AWS Access Key ID None ENTER AWS Secret Access Key None ENTER Default region name None us west 2 Default output format None json The AWS CLI will read credentials from the instance metadata For more information see Granting Applications that Run on Amazon EC2 Instances Access to AWS Resources in AM User Guide Where to Go from Here
35. west 2a availability zone aws ec2 describe volumes query Volumes AvailabilityZone us west 2a Note When specifying a literal value such as us west 2 above in a JMESPath query expression you must surround the value in backticks in order for it to be read properly Combined with the three output formats that will be explained in more detail in the following sections the query option is a powerful tool you can use to customize the content and style of outputs For more examples and the full spec of JMESPath the underlying JSON processing library visit http jmespath org specification html JSON Output Format JSON is the default output format of the AWS CLI Most languages can easily decode JSON strings using built in functions or with publicly available libraries As shown in the previous topic along with output 40 AWS Command Line Interface User Guide Text Output Format examples the query option provides powerful ways to filter and format the AWS CLI s JSON formatted output If you need more advanced features that may not be possible with query you can check out jq a command line JSON processor You can download it and find the official tutorial at http stedolan github io jq Text Output Format The text format organizes the AWS CLI s output into tab delimited lines It works well with traditional Unix text tools such as grep sed and awk as well as Windows PowerShell The text
36. 0 1 114 ProductCodes vpcld vpc 1a2b3c4d InstanceId i 5203422c ImageId ami 173d747e PrivateDnsName ip 10 0 1 114 ec2 internal KeyName MyKeyPair SecurityGroups 57 AWS Command Line Interface User Guide Using Instances GroupName MySecurityGroup GroupId sg 903004f8 r ClientToken null SubnetId subnet 6e7f829e InstanceType tl micro NetworkInterfaces Status in use SourceDestCheck true VpcId vpc 1a2b3c4d Description Primary network interface NetworkInterfaceld eni aledblc9 PrivateIpAddresses PrivateDnsName ip 10 0 1 114 ec2 internal Primary true PrivateIpAddress 10 0 1 114 r PrivateDnsName ip 10 0 1 114 ec2 internal Attachment Status attached DeviceIndex 0 DeleteOnTermination true AttachmentId eni attach 52193138 AttachTime 2013 07 19T02 42 39 000z hey Groups GroupName MySecurityGroup GroupId sg 903004f8 I SubnetId subnet 6e7f829e OwnerId 123456789012 PrivateIpAddress 10 0 1 114 1 SourceDestCheck true Placement Tenancy default GroupName null AvailabilityZone us west 2b rs Hypervisor xen BlockDeviceMappings DeviceName dev sdal Ebs Status attached DeleteOnTermination true VolumeId vol 877166c8
37. AM user named jonsmith Version 2012 10 17 Statement 12 AWS Command Line Interface User Guide Assuming a Role ES oat Effect Allow Principal AWS arn aws iam 123456789012 user jonsmith Action sts AssumeRole Next grant your IAM user permission to assume the role The following example shows an AWS Identity and Access Management policy that allows an IAM user to assume the market ingadmin role Version 2012 10 17 Statement Effect Allow Action sts AssumeRole Resource arn aws iam 123456789012 role marketingadmin The user doesn t need to have any additional permissions to run commands using the role profile If you want your users to be able to access AWS resources without using the role apply additional inline or managed policies for those resources With the role profile role permissions trust relationship and user permissions applied you can assume the role at the command line by using the profile option for example aws s3 ls profile marketingadmin To use the role for multiple calls you can set the AWS DEFAULT PROFILE environment variable for the current session from the command line Linux OS X or Unix export AWS DEFAULT PROFILE marketingadmin Windows set AWS DEFAULT PROFILE marketingadmin For more information on configuring IAM users and roles see Users and
38. Command Line Interface User Guide Table Output Format use vol ella5288 standard Attachments t t t t t tll AttachTime DeleteOnTermination Device InstanceId State VolumeId L3 tll 2013 09 17T00 55 03 000Z True dev sdal i a071c394 attached vol e11a5288 FI t t t t t Volumes AvailabilityZone CreateTime Size SnapshotId State VolumeId VolumeType B us west 2a 2013 09 18T20 26 15 0002 8 snap 708e8348 in use vol 2e410a47 standard Attachments El AttachTime DeleteOnTermination Device InstanceId State VolumeId EE t t t t t 2013 09 18T20 26 16 0002 True dev sdal i 4b4la37c attached vol 2e410a47 It 11 The query option can b raw output Note the outpu e used with the table format to display a set of elements pre selected from the t differences in dictionary and list notations column names are alphabetically ordered in the first example and unnamed columns are ordered as defined by the user in the second example aws ec2 describe volumes query Volumes ID Volumeld InstanceId Attach ments 0 InstanceId AZ AvailabilityZone Size Size output table DescribeVolumes AZ ID InstanceId Size us west 2a vo
39. EC2 through the AWS Command Line Interface p 48 Using Amazon Glacier with the AWS Command Line Interface p 61 AWS Identity and Access Management from the AWS Command Line Interface p 65 Using Amazon S3 with the AWS Command Line Interface p 68 Using the AWS Command Line Interface with Amazon SNS p 75 Using Amazon Simple Workflow Service with the AWS Command Line Interface p 77 Using Amazon DynamoDB with the AWS Command Line Interface The AWS Command Line Interface AWS CLI provides support for Amazon DynamoDB You can use the AWS CLI for ad hoc operations such as creating a table You can also use it to embed DynamoDB operations within utility scripts The command line format consists of an Amazon DynamoDB API name followed by the parameters for that API The AWS CLI supports a shorthand syntax for the parameter values as well as JSON For example the following command will create a table named MusicCollection Note For easier readability long commands in this section are broken into separate lines The backslash character lets you copy and paste or type multiple lines into a Linux terminal If you are using 46 AWS Command Line Interface User Guide DynamoDB a shell that does not use backslash to escape characters replace the backslash with another escape character or remove the backslashes and put the entire command on a single line aws dynamodb create table table name MusicCollection
40. If you use 1ist domains to view the registered domains however you will see that the domain no longer appears among them aws swf list domains registration status REGISTERED domainInfos status REGISTERED name ExampleDomain status REGISTERED 82 AWS Command Line Interface User Guide Working with Amazon SWF Domains name mytest You can see deprecated domains by using registration status DEPRECATED With list domains aws swf list domains registration status DEPRECATED domainInfos status DEPRECATED name MyNeatNewDomain You can also use describe domain to get information about a deprecated domain aws swf describe domain name MyNeatNewDomain domainInfo status DEPRECATED name MyNeatNewDomain P configuration workflowExecutionRetentionPeriodInDays 0 See Also deprecate domain in the AWS Command Line Interface Reference describe domain in the AWS Command Line Interface Reference list domains in the AWS Command Line Interface Reference register domain in the AWS Command Line Interface Reference 83 AWS Command Line Interface User Guide AWS CLI User Guide Document History The following table describes the important changes since the last release
41. On Linux you will also need to change the file mode so that only you have access to the key file chmod 400 devenv key pem Step 3 Launch and Connect to the Instance Finally you are ready to launch an instance and connect to it To launch and connect to the instance 1 Run the following command aws ec2 run instances image id ami 29ebb519 count 1 instance type t2 micro key name devenv key security groups devenv sg query In stances 0 InstanceId i ec3ele2k The instance will take a few moments to launch Once the instance is up and running the following command will retrieve the public IP address that you will use to connect to the instance aws ec2 describe instances instance ids i ec3ele2k query Reserva tions 0 Instances 0 PublicIpAddress 54 183 22 255 To connect to the instance use the public IP address and private key with your preferred terminal program On Linux OS X or Unix you can do this from the command line with the following command 25 AWS Command Line Interface User Guide Step 3 Launch and Connect to the Instance ssh i devenv key pem ubuntu 54 183 22 255 SSH on Windows On Windows you can use the PuTTY terminal application available here Get putty exe and puttygen exe from the downloads page Use puttygen exe to convert your private key to a ppk file required by PUTTY Launch putty exe enter the public IP addr
42. PRIVATE KEY T Your private key is not stored in AWS and can only be retrieved when it is created If you re using an SSH client on a Linux computer to connect to your instance use the following command to set the permissions of your private key file so that only you can read it chmod 400 MyKeyPair pem Displaying Your Key Pair A fingerprint is generated from your key pair and you can use it to verify that the private key that you have on your local machine matches the public key that s stored in AWS The fingerprint is an SHA1 hash taken from a DER encoded copy of the private key This value is stored in AWS and can be viewed in 49 AWS Command Line Interface User Guide Using Security Groups the EC2 management console or by calling aws ec2 describe key pairs For example you can view the fingerprint for MyKeyPair by using the following command aws ec2 describe key pairs key name MyKeyPair The following is example output KeyPairs KeyName MyKeyPair KeyFingerprint 1f 51 ae 28 bf 89 69 08 1 25 54 37 20 7d4 58 ca 9 5 1 6 1 For more information on keys and fingerprints see the Amazon EC2 Key Pairs page in the Amazon EC2 User Guide Deleting Your Key Pair To delete MyKeyPair
43. Using Key Pairs p 48 Using Security Groups p 50 Using Amazon EC2 Instances p 55 Using Key Pairs You can use the AWS CLI to create display and delete your key pairs You must specify a key pair when you launch and connect to an Amazon EC2 instance Note Before you try the example commands set your default credentials Topics Creating a Key Pair p 49 Displaying Your Key Pair p 49 Deleting Your Key Pair p 50 48 AWS Command Line Interface User Guide Using Key Pairs Creating a Key Pair To create a key pair named MyKeyPair use the create key pair command and use the query option andthe output text option to pipe your private key directly into a file aws ec2 create key pair key name MyKeyPair query KeyMaterial output text MyKeyPair pem Note that for Windows PowerShell the gt file redirection defaults to UTF 8 encoding which cannot be used with some SSH clients So you must explicitly specify ASCII encoding in the out file command gt aws ec2 create key pair key name MyKeyPair query KeyMaterial output text out file encoding ascii filepath MyKeyPair pem The resulting MyKeyPair pem file looks like this gt BEGIN RSA PRIVA KEEY EXAMPLEKEYKCAQEAy7WZhaDsrAl1W3mRlQtvhwyORRX8gnxgDAfRt gx42kWXsTArXE b5CpSgie vBoU7jLxx92pNHoFnByP Dc21eyyz6CvjTmWAOJwfWiW5 akH7iO5dSrvC7dQkW2duV5QuUdEOOW Z aNxMniGOQE6XAgfwlnXVBwrerrQo t ZWO
44. a84646 a7de5 219 50398238364881 0cc0e18aa67 location 123456789012 vaults myvault archives d3Ab WhEOYEl1m6f fI1jPG82F8xzbMEEZmrAlLGAAONJAzo5QdP N83MKqd96Unspoa5H51lItWX sK8 QS0ZhwsyGiu9 R kwWUySldSBlmgPPWkEbeFfqDSav053rU7FvVLHfRc6hg You can also check the status of the vault using aws glacier describe vault aws glacier describe vault account id vault name myvault SizeInBytes 3178496 VaultARN arn aws glacier us west 2 123456789012 vaults myvault LastInventoryDate 2015 04 07T00 26 19 0282 NumberOfArchives 1 CreationDate 2015 04 06T21 23 45 7082 64 AWS Command Line Interface User Guide AWS ldentity and Access Management VaultName myvault It is now safe to remove the part and hash files you created rm chunk hash For more information on multipart uploads see Uploading Large Archives in Parts and Computing Checksums in the Amazon Glacier Developer Guide AWS Identity and Access Management from the AWS Command Line Interface This section describes some common tasks related to AWS Identity and Access Management IAM and how to perform them using the AWS Command Line Interface The commands shown here assume that you have set default credentials and a default region Topics Create New IAM Users and Groups p 65 Set an IAM Policy for an IAM User p 67 Setan Initial Password for an IAM User p
45. ace User Guide Using JSON for Parameters The next section covers JSON arguments in more detail Using JSON for Parameters JSON is useful for specifying complex command line parameters For example the following command will list all EC2 instances that have an instance type of m1 small or m1 medium that are also in the us west 2c Availability Zone aws ec2 describe instances filters Name instance type Values t2 micro ml me dium Name availability zone Values us west 2c The following example specifies the equivalent list of filters in a JSON array Square brackets are used to create an array of JSON objects separated by commas Each object is a comma separated list of key value pairs Name and Values are both keys in this instance Note that value to the right of the Values key is itself an array This is required even if the array contains only one value string Name instance type Values t2 micro ml medium T Name availability zone Values us west 2c The outermost brackets on the other hand are only required if more than one filter is specified A single filter version of the above command formatted in JSON looks like this aws ec2 describe instances filters Name instance type Values t2 micro ml medium Some operations require data to be formatted as JSON For example to pass parameters to the block device mappings paramet
46. als specified with aws configure in a local file named credentials in a folder named aws in your home directory Home directory location varies but can be referred to using the environment variables SUserProfile in Windows and HOME or tilde in Unix like systems For example the following commands list the contents of the aws folder Linux OS X or Unix ls aws Windows gt dir UserProfile aws In order to separate credentials from less sensitive options region and output format are stored in a separate file named config in the same folder The default file location for the config file can be overridden by setting the AWS CONFIG FILE environment variable to another local path See Environment Variables p 20 for details Storing Credentials in Config The AWS CLI will also read credentials from the config file If you want to keep all of your profile settings in a single file you can If there are ever credentials in both locations for a profile say you used aws configure to update the profile s keys the keys in the credentials file will take precendence If you use one of the SDKs in addition to the AWS CLI you may notice additional warnings if credentials are not stored in their own file The files generated by the CLI for the profile configured in the previous section look like this aws credentials default aws access key id AKIAIOSFODNN7EXAMPLE aws secret access key wJalrXUt
47. amGroup CreateDate 2012 12 20T03 03 522 GroupId AKIAI44QH8DHBEXAMPLE Arn arn aws iam 123456789012 group MyIamGroup Path s 7 Users UserName MyUser Path y CreateDate 2012 12 20T03 13 022 UserId AKIAIOSFODNN7EXAMPLE Arn arn aws iam 123456789012 user MyUser l IsTruncated false You can also view IAM users and groups with the AWS Management Console 66 AWS Command Line Interface User Guide Set an IAM Policy for an IAM User Set an IAM Policy for an IAM User The following commands show how to assign an IAM policy to an IAM user The policy specified here provides the user with Power User Access This policy is identical to the Power User Access policy template provided in the IAM console In this example the policy is saved to a file MyPolicyFile json Version 2012 10 17 Statement Effect Allow NotAction iam Resource To specify the policy use the put user policy command aws iam put user policy user name MyUser policy name MyPowerUserRol policy document file C NTempMMyPolicyFile json This command should return with no output Verify the policy has been assigned to the user with the list user policies command aws iam list user policies user name MyUser The following is example output PolicyNames MyPowerUserRole
48. and Line Interface User Guide Amazon EC2 aws dynamodb query table name MusicCollection key conditions file key conditions json For more documentation on using the AWS CLI with DynamoDB go to hitp docs amazonaws cn cli latest reference dynamodb index html Tip In addition to DynamoDB you can use the AWS CLI with DynamoDB Local DynamoDB Local is a small client side database and server that mimics the DynamoDB service DynamoDB Local enables you to write applications that use the DynamoDB API without actually manipulating any tables or data in DynamoDB Instead all of the API actions are rerouted to DynamoDB Local When your application creates a table or modifies data those changes are written to a local database This lets you save on provisioned throughput data storage and data transfer fees For more information about DynamoDB Local and how to use it with the AWS CLI see the following sections of the Amazon DynamoDB Developer Guide DynamoDB Local Using the AWS CLI with DynamoDB Local Using Amazon EC2 through the AWS Command Line Interface You can access the features of Amazon EC2 using the AWS CLI To list the AWS CLI commands for Amazon EC2 use the following command aws ec2 help Before you run any commands set your default credentials For more information see Configuring the AWS CLI p 11 For examples of common tasks for Amazon EC2 see the following topics Topics
49. and from the service and possible error conditions API Documentation Sections Actions Detailed information on parameters including constraints on length or content and errors specific to an action Actions correspond to subcommands in the AWS CLI Data Types May contain additional information about object data returned by a subcommand Common Parameters Detailed information about parameters that are used by all of a service s actions Common Errors Detailed information about errors returned by all of a service s actions The name and availability of each section may vary depending on the service Service Specific CLIs Some services have a separate CLI from before a single AWS CLI was created that works with all services These service specific CLIs have separate documentation that is linked from the service s documentation page Documentation for service specific CLIs does not apply to the AWS CLI Command Structure in the AWS Command Line Interface The AWS CLI uses a multipart structure on the command line It starts with the base call to aws The next part specifies a top level command which often represents an AWS service supported in the AWS CLI Each AWS service has additional subcommands that specify the operation to perform The general CLI options or the specific parameters for an operation can be specified on the command line in any order If an exclusive parameter is specified multiple times then only th
50. anually with the bundled installer p 8 Note The awscli package may be available in repositories for other package managers such as APT yum and Homebrew but it is not guaranteed to be the latest version To make sure you have the latest version use one of the installation methods described here Install the AWS CLI Using the MSI Installer Windows The AWS CLI is supported on Microsoft Windows XP or later For Windows users the MSI installation package offers a familiar and convenient way to install the AWS CLI without installing any other prerequisites Windows users should use the MSI installer unless they are already using pip for package management To install the AWS CLI using the MSI installer 1 Download the appropriate MSI installer Download the AWS CLI MSI installer for Windows 64 bit Download the AWS CLI MSI installer for Windows 32 bit Note The MSI installer for the AWS CLI does not currently work with Windows Server 2008 version 6 0 6002 Please use pip p 6 to install with this version of Windows 2 Run the downloaded MSI installer 3 Follow the instructions that appear The CLI installs to C Program Files Amazon AWSCLI 64 bit or C Program Files x86 Amazon AWSCLI 32 bit by default To confirm the installation use the aws version command at a command prompt open the START menu and search for cmd if you re not sure where the command prompt is installed Note If the command prompt was
51. ating system Linux OS X or Unix and Windows PowerShell use the single quote to enclose the JSON data structure as in the following example aws ec2 run instances image id ami 05355a6c block device mappings DeviceName dev sdb Ebs VolumeSize 20 DeleteOnTermina tion false VolumeType standard The Windows command prompt on the other hand uses the double quote to enclose the JSON data structure In addition a backslash escape character is required for each double quote within the JSON data structure itself as in the following example gt aws ec2 run instances image id ami 05355a6c block device mappings N DeviceNameV V dev sdbN Ebs VolumeSize 20 DeleteOnTermina tion false VolumeType standard Lastly Windows PowerShell requires a single quote to enclose the JSON data structure as well as a backslash to escape each double quote within the JSON structure as in the following example gt aws ec2 run instances image id ami 05355a6c block device mappings N DeviceNameV V dev sdbN Ebs VolumeSize 20 V DeleteOnTermina tion false VolumeType standard 32 AWS Command Line Interface User Guide Loading Parameters from a File Loading Parameters from a File To load parameters from a local file provide the path to the file using the file prefix as in
52. ault configuration settings for a single operation but cannot be used to specify credentials The following settings can be specified at the command line profile name of a profile to use or default to use the default profile region AWS region to call output output format endpoint url The endpoint to make the call against The endpoint can be the address of a proxy or an endpoint URL for the in use AWS region Specifying an endpoint is not required for normal use as the AWS CLI determines which endpoint to call based on the in use region The above options override the corresponding profile settings for a single operation Each takes a string argument with a space or equals sign separating the argument from the option name Quotes around the argument are not required unless the argument string contains a space Tip You can use the profile option with aws configure to setup additional profiles aws configure profile profilename Common uses for command line options include checking your resources in multiple regions and changing output format for legibility or ease of use when scripting For example if you are not sure which region your instance is running in you could run the describe instances command against each region until you find it aws ec2 describe instances output table region us east 1 DescribeInstances T ae aws ec2 describe instances output table region us
53. aximum duration Otherwise workflow execution data will not be retained after the specified number of days have passed Here s an example of registering a new domain aws swf register domain name MyNeatNewDomain workflow execution retention period in days 0 81 AWS Command Line Interface User Guide Working with Amazon SWF Domains When you register a domain nothing is returned but you can use swf list domains Or swf describe domain to see the new domain For example aws swf list domains registration status REGISTERED domainInfos status REGISTERED name ExampleDomain r status REGISTERED name MyNeatNewDomain r status REGISTERED name mytest Here s an example using swf describe domain aws swf describe domain name MyNeatNewDomain domainInfo status REGISTERED name MyNeatNewDomain configuration workflowExecutionRetentionPeriodInDays 0 Deprecating a Domain To deprecate a domain you can still see it but cannot create new workflow executions or register types on it use swf deprecate domain lt has a sole required parameter name which takes the name of the domain to deprecate aws swf deprecate domain name MyNeatNewDomain As with register domain no output is returned
54. ching an Instance p 55 Adding a Block Device Mapping to Your Instance p 59 Adding a Name Tag to Your Instance p 60 Connecting to Your Instance p 60 Listing Your Instances p 60 Terminating Your Instance p 60 Launching an Instance To launch a single Amazon EC2 instance using the AMI you selected use the run instances command Depending on the platforms that your account supports you can launch the instance into EC2 Classic or EC2 VPC Initially your instance is in the pending state but will be in the running state in a few minutes EC2 Classic The following command launches a t1 micro instance in EC2 Classic aws ec2 run instances image id ami xxxxxxxx count 1 instance type tl micro key name MyKeyPair security groups MySecurityGroup 55 AWS Command Line Interface User Guide Using Instances The following is example output Ownerld 123456789012 ReservationId r 5875ca20 Groups GroupName MySecurityGroup GroupId sg 903004f8 1 Instances Monitoring State disabled PublicDnsName null Platform windows State Code 0 Name pending Fi EbsOptimized false LaunchTime 2013 07 19T02 42 39 0002 ProductCodes InstanceId i 5203422c ImageId ami 173d747e PrivateDnsName null KeyName MyKeyPair SecurityGroups GroupName MySecurityGroup Gr
55. dled installer To install the AWS CLI using the bundled installer 1 Download the AWS CLI Bundled Installer using wget or curl 2 Unzip the package 3 Run the install executable On Linux and OS X here are the three commands that correspond to each step curl https s3 amazonaws com aws cli awscli bundle zip o awscli bundle zip unzip awscli bundle zip sudo awscli bundle install i usr local aws b usr local bin aws If you don t have unzip use your Linux distribution s built in package manager to install it typically with either sudo yum install unzipOrsudo apt get install unzip Note By default the install script runs under the system default version of Python If you have installed an alternative version of Python and want to use that to install the AWS CLI run the install script with that version by absolute path to the Python executable For example sudo usr local bin python2 7 awscli bundle install i usr local aws b usr local bin aws The third command installs the AWS CLI at usr local aws and create the symlink aws at the usr local bin directory Using the b option to create a symlink eliminates the need to specify the install directory in the user s PATH variable This should enable all users to call the AWS CLI by typing aws from any directory Important The bundled installer does not support installing to paths that contain spaces To see an explanation of the i and
56. e You can access features of Amazon Simple Workflow Service Amazon SWF using the AWS CLI For a list of commands and how to work with domains in Amazon SWF see the following topics Topics List of Amazon SWF Commands by Category p 77 Working with Amazon SWF Domains Using the AWS Command Line Interface p 80 List of Amazon SWF Commands by Category This section lists the reference topics for Amazon SWF commands in the AWS CLI The commands here are listed by functional category For an alphabetic list of commands see the Amazon SWF section of the AWS Command Line Interface Reference or use the following command aws swf help To get help for a particular command use the help directive after the command name The following shows an example aws swf register domain help Topics Commands Related to Activities p 78 Commands Related to Deciders p 78 Commands Related to Workflow Executions p 78 Commands Related to Administration p 78 Visibility Commands p 79 77 AWS Command Line Interface User Guide List of Amazon SWF Commands Commands Related to Activities Activity workers use poll for activity task to get new activity tasks After a worker receives an activity task from Amazon SWF it performs the task and responds using respond activity task completed if successful or respond activity task failedif unsuccessful The following are commands that are p
57. e ast value applies aws command subcommand options and parameters 28 AWS Command Line Interface User Guide Specifying Parameter Values Parameters can take various types of input values such as numbers strings lists maps and JSON structures Specifying Parameter Values for the AWS Command Line Interface This section explains how to pass parameters as values for AWS CLI command options First many parameters are simple string or numeric values such as the key pair name MyKeyPair in the following example aws ec2 create key pair key name MyKeyPair Strings without any space characters may be quoted or unquoted However strings that include one or more space characters must be quoted Use a single quote in Linux OS X or Unix and Windows PowerShell or use a double quote in the Windows command prompt as shown in the following examples Windows PowerShell Linux OS X or Unix aws ec2 create key pair key name My Key Pair Windows Command Processor gt aws ec2 create key pair key name My Key Pair Topics Common Parameter Types p 29 Using JSON for Parameters p 31 Loading Parameters from a File p 33 Common Parameter Types This section describes some of the common parameter types and the format that the services expect them to conform to If you are having trouble with the formatting of a parameter for a sp
58. e Python installed install version 2 7 or 3 4 using one of the following methods On Windows or OS X download the Python package for your operating system from python org and run the installer These installers include pip On Linux OS X or Unix install Python using your distribution s package manager To install Python 2 7 on Linux 1 Checkto see if Python is already installed python version Note If your Linux distribution came with Python you may need to install the Python developer package in order to get the headers and libraries required to compile extensions and install the AWS CLI Install the developer package typically named python dev or python devel using your package manager AWS Command Line Interface User Guide Install the AWS CLI Using Pip If Python 2 7 or later is not installed install it with your distribution s package manager The command and package name varies On Debian derivatives such as Ubuntu use APT sudo apt get install python2 7 On Red Hat and derivatives use yum sudo yum install python27 On SUSE and derivatives use zypper sudo zypper install python Open a command prompt or shell and run the following command to verify that Python installed correctly python version Python 2 7 9 Install pip Install pip by using the script provided by the Python Packaging Authority To install pip o
59. e current user The shell will be one of them ps PID TTY TIME CMD 2148 pts 1 00 00 00 bash 8756 pts 1 00 00 00 ps Locate the AWS Completer The location can vary depending on the installation method used Package Manager programs such as pip yum brew and apt get typically install the AWS completer or a symlink to it to a standard path location In this case which will locate the completer for you which aws completer usr local bin aws completer Bundled Installer if you used the bundled installer per the instructions in the previous section the AWS completer will be located in the bin subfolder of the installation directory 1s usr local aws bin activate activate csh activate fish activate this py aws aws cmd aws completer If all else fails you can use find to search your entire file system for the AWS completer find name aws completer usr local aws bin aws completer Enable Command Completion The command that you use to enable completion depends on the shell that you are using bash use the built in command complete complete C usr local bin aws completer aws tcsh complete for tcsh takes a word type and pattern to define the completion behavior 15 AWS Command Line Interface User Guide Quick Configuration gt complete aws p aws completer zsh source bin aws zsh complete
60. e set to uri emailaddress Or id e Grantee ID Specifies the grantee based on Grantee Type uri The group s URI For more information see Who Is a Grantee emailaddress The account s email address id The account s canonical ID For more information on Amazon S3 access control see Access Control The following example copies an object into a bucket It grants read permissions on the object to everyone and full permissions read readacl and writeacl to the account associated with userlexample com aws s3 cp file txt s3 bucket name grants read uri http acs amazon aws com groups global AllUsers full emailaddress user example com The sync command has the following form Possible source target combinations are Local file system to Amazon S3 Amazon S3 to local file system Amazon S3 to Amazon S3 aws s3 sync source target options The following example synchronizes the contents of an Amazon S3 folder named MyFolder in my bucket with the current working directory The output displays specific operations performed during the sync Notice that the operation recursively synchronizes the subdirectory MySubdirectory and its contents with s3 my bucket MyFolder MySubdirectory aws s3 sync s3 my bucket MyFolder upload MySubdirectoryMMyFile3 txt to s3 my bucket MyFolder MySubdirectory My File3 txt 71 AWS Command Line Interface User Guide Using High Level s3 C
61. ecific command check the manual by typing help after the command name for example aws ec2 describe spot price history help The help for each subcommand describes its function options output and examples The options section includes the name and description of each option with the option s parameter type in parentheses String String parameters can contain alphanumeric characters symbols and whitespace from the ASCII character set Strings that contain whitespace must be surrounded by quotes Use of symbols and whitespace other than the standard space character is not recommended and may cause issues when using the AWS CLI Some string parameters can accept binary data from a file See Binary Files p 33 for an example 29 AWS Command Line Interface User Guide Common Parameter Types Timestamp Timestamps are formatted per the ISO 8601 standard These are sometimes referred to as DateTime or Date type parameters aws ec2 describe spot price history start time 2014 10 13719 00 002 Acceptable formats include YYYY MM DDThh mm ss sssTZD UTC e g 2014 10 01T20 30 00 000Z e YYYY MM DDThh mm ss sssTZD with offset e g 2014 10 01T12 30 00 000 08 00 YYYY MM DD e g 2014 10 01 YYYYMMDD e g 20141001 List One or more strings separated by spaces aws ec2 describe spot price history instance types ml xlarge ml medium Boolean Binary flag
62. ely an example for illustrative purposes When you make the call again this time supplying the value of nextPageToken in the next page token argument you ll get another page of results aws swf list domains registration status REGISTERED maximum page size 1 next page token ANeXAMPLEtOKENiSpRETTYlONG domainInfos status REGISTERED name mytest When there are no further pages of results to retrieve next PageToken will not be returned in the results Getting Information About a Domain To get detailed information about a particular domain use swf describe domain There is one required parameter name which takes the name of the domain you want information about For example aws swf describe domain name ExampleDomain domainInfo status REGISTERED name ExampleDomain configuration workflowExecutionRetentionPeriodInDays 1 Registering a Domain To register new domains use swf register domain There are two required parameters name which takes the domain name and workflow execution retention period in days which takes an integer to specify the number of days to retain workflow execution data on this domain up to a maximum period of 90 days for more information see the Amazon SWF FAQ If you specify zero 0 for this value the retention period is automatically set at the m
63. enne nenne he nenne he he hehehe heres enne 31 Loading Parameters from a File sssssssssese Hmmm meer 33 Generate CLI Skeleton 2 0 2 2 cece cece cece eee ee eee ene eee ne he he he nenne hehe ne ne hehehe nennen 34 Controlling Command Output 0 cc cece cece cece eee eee eme me menm hehehe he he he hehehe hehe tenen nens 37 How to Select the Output Format ssssssssssssssssne ne ne mene he hehehe hehe 37 How to Filter the Output with the query Option ssssm eee ee neta een eea neared 38 JSONOutBUt o Teucer HE 40 uenire 41 Table Q tput Format tM T 42 Shorthand Syntax asian un al AG 44 Str cture Parameters aa a i tanga RU ge Ra Gl a IE DONEC SM ER M EO 44 List Parameters ETE o I dowseeiedamantitacmmadiengennciee 45 Moris Bue e RL m 46 AWS Command Line Interface User Guide DynamoDB essences Ek r a a ara LA Ra a Rg hes 46 Amazon ase eis es Rata eae er Ae as A a A A 48 USING Key Pairs ineeie Neng oue Eee aa e e sac Sena RA RE sed unna aa RL oes 48 Using Security Groups vcs a a A vo do dee de dre ine Ea 50 USM INStaNCES Mm 55 Amazon Glacier si ns E 61 Create an Amazon Glacier Vault 0e0at nearest 61 Prepare a File for Uploading iiis erisia e eei i e e ae Ei 63 Initiate a Multipart Upload and Upload Files sssm MH 62 Complete the pload
64. entials file uses a different naming format than the CLI config file for named profiles Do not include the profile prefix when configuring a named profile in the AWS credentials file Using Profiles with the AWS CLI To use a named profile add the profile option to your command The following example lists running instances using the user2 profile from the previous section aws ec2 describe instances profile user2 If you are going to use a different profile for multiple commands you can avoid specifying the profile in every command by setting the AWS DEFAULT PROFILE environment variable at the command line Linux OS X or Unix export AWS DEFAULT PROFILE user2 19 AWS Command Line Interface User Guide Environment Variables Windows gt set AWS DEFAULT PROFILE user2 Setting the environment variable changes the default profile until the end of your shell session or until you set the variable to a different value More on variables in the next section Environment Variables Environment variables override configuration and credential files and can be useful for scripting or temporarily setting a named profile as the default The following variables are supported by the AWS CLI AWS ACCESS KEY ID AWS access key AWS SECRET ACCESS KEY AWS secret key Access and secret key variables override credentials stored in credential and config files AWS SESSION TOKEN
65. eptember 20 2013 September 3 2013 84 AWS Command Line Interface User Guide Change Description Date Changed New developer pre This is a developer preview of the AWS Command Line December 21 2012 view guide Interface User Guide 85
66. eqiUwwMkuEbLeJFLhMCvYURpUMSCloehm449ilx9X1F G50TCFeOzfl8dqqCP6GzbPaljiU19xX azOR9V tpUOzEL wmXnZt3 nHPQ5xvD20JH67km6SuPW oPzev D8V x4 bHthfSjR9Y7DvOF j BVwHXigBdtZcU2 wei8D HYwIDAOQABAOIBAGZlkaEvnrqu uler7vgIn5m71N5LKwA4hJLAIWG6tUT fzvtcHKOSkbOCOXuriHmQ2MQyJX Okn2NfjLV ufGxbL1 mb5qwMGUnEpJaZD6QSSs3kICLwWUYUiGfcOuiSbmJoap GTLUOWS5MfcCv36PaBUNy5p53V6G7hXb2 bahyWyJNf jLe4M8 6yd2YK3V2CmK X BOsShnJ36 hjrXPPWmV3N9zEmCdJjA K15DYmhm t JWSD9 810Gk 9TopEp7CkI fatEATyyZiVgoRq6k64iuM9JkA30zdXzMQexXVJ1TLZVEHOE7bDALYId8010zR oQs FiZNAx2iijCWyvO01pjE73 kCgYEA9mZt ynkHkFDpwrSM1APaL80NAbb jwEy7Z5Mqfql liIpl YkriLODbLX1vRAH yHPRit 2hHOjtUNZh4Axvt cpg0 9qbUI3 4 3eEy24B7G Uh GTfbjsxXsOxOx x p9o0tyVwe7hsQSTA5PZb mvkJ50BEKzet 9XcKwWONBYELGhnEPe7cCgYEA0 6Vgov6YHleHui 9kHuws ayavO0elc5zkxjF9nfHFJRry21Rltrw2Vdpn 99g481URrpzWVOEihvmtxTtmaZl1Sp lkq75XDwnU WA8gkn603QE3fq2yN98BURSAKdJfJ5RLIHvGQvTelOHLYYXpJnEkHv 4 Unl2ajLivWUt5pbBrKbUC gYBjbO OZk0sCcpZ29sbzjYjpIddErySIyRX5gV2uNQwAjLdp9PfN295yQ BxMBXiIycWVQiwObH oMo7yykABY70zd5wQewBO4AdSl1WSX4nGDtsiFxWil5sKuAAeOCbTosyls8w8fxoJ5TzlsdoxNeGs Arq6Wv Gl6zQuAE9zK9vvwKBgFt 09VI lwJBirsDGz9whVWfFPrTkJNvJZzYt69qezxlsjgFKshy WBhd4AxHZtmCqpBPlAymEjr TOlbxyARmXMnlOWIAnNXMGBA4KGSyllmzSVAoQ tfqR cJ3d0dyP11j jjb0Ed NY8frlNDxAVHE8BSkdsx2f6ELEyBKJSRr9snRAOGAMrTwYneXzvTskF S5Fyu0iOegLDa NWUH38v nDCgEpIXD5Hn3gAEcjulIjmbwlvtW 4 nY2jVhv7UGd8MjwUTNGItdb6nsYqM2asrnF3qS VRkAKKKYeGjkpUfVTrWOYFjXkfcrR V QFL5OndHAKJXjW7a4ejJLncTzmZSpYzwApc ai ip END RSA
67. er in the ec2 run instances command you need to format the block device information as JSON This example shows the JSON to specify a single 20 GiB Elastic Block Store device to be mapped at dev sdb on the launching instance DeviceName dev sdb Ebs VolumeSize 20 DeleteOnTermination false VolumeType standard 31 AWS Command Line Interface User Guide Using JSON for Parameters To attach multiple devices list the objects in an array like in the next example DeviceName dev sdb Ebs VolumeSize 20 DeleteOnTermination false VolumeType standard DeviceName dev sdc Ebs VolumeSize 10 DeleteOnTermination true VolumeType standard You can either enter the JSON directly on the command line see Quoting Strings p 32 or save it to a file that is referenced from the command line see Loading Parameters from a File p 33 When passing in large blocks of data you might find it easier to save the JSON to a file and reference it from the command line JSON data in a file is easier to read edit and share with others This technique is described in the next section For more information about JSON see Wikipedia JSON and RFC4627 The application json Media Type for JSON Quoting Strings The way you enter JSON formatted parameters on the command line differs depending upon your oper
68. erformed by activity workers poll for activity task respond activity task completed respond activity task failed respond activity task canceled record activity task heartbeat Commands Related to Deciders Deciders use poll for decision task to get decision tasks After a decider receives a decision task from Amazon SWF it examines its workflow execution history and decides what to do next lt calls respond decision task completed to complete the decision task and provides zero or more next decisions The following are commands that are performed by deciders poll for decision task respond decision task completed Commands Related to Workflow Executions The following commands operate on a workflow execution request cancel workflow execution start workflow execution signal workflow execution terminate workflow execution Commands Related to Administration Although you can perform administrative tasks from the Amazon SWF console you can use the commands in this section to automate functions or build your own administrative tools Activity Management register activity type deprecate activity type Workflow Management register workflow type deprecate workflow type 78 AWS Command Line Interface User Guide List of Amazon SWF Commands Domain Management register domain deprecate domain For more information and examples of these domain management commands see Working with Amazon
69. ess of the instance in the Host Name field and set the connection type to SSH In the Category panel navigate to Connection gt SSH gt Auth and click Browse to select your ppk file and then click Open to connect 4 The terminal will prompt you to accept the server s public key Type yes and click Enter to complete the connection You ve now configured a security group created a key pair launched an EC2 instance and connected to it without ever leaving the command line 26 AWS Command Line Interface User Guide Getting Help Using the AWS Command Line Interface This section introduces the common features and calling patterns used throughout the AWS Command Line Interface Topics Getting Help with the AWS Command Line Interface p 27 Command Structure in the AWS Command Line Interface p 28 Specifying Parameter Values for the AWS Command Line Interface p 29 Generate CLI Skeleton and CLI Input JSON Parameters p 34 Controlling Command Output from the AWS Command Line Interface p 37 Using Shorthand Syntax with the AWS Command Line Interface p 44 Getting Help with the AWS Command Line Interface To get help when using the AWS CLI you can simply add ne1p to the end of a command For example the following command lists help for the general AWS CLI options and the available top level commands aws help The following command lists the available subcommands for Amazon EC2 a
70. est Driving AWS in the Free Usage Tier To obtain an AWS account open the AWS home page and then click Sign Up AWS Command Line Interface User Guide Sign Up for Amazon Web Services Getting Set Up with the AWS Command Line Interface Before you can start using the AWS Command Line Interface you must sign up for an AWS account if you don t already have one and set up your CLI environment Depending on your operating system and environment there are different ways to install the AWS CLI an MSI installer a bundled installer or pip The following sections will help you decide which option to use Note The AWS CLI makes API calls to services over HTTPS Outbound connections on TCP port 443 must be enabled in order to perform calls Topics Sign Up for Amazon Web Services p 3 Installing the AWS Command Line Interface p 4 Configuring the AWS Command Line Interface p 11 Where to Go from Here p 22 Sign Up for Amazon Web Services To use Amazon Web Services AWS you will need to sign up for an AWS account If you already have an AWS account you can skip to Installing the AWS CLI p 4 To sign up for an AWS account 1 Open htip www amazonaws cn and then click Sign Up 2 Follow the on screen instructions Part of the sign up procedure involves receiving a phone call and entering a PIN using the phone keypad AWS sends you a confirmation email after the sign up process is complete At any time yo
71. et xclude my bucket MyFolder My File txt delete s3 my bucket MyFolder MyFile88 txt Bas Delete MyFile2 rtf aws s3 rm s3 my bucket MyFolder MyFile2 rtf Sync with delete excluding MyFile2 rtf local file is NOT deleted aws s3 sync s3 my bucket MyFolder delet xclude MyFile2 rtf download s3 my bucket MyFolder MyFilel txt to MyFilel txt Sync with delete local copy of MyFile2 rtf is deleted aws s3 sync s3 my bucket MyFolder delete delete MyFile2 rtf The sync command also accepts an ac1 option by which you may set the access permissions for files copied to Amazon S3 The option accepts private public read and public read write values aws s3 sync s3 my bucket MyFolder acl public read As previously mentioned the s3 command set includes cp mv 1s and rm and they work in similar ways to their Unix counterparts The following are some examples Copy MyFile txt in current directory to s3 my bucket MyFolder aws s3 cp MyFile txt s3 my bucket MyFolder Move all jpg files in s3 my bucket MyFolder to MyDirectory aws S3 mv s3 my bucket MyFolder MyDirectory xclude include jpg recursive List the contents of my bucket aws s3 ls s3 my bucket List the contents of MyFolder in my bucket aws s3 ls s3 my bucket MyFolder Delete s3 my bucket MyFolder MyFile txt aws s3 rm s3 my bucket MyFolder MyFile txt
72. file chunkaa creating file chunkab creating file chunkac 2 Calculate and store the binary SHA 256 hash of each chunk openssl dgst sha256 binary chunkaa hashl openssl dgst sha256 binary chunkab hash2 openssl dgst sha256 binary chunkac hash3 3 Combine the first two hashes and take the binary hash of the result cat hashl hash2 gt hash12 openssl dgst sha256 binary hash12 gt hashl2hash 4 Combine the parent hash of chunks aa and ab with the hash of chunk ac and hash the result this time outputing hexadecimal Store the result in a shell variable cat hashl2hash hash3 hash123 openssl dgst sha256 hash123 SHA256 hash123 9628195fcdb cbbe76cdde932d4646fa7de5f 219 5039823836d81 0cc0e18aa67 TREEHASH 9628195fcdbcbbe76cdde932d4646fa7de5f219 b39823836d81f0cc0e18aa67 Finally complete the upload with the aws glacier complete multipart upload command This command takes the original file s size in bytes the final tree hash value in hexadecimal and your account ID and vault name aws glacier complete multipart upload checksum TREEHASH archive size 3145728 upload id UPLOADID account id vault name myvault archiveId d3AbWhEOYEl1m6f fI1jPG82F8xzbMEEZmrAlLGAAONJAzo5QdP N83MKqd96Unspoa5H51ItWX sK8 OQSOZhwsyGiu9 R kwWUyS1dSBlmgPPWkEbeFfqDSav053rU7FvVL HfRc6hg checksum 9628195fcdb cbbe76cdde932
73. ide your organization even if an inquiry appears to come from AWS or Amazon com No one who legitimately represents Amazon will ever ask you for your secret key Related topics e What Is IAM in IAM User Guide AWS Security Credentials in AWS General Reference Installing the AWS Command Line Interface This section discusses various ways to install the AWS CLI Note The AWS CLI comes pre installed on the Amazon Linux AMI Run sudo yum update after connecting to the instance to get the latest version of the package available via yum If you need a more recent version of the AWS CLI than what is available in the Amazon updates repository uninstall the package sudo yum remove aws cli and then install using pip Topics Choose an Installation Method p 5 Install the AWS CLI Using the MSI Installer Windows p 5 Install the AWS CLI Using Pip p 6 Install the AWS CLI Using the Bundled Installer Linux OS X or Unix p 8 Test the AWS CLI Installation p 10 Where to Go from Here p 10 AWS Command Line Interface User Guide Choose an Installation Method Uninstalling the AWS CLI p 10 Choose an Installation Method There are a number of different ways to install the AWS CLI on your machine depending on what operating System and environment you are using On Microsoft Windows use the MSI installer p 5 OnLinux OS X or Unix use pip p 6 a package manager for Python software or install m
74. imilar example for all stopped instances and takes it one step further to automate changing instance types for each stopped instance aws ec2 describe instances query Reservations Instances State Name InstanceId output text gt grep stopped gt awk print 2 while read line gt do aws ec2 modify instance attribute instance id line instance type Value ml medium done The text output is useful in Windows PowerShell as well Because AWS CLI s text output is tab delimited it is easily split into an array in PowerShell using the t delimiter The following command displays the value of the third column Instancerg ifthe first column availabilityZone matches us west 2a aws ec2 describe instances query Reservations Instances Place ment AvailabilityZone State Name InstanceId output text S if split t 0 match us west 2a _ split t 2 i 4b41a37c i a071c394 1 3045b007 i 6fc67758 Table Output Format The table format produces human readable representations of AWS CLI output Here is an example aws ec2 describe volumes output table DescribeVolumes Volumes AvailabilityZone CreateTime Size SnapshotId State VolumeId VolumeType 4 t us west 2a 2013 09 17T00 55 03 000Zz 30 snap f23eclc8 in 42 AWS
75. ion My security group IpPermissions GroupName MySecurityGroup OwnerId 123456789012 GroupId sg 903004f8 EC2 VPC The following command creates a security group named MySecurityGroup for the specified VPC aws ec2 create security group group name MySecurityGroup description My security group vpc id vpc 1a2b3c4d The following is example output return true GroupId sg 903004f8 To view the initial information for MySecurityGroup use the describe security groups command as follows Note that you can t reference a security group for EC2 VPC by name aws ec2 describe security groups group ids sg 903004f8 51 AWS Command Line Interface User Guide Using Security Groups The following is example output SecurityGroups IpPermissionsEgress IpProtocol s al TpRanges Cidrip 0 0 0 0 0 1 UserIdGroupPairs 1 Description My security group IpPermissions GroupName MySecurityGroup VpcId vpc 1a2b3c4d OwnerId 123456789012 GroupId sg 903004f8 Adding Rules to Your Security Group If you re launching a Windows instance you must add a rule to allow inbound traffic on TCP port 3389 RDP If you re launching a Linux instance you must add a rule to allow inbound traffic on TCP port 22 SSH Use the authorize security grou
76. k seamlessly across your local directories and Amazon S3 buckets The sync command synchronizes the contents of a bucket and a directory or two buckets Note All high level commands that involve uploading objects into an Amazon S3 bucket aws s3 cp aws s3 mv andaws s3 sync automatically perform a multipart upload when the object is large 70 AWS Command Line Interface User Guide Using High Level s3 Commands Failed uploads cannot be resumed when using these commands If the multipart upload fails due to a timeout or is manually cancelled by pressing CTRL C the AWS CLI cleans up any files created and aborts the upload This process can take several minutes If the process is interrupted by a kill command or system failure the in progress multipart upload remains in Amazon S3 and must be cleaned up manually in the AWS Management Console or with the s3api abort multipart upload command The cp mv and sync commands include a grants option that can be used to grant permissions on the object to specified users or groups You set the grants option to a list of permissions using following syntax grants Permission Grantee Type Grantee ID Permission Grantee Type Grantee ID Each value contains the following elements Permission Specifies the granted permissions and can be set to read readacl writeacl or full Grantee Type Specifies how the grantee is to be identified and can b
77. l e11a5288 i a071c394 30 us west 2a vol 2e410a47 i 4b41a37c 8 aws ec2 describe volumes query Volumes VolumeId Attachments 0 In 43 AWS Command Line Interface User Guide Shorthand Syntax stanceId AvailabilityZone Size output table DescribeVolumes vol ella5288 i a071c394 us west 2a 30 vol 2e410a47 i 4b41a37c us west 2a 8 Using Shorthand Syntax with the AWS Command Line Interface While the AWS Command Line Interface can take nonscalar option parameters in JSON format it can be tedious to type large JSON lists or structures on the command line To address this issue the AWS CLI supports a shorthand syntax that allows simpler representation of your option parameters than using the full JSON format Structure Parameters The shorthand syntax in the AWS CLI makes it easier for users to input parameters that are flat non nested structures The format is a comma separate list of key value pairs Linux OS X or Unix option keyl valuel key2 value2 key3 value3 Windows PowerShell option keyl valuel key2 value2 key3 value3 This is equivalent to the following example formatted in JSON option key1 valuel key2 value2 key3 value3 There must be no whitespace between each comma separated key value pair Here is an example of the DynamoDB update table command with the provisioned throughput option specified
78. lable to your instance depends on its instance type block device mappings DeviceName dev sdf VirtualName ephem eral0 DeviceName dev sdg VirtualName ephemerall1 The following example omits a mapping for a device specified by the AMI used to launch the instance dev sdj block device mappings DeviceName dev sdj NoDevice For more information see Block Device Mapping in the Amazon EC2 User Guide for Linux Instances 59 AWS Command Line Interface User Guide Using Instances Adding a Name Tag to Your Instance To add the tag Name MyInstance to your instance use the create tags command as follows aws ec2 create tags resources i XXXXXXXX tags Key Name Value MyInstance The following is example output return true For more information see Tagging Your Resources in the Amazon EC2 User Guide for Linux Instances Connecting to Your Instance While your instance is running you can connect to it and use it just as you d use a computer sitting in front of you For more information see Connect to Your Amazon EC2 Instance in the Amazon EC2 User Guide for Linux Instances Listing Your Instances You can use the AWS CLI to list your instances and view information about them You can list all your instances or filter the results based on the instances that you re interested in Note Before you
79. line use two percent signs i e SUPLOADID You must specify the byte range of each part when you upload it so it can be reassembled in the proper order by Amazon Glacier Each piece is 1048576 bytes so the first piece occupies bytes 0 1048575 the second 1048576 2097151 and the third 2097152 3145727 Complete the Upload Amazon Glacier requires a tree hash of the original file in order to confirm that all of the uploaded pieces reached AWS intact To calculate a tree hash you split the file into 1 MiB parts and calculate a binary SHA 256 hash of each piece Then you split the list of hashes into pairs combine the two binary hashes in each pair and take hashes of the results Repeat this process until there is only one hash left If there is an odd number of hashes at any level promote it to the next level without modifying it The key to calculating a tree hash correctly when using command line utilities is to store each hash in binary format and only convert to hexadecimal at the last step Combining or hashing the hexadecimal version of any hash in the tree will cause an incorrect result Note Windows users can use the type command in place of cat OpenSSL is available for Windows at OpenSSL org To calculate a tree hash 1 Split the original file into 1 MiB parts if you haven t already 63 AWS Command Line Interface User Guide Complete the Upload split bytes 1048576 verbose largefile chunk creating
80. lt profile profile marketingadmin role arn arn aws iam 123456789012 role marketingadmin source profile default In this case the default profile is an IAM user with credentials and permission to assume a role named marketingadmin To access the role you create a named profile Instead of configuring this profile with credentials you specify the ARN of the role and the name of the profile that has access to it Topics Configuring and Using a Role p 12 Using Multifactor Authentication p 13 Cross Account Roles p 14 Configuring and Using a Role When you run commands using the role profile the AWS CLI uses the source profile s credentials to call AWS Security Token Service and assume the specified role The source profile must have permission to call sts assume role against the role and the role must have a trust relationship with the source profile to allow itself to be assumed Create a new role in IAM with the permissions that you want users to assume by following the procedure under Creating a Role to Delegate Permissions to an IAM User in the AWS Identity and Access Management User Guide lf the role and the target IAM user are in the same account you can enter your own account ID when configuring the role s trust relationship After creating the role modify the trust relationship to allow the IAM user to assume it The following example shows a trust relationship that allows a role to be assumed by an I
81. n Linux 1 Download the installation script from pypa io curl O https bootstrap pypa io get pip py The script downloads and installs the latest version of pip and another required package named setuptools Run the script with Python sudo python27 get pip py Collecting pip Downloading pip 6 1 1 py2 py3 none any whl 1 1MB Collecting setuptools Downloading setuptools 15 0 py2 py3 none any whl 501kB Installing collected packages pip setuptools Successfully installed pip 6 1 1 setuptools 15 0 Invoking version 2 7 of Python directly by using the python27 command instead of python ensures that pip is installed in the proper location even if an older system version of Python is present on your system AWS Command Line Interface User Guide Install the AWS CLI Using the Bundled Installer Linux OS X or Unix Install the AWS CLI Using pip With Python and pip installed use pip to install the AWS CLI Windows pip install awscli To upgrade an existing AWS CLI installation use the upgrade option gt pip install upgrade awscli Linux OS X or Unix sudo pip install awscli Note If you installed a new version of Python alongside an older version that came with your distribution you may get an error like the following when trying to invoke pip with sudo sudo pip command not found To work around this issue use which pip to
82. nFEMI K7MDENG bPxRfiCYEXAMPLEKEY aws config default region us west 2 output json The following settings are supported aws access key id AWS access key aws secret access key AWS secret key aws session token AWS session token A session token is only required if you are using temporary security credentials region AWS region 18 AWS Command Line Interface User Guide Named Profiles output output format json text or table Named Profiles The AWS CLI supports named profiles stored in the config and credentials files You can configure additional profiles by using aws configure with the profile option or by adding entries to the config and credentials files The following example shows a credentials file with two profiles aws credentials default aws access key id AKIAIOSFODNN7EXAMPLE aws secret access key wJalrXUtnFEMI K7MDENG bPxRfiCYEXAMPLEKEY user2 aws access key id AKIAIA440H8DHBEXAMPLE aws secret access key je7MtGbClwBF 2Z2p9Utk h3yCo8nvbEXAMPLEKEY Each profile uses different credentials perhaps from two different IAM users and can also use different regions and output formats aws config default region us west 2 output json profile user2 region us east 1 output texrt Important The AWS cred
83. nfigure command is the fastest way to setup your AWS CLI installation 16 AWS Command Line Interface User Guide Configuration Settings and Precedence aws configure AWS Access Key ID None AKIAIOSFODNN7EXAMPLE AWS Secret Access Key None wJalrXUtnFEMI K7MDENG bPxRfiCYEXAMPLEKEY Default region name None us west 2 Default output format None json The AWS CLI will prompt you for four pieces of information AWS Access Key ID and AWS Secret Access Key are your account credentials If you don t have keys see the Getting Set Up p 3 section earlier in this guide Default region is the name of the region you want to make calls against by default This is usually the region closest to you but it can be any region Note You must specify an AWS region when using the AWS CLI For a list of services and available regions see Regions and Endpoints Default output format can be either json text or table If you don t specify an output format json will be used If you have multiple profiles you can configure additional named profiles by using the profile option aws configure profile user2 AWS Access Key ID None AKIAI44QH8DHBEXAMPLE AWS Secret Access Key None je7MtGbClwBF 2Zp9Utk h3yCo8nvbEXAMPLEKEY Default region name None us east 1 Default output format None text To update any of your settings simply run aws configure again and enter new values as appropriate
84. of the AWS Command Line Interface User Guide Last documentation update February 3 2015 Change New Topic New Tutorial Rewrote Configura tion Instructions New Sections Updated Document ation Update Update General release Description Generate CLI Skeleton p 34 Deploying a Development Environment in Amazon EC2 Using the AWS Command Line Interface p 23 Reorganized Configuring the AWS CLI p 11 to emphas ize the quickest configuration path and sort instructions by configuration method instead of setting Moved some topics to subpages Added a section to the Using Parameters page p 29 describing the standard parameter types Added a section to the Getting Help page p 27 describing the API refer ences and their use Various minor corrections and formatting updates The introduction p 1 and getting started p 3 sections have been reworked and guidance has been updated with information about the default credential provider chain Updated instructions for getting set up For more informa tion see Getting Set Up p 3 Added information about using Amazon SWF commands For more information see Using Amazon Simple Workflow Service with the AWS Command Line Interface p 77 This is the general release of the AWS Command Line Interface User Guide Date Changed February 3 2015 December 22 2014 November 17 2014 October 17 2014 May 26 2014 October 15 2013 S
85. ommands upload MyFile2 txt to s3 my bucket MyFolder MyFile2 txt upload MyFilel txt to s3 my bucket MyFolder MyFilel txt Normally sync only copies missing or outdated files or objects between the source and target However you may supply the delete option to remove files or objects from the target not present in the source The following example which extends the previous one shows how this works Delete local file rm MyFilel txt Attempt sync without delete option nothing happens aws S3 sync s3 my bucket MyFolder Sync with deletion object is deleted from bucket aws s3 sync s3 my bucket MyFolder delete delete s3 my bucket MyFolder MyFilel txt Delete object from bucket aws s3 rm s3 my bucket MyFolder MySubdirectory MyFile3 txt delete s3 my bucket MyFolder MySubdirectory MyFile3 txt Sync with deletion local file is deleted aws s3 sync s3 my bucket MyFolder delete delete MySubdirectoryMMyFile3 txt The xclude and include options allow you to specify rules to filter the files or objects to be copied during the sync operation By default all items in a specified directory are included in the sync Therefore include is only needed when specifying exceptions to the exc1ude option for example include effectively means don t exclude The options apply in the order that is specified as demonstrated in the following example Local di
86. oupId sg 903004f8 I ClientToken null InstanceType tl micro NetworkInterfaces Placement Tenancy default GroupName null AvailabilityZone us west 2b Hypervisor xen BlockDeviceMappings DeviceName dev sdal Ebste Status attached DeleteOnTermination true VolumeId vol 877166c8 AttachTime 2013 07 19702 42 39 0002 l Architecture x86 64 StateReason Message pending 56 AWS Command Line Interface User Guide Using Instances Code pending Fy RootDeviceName dev sdal VirtualizationType hvm RootDeviceType ebs Tags Value MyInstance Key Name l AmiLaunchIndex 0 EC2 VPC The following command launches a t 1 micro instance in the specified subnet aws ec2 run instances image id ami xxxxxxxx count 1 instance type tl micro key name MyKeyPair security group ids sg xxxxxxxx subnet id subnet XXXXXXXX The following is example output OwnerId 123456789012 ReservationId r 5875ca20 Groups GroupName MySecurityGroup GroupId sg 903004f8 I Instances Monitoring State disabled Is PublicDnsName null Platform windows State Code 0 Name pending hey EbsOptimized false LaunchTime 2013 07 19T02 42 39 0002 PrivatelpAddress 10
87. output format follows the basic structure shown below The columns are sorted alphabetically by the corresponding key names of the underlying JSON object IDENTIFIER sorted columnl sorted column2 IDENTIFIER2 sorted columnl sorted column2 The following is an example of a text output aws ec2 describe volumes output text VOLUMES us west 2a 2013 09 17T00 55 03 0002 30 snap f23eclc8 in use vol e11a5288 standard ATTACHMENTS 2013 09 17T00 55 03 0002 True dev sdal i a071c394 attached vol e11a5288 VOLUMES us west 2a 2013 09 18T20 26 15 0002 8 snap 708e8348 in use vol 2e410a47 standard ATTACHMENTS 2013 09 18T20 26 16 0002 True dev sdal i 4b41a37c attached vol 2e410a47 We strongly recommend that the text output be used along with the query option to ensure consistent behavior This is because the text format alphabetically orders output columns and similar resources may not always have the same collection of keys For example a JSON representation of a Linux EC2 instance may have elements that are not present in the JSON representation of a Windows instance or vice versa Also resources may have key value elements added or removed in future updates altering the column ordering This is where query augments the functionality of the text output to enable complete control over the output format In the example below the command pre selects which elements to display and define
88. p ingress command to add a rule to your security group One of the required parameters of this command is the public IP address of your computer in CIDR notation Note You can get the public IP address of your local computer using a service For example we provide the following service htip checkip amazonaws com To locate another service that provides your IP address use the search phrase what is my IP address If you are connecting through an ISP or from behind your firewall without a static IP address you need to find out the range of IP addresses used by client computers EC2 Classic The following command adds a rule for RDP to the security group MySecurityGroup aws ec2 authorize security group ingress group name MySecurityGroup pro tocol tcp port 3389 cidr 203 0 113 0 24 The following command adds a rule for SSH to the security group for MySecurityGroup aws ec2 authorize security group ingress group name MySecurityGroup pro tocol tcp port 22 cidr 203 0 113 0 24 The following is example output 52 AWS Command Line Interface User Guide Using Security Groups return true To view the changes to MySecurityGroup use the describe security groups command as follows aws ec2 describe security groups group names MySecurityGroup The following is example output SecurityGroups IpPermissionsEgress Descri
89. port HTTP PROXY http a b c d n export HTTPS PROXY http w x y z m Windows gt set HTTP PROXY http a b c d n gt set HTTPS PROXY http w x y z m In these examples http a b c d n and http w x y z mare the IP addresses and ports for the HTTP and HTTPS proxies Authenticating to a Proxy The AWS CLI supports HTTP Basic authentication Specify a username and password in the proxy URL like this Linux OS X or Unix export HTTP PROXY http username password ja b c d n export HTTPS PROXY http username password Ww x y z m Windows gt set HTTP PROXY http username password la b c d n gt set HTTPS PROXY http username password Ww x y z m Note The AWS CLI does not support NTLM proxies 11 AWS Command Line Interface User Guide Assuming a Role Using a proxy on EC2 Instances If you configure a proxy on an ec2 instance launched with an IAM role you should also set the NO PROXY environment variable with the IP address 169 254 169 254 so that the AWS CLI can access the Instance Meta Data Service IMDS Linux OS X or Unix export NO PROXY 169 254 169 254 Windows set NO PROXY 169 254 169 254 Assuming a Role You can configure the AWS Command Line Interface to use a role by creating a profile for the role in the aws config file The following example shows a role profile named market ingadmin that is assumed by the defau
90. ption My security group IpPermissions TOPOLrt 22 TpProtocol top TpRanges Cidrip 203 0 113 0 24 UserlIdGroupPairs FromPort 22 T GroupName MySecurityGroup OwnerId 123456789012 GroupId sg 903004f8 EC2 VPC The following command adds a rule for RDP to the security group with the ID sg 903004f8 aws ec2 authorize security group ingress group id sg 903004f8 protocol tcp port 3389 cidr 203 0 113 0 24 The following command adds a rule for SSH to the security group with the ID sg 903004f8 aws ec2 authorize security group ingress group id sg 903004f8 protocol tcp port 22 cidr 203 0 113 0 24 The following is example output return true 53 AWS Command Line Interface User Guide Using Security Groups To view the changes to MySecurityGroup use the describe security groups command as follows aws ec2 describe security groups group ids sg 903004f8 The following is example output SecurityGroups TpPermissionsEgress IpProtocol 1 TpRanges Oidrip 0 0 0 0 0 I UserIdGroupPairs r Description My security group IpPermissions ToPort 22 TpProtocol tcp IpRanges Cidrip 203 0 113 0 24 UserIdGroupPairs FromPort 22 I GroupName MySecurityGroup
91. r sh o source usr local bin aws_zsh_completer sh The AWS CLI uses bash compatibility auto completion bashcompinit for zsh support For further details refer to the top of aws_zsh_completer sh Note If you installed the AWS CLI using the bundled installer add the install location to your PATH variable to allow command completion to find it export PATH usr local aws bin PATH Test Command Completion After enabling command completion type in a partial command and press tab to see the available commands aws sTAB s3 ses sqs sts swf s3api sns storagegateway support Finally to ensure that completion continues to work after a reboot add the configuration command that you used to enable command completion to your shell profile If you added a directory to your PATH variable put the export statement in your profile as well The following example appends the profile for a bash user who installed the AWS CLI to usr local aws using the bundled installer cat gt gt bash profile complete C usr local aws bin aws completer aws export PATH usr local aws bin PATH CTRL D Topics Quick Configuration p 16 Configuration Settings and Precedence p 17 Configuration and Credential Files p 18 Named Profiles p 19 Environment Variables p 20 Command Line Options p 21 Instance Metadata p 22 Quick Configuration For general use the aws co
92. rectory contains 3 files MyFilel txt MyFile2 rtf MyFile88 txt TY XY aws s3 sync s3 my bucket MyFolder exclude txt upload MyFile2 rtf to s3 my bucket MyFolder MyFile2 rtf rr aws s3 sync s3 my bucket MyFolder exclude txt include MyFile txt upload MyFilel txt to s3 my bucket MyFolder MyFilel txt upload MyFile88 txt to s3 my bucket MyFolder MyFile88 txt upload MyFile2 rtf to s3 my bucket MyFolder MyFile2 rtf L Bi aws s3 sync s3 my bucket MyFolder exclude txt include MyFile txt exclude MyFile txt upload MyFile2 rtf to s3 my bucket MyFolder MyFile2 rtf upload MyFile88 txt to s3 my bucket MyFolder MyFile88 txt The xclude and include options can also filter files or objects to be deleted during a sync operation with the delete option In this case the parameter string must specify files to be excluded from or included for deletion in the context of the target directory or bucket The following shows an example 72 AWS Command Line Interface User Guide Using High Level s3 Commands Assume local directory and s3 my bucket MyFolder currently in sync and each contains 3 files MyFilel txt MyFile2 rtf MyFile88 txt rie Delete local txt files rm txt Sync with delete excluding files that match a pattern MyFile88 txt is de leted while remote MyFilel txt is not aws s3 sync s3 my bucket MyFolder del
93. s Account Access and optionally select Require MFA The Require MFA option configures the appropriate condition in the trust relationship as described in Using Multifactor Authentication p 13 If you use an external ID to provide additional control over who can assume a role across accounts add an external_id parameter to the role profile profile crossaccountrole role arn arn aws iam 123456789012 role xaccount source profile default mfa serial arn aws iam 123456789012 mfa jonsmith external id 123456 Command Completion On Unix like systems the AWS CLI includes a command completion feature that enables you to use the TAB key to complete a partially typed command This feature is not automatically installed so you need to configure it manually Configuring command completion requires two pieces of information the name of the shell you are using and the location of the aws completer script Completion on Amazon Linux Command completion is configured by default on instances running Amazon Linux Identify Your Shell If you are not sure which shell you are using identify it with one of the following commands 14 AWS Command Line Interface User Guide Command Completion echo SHELL show the shell s installation directory This will usually match the in use shell unless you launched a different shell after logging in S echo SHELL bin bash ps show the processes running for th
94. s example your vault name and an account ID in order to configure the multipart upload The AWS CLI outputs an upload ID when the operation is complete Save the upload ID to a shell variable for later use Linux OS X or Unix 62 AWS Command Line Interface User Guide Complete the Upload UPLOADID 19gaRezEXAMPLES 6Ry5YYdqthHOC kGRCT03L9yetr220UmPtBYKk OssZtLqy Fu7sYl l1R7vgFuJV6NtcV5zpsJ Windows C temp gt set UPLOADID 19gaRezEXAMPLES 6Ry5YYdqthHOC_kGRCTO3L9yetr220UmPtBYKk OssZtLqyFu7sYl l1R7vgFuJV6NtcV5zpsJ Next use the aws glacier upload multipart part command to upload each part aws glacier upload multipart part upload id UPLOADID body chunkaa range bytes 0 1048575 account id vault name myvault checksum elf2a7cd6e047f a606f e2 0280350 69509 8c a602097a9a026360a7edc1 553 aws glacier upload multipart part upload id UPLOADID body chunkab range bytes 1048576 2097151 account id vault name myvault checksum elf2a7cd6e047fa606fe2f0280350f69b9f8cfa602097a9a026360aledcl1f553 S aws glacier upload multipart part upload id UPLOADID body chunkac range bytes 2097152 3145727 account id vault name myvault checksum elf2a7cd6e047fa606fe2f0280350f69b9f8cfa602097a9a026360aledcl1f553 Note The above example uses the dollar sign to dereference the UPLOADID shell variable On the Windows command
95. s the ordering of the columns with the list notation key1 key2 This gives users full confidence that the correct key values will always be displayed in the expected column Finally notice how the AWS CLI outputs None as values for keys that don t exist aws ec2 describe volumes query Volumes VolumeId Attachments 0 In stanceld AvailabilityZone Size FakeKey output text vol e11a5288 i a071c394 us west 2a 30 None vol 2e410a47 i 4b41a37c us west 2a 8 None Below is an example of how grep and awk can be used along with a text output from aws ec2 describe instances command The first command displays the Availability Zone state and instance ID of each instance in text output The second command outputs only the instance IDs of all running instances in the us west 2a Availability Zone aws ec2 describe instances query Reservations Instances Place ment AvailabilityZone State Name InstanceId output text us west 2a running i 4b41a37c us west 2a stopped i a071c394 us west 2b stopped i 97a217a0 41 AWS Command Line Interface User Guide Table Output Format us west 2a running i 3045b007 us west 2a running i 6fc67758 aws ec2 describe instances query Reservations Instances Place ment AvailabilityZone State Name InstanceId output text grep us west 2a grep running awk print 3 i 4b41a37c 1 3045b007 i 6fc67758 The next command shows a s
96. service side COPY operation provided by Amazon S3 Your files are kept in the cloud and are not downloaded to the client machine then back up to Amazon S3 When operations such as these can be performed completely in the cloud only the bandwidth necessary for the HTTP request and response is used For examples of Amazon S3 usage see the following topics in this section Topics Using High Level s3 Commands with the AWS Command Line Interface p 69 Using API Level s3api Commands with the AWS Command Line Interface p 74 Using High Level s3 Commands with the AWS Command Line Interface This section describes how you can manage Amazon S3 buckets and objects using high level aws s3 commands Managing Buckets High level aws s3 commands support commonly used bucket operations such as creating removing and listing buckets Creating Buckets Use the aws s3 mb command to create a new bucket Bucket names must be unique and should be DNS compliant Bucket names can contain lowercase letters numbers hyphens and periods Bucket names can only start and end with a letter or number and cannot contain a period next to a hyphen or another period aws s3 mb s3 bucket name Removing Buckets To remove a bucket use the aws s3 rb command aws s3 rb s3 bucket name By default the bucket must be empty for the operation to succeed To remove a non empty bucket you need to include the force option
97. session token A session token is only required if you are using temporary security credentials AWS DEFAULT REGION AWS region This variable overrides the default region of the in use profile if set AWS DEFAULT PROFILE name of the CLI profile to use This can be the name of a profile stored in a credential or config file or default to use the default profile AWS CONFIG FILE path to a CLI config file If the config file variable is set aws configure will write region and output settings to the specified file and the CLI will attempt to read profiles settings from there instead of the default file aws config Credentials will still be read from and written to the default credentials file aws credentials The following example shows how you would configure environment variables for the default user from earlier in this guide Linux OS X or Unix export AWS ACCESS KEY ID AKIAIOSFODNN7EXAMPLE export AWS SECRET ACCESS KEY wJalrXUtnFEMI K7MDENG bPxRfiCYEXAMPLEKEY export AWS DEFAULT REGION us west 2 Windows set AWS ACCESS KEY ID AKIAIOSFODNN7EXAMPLE gt set AWS SECRET ACCESS KEY wJalrXUtnFEMI K7MDENG bPxRfiCYEXAMPLEKEY set AWS DEFAULT REGION us west 2 20 AWS Command Line Interface User Guide Command Line Options Command Line Options The AWS CLI uses GNU style long command line options preceded by two hyphens Command line options can be used to override def
98. stances Using Amazon Glacier with the AWS Command Line Interface You can upload a large file to Amazon Glacier by splitting it into smaller parts and uploading them from the command line This topic describes the process of creating a vault splitting a file and configuring and executing a multipart upload to Amazon Glacier with the AWS CLI Note This tutorial uses several command line tools that typically come pre installed on Unix like operating systems including Linux and OS X Windows users can use the same tools by installing Cygwin and running the commands from the Cygwin terminal Windows native commands and utilities that perform the same functions are noted where available Topics Create an Amazon Glacier Vault p 61 Prepare a File for Uploading p 63 Initiate a Multipart Upload and Upload Files p 62 Complete the Upload p 63 Create an Amazon Glacier Vault Create a vault with the aws glacier create vault command The following command creates a vault named myvault aws glacier create vault account id vault name myvault location 123456789012 vaults myvault 61 AWS Command Line Interface User Guide Prepare a File for Uploading Note All glacier commands require an account ID parameter Use a hyphen to specify the current account Prepare a File for Uploading Create a file for the test upload The following commands create a file that contains exactly 3 MiB 3 x
99. stent in some cases aws ec2 describe volumes query Volumes ID VolumeId AZ Availabil ityZone Size Size AZ us west 2a ID vol ella5288 Size 30 Ey AZ us west 2a ID vol 2e410a47 Size 8 In the dictionary notation you can also use chained keys such as key1 key2 0 key3 to filter elements deeply nested within the structure The example below demonstrates this with the Attachments 0 InstanceId key aliased to simply Instancerd 39 AWS Command Line Interface User Guide JSON Output Format aws ec2 describe volumes query Volumes ID Volumeld InstanceId Attach ments 0 InstanceId AZ AvailabilityZone Size Size Instanceld i a071c394 AZ us west 2a ID yol el11a5288 Size 30 Ly InstanceId i 4b4la37c AZ us west 2a ID vol 2e410a47 Size 8 You can also filter multiple elements with the list notation key1 key2 This will format all filtered attributes into a single ordered list per object regardless of type aws ec2 describe volumes query Volumes VolumeId Attachments 0 In stanceId AvailabilityZone Size vol ella5288 i a071c394 us west 2a 30 vol 2e410a47 i 4b41a37c us west 2a 8 To filter results by the value of a specific field use the JMESPath operator The following example query outputs only volumes in the us
100. t ec2runinst json Open the skeleton in a text editor and remove any parameters that you will not use DryRun true ImageId T KeyName mm SecurityGroups wn InstanceType Monitoring Enabled true Leave the DryRun parameter set to true to use EC2 s dry run feature which lets you test your configuration without creating resources Fill in the values for the instance type key name security group and AMI in your default region In this example ami dfc39aef is a 64 bit Amazon Linux image in the us west 2 region DryRun true ImageId ami dfc39aef KeyName mykey SecurityGroups my sg r InstanceType t2 micro Monitoring Enabled true Pass the JSON configuration to the cli input json parameter using the file prefix aws ec2 run instances cli input json file ec2runinst json A client error DryRunOperation occurred when calling the RunInstances op eration Request would have succeeded but DryRun flag is set The dry run error indicates that the JSON is formed correctly and the parameter values are valid If any other issues are reported in the output fix them and repeat the above step until the dry run error is shown Set the DryRun parameter to false to disable the dry run feature DryRun false ImageId ami dfc39aef KeyName mykey SecurityGroups my sg
101. that turns an option on or off For example ec2 describe spot price history has a boolean dry run parameter that when specified validates the command against the service without actually running a query aws ec2 describe spot price history dry run The output indicates whether the command was well formed or not This command also includes a no dry run version of the parameter that can be used to explicitly indicate that the command should be run normally although including it is not necessary as this is the default behavior Integer An unsigned whole number aws ec2 describe spot price history max items 5 Blob Binary object Blob parameters take a path to a local file that contains binary data The path should not contain any protocol identifier such as http or file The body parameter for aws s3api put object is a blob aws s3api put object bucket my bucket key testimage png body tmp im age png Map A sequence of key value pairs specified in JSON or shorthand syntax p 44 The following example reads an item from a DynamoDB table named my table with a map parameter key The parameter specifies the primary key named id with a number value of 7 in a nested JSON structure aws dynamodb get item table name my table key id N 1 Item name Wows John Wid NM jq 30 AWS Command Line Interf
102. tings and Precedence 0 nne nenna 17 Configuration and Credential Files ssssssssese Heer 18 Named PROMS skara a E ga ala ja 19 Environment Variables na ind ni POE 20 Command Line Options sasinan an e a E mene men eren eene nennen enne 21 Instance Metadala ccrte rebels aj eq usd uie ter Pues eu npe Vete tii pius 22 Where to Go from Here 2 2 0 nearest 22 Tutorial Using Amazon EC2 eeaeee eno E e EE Eaa ete tenentem testen men tiem ee ten es reete rene 23 Install the AWS CEI aaa HE 23 lb M 23 Linux OS X or Unix Gn assis sisi isi asa ases DEEE 24 Configure the CLI and Launch an EC2 Instance sss eene 24 Step 1 Configure the AWS CLI 0 cece eee n eee e eee eee eee e cee a eae e ane ne hehehe hehe nennen nennen 24 Step 2 Create a Security Group Key Pair and Role for the EC2 Instance 24 Step 3 Launch and Connect to the Instance 0 0 ne near 25 Using the AWS GLI aa oiled cin A a A nape RA i a 27 Gening ao CE 27 AWS CLI Documentation 0 cece cece eee e eee e eee eee eene eene hehe eere herren re nere ne nenne 28 AP DOCUMENTATION ass agir a GR 28 COMMANG SMUCIURG ob na un sn albin 28 Specifying Parameter Values 0 00 00ae0ne arnar 29 Common Parameter Types 0 0 0 nennt 29 Using JSON for Parameters ssssssssssssssssssseen
103. tion message should appear in your browser with information similar to the following Subscription confirmed You have subscribed emailusername example com to the topic MyTopic Your subscription s id is arn aws sns us west 2 123456789012 MyTopic 1328 057 de93 4c15 512e 8bb2268db8c4 If it was not your intention to subscribe click here to unsubscribe Publish to a Topic The following command publishes a message to a topic aws sns publish topic arn arn aws sns us west 2 123456789012 MyTopic message Hello World The MessageId is returned MessageId 4e41661d 5eec 5ddf 8dab 2c867a709bab An email message with the text Hello World will be sent to emailusername example com Unsubscribe from a Topic The following command unsubscribes from a topic aws sns unsubscribe subscription arn arn aws sns us west 2 123456789012 MyTopic 1328 057 de93 4c15 512e 8bb2268db8c4 To verify the unsubscription to the topic type the following aws sns list subscriptions 76 AWS Command Line Interface User Guide Delete a Topic Delete a Topic The following command deletes a topic aws sns delete topic topic arn arn aws sns us west 2 123456789012 MyTopic To verify the deletion of the topic type the following aws sns list topics Using Amazon Simple Workflow Service with the AWS Command Line Interfac
104. try the example commands set your default credentials The following examples show how to use the describe instances command Example 1 List the instances with the specified instance type The following command lists your m1 sma11 instances aws ec2 describe instances filters Name instance type Values ml small Example 2 List the instances launched using the specified images The following command lists your instances that were launched from the following AMIs ami x0123456 ami y0123456 and ami z0123456 aws ec2 describe instances filters Name image id Values ami x0123456 ami y0123456 ami z0123456 Terminating Your Instance Terminating an instance effectively deletes it you can t reconnect to an instance after you ve terminated it As soon as the state of the instance changes to shutting down Or terminated you stop incurring charges for that instance After you ve finished with the instance use the terminate instances command as follows aws ec2 terminate instances instance ids i 5203422c 60 AWS Command Line Interface User Guide Amazon Glacier The following is example output TerminatingInstances InstanceId i 5203422c CurrentState Code 32 Name shutting down Fi PreviousState Code 16 Name running For more information see Terminate Your Instance in the Amazon EC2 User Guide for Linux In
105. u can view your current account activity and manage your account by going to http www amazonaws cn and clicking My Account Console AWS Command Line Interface User Guide Installing the AWS CLI To get your access key ID and secret access key Access keys consist of an access key ID and secret access key which are used to sign programmatic requests that you make to AWS If you don t have access keys you can create them by using the AWS Management Console We recommend that you use IAM access keys instead of AWS root account access keys IAM lets you securely control access to AWS services and resources in your AWS account grew wc Note To create access keys you must have permissions to perform the required IAM actions For more information see Granting IAM User Permission to Manage Password Policy and Credentials in AM User Guide Open the IAM console From the navigation menu click Users Select your IAM user name Click User Actions and then click Manage Access Keys Click Create Access Key Your keys will look something like this Access key ID example AKIAIOSFODNN7EXAMPLE Secret access key example wJalrXUtnFEMI K7MDENG bPxRfiCYEXAMPLEKEY Click Download Credentials and store the keys in a secure location Your secret key will no longer be available through the AWS Management Console you will have the only copy Keep it confidential in order to protect your account and never email it Do not share it outs
106. un instances generate cli skeleton DryRun true Imageld MinCount 0 MaxCount 0 KeyName SecurityGroups wee l SecurityGroupIds nm l UserData T InstanceType Placement AvailabilityZone GroupName n o m 34 AWS Command Line Interface User Guide Generate CLI Skeleton 2 Tenancy y KernelId RamdiskId BlockDeviceMappings VirtualName DeviceName Ebs SnapshotId VolumeSize 0 DeleteOnTermination true VolumeType Tops 0 Encrypted true NoDevice Monitoring Enabled true SubnetId DisableApiTermination true InstanceInitiatedShutdownBehavior PrivatelpAddress ClientToken Additionallnfo Tw NetworkInterfaces NetworkInterfaceId DeviceIndex 0 SubnetId Description PrivateIpAddress Groups wn 17 DeleteOnTermination true PrivateIpAddresses PrivatelpAddress Primary true l SecondaryPrivateIpAddressCount 0 AssociatePublicIpAddress true 1 IamInstanceProfile Arn n Name EbsOptimized true Direct the output to a file to save the skeleton locally 35 AWS Command Line Interface User Guide Generate CLI Skeleton aws ec2 run instances generate cli skeleton g
107. ws ec2 help The next example lists the detailed help for the EC2 DescribeInstances operation including descriptions of its input parameters filters and output Check the examples section of the help if you are not sure how to phrase a command aws ec2 describe instances help 27 AWS Command Line Interface User Guide AWS CLI Documentation Windows Users Pipe the output of the help command to more to view the help file one page at a time Press the space bar or Page Down to view more of the document and q to quit gt aws ec2 describe instances help more AWS CLI Documentation The AWS Command Line Interface Reference provides the content of all AWS CLI commands help files compiled and presented online for easy navigation and viewing on mobile tablet and desktop screens Help files sometimes contain links that cannot be viewed or followed from the command line view these are preserved in the online AWS CLI reference API Documentation All subcommands in the AWS CLI correspond to calls made against a service s public API Each service with a public API in turn has a set of API reference documentation that can be found from the service s homepage on the AWS Documentation website The content of an API reference varies based on how the API is constructed and which protocol is used Typically an API reference will contain detailed information on actions supported by the API data sent to

AWS Command Line Interface User Guide

Contents

Download Pdf Manuals

Related Search

Related Contents