Skip to content

Commit 85d9842

Browse files
DOCSP-13628 Missing externalId or roleId in API docs (#108)
1 parent c35a21b commit 85d9842

File tree

3 files changed

+12
-3
lines changed

3 files changed

+12
-3
lines changed

source/includes/fact-data-lake-api-response.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,12 @@
2020

2121
{+data-lake-short+} only supports ``aws``.
2222

23+
* - ``cloudProviderConfig.externalId``
24+
- string
25+
- Unique identifier associated with the IAM Role that
26+
{+data-lake-short+} assumes when accessing the
27+
{+data-lake-stores+}.
28+
2329
* - ``cloudProviderConfig.aws.
2430
iamAssumedRoleARN``
2531
- string

source/reference/api/dataLakes-get-all-tenants.txt

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,8 @@ Response
8989
"aws": {
9090
"externalId": "fe47642b-d13a-47d7-ad1e-edab7bb0d8d1",
9191
"iamAssumedRoleARN": "arn:aws:iam::123456789012:roleReadS3BucketRole",
92-
"iamUserARN": "arn:aws:iam::1234567890123:user/queryengine"
92+
"iamUserARN": "arn:aws:iam::1234567890123:user/queryengine",
93+
"roleId": "1a2bc3d4ef567a1bc23456c7"
9394
}
9495
},
9596
"dataProcessRegion": {
@@ -112,7 +113,8 @@ Response
112113
"aws": {
113114
"externalId": "9c06e04c-a8fc-4a8e-a5c4-ff17461d5914",
114115
"iamAssumedRoleARN": "arn:aws:iam::123456789012:role/ReadS3BucketRole",
115-
"iamUserARN": "arn:aws:iam::1234567890123:root"
116+
"iamUserARN": "arn:aws:iam::1234567890123:root",
117+
"roleId": "1a234bcd5e67f89a12b345c6"
116118
}
117119
},
118120
"dataProcessRegion": {

source/reference/api/dataLakes-get-one-tenant.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,8 @@ Response
9696
"aws": {
9797
"externalId": "fe47642b-d13a-47d7-ad1e-edab7bb0d8d1",
9898
"iamAssumedRoleARN": "arn:aws:iam::123456789012:role/ReadS3BucketRole",
99-
"iamUserARN": "arn:aws:iam::1234567890123:root"
99+
"iamUserARN": "arn:aws:iam::1234567890123:root",
100+
"roleId": "1a234bcd5e67f89a12b345c6"
100101
}
101102
},
102103
"dataProcessRegion": {

0 commit comments

Comments
 (0)