Skip to content

Commit a214811

Browse files
author
AWS
committed
AWS Service Catalog Update: Documentation updates for ServiceCatalog.
1 parent 10024c3 commit a214811

File tree

2 files changed

+13
-7
lines changed

2 files changed

+13
-7
lines changed
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "AWS Service Catalog",
4+
"contributor": "",
5+
"description": "Documentation updates for ServiceCatalog."
6+
}

services/servicecatalog/src/main/resources/codegen-resources/service-2.json

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -649,7 +649,7 @@
649649
{"shape":"InvalidParametersException"},
650650
{"shape":"ResourceNotFoundException"}
651651
],
652-
"documentation":"<p>Disassociates a previously associated principal ARN from a specified portfolio.</p> <p>The <code>PrincipalType</code> and <code>PrincipalARN</code> must match the <code>AssociatePrincipalWithPortfolio</code> call request details. For example, to disassociate an association created with a <code>PrincipalARN</code> of <code>PrincipalType</code> IAM you must use the <code>PrincipalType</code> IAM when calling <code>DisassociatePrincipalFromPortfolio</code>. </p> <p>For portfolios that have been shared with principal name sharing enabled: after disassociating a principal, share recipient accounts will no longer be able to provision products in this portfolio using a role matching the name of the associated principal. </p>"
652+
"documentation":"<p>Disassociates a previously associated principal ARN from a specified portfolio.</p> <p>The <code>PrincipalType</code> and <code>PrincipalARN</code> must match the <code>AssociatePrincipalWithPortfolio</code> call request details. For example, to disassociate an association created with a <code>PrincipalARN</code> of <code>PrincipalType</code> IAM you must use the <code>PrincipalType</code> IAM when calling <code>DisassociatePrincipalFromPortfolio</code>. </p> <p>For portfolios that have been shared with principal name sharing enabled: after disassociating a principal, share recipient accounts will no longer be able to provision products in this portfolio using a role matching the name of the associated principal. </p> <p>For more information, review <a href=\"https://docs.aws.amazon.com/cli/latest/reference/servicecatalog/associate-principal-with-portfolio.html#options\">associate-principal-with-portfolio</a> in the Amazon Web Services CLI Command Reference. </p> <note> <p>If you disassociate a principal from a portfolio, with PrincipalType as <code>IAM</code>, the same principal will still have access to the portfolio if it matches one of the associated principals of type <code>IAM_PATTERN</code>. To fully remove access for a principal, verify all the associated Principals of type <code>IAM_PATTERN</code>, and then ensure you disassociate any <code>IAM_PATTERN</code> principals that match the principal whose access you are removing.</p> </note>"
653653
},
654654
"DisassociateProductFromPortfolio":{
655655
"name":"DisassociateProductFromPortfolio",
@@ -1421,11 +1421,11 @@
14211421
},
14221422
"PrincipalARN":{
14231423
"shape":"PrincipalARN",
1424-
"documentation":"<p>The ARN of the principal (user, role, or group). This field allows an ARN with no <code>accountID</code> if <code>PrincipalType</code> is <code>IAM_PATTERN</code>. </p> <p>You can associate multiple <code>IAM</code> patterns even if the account has no principal with that name. This is useful in Principal Name Sharing if you want to share a principal without creating it in the account that owns the portfolio. </p>"
1424+
"documentation":"<p>The ARN of the principal (user, role, or group). The supported value is a fully defined <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns\"> <code>IAM</code> ARN</a> if the <code>PrincipalType</code> is <code>IAM</code>. If the <code>PrincipalType</code> is <code>IAM_PATTERN</code>, the supported value is an <code>IAM</code> ARN without an AccountID in the following format:</p> <p> <i>arn:partition:iam:::resource-type/resource-id</i> </p> <p>The resource-id can be either of the following:</p> <ul> <li> <p>Fully formed, for example <i>arn:aws:iam:::role/resource-name</i> or <i>arn:aws:iam:::role/resource-path/resource-name</i> </p> </li> <li> <p>A wildcard ARN. The wildcard ARN accepts <code>IAM_PATTERN</code> values with a \"*\" or \"?\" in the resource-id segment of the ARN, for example <i>arn:partition:service:::resource-type/resource-path/resource-name</i>. The new symbols are exclusive to the <b>resource-path</b> and <b>resource-name</b> and cannot be used to replace the <b>resource-type</b> or other ARN values. </p> </li> </ul> <p>Examples of an <b>acceptable</b> wildcard ARN:</p> <ul> <li> <p>arn:aws:iam:::role/ResourceName_*</p> </li> <li> <p>arn:aws:iam:::role/*/ResourceName_?</p> </li> </ul> <p>Examples of an <b>unacceptable</b> wildcard ARN:</p> <ul> <li> <p>arn:aws:iam:::*/ResourceName</p> </li> </ul> <p>You can associate multiple <code>IAM_PATTERN</code>s even if the account has no principal with that name. </p> <note> <ul> <li> <p>The ARN path and principal name allow unlimited wildcard characters. </p> </li> <li> <p>The \"?\" wildcard character matches zero or one of any character. This is similar to \".?\" in regular regex context.</p> </li> <li> <p>The \"*\" wildcard character matches any number of any characters. This is similar \".*\" in regular regex context.</p> </li> <li> <p>In the IAM Principal ARNs format (arn:partition:iam:::resource-type/resource-path/resource-name), valid <b>resource-type</b> values include user/, group/, or role/. The \"?\" and \"*\" are allowed only after the <b>resource-type</b>, in the resource-id segment. You can use special characters anywhere within the <b>resource-id</b>.</p> </li> <li> <p>The \"*\" also matches the \"/\" character, allowing paths to be formed within the <b>resource-id</b>. For example, arn:aws:iam:::role/*/ResourceName_? matches both arn:aws:iam:::role/pathA/pathB/ResourceName_1 and arn:aws:iam:::role/pathA/ResourceName_1.</p> </li> </ul> </note>"
14251425
},
14261426
"PrincipalType":{
14271427
"shape":"PrincipalType",
1428-
"documentation":"<p>The principal type. The supported value is <code>IAM</code> if you use a fully defined ARN, or <code>IAM_PATTERN</code> if you use an ARN with no <code>accountID</code>. </p>"
1428+
"documentation":"<p>The principal type. The supported value is <code>IAM</code> if you use a fully defined ARN, or <code>IAM_PATTERN</code> if you use an ARN with no <code>accountID</code>, with or without wildcard characters. </p>"
14291429
}
14301430
}
14311431
},
@@ -3001,11 +3001,11 @@
30013001
},
30023002
"PrincipalARN":{
30033003
"shape":"PrincipalARN",
3004-
"documentation":"<p>The ARN of the principal (user, role, or group). This field allows an ARN with no <code>accountID</code> if <code>PrincipalType</code> is <code>IAM_PATTERN</code>.</p>"
3004+
"documentation":"<p>The ARN of the principal (user, role, or group). This field allows an ARN with no <code>accountID</code> with or without wildcard characters if <code>PrincipalType</code> is <code>IAM_PATTERN</code>.</p>"
30053005
},
30063006
"PrincipalType":{
30073007
"shape":"PrincipalType",
3008-
"documentation":"<p>The supported value is <code>IAM</code> if you use a fully defined ARN, or <code>IAM_PATTERN</code> if you use no <code>accountID</code>. </p>"
3008+
"documentation":"<p>The supported value is <code>IAM</code> if you use a fully defined ARN, or <code>IAM_PATTERN</code> if you specify an <code>IAM</code> ARN with no AccountId, with or without wildcard characters. </p>"
30093009
}
30103010
}
30113011
},
@@ -4531,11 +4531,11 @@
45314531
"members":{
45324532
"PrincipalARN":{
45334533
"shape":"PrincipalARN",
4534-
"documentation":"<p>The ARN of the principal (user, role, or group). This field allows for an ARN with no <code>accountID</code> if the <code>PrincipalType</code> is an <code>IAM_PATTERN</code>. </p>"
4534+
"documentation":"<p>The ARN of the principal (user, role, or group). This field allows for an ARN with no <code>accountID</code>, with or without wildcard characters if the <code>PrincipalType</code> is an <code>IAM_PATTERN</code>. </p> <p>For more information, review <a href=\"https://docs.aws.amazon.com/cli/latest/reference/servicecatalog/associate-principal-with-portfolio.html#options\">associate-principal-with-portfolio</a> in the Amazon Web Services CLI Command Reference. </p>"
45354535
},
45364536
"PrincipalType":{
45374537
"shape":"PrincipalType",
4538-
"documentation":"<p>The principal type. The supported value is <code>IAM</code> if you use a fully defined ARN, or <code>IAM_PATTERN</code> if you use an ARN with no <code>accountID</code>. </p>"
4538+
"documentation":"<p>The principal type. The supported value is <code>IAM</code> if you use a fully defined ARN, or <code>IAM_PATTERN</code> if you use an ARN with no <code>accountID</code>, with or without wildcard characters. </p>"
45394539
}
45404540
},
45414541
"documentation":"<p>Information about a principal.</p>"

0 commit comments

Comments
 (0)