Skip to content

Create update-vpc-link.rst #9405

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Create update-vpc-link.rst #9405

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
43 changes: 43 additions & 0 deletions awscli/examples/apigateway/update-vpc-link.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
**Example 1: To update an existing vpc link name**
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
**Example 1: To update an existing vpc link name**
**Example 1: To update an existing VPC link name**


The following ``update-vpc-link`` example updates name of an existing the vpc link. ::
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The following ``update-vpc-link`` example updates name of an existing the vpc link. ::
The following ``update-vpc-link`` example updates the name of the specified VPC link. ::


aws apigateway update-vpc-link \
--vpc-link-id ab3de6 \
--patch-operations op=replace,path=/name,value=my-vpc-link

Output::

{
"id": "ab3de6",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"id": "ab3de6",
"id": "ab3de6",

Each indentation must be 4 spaces each. Please fix all the indentation in the JSON output.
https://aws.github.io/aws-cli/docs_styleguide.html#general

"name": "my-vpc-link",
"targetArns": [
"arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/net/my-lb/12a456s89aaa12345"
],
"status": "AVAILABLE",
"statusMessage": "Your vpc link is ready for use",
"tags": {}
}

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please provide a For more information link for each example.

https://aws.github.io/aws-cli/docs_styleguide.html#for-more-information-link


**Example 2: To update an existing vpc link name and description**
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
**Example 2: To update an existing vpc link name and description**
**Example 2: To update an existing VPC link name and description**


The following ``update-vpc-link`` example updates name of an existing the vpc link. ::
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The following ``update-vpc-link`` example updates name of an existing the vpc link. ::
The following ``update-vpc-link`` example updates name of the specified VPC link. ::


aws apigateway update-vpc-link \
--vpc-link-id ab3de6 \
--patch-operations op=replace,path=/name,value=my-vpc-link op=replace,path=/description,value="My custom description"

Output::

{
"id": "ab3de6",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"id": "ab3de6",
"id": "ab3de6",

Same here, the indenting needs to be 4 spaces for each indent in the JSON output.

"name": "my-vpc-link",
"description": "My custom description",
"targetArns": [
"arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/net/my-lb/12a456s89aaa12345"
],
"status": "AVAILABLE",
"statusMessage": "Your vpc link is ready for use",
"tags": {}
}
Loading