Skip to content

Commit 31d0265

Browse files
authored
Merge pull request #42689 from hashicorp/d-further-arguments-byline-standardization
Documentation: Additional `Argument Reference` section byline standardization
2 parents 4c72db3 + 430ac37 commit 31d0265

File tree

75 files changed

+170
-210
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

75 files changed

+170
-210
lines changed

website/docs/d/apigatewayv2_api.html.markdown

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,6 @@ data "aws_apigatewayv2_api" "example" {
2020

2121
## Argument Reference
2222

23-
The arguments of this data source act as filters for querying the available APIs in the current region.
24-
The given filters must match exactly one API whose data will be exported as attributes.
25-
2623
This data source supports the following arguments:
2724

2825
* `api_id` - (Required) API identifier.

website/docs/d/connect_contact_flow.html.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,14 +32,14 @@ data "aws_connect_contact_flow" "test" {
3232

3333
## Argument Reference
3434

35-
~> **NOTE:** `instance_id` and one of either `name` or `contact_flow_id` is required.
36-
3735
This data source supports the following arguments:
3836

3937
* `contact_flow_id` - (Optional) Returns information on a specific Contact Flow by contact flow id
4038
* `instance_id` - (Required) Reference to the hosting Amazon Connect Instance
4139
* `name` - (Optional) Returns information on a specific Contact Flow by name
4240

41+
~> **NOTE:** `instance_id` and one of either `name` or `contact_flow_id` is required.
42+
4343
## Attribute Reference
4444

4545
This data source exports the following attributes in addition to the arguments above:

website/docs/d/connect_contact_flow_module.html.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,14 +32,14 @@ data "aws_connect_contact_flow_module" "example" {
3232

3333
## Argument Reference
3434

35-
~> **NOTE:** `instance_id` and one of either `name` or `contact_flow_module_id` is required.
36-
3735
This data source supports the following arguments:
3836

3937
* `contact_flow_module_id` - (Optional) Returns information on a specific Contact Flow Module by contact flow module id
4038
* `instance_id` - (Required) Reference to the hosting Amazon Connect Instance
4139
* `name` - (Optional) Returns information on a specific Contact Flow Module by name
4240

41+
~> **NOTE:** `instance_id` and one of either `name` or `contact_flow_module_id` is required.
42+
4343
## Attribute Reference
4444

4545
This data source exports the following attributes in addition to the arguments above:

website/docs/d/connect_hours_of_operation.html.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,14 +32,14 @@ data "aws_connect_hours_of_operation" "test" {
3232

3333
## Argument Reference
3434

35-
~> **NOTE:** `instance_id` and one of either `name` or `hours_of_operation_id` is required.
36-
3735
This data source supports the following arguments:
3836

3937
* `hours_of_operation_id` - (Optional) Returns information on a specific Hours of Operation by hours of operation id
4038
* `instance_id` - (Required) Reference to the hosting Amazon Connect Instance
4139
* `name` - (Optional) Returns information on a specific Hours of Operation by name
4240

41+
~> **NOTE:** `instance_id` and one of either `name` or `hours_of_operation_id` is required.
42+
4343
## Attribute Reference
4444

4545
This data source exports the following attributes in addition to the arguments above:

website/docs/d/connect_instance.html.markdown

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,14 +30,13 @@ data "aws_connect_instance" "foo" {
3030

3131
## Argument Reference
3232

33-
~> **NOTE:** One of either `instance_id` or `instance_alias` is required.
34-
3533
This data source supports the following arguments:
3634

3735
* `instance_id` - (Optional) Returns information on a specific connect instance by id
38-
3936
* `instance_alias` - (Optional) Returns information on a specific connect instance by alias
4037

38+
~> **NOTE:** One of either `instance_id` or `instance_alias` is required.
39+
4140
## Attribute Reference
4241

4342
This data source exports the following attributes in addition to the arguments above:

website/docs/d/connect_queue.html.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,14 +32,14 @@ data "aws_connect_queue" "example" {
3232

3333
## Argument Reference
3434

35-
~> **NOTE:** `instance_id` and one of either `name` or `queue_id` is required.
36-
3735
This data source supports the following arguments:
3836

3937
* `queue_id` - (Optional) Returns information on a specific Queue by Queue id
4038
* `instance_id` - (Required) Reference to the hosting Amazon Connect Instance
4139
* `name` - (Optional) Returns information on a specific Queue by name
4240

41+
~> **NOTE:** `instance_id` and one of either `name` or `queue_id` is required.
42+
4343
## Attribute Reference
4444

4545
This data source exports the following attributes in addition to the arguments above:

website/docs/d/connect_quick_connect.html.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,14 +32,14 @@ data "aws_connect_quick_connect" "example" {
3232

3333
## Argument Reference
3434

35-
~> **NOTE:** `instance_id` and one of either `name` or `quick_connect_id` is required.
36-
3735
This data source supports the following arguments:
3836

3937
* `quick_connect_id` - (Optional) Returns information on a specific Quick Connect by Quick Connect id
4038
* `instance_id` - (Required) Reference to the hosting Amazon Connect Instance
4139
* `name` - (Optional) Returns information on a specific Quick Connect by name
4240

41+
~> **NOTE:** `instance_id` and one of either `name` or `quick_connect_id` is required.
42+
4343
## Attribute Reference
4444

4545
This data source exports the following attributes in addition to the arguments above:

website/docs/d/connect_routing_profile.html.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,14 +32,14 @@ data "aws_connect_routing_profile" "example" {
3232

3333
## Argument Reference
3434

35-
~> **NOTE:** `instance_id` and one of either `name` or `routing_profile_id` is required.
36-
3735
This data source supports the following arguments:
3836

3937
* `instance_id` - Reference to the hosting Amazon Connect Instance
4038
* `name` - (Optional) Returns information on a specific Routing Profile by name
4139
* `routing_profile_id` - (Optional) Returns information on a specific Routing Profile by Routing Profile id
4240

41+
~> **NOTE:** `instance_id` and one of either `name` or `routing_profile_id` is required.
42+
4343
## Attribute Reference
4444

4545
This data source exports the following attributes in addition to the arguments above:

website/docs/d/connect_security_profile.html.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,14 +32,14 @@ data "aws_connect_security_profile" "example" {
3232

3333
## Argument Reference
3434

35-
~> **NOTE:** `instance_id` and one of either `name` or `security_profile_id` is required.
36-
3735
This data source supports the following arguments:
3836

3937
* `security_profile_id` - (Optional) Returns information on a specific Security Profile by Security Profile id
4038
* `instance_id` - (Required) Reference to the hosting Amazon Connect Instance
4139
* `name` - (Optional) Returns information on a specific Security Profile by name
4240

41+
~> **NOTE:** `instance_id` and one of either `name` or `security_profile_id` is required.
42+
4343
## Attribute Reference
4444

4545
This data source exports the following attributes in addition to the arguments above:

website/docs/d/connect_user.html.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,14 +32,14 @@ data "aws_connect_user" "example" {
3232

3333
## Argument Reference
3434

35-
~> **NOTE:** `instance_id` and one of either `name` or `user_id` is required.
36-
3735
This data source supports the following arguments:
3836

3937
* `instance_id` - (Required) Reference to the hosting Amazon Connect Instance
4038
* `name` - (Optional) Returns information on a specific User by name
4139
* `user_id` - (Optional) Returns information on a specific User by User id
4240

41+
~> **NOTE:** `instance_id` and one of either `name` or `user_id` is required.
42+
4343
## Attribute Reference
4444

4545
This data source exports the following attributes in addition to the arguments above:

0 commit comments

Comments
 (0)