Skip to content

Commit

Permalink
Merge branch 'EronHennessey-doc_updates' into develop
Browse files Browse the repository at this point in the history
* EronHennessey-doc_updates:
  Fix describe-vpc-peering-connection with correct filter syntax
  Fixed describe-reserved-instances with correct --filter syntax
  Correct syntax for describe-volumes example
  Update example to quote entire Key value
  Fixed unwieldy description in s3/_concepts.rst and the related subcommand test.
  re-added lines from commit fb84aaf
  Small correction to get-metric-statistics example
  Synced changes with doc team sources.
  • Loading branch information
jamesls committed Aug 12, 2014
2 parents a66245c + 2b24bc0 commit 2643155
Show file tree
Hide file tree
Showing 12 changed files with 76 additions and 54 deletions.
6 changes: 4 additions & 2 deletions awscli/examples/cloudwatch/get-metric-statistics.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
**To get the CPU utilization per EC2 instance**

The following example uses the ``get-metric-statistics`` command to get the CPU utilization for an EC2
instance with the ID i-abcdef. For more examples using the ``get-metric-statistics`` command, see `Get Statistics for a Metric`_ in the *Amazon CloudWatch Developer Guide*.
instance with the ID i-abcdef. For more examples using the ``get-metric-statistics`` command, see `Get Statistics for a Metric`__ in the *Amazon CloudWatch Developer Guide*.

.. _`Get Statistics for a Metric`: http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/US_GetStatistics.html::
.. __: http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/US_GetStatistics.html

::

aws cloudwatch get-metric-statistics --metric-name CPUUtilization --start-time 2014-04-08T23:18:00 --end-time 2014-04-09T23:18:00 --period 3600 --namespace AWS/EC2 --statistics Maximum --dimensions Name=InstanceId,Value=i-abcdef

Expand Down
22 changes: 21 additions & 1 deletion awscli/examples/ec2/create-tags.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,24 @@ This example adds (or overwrites) two tags for an AMI and an instance. One of th

Command::

aws ec2 create-tags --resources ami-1a2b3c4d i-10a64379 --tags Key=webserver,Value= Key=stack,Value=Production
aws ec2 create-tags --resources ami-1a2b3c4d i-10a64379 --tags Key=webserver,Value= Key=stack,Value=Production

**To add tags with special characters**

This example adds the tag ``[Group]=test`` for an instance. The square brackets ([ and ]) are special characters, and must be escaped. If you are using Windows, surround the value with (\"):

Command::

aws ec2 create-tags --resources i-1a2b3c4d --tags Key=\"[Group]\",Value=test

If you are using Windows PowerShell, break out the characters with a backslash (\\), surround them with double quotes ("), and then surround the entire key and value structure with single quotes ('):

Command::

aws ec2 create-tags --resources i-1a2b3c4d --tags 'Key=\"[Group]\",Value=test'

If you are using Linux or OS X, enclose the entire key and value structure with single quotes ('), and then enclose the element with the special character with double quotes ("):

Command::

aws ec2 create-tags --resources i-1a2b3c4d --tags 'Key="[Group]",Value=test'
2 changes: 1 addition & 1 deletion awscli/examples/ec2/describe-reserved-instances.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ This example filters the response to include only one-year, t1.micro Linux/UNIX

Command::

aws ec2 describe-reserved-instances --filters Name=duration,Values=31536000, Name=instance-type,Values=t1.micro, Name=product-description,Values=Linux/UNIX, Name=availability-zone,Values=us-west-1c
aws ec2 describe-reserved-instances --filters Name=duration,Values=31536000 Name=instance-type,Values=t1.micro Name=product-description,Values=Linux/UNIX Name=availability-zone,Values=us-west-1c

Output::

Expand Down
4 changes: 2 additions & 2 deletions awscli/examples/ec2/describe-volumes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ This example command describes all volumes that are both attached to the instanc

Command::

aws ec2 describe-volumes --region us-east-1 --filter Name=attachment.instance-id,Values=i-abe041d4 --filter Name=attachment.delete-on-termination,Values=true
aws ec2 describe-volumes --region us-east-1 --filter Name=attachment.instance-id,Values=i-abe041d4 Name=attachment.delete-on-termination,Values=true

Output::

Expand All @@ -75,4 +75,4 @@ Output::
"Size": 8
}
]
}
}
2 changes: 1 addition & 1 deletion awscli/examples/ec2/describe-vpc-peering-connections.rst
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ This example describes all of your VPC peering connections that have the tag Nam

Command::

aws ec2 describe-vpc-peering-connections --filters Name=tag-key,Values=Name,Name=tag-value,Values=Finance,Accounts
aws ec2 describe-vpc-peering-connections --filters Name=tag-key,Values=Name Name=tag-value,Values=Finance,Accounts


This example describes all of the VPC peering connections you requested for the specified VPC, vpc-1a2b3c4d.
Expand Down
6 changes: 3 additions & 3 deletions awscli/examples/emr/add-steps.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
**2. To add Streaming steps to a cluster**

- Command::

aws emr add-steps --cluster-id j-XXXXXXXX --steps Type=STREAMING,Name='Streaming Program',ActionOnFailure=CONTINUE,Args=-mapper,mymapper,-reducer,myreducer,-input,myinput,-output,myoutput Type=STREAMING,Name='Streaming Program',ActionOnFailure=CONTINUE,Args=--files,s3://elasticmapreduce/samples/wordcount/wordSplitter.py,-mapper,wordSplitter.py,-reducer,aggregate,-input,s3://elasticmapreduce/samples/wordcount/input,-output,s3://mybucket/wordcount/output

- Required parameters::
Expand All @@ -49,7 +49,7 @@

- Command::

aws emr add-steps --cluster-id j-XXXXXXXX --steps Type=HIVE,Name='Hive program',ActionOnFailure=CONTINUE,Args=[-f,s3://mybuckey/myhivescript.q,-d,INPUT=s3://mybucket/myhiveinput,-d,OUTPUT=s3://mybucket/myhiveoutput,arg1,arg2] Type=HIVE,Name='Hive steps',ActionOnFailure=TERMINATE_CLUSTER,Args=[-f,s3://elasticmapreduce/samples/hive-ads/libs/model-build.q,-d,INPUT=s3://elasticmapreduce/samples/hive-ads/tables,-d,OUTPUT=s3://mybucket/hive-ads/output/2014-04-18/11-07-32,-d,LIBS=s3://elasticmapreduce/samples/hive-ads/libs]
aws emr add-steps --cluster-id j-XXXXXXXX --steps Type=HIVE,Name='Hive program',ActionOnFailure=CONTINUE,Version=latest,Args=[-f,s3://mybuckey/myhivescript.q,-d,INPUT=s3://mybucket/myhiveinput,-d,OUTPUT=s3://mybucket/myhiveoutput,arg1,arg2] Type=HIVE,Name='Hive steps',ActionOnFailure=TERMINATE_CLUSTER,Version=latest,Args=[-f,s3://elasticmapreduce/samples/hive-ads/libs/model-build.q,-d,INPUT=s3://elasticmapreduce/samples/hive-ads/tables,-d,OUTPUT=s3://mybucket/hive-ads/output/2014-04-18/11-07-32,-d,LIBS=s3://elasticmapreduce/samples/hive-ads/libs]


- Required parameters::
Expand All @@ -74,7 +74,7 @@

- Command::

aws emr add-steps --cluster-id j-XXXXXXXX --steps Type=PIG,Name='Pig program',ActionOnFailure=CONTINUE,Args=[-f,s3://mybuckey/mypigscript.pig,-p,INPUT=s3://mybucket/mypiginput,-p,OUTPUT=s3://mybucket/mypigoutput,arg1,arg2] Type=PIG,Name='Pig program',Args=[-f,s3://elasticmapreduce/samples/pig-apache/do-reports2.pig,-p,INPUT=s3://elasticmapreduce/samples/pig-apache/input,-p,OUTPUT=s3://mybucket/pig-apache/output,arg1,arg2]
aws emr add-steps --cluster-id j-XXXXXXXX --steps Type=PIG,Name='Pig program',ActionOnFailure=CONTINUE,Version=latest,Args=[-f,s3://mybuckey/mypigscript.pig,-p,INPUT=s3://mybucket/mypiginput,-p,OUTPUT=s3://mybucket/mypigoutput,arg1,arg2] Type=PIG,Name='Pig program',Version=latest,Args=[-f,s3://elasticmapreduce/samples/pig-apache/do-reports2.pig,-p,INPUT=s3://elasticmapreduce/samples/pig-apache/input,-p,OUTPUT=s3://mybucket/pig-apache/output,arg1,arg2]


- Required parameters::
Expand Down
14 changes: 7 additions & 7 deletions awscli/examples/emr/add-tags.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,19 +18,19 @@

[
{
"Value": "male",
"Value": "male",
"Key": "sex"
},
},
{
"Value": "123 East NW Seattle",
"Value": "123 East NW Seattle",
"Key": "address"
},
},
{
"Value": "John Doe",
"Value": "John Doe",
"Key": "name"
},
},
{
"Value": "29",
"Value": "29",
"Key": "age"
}
]
Loading

0 comments on commit 2643155

Please sign in to comment.