Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions awscli/examples/apigatewayv2/put-routing-rule.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
The following ``put-routing-rule`` example updates the priority of a routing rule. ::

aws apigatewayv2 put-routing-rule \
--routing-rule-id 'abc123' \
--domain-name 'regional.example.com' \
--priority 150 \
--conditions '[ \
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ The following ``put-scaling-policy`` example applies a target tracking scaling p
aws application-autoscaling put-scaling-policy --service-namespace ecs \
--scalable-dimension ecs:service:DesiredCount \
--resource-id service/default/web-app \
--policy-name cms75-target-tracking-scaling-policy
--policy-name cms75-target-tracking-scaling-policy \
--policy-type TargetTrackingScaling \
--target-tracking-scaling-policy-configuration file://config.json

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
The following ``create-pull-request-approval-rule`` example creates an approval rule named ``Require two approved approvers`` for the specified pull request. The rule specifies that two approvals are required from an approval pool. The pool includes all users who access CodeCommit by assuming the role of ``CodeCommitReview`` in the ``123456789012`` AWS account. It also includes either an IAM user or federated user named ``Nikhil_Jayashankar`` from the same AWS account. ::

aws codecommit create-pull-request-approval-rule \
--pull-request-id 42
--approval-rule-name "Require two approved approvers" \
--approval-rule-content "{\"Version\": \"2018-11-08\",\"Statements\": [{\"Type\": \"Approvers\",\"NumberOfApprovalsNeeded\": 2,\"ApprovalPoolMembers\": [\"CodeCommitApprovers:123456789012:Nikhil_Jayashankar\", \"arn:aws:sts::123456789012:assumed-role/CodeCommitReview/*\"]}]}"

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ This example demonstrates how to view comments for a pull request in a repositor

aws codecommit get-comments-for-pull-request \
--repository-name MyDemoRepo \
--pull-request-id 42 \
--before-commit-ID 317f8570EXAMPLE \
--after-commit-id 5d036259EXAMPLE

Expand Down
3 changes: 2 additions & 1 deletion awscli/examples/codecommit/put-repository-triggers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
This example demonstrates how to update triggers named 'MyFirstTrigger' and 'MySecondTrigger' using an already-created JSON file (here named MyTriggers.json) that contains the structure of all the triggers for a repository named MyDemoRepo. To learn how to get the JSON for existing triggers, see the get-repository-triggers command. ::

aws codecommit put-repository-triggers \
--repository-name MyDemoRepo file://MyTriggers.json
--repository-name MyDemoRepo \
--triggers file://MyTriggers.json

Contents of ``MyTriggers.json``::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ The following ``update-pull-request-approval-rule-content`` example updates she
aws codecommit update-pull-request-approval-rule-content \
--pull-request-id 27 \
--approval-rule-name "Require two approved approvers" \
--approval-rule-content "{Version: 2018-11-08, Statements: [{Type: \"Approvers\", NumberOfApprovalsNeeded: 1, ApprovalPoolMembers:[\"CodeCommitApprovers:123456789012:user/*\"]}]}}"
--new-rule-content "{Version: 2018-11-08, Statements: [{Type: \"Approvers\", NumberOfApprovalsNeeded: 1, ApprovalPoolMembers:[\"CodeCommitApprovers:123456789012:user/*\"]}]}}"

Output::

Expand Down
6 changes: 5 additions & 1 deletion awscli/examples/codepipeline/disable-stage-transition.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,11 @@ This example disables transitions into the Beta stage of the MyFirstPipeline pip

Command::

aws codepipeline disable-stage-transition --pipeline-name MyFirstPipeline --stage-name Beta --transition-type Inbound
aws codepipeline disable-stage-transition \
--pipeline-name MyFirstPipeline \
--stage-name Beta \
--transition-type Inbound \
--reason "An example reason"


Output::
Expand Down
2 changes: 1 addition & 1 deletion awscli/examples/cognito-identity/delete-identities.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This example deletes an identity pool.

Command::

aws cognito-identity delete-identity-pool --identity-ids-to-delete "us-west-2:11111111-1111-1111-1111-111111111111"
aws cognito-identity delete-identities --identity-ids-to-delete "us-west-2:11111111-1111-1111-1111-111111111111"

Output::

Expand Down
2 changes: 1 addition & 1 deletion awscli/examples/comprehend/create-document-classifier.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ The following ``create-document-classifier`` example begins the training process

aws comprehend create-document-classifier \
--document-classifier-name example-classifier \
--data-access-arn arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/123456abcdeb0e11022f22a11EXAMPLE \
--data-access-role-arn arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role \
--input-data-config "S3Uri=s3://amzn-s3-demo-bucket/" \
--language-code en

Expand Down
2 changes: 1 addition & 1 deletion awscli/examples/comprehend/describe-entity-recognizer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
The following ``describe-entity-recognizer`` example gets the properties of a custom entity recognizer model. ::

aws comprehend describe-entity-recognizer \
entity-recognizer-arn arn:aws:comprehend:us-west-2:111122223333:entity-recognizer/business-recongizer-1/version/1
--entity-recognizer-arn arn:aws:comprehend:us-west-2:111122223333:entity-recognizer/business-recongizer-1/version/1

Output::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The following ``describe-user-hierarchy-structure`` example displays the details for the hierarchy structure for the specified Amazon Connect instance. ::

aws connect describe-user-hierarchy-group \
aws connect describe-user-hierarchy-structure \
--instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111

Output::
Expand Down
6 changes: 3 additions & 3 deletions awscli/examples/directconnect/allocate-hosted-connection.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ The following ``allocate-hosted-connection`` example creates a hosted connection
aws directconnect allocate-hosted-connection \
--bandwidth 500Mbps \
--connection-name mydcinterconnect \
--owner-account 123456789012
-connection-id dxcon-fgktov66
-vlan 101
--owner-account 123456789012 \
--connection-id dxcon-fgktov66 \
--vlan 101

Output::

Expand Down
2 changes: 1 addition & 1 deletion awscli/examples/ds-data/search-users.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ The following ``search-users`` example searches for the specified user in the sp
aws ds-data search-users \
--directory-id d-1234567890 \
--search-attributes 'SamAccountName' \
--Search-string 'john.doe'
--search-string 'john.doe'

Output::

Expand Down
2 changes: 1 addition & 1 deletion awscli/examples/dynamodb/restore-table-from-backup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ The following ``restore-table-from-backup`` example restores the specified table

aws dynamodb restore-table-from-backup \
--target-table-name MusicCollection \
--backup-arnarn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection/backup/01576616366715-b4e58d3a
--backup-arn arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection/backup/01576616366715-b4e58d3a

Output::

Expand Down
3 changes: 2 additions & 1 deletion awscli/examples/ec2/describe-byoip-cidrs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@

The following ``describe-byoip-cidrs`` example displays details about the public IPv4 address ranges that you provisioned for use by AWS. ::

aws ec2 describe-byoip-cidrs
aws ec2 describe-byoip-cidrs \
--max-results 5

Output::

Expand Down
2 changes: 1 addition & 1 deletion awscli/examples/ec2/modify-fleet.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
The following ``modify-fleet`` example modifies the target capacity of the specified EC2 Fleet. If the specified value is greater than the current capacity, the EC2 Fleet launches additional instances. If the specified value is less than the current capacity, the EC2 Fleet cancels any open requests and if the termination policy is ``terminate``, the EC2 fleet terminates any instances that exceed the new target capacity. ::

aws ec2 modify-fleet \
--fleet-ids fleet-12a34b55-67cd-8ef9-ba9b-9208dEXAMPLE \
--fleet-id fleet-12a34b55-67cd-8ef9-ba9b-9208dEXAMPLE \
--target-capacity-specification TotalTargetCapacity=5

Output::
Expand Down
2 changes: 1 addition & 1 deletion awscli/examples/ec2/modify-spot-fleet-request.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ This example command decreases the target capacity of the specified Spot fleet r

Command::

aws ec2 modify-spot-fleet-request --target-capacity 10 --excess-capacity-termination-policy NoTermination --spot-fleet-request-ids sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE
aws ec2 modify-spot-fleet-request --target-capacity 10 --excess-capacity-termination-policy NoTermination --spot-fleet-request-id sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE

Output::

Expand Down
2 changes: 1 addition & 1 deletion awscli/examples/ec2/reset-network-interface-attribute.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@ The following ``reset-network-interface-attribute`` example resets the value of

aws ec2 reset-network-interface-attribute \
--network-interface-id eni-686ea200 \
--source-dest-check
--source-dest-check sourceDestCheck

This command produces no output.
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
The following ``list-tags-for-resource`` example lists the tags for a specific accelerator. ::

aws globalaccelerator list-tags-for-resource \
--accelerator-arn arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh
--resource-arn arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh

Output::

Expand Down
2 changes: 1 addition & 1 deletion awscli/examples/iot/cancel-job.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
The following ``cancel-job`` example cancels the specified job. ::

aws iot cancel-job \
--job-job "example-job-03"
--job-id "example-job-03"

Output::

Expand Down
2 changes: 1 addition & 1 deletion awscli/examples/iotevents/untag-resource.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ The following ``untag-resource`` example removes the tag with the specified key

aws iotevents untag-resource \
--resource-arn arn:aws:iotevents:us-west-2:123456789012:input/PressureInput \
--tagkeys deviceType
--tag-keys deviceType

This command produces no output.

Expand Down
2 changes: 1 addition & 1 deletion awscli/examples/iotsitewise/list-project-assets.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The following ``list-project-assets`` example lists all assets that are associated to a wind farm project. ::

aws iotsitewise list-projects \
aws iotsitewise list-project-assets \
--project-id a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE

Output::
Expand Down
2 changes: 1 addition & 1 deletion awscli/examples/iotsitewise/update-dashboard.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
The following ``update-dashboard`` example changes the title of a dashboard's line chart that displays total generated power for a wind farm. ::

aws iotsitewise update-dashboard \
--project-id a1b2c3d4-5678-90ab-cdef-fffffEXAMPLE \
--dashboard-id a1b2c3d4-5678-90ab-cdef-dddddEXAMPLE \
--dashboard-name "Wind Farm" \
--dashboard-definition file://update-wind-farm-dashboard.json

Expand Down
4 changes: 2 additions & 2 deletions awscli/examples/iotthingsgraph/create-system-instance.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

The following ``create-system-instance`` example creates a system instance. The value of ``MySystemInstanceDefinition`` is the GraphQL that models the system instance. ::

aws iotthingsgraph create-system-instance -\
-definition language=GRAPHQL,text="MySystemInstanceDefinition" \
aws iotthingsgraph create-system-instance \
--definition language=GRAPHQL,text="MySystemInstanceDefinition" \
--target CLOUD \
--flow-actions-role-arn myRoleARN

Expand Down
2 changes: 1 addition & 1 deletion awscli/examples/ivs-realtime/get-storage-configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
The following ``get-storage-configuration`` example gets the composition storage configuration specified by the given ARN (Amazon Resource Name). ::

aws ivs-realtime get-storage-configuration \
--name arn "arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/abcdABCDefgh"
--arn "arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/abcdABCDefgh"

Output::

Expand Down
2 changes: 1 addition & 1 deletion awscli/examples/ivs/start-viewer-session-revocation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The following ``start-viewer-session-revocation`` example starts the process of revoking the viewer session associated with a specified channel ARN and viewer ID, up to and including the specified session version number. If the version is not provided, it defaults to 0. ::

aws ivs batch-start-viewer-session-revocation \
aws ivs start-viewer-session-revocation \
--channel-arn arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh \
--viewer-id abcdefg \
--viewer-session-versions-less-than-or-equal-to 1234567890
Expand Down
8 changes: 4 additions & 4 deletions awscli/examples/ivschat/create-chat-token.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@
The following ``create-chat-token`` example creates an encrypted chat token that is used to establish an individual WebSocket connection to a room. The token is valid for one minute, and a connection (session) established with the token is valid for the specified duration. ::

aws ivschat create-chat-token \
--roomIdentifier "arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6", \
--userId" "11231234" \
--capabilities "SEND_MESSAGE", \
--sessionDurationInMinutes" 30
--room-identifier "arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6" \
--user-id "11231234" \
--capabilities "SEND_MESSAGE" \
--session-duration-in-minutes 30

Output::

Expand Down
2 changes: 1 addition & 1 deletion awscli/examples/ivschat/delete-message.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
The following ``delete-message`` example sends an even to the specified room, which directs clients to delete the specified message: that is, unrender it from view and delete it from the client's chat history. ::

aws ivschat delete-message \
--roomIdentifier "arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6" \
--room-identifier "arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6" \
--id "ABC123def456" \
--reason "Message contains profanity"

Expand Down
4 changes: 2 additions & 2 deletions awscli/examples/ivschat/disconnect-user.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
The following ``disconnect-user`` example disconnects all connections for the specified user from the specified room. On success it returns HTTP 200 with an empty response body. ::

aws ivschat disconnect-user \
--roomIdentifier "arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6" \
--userId "ABC123def456" \
--room-identifier "arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6" \
--user-id "ABC123def456" \
--reason "Violated terms of service"

This command produces no output.
Expand Down
4 changes: 2 additions & 2 deletions awscli/examples/ivschat/send-event.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
The following ``send-event`` example sends the given event to the specified room. ::

aws ivschat send-event \
--roomIdentifier "arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6" \
--eventName "SystemMessage" \
--room-identifier "arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6" \
--event-name "SystemMessage" \
--attributes \
"msgType"="user-notification", \
"msgText"="This chat room will close in 15 minutes."
Expand Down
5 changes: 3 additions & 2 deletions awscli/examples/memorydb/describe-parameters.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
**To return a list of parameters**

The following `describe-parameters`` returns a list of parameters. ::
The following ``describe-parameters`` returns a list of parameters. ::

aws memorydb describe-parameters
aws memorydb describe-parameters \
--parameter-group-name default.memorydb-redis6

Output::

Expand Down
5 changes: 3 additions & 2 deletions awscli/examples/memorydb/list-allowed-node-type-updates.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
**To return a list of allowed node type updates**

The following `list-allowed-node-type-updates` returns a list of available node type updates. ::
The following ``list-allowed-node-type-updates`` returns a list of available node type updates. ::

aws memorydb list-allowed-node-type-updates
aws memorydb list-allowed-node-type-updates \
--cluster-name my-cluster

Output::

Expand Down
2 changes: 1 addition & 1 deletion awscli/examples/omics/accept-share.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
The following ``accept-share`` example accepts a share of HealthOmics analytics store data. ::

aws omics accept-share \
----share-id "495c21bedc889d07d0ab69d710a6841e-dd75ab7a1a9c384fa848b5bd8e5a7e0a"
--share-id "495c21bedc889d07d0ab69d710a6841e-dd75ab7a1a9c384fa848b5bd8e5a7e0a"

Output::

Expand Down
2 changes: 1 addition & 1 deletion awscli/examples/pipes/untag-resource.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@ The following ``untag-resource`` example removes a tag with the key ``stack`` fr

aws pipes untag-resource \
--resource-arn arn:aws:pipes:us-east-1:123456789012:pipe/Demo_Pipe \
--tags stack
--tag-keys stack

For more information, see `Amazon EventBridge Pipes concepts <https://docs.aws.amazon.com/eventbridge/latest/userguide/pipes-concepts.html>`__ in the *Amazon EventBridge User Guide*.
1 change: 1 addition & 0 deletions awscli/examples/ram/list-principals.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
The following ``list-principals`` example displays a list of the principals that can access resources of the specified type through any resource shares. ::

aws ram list-principals \
--resource-owner SELF \
--resource-type ec2:Subnet

Output::
Expand Down
4 changes: 2 additions & 2 deletions awscli/examples/rds/describe-db-log-files.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

The following ``describe-db-log-files`` example retrieves details about the log files for the specified DB instance. ::

aws rds describe-db-log-files -\
-db-instance-identifier test-instance
aws rds describe-db-log-files \
--db-instance-identifier test-instance

Output::

Expand Down
6 changes: 3 additions & 3 deletions awscli/examples/resource-explorer-2/search.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
**Example 1: To search using the default view**

The following ``search`` example displays all resources in the specified that are associated with the service. The search uses the default view for the Region. The example response includes a ``NextToken`` value, which indicates that there is more output available to retrieve with additional calls. ::
The following ``search`` example displays all resources in the specified Region that are associated with the IAM service. The search uses the default view for the Region. The example response includes a ``NextToken`` value, which indicates that there is more output available to retrieve with additional calls. ::

aws resource-explorer-2 search \
--query-string "service:iam"
Expand Down Expand Up @@ -40,8 +40,8 @@ Output::
The following ``search`` example search displays all resources ("*") in the specified AWS Region that are visible through the specified view. The results include only resources associated with Amazon EC2 because of the filters attached to the view. ::

aws resource-explorer-2 search \
-- query-string "*" \
-- view-arn arn:aws:resource-explorer-2:us-east-1:123456789012:view/My-EC2-view/EXAMPLE8-90ab-cdef-fedc-EXAMPLE22222
--query-string "*" \
--view-arn arn:aws:resource-explorer-2:us-east-1:123456789012:view/My-EC2-view/EXAMPLE8-90ab-cdef-fedc-EXAMPLE22222

Output::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
The following ``put-firewall-rule-group-policy`` example attaches an AWS Identity and Access Management (AWS IAM) policy for sharing the rule group. ::

aws route53resolver put-firewall-rule-group-policy \
--arn arn:aws:route53resolver:us-east-1:AWS_ACCOUNT_ID:firewall-rule-group/rslvr-frg-47f93271fexample \
--firewall-rule-group-policy "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"test\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::AWS_ACCOUNT_ID:root\"},\"Action\":[\"route53resolver:GetFirewallRuleGroup\",\"route53resolver:ListFirewallRuleGroups\"],\"Resource\":\"arn:aws:route53resolver:us-east-1:AWS_ACCOUNT_ID:firewall-rule-group/rslvr-frg-47f93271fexample\"}]}"

Output::
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@

The following ``accept-administrator-invitation`` example accepts the specified invitation from the specified administrator account. ::

aws securityhub accept-invitation \
--administrator-id 123456789012 \
aws securityhub accept-administrator-invitation \
--administrator-id 123456789012 \
--invitation-id 7ab938c5d52d7904ad09f9e7c20cc4eb

This command produces no output.

This command produces no output.
For more information, see `Managing administrator and member accounts <https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-accounts.html>`__ in the *AWS Security Hub User Guide*.
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
The following ``batch-get-configuration-policy-associations`` example retrieves association details for the specified targets. You can provide account IDs, organizational unit IDs, or the root ID for the target. ::

aws securityhub batch-get-configuration-policy-associations \
--target '{"OrganizationalUnitId": "ou-6hi7-8j91kl2m"}'
--configuration-policy-association-identifiers '{"OrganizationalUnitId": "ou-6hi7-8j91kl2m"}'

Output::

Expand Down
Loading