Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix the document link to aws-cli v2 #8629

Open
wants to merge 1 commit into
base: v2
Choose a base branch
from
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion awscli/examples/cognito-idp/admin-initiate-auth.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@ Output::
}
}

.. _`admin-respond-to-auth-challenge`: https://docs.aws.amazon.com/cli/latest/reference/cognito-idp/admin-respond-to-auth-challenge.html
.. _`admin-respond-to-auth-challenge`: https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-respond-to-auth-challenge.html
2 changes: 1 addition & 1 deletion awscli/examples/cognito-idp/respond-to-auth-challenge.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ Output::
}
}

.. _`initiate-auth`: https://docs.aws.amazon.com/cli/latest/reference/cognito-idp/initiate-auth.html
.. _`initiate-auth`: https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/initiate-auth.html
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ Output::
"NextToken": ""
}

Configure the JSON file. You must provide values for ``ArchitectureTypes``, ``VirtualizationTypes``, ``VCpuCount``, and ``MemoryMiB``. You can omit the other attributes. When omitted, default values are used. For a description of each attribute and their default values, see `get-instance-types-from-instance-requirements <https://docs.aws.amazon.com/cli/latest/reference/ec2/get-instance-types-from-instance-requirements.html>`.
Configure the JSON file. You must provide values for ``ArchitectureTypes``, ``VirtualizationTypes``, ``VCpuCount``, and ``MemoryMiB``. You can omit the other attributes. When omitted, default values are used. For a description of each attribute and their default values, see `get-instance-types-from-instance-requirements <https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-instance-types-from-instance-requirements.html>`.

Preview the instance types that have the attributes specified in ``attributes.json``. Specify the name and path to your JSON file by using the ``--cli-input-json`` parameter. In the following request, the output is formatted as a table. ::

Expand Down Expand Up @@ -133,4 +133,4 @@ Output::
|| d2.xlarge ||
...

For more information about attribute-based instance type selection, see `How attribute-based instance type selection works <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html#ec2fleet-abs-how-it-works>`__ in the *Amazon EC2 User Guide*.
For more information about attribute-based instance type selection, see `How attribute-based instance type selection works <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html#ec2fleet-abs-how-it-works>`__ in the *Amazon EC2 User Guide*.
2 changes: 1 addition & 1 deletion awscli/examples/ec2/modify-address-attribute.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,4 @@ Output::
]
}

To monitor the pending change and to view the modified attributes of an elastic IP address, see `describe-addresses-attribute <https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-addresses-attribute.html>`__ in the *AWS CLI Command Reference*.
To monitor the pending change and to view the modified attributes of an elastic IP address, see `describe-addresses-attribute <https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-addresses-attribute.html>`__ in the *AWS CLI Command Reference*.
2 changes: 1 addition & 1 deletion awscli/examples/ec2/reset-address-attribute.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,4 @@ Output::
]
}

To monitor the pending change, see `describe-addresses-attribute <https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-addresses-attribute.html>`__ in the *AWS CLI Command Reference*.
To monitor the pending change, see `describe-addresses-attribute <https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-addresses-attribute.html>`__ in the *AWS CLI Command Reference*.
4 changes: 2 additions & 2 deletions awscli/examples/kms/update-key-description.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The following ``update-key-description`` example adds a description to a custome

This command produces no output. To view the description of a KMS key, use the ``describe-key`` command.

For more information, see `UpdateKeyDescription <https://docs.aws.amazon.com/cli/latest/reference/kms/update-key-description.html>`__ in the *AWS Key Management Service API Reference*.
For more information, see `UpdateKeyDescription <https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/update-key-description.html>`__ in the *AWS Key Management Service API Reference*.

**Example 2: To delete the description of a customer managed KMS key**

Expand All @@ -26,4 +26,4 @@ The following ``update-key-description`` example deletes the description to a cu

This command produces no output. To view the description of a KMS key, use the the describe-key command.

For more information, see `UpdateKeyDescription <https://docs.aws.amazon.com/cli/latest/reference/kms/update-key-description.html>`__ in the *AWS Key Management Service API Reference*.
For more information, see `UpdateKeyDescription <https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/update-key-description.html>`__ in the *AWS Key Management Service API Reference*.
4 changes: 2 additions & 2 deletions awscli/examples/resource-explorer-2/create-index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,6 @@ Output::
"State": "CREATING"
}

After you create a local index, you can convert it into the aggregator index for the account by running the `update-index-type <https://docs.aws.amazon.com/cli/latest/reference/resource-explorer-2/update-index-type.html>`__ command.
After you create a local index, you can convert it into the aggregator index for the account by running the `update-index-type <https://awscli.amazonaws.com/v2/documentation/api/latest/reference/resource-explorer-2/update-index-type.html>`__ command.

For more information, see `Turning on Resource Explorer in an AWS Region to index your resources <https://docs.aws.amazon.com/resource-explorer/latest/userguide/manage-service-register.html>`__ in the *AWS Resource Explorer Users Guide*.
For more information, see `Turning on Resource Explorer in an AWS Region to index your resources <https://docs.aws.amazon.com/resource-explorer/latest/userguide/manage-service-register.html>`__ in the *AWS Resource Explorer Users Guide*.
2 changes: 1 addition & 1 deletion awscli/examples/route53domains/delete-tags-for-domain.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,5 @@ This command runs only in the ``us-east-1`` Region. If your default region is se

This command produces no output.

To confirm that the tags were deleted, you can run `list-tags-for-domain <https://docs.aws.amazon.com/cli/latest/reference/route53domains/list-tags-for-domain.html>`__ .
To confirm that the tags were deleted, you can run `list-tags-for-domain <https://awscli.amazonaws.com/v2/documentation/api/latest/reference/route53domains/list-tags-for-domain.html>`__ .
For more information, see `Tagging Amazon Route 53 Resources <https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/tagging-resources.html>`__ in the *Amazon Route 53 Developer Guide*.
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,5 @@ This command runs only in the ``us-east-1`` Region. If your default region is se

This command produces no output.

To confirm that the setting was changed, you can run `get-domain-detail <https://docs.aws.amazon.com/cli/latest/reference/route53domains/get-domain-detail.html>`__ . If automatic renewal is disabled, the value of ``AutoRenew`` is ``False``.
To confirm that the setting was changed, you can run `get-domain-detail <https://awscli.amazonaws.com/v2/documentation/api/latest/reference/route53domains/get-domain-detail.html>`__ . If automatic renewal is disabled, the value of ``AutoRenew`` is ``False``.
For more information about automatic renewal, see `Renewing Registration for a Domain <https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/domain-renew.html`__ in the *Amazon Route 53 Developer Guide*.
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,6 @@ Output::
"OperationId": "3f28e0ac-126a-4113-9048-cc930example"
}

To confirm that the transfer lock has been changed, you can run `get-domain-detail <https://docs.aws.amazon.com/cli/latest/reference/route53domains/get-domain-detail.html>`__ . When the transfer lock is disabled, the value of ``StatusList`` does *not* include ``clientTransferProhibited``.
To confirm that the transfer lock has been changed, you can run `get-domain-detail <https://awscli.amazonaws.com/v2/documentation/api/latest/reference/route53domains/get-domain-detail.html>`__ . When the transfer lock is disabled, the value of ``StatusList`` does *not* include ``clientTransferProhibited``.

For more information about the transfer process, see `Transferring a Domain from Amazon Route 53 to Another Registrar <https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/domain-transfer-from-route-53.html>`__ in the *Amazon Route 53 Developer Guide*.
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@ This command runs only in the ``us-east-1`` Region. If your default region is se
--region us-east-1 \
--domain-name example.com

This command produces no output. To confirm that the setting was changed, you can run `get-domain-detail <https://docs.aws.amazon.com/cli/latest/reference/route53domains/get-domain-detail.html>`__ . If automatic renewal is enabled, the value of ``AutoRenew`` is ``True``.
This command produces no output. To confirm that the setting was changed, you can run `get-domain-detail <https://awscli.amazonaws.com/v2/documentation/api/latest/reference/route53domains/get-domain-detail.html>`__ . If automatic renewal is enabled, the value of ``AutoRenew`` is ``True``.

For more information about automatic renewal, see `Renewing Registration for a Domain <https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/domain-renew.html`__ in the *Amazon Route 53 Developer Guide*.
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,6 @@ Output::
"OperationId": "3f28e0ac-126a-4113-9048-cc930example"
}

To confirm that the transfer lock has been changed, you can run `get-domain-detail <https://docs.aws.amazon.com/cli/latest/reference/route53domains/get-domain-detail.html>`__ . When the transfer lock is enabled, the value of ``StatusList`` includes ``clientTransferProhibited``.
To confirm that the transfer lock has been changed, you can run `get-domain-detail <https://awscli.amazonaws.com/v2/documentation/api/latest/reference/route53domains/get-domain-detail.html>`__ . When the transfer lock is enabled, the value of ``StatusList`` includes ``clientTransferProhibited``.

For more information about the transfer process, see `Transferring a Domain from Amazon Route 53 to Another Registrar <https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/domain-transfer-from-route-53.html>`__ in the *Amazon Route 53 Developer Guide*.
2 changes: 1 addition & 1 deletion awscli/examples/route53domains/register-domain.rst
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ Output::
"OperationId": "b114c44a-9330-47d1-a6e8-a0b11example"
}

To confirm that the operation succeeded, you can run ``get-operation-detail``. For more information, see `get-operation-detail <https://docs.aws.amazon.com/cli/latest/reference/route53domains/get-operation-detail.html>`__ .
To confirm that the operation succeeded, you can run ``get-operation-detail``. For more information, see `get-operation-detail <https://awscli.amazonaws.com/v2/documentation/api/latest/reference/route53domains/get-operation-detail.html>`__ .

For more information, see `Registering a New Domain <https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/domain-register.html>`__ in the *Amazon Route 53 Developer Guide*.

Expand Down
2 changes: 1 addition & 1 deletion awscli/examples/route53domains/renew-domain.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Output::
"OperationId": "3f28e0ac-126a-4113-9048-cc930example"
}

To confirm that the operation succeeded, you can run ``get-operation-detail``. For more information, see `get-operation-detail <https://docs.aws.amazon.com/cli/latest/reference/route53domains/get-operation-detail.html>`__.
To confirm that the operation succeeded, you can run ``get-operation-detail``. For more information, see `get-operation-detail <https://awscli.amazonaws.com/v2/documentation/api/latest/reference/route53domains/get-operation-detail.html>`__.

The registry for each top-level domain (TLD), such as .com or .org, controls the maximum number of years that you can renew a domain for. To get the maximum renewal period for your domain, see the "Registration and Renewal Period" section for your TLD in `Domains That You Can Register with Amazon Route 53 <https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/registrar-tld-list.html>`__ in the *Amazon Route 53 Developer Guide*.

Expand Down
4 changes: 2 additions & 2 deletions awscli/examples/route53domains/transfer-domain.rst
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,6 @@ Output::
"OperationId": "b114c44a-9330-47d1-a6e8-a0b11example"
}

To confirm that the operation succeeded, you can run ``get-operation-detail``. For more information, see `get-operation-detail <https://docs.aws.amazon.com/cli/latest/reference/route53domains/get-operation-detail.html>`__ .
To confirm that the operation succeeded, you can run ``get-operation-detail``. For more information, see `get-operation-detail <https://awscli.amazonaws.com/v2/documentation/api/latest/reference/route53domains/get-operation-detail.html>`__ .

For more information, see `Transferring Registration for a Domain to Amazon Route 53 <https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/domain-transfer-to-route-53.html>`__ in the *Amazon Route 53 Developer Guide*.
For more information, see `Transferring Registration for a Domain to Amazon Route 53 <https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/domain-transfer-to-route-53.html>`__ in the *Amazon Route 53 Developer Guide*.
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,6 @@ Output::
"OperationId": "b3a219e9-d801-4244-b533-b7256example"
}

To confirm that the operation succeeded, you can run ``get-operation-detail``. For more information, see `get-operation-detail <https://docs.aws.amazon.com/cli/latest/reference/route53domains/get-operation-detail.html>`__ .
To confirm that the operation succeeded, you can run ``get-operation-detail``. For more information, see `get-operation-detail <https://awscli.amazonaws.com/v2/documentation/api/latest/reference/route53domains/get-operation-detail.html>`__ .

For more information, see `Enabling or Disabling Privacy Protection for Contact Information for a Domain <https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/domain-privacy-protection.html>`__ in the *Amazon Route 53 Developer Guide*.
2 changes: 1 addition & 1 deletion awscli/examples/route53domains/update-domain-contact.rst
Original file line number Diff line number Diff line change
Expand Up @@ -62,5 +62,5 @@ Output::
"OperationId": "b3a219e9-d801-4244-b533-b7256example"
}

To confirm that the operation succeeded, you can run `get-domain-detail <https://docs.aws.amazon.com/cli/latest/reference/route53domains/get-domain-detail.html>`__ .
To confirm that the operation succeeded, you can run `get-domain-detail <https://awscli.amazonaws.com/v2/documentation/api/latest/reference/route53domains/get-domain-detail.html>`__ .
For more information, see `Updating Contact Information for a Domain <https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/domain-update-contacts.html#domain-update-contacts-basic>`__ in the *Amazon Route 53 Developer Guide*.
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,6 @@ Output::
"OperationId": "f1691ec4-0e7a-489e-82e0-b19d3example"
}

To confirm that the operation succeeded, you can run `get-domain-detail <https://docs.aws.amazon.com/cli/latest/reference/route53domains/get-domain-detail.html>`__ .
To confirm that the operation succeeded, you can run `get-domain-detail <https://awscli.amazonaws.com/v2/documentation/api/latest/reference/route53domains/get-domain-detail.html>`__ .

For more information, see `Adding or Changing Name Servers and Glue Records for a Domain <https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/domain-name-servers-glue-records.html>`__ in the *Amazon Route 53 Developer Guide*.
2 changes: 1 addition & 1 deletion awscli/examples/route53domains/update-tags-for-domain.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,6 @@ This command runs only in the ``us-east-1`` Region. If your default region is se
--domain-name example.com \
--tags-to-update "Key=key1,Value=value1" "Key=key2,Value=value2"

This command produces no output. To confirm that the tags were added or updated, you can run `list-tags-for-domain <https://docs.aws.amazon.com/cli/latest/reference/route53domains/list-tags-for-domain.html>`__ .
This command produces no output. To confirm that the tags were added or updated, you can run `list-tags-for-domain <https://awscli.amazonaws.com/v2/documentation/api/latest/reference/route53domains/list-tags-for-domain.html>`__ .

For more information, see `Tagging Amazon Route 53 Resources <https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/tagging-resources.html>`__ in the *Amazon Route 53 Developer Guide*.
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The following ``disassociate-resolver-endpoint-ip-address`` example removes an IP address from a specified Resolver inbound or outbound endpoint.

**Note** An endpoint must have at least two IP addresses. If an endpoint currently has only two IP addresses and you want to replace one address with another address, you must first use `associate-resolver-endpoint-ip-address <https://docs.aws.amazon.com/cli/latest/reference/route53resolver/associate-resolver-endpoint-ip-address.html>`__ to associate the new IP address. Then you can disassociate one of the original IP addresses from the endpoint. ::
**Note** An endpoint must have at least two IP addresses. If an endpoint currently has only two IP addresses and you want to replace one address with another address, you must first use `associate-resolver-endpoint-ip-address <https://awscli.amazonaws.com/v2/documentation/api/latest/reference/route53resolver/associate-resolver-endpoint-ip-address.html>`__ to associate the new IP address. Then you can disassociate one of the original IP addresses from the endpoint. ::

aws route53resolver disassociate-resolver-endpoint-ip-address \
--resolver-endpoint-id rslvr-in-f9ab8a03f1example \
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
**To get information about the association between a Resolver rule and a VPC**

The following ``get-resolver-rule-association`` example displays details about the association between a specified Resolver rule and a VPC. You associate a resolver rule and a VPC using `associate-resolver-rule <https://docs.aws.amazon.com/cli/latest/reference/route53resolver/associate-resolver-rule.html>`__. ::
The following ``get-resolver-rule-association`` example displays details about the association between a specified Resolver rule and a VPC. You associate a resolver rule and a VPC using `associate-resolver-rule <https://awscli.amazonaws.com/v2/documentation/api/latest/reference/route53resolver/associate-resolver-rule.html>`__. ::

aws route53resolver get-resolver-rule-association \
--resolver-rule-association-id rslvr-rrassoc-d61cbb2c8bexample
Expand Down
4 changes: 2 additions & 2 deletions awscli/examples/route53resolver/put-resolver-rule-policy.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,6 @@ After you run ``put-resolver-rule-policy``, you can run the following two Resour

For more information, see the following documentation:

- `get-resource-share-invitations <https://docs.aws.amazon.com/cli/latest/reference/ram/get-resource-share-invitations.html>`__
- `accept-resource-share-invitations <https://docs.aws.amazon.com/cli/latest/reference/ram/accept-resource-share-invitation.html>`__
- `get-resource-share-invitations <https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ram/get-resource-share-invitations.html>`__
- `accept-resource-share-invitations <https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ram/accept-resource-share-invitation.html>`__
- `Sharing Forwarding Rules with Other AWS Accounts and Using Shared Rules <https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/resolver-rules-managing.html#resolver-rules-managing-sharing>`__ in the *Amazon Route 53 Developer Guide*
2 changes: 1 addition & 1 deletion awscli/examples/route53resolver/untag-resource.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@ The following ``untag-resource`` example removes two tags from the specified Res
--resource-arn "arn:aws:route53resolver:us-west-2:111122223333:resolver-rule/rslvr-rr-42b60677c0example" \
--tag-keys my-key-1 my-key-2

This command produces no output. To confirm that the tags were removed, you can use `list-tags-for-resource <https://docs.aws.amazon.com/cli/latest/reference/route53resolver/list-tags-for-resource.html>`__.
This command produces no output. To confirm that the tags were removed, you can use `list-tags-for-resource <https://awscli.amazonaws.com/v2/documentation/api/latest/reference/route53resolver/list-tags-for-resource.html>`__.

For information about using tags for cost allocation, see `Using Cost Allocation Tags <https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html>`__ in the *AWS Billing and Cost Management User Guide*.