From 9fa141e327da0f4215f31bf4e0e3ab7207372153 Mon Sep 17 00:00:00 2001
From: awstools
You can associate a maximum of 10 Principals with a portfolio using PrincipalType
as IAM_PATTERN
*
When you associate a principal with portfolio, a potential privilege escalation path may occur when that portfolio is * then shared with other accounts. For a user in a recipient account who is not an Service Catalog Admin, @@ -827,12 +826,11 @@ export class ServiceCatalog extends ServiceCatalogClient { * organization or by a delegated administrator. You can share portfolios to an organization, * an organizational unit, or a specific account.
*Note that if a delegated admin is de-registered, they can no longer create portfolio shares.
- *+ *
* AWSOrganizationsAccess
must be enabled in order to create a portfolio share to an organization node.
You can't share a shared resource, including portfolios that contain a shared product.
*If the portfolio share with the specified account or organization node already exists, this action will have no effect
* and will not return an error. To update an existing share, you must use the UpdatePortfolioShare
API instead.
When you associate a principal with portfolio, a potential privilege escalation path may occur when that portfolio is * then shared with other accounts. For a user in a recipient account who is not an Service Catalog Admin, @@ -875,7 +873,6 @@ export class ServiceCatalog extends ServiceCatalogClient { /** *
Creates a product.
*A delegated admin is authorized to invoke this command.
- * *The user or role that performs this operation must have the
* cloudformation:GetTemplate
IAM policy permission. This policy permission is
* required when using the ImportFromPhysicalId
template source in the
@@ -952,7 +949,6 @@ export class ServiceCatalog extends ServiceCatalogClient {
/**
*
Creates a provisioning artifact (also known as a version) for the specified product.
*You cannot create a provisioning artifact for a product that was shared with you.
- * *The user or role that performs this operation must have the cloudformation:GetTemplate
* IAM policy permission. This policy permission is required when using the
* ImportFromPhysicalId
template source in the information data section.
Gets information about the specified product.
+ *+ * Running this operation + * with administrator access + * results + * in a failure. + * DescribeProductAsAdmin should be used instead. + *
+ *Requests the import of a resource as an Service Catalog provisioned product that is - * associated to an Service Catalog product and provisioning artifact. Once imported, all - * supported Service Catalog governance actions are supported on the provisioned - * product.
- *Resource import only supports CloudFormation stack ARNs. CloudFormation StackSets and - * non-root nested stacks are not supported.
- *The CloudFormation stack must have one of the following statuses to be imported:
- * CREATE_COMPLETE
, UPDATE_COMPLETE
, UPDATE_ROLLBACK_COMPLETE
, IMPORT_COMPLETE
,
- * IMPORT_ROLLBACK_COMPLETE
.
Import of the resource requires that the CloudFormation stack template matches the - * associated Service Catalog product provisioning artifact.
- * - *The user or role that performs this operation must have the cloudformation:GetTemplate
- * and cloudformation:DescribeStacks
IAM policy permissions.
+ * Requests the import + * of a resource + * as an Service Catalog provisioned product + * that is associated + * to an Service Catalog product and provisioning artifact. + * Once imported, + * all supported governance actions are supported + * on the provisioned product. + *
+ *+ * Resource import only supports CloudFormation stack ARNs. CloudFormation StackSets, and non-root nested stacks are not supported. + *
+ *
+ * The CloudFormation stack must have one
+ * of the following statuses
+ * to be imported: CREATE_COMPLETE
, UPDATE_COMPLETE
, UPDATE_ROLLBACK_COMPLETE
, IMPORT_COMPLETE
, and IMPORT_ROLLBACK_COMPLETE
.
+ *
+ * Import + * of the resource requires + * that the CloudFormation stack template matches the associated Service Catalog product provisioning artifact. + *
+ *
+ * When you import an existing CloudFormation stack
+ * into a portfolio,
+ * constraints
+ * that are associated
+ * with the product
+ * aren't applied
+ * during the import process.
+ * The constraints are applied
+ * after you call UpdateProvisionedProduct
+ * for the provisioned product.
+ *
+ * The user or role
+ * that performs this operation
+ * must have the cloudformation:GetTemplate
and cloudformation:DescribeStacks
IAM policy permissions.
+ *
Lists the paths to the specified product. A path is how the user - * has access to a specified product, and is necessary when provisioning a product. A path - * also determines the constraints put on the product.
+ *+ * Lists the paths + * to the specified product. + * A path describes + * how the user + * gets access + * to a specified product + * and is necessary + * when provisioning a product. + * A path also determines the constraints + * that are put on a product. + * A path is dependent + * on a specific product, porfolio, and principal. + *
+ *+ * When provisioning a product + * that's been added + * to a portfolio, + * you must grant your user, group, or role access + * to the portfolio. + * For more information, + * see Granting users access + * in the Service Catalog User Guide. + *
+ *Provisions the specified product.
- *A provisioned product is a resourced instance of a product. - * For example, provisioning a product based on a CloudFormation template launches a - * CloudFormation stack and its underlying resources. - * You can check the status of this request using DescribeRecord.
- *If the request contains a tag key with an empty list of values, there is a - * tag conflict for that key. Do not include conflicted keys as tags, or this causes - * the error "Parameter validation failed: Missing required parameter in - * Tags[N]:Value".
+ *+ * Provisions the specified product. + *
+ *+ * A provisioned product is a resourced instance + * of a product. + * For example, + * provisioning a product + * that's based + * on an CloudFormation template + * launches an CloudFormation stack and its underlying resources. + * You can check the status + * of this request + * using DescribeRecord. + *
+ *+ * If the request contains a tag key + * with an empty list + * of values, + * there's a tag conflict + * for that key. + * Don't include conflicted keys + * as tags, + * or this will cause the error "Parameter validation failed: Missing required parameter in Tags[N]:Value". + *
+ *+ * When provisioning a product + * that's been added + * to a portfolio, + * you must grant your user, group, or role access + * to the portfolio. + * For more information, + * see Granting users access + * in the Service Catalog User Guide. + *
+ *Gets information about the provisioned products that meet the specified criteria.
- * - *To ensure a complete list of provisioned products and remove duplicate products, use
- * sort-by createdTime
.
Here is a CLI example:
- *
- * aws servicecatalog search-provisioned-products --sort-by createdTime
- *
Updates the specified portfolio share. You can use this API to enable or disable TagOptions
sharing
* or Principal sharing for an existing portfolio share.
The portfolio share cannot be updated if the CreatePortfolioShare
operation is IN_PROGRESS
, as the share is not available to recipient entities. In this case, you must wait for the portfolio share to be COMPLETED.
You must provide the accountId
or organization node in the input, but not both.
If the portfolio is shared to both an external account and an organization node, and both shares need to be updated, you must invoke UpdatePortfolioShare
separately for each share type.
This API cannot be used for removing the portfolio share. You must use DeletePortfolioShare
API for that action.
When you associate a principal with portfolio, a potential privilege escalation path may occur when that portfolio is * then shared with other accounts. For a user in a recipient account who is not an Service Catalog Admin, diff --git a/clients/client-service-catalog/src/commands/AssociatePrincipalWithPortfolioCommand.ts b/clients/client-service-catalog/src/commands/AssociatePrincipalWithPortfolioCommand.ts index 469de8638a1a..22a78705e745 100644 --- a/clients/client-service-catalog/src/commands/AssociatePrincipalWithPortfolioCommand.ts +++ b/clients/client-service-catalog/src/commands/AssociatePrincipalWithPortfolioCommand.ts @@ -38,7 +38,6 @@ export interface AssociatePrincipalWithPortfolioCommandOutput * required.
*You can associate a maximum of 10 Principals with a portfolio using PrincipalType
as IAM_PATTERN
*
When you associate a principal with portfolio, a potential privilege escalation path may occur when that portfolio is * then shared with other accounts. For a user in a recipient account who is not an Service Catalog Admin, diff --git a/clients/client-service-catalog/src/commands/CreatePortfolioShareCommand.ts b/clients/client-service-catalog/src/commands/CreatePortfolioShareCommand.ts index 31470caeee39..87fcd17db5ce 100644 --- a/clients/client-service-catalog/src/commands/CreatePortfolioShareCommand.ts +++ b/clients/client-service-catalog/src/commands/CreatePortfolioShareCommand.ts @@ -34,12 +34,11 @@ export interface CreatePortfolioShareCommandOutput extends CreatePortfolioShareO * organization or by a delegated administrator. You can share portfolios to an organization, * an organizational unit, or a specific account.
*Note that if a delegated admin is de-registered, they can no longer create portfolio shares.
- *+ *
* AWSOrganizationsAccess
must be enabled in order to create a portfolio share to an organization node.
You can't share a shared resource, including portfolios that contain a shared product.
*If the portfolio share with the specified account or organization node already exists, this action will have no effect
* and will not return an error. To update an existing share, you must use the UpdatePortfolioShare
API instead.
When you associate a principal with portfolio, a potential privilege escalation path may occur when that portfolio is * then shared with other accounts. For a user in a recipient account who is not an Service Catalog Admin, diff --git a/clients/client-service-catalog/src/commands/CreateProductCommand.ts b/clients/client-service-catalog/src/commands/CreateProductCommand.ts index 755a690c5e35..abb1f9fbc297 100644 --- a/clients/client-service-catalog/src/commands/CreateProductCommand.ts +++ b/clients/client-service-catalog/src/commands/CreateProductCommand.ts @@ -31,7 +31,6 @@ export interface CreateProductCommandOutput extends CreateProductOutput, __Metad /** *
Creates a product.
*A delegated admin is authorized to invoke this command.
- * *The user or role that performs this operation must have the
* cloudformation:GetTemplate
IAM policy permission. This policy permission is
* required when using the ImportFromPhysicalId
template source in the
diff --git a/clients/client-service-catalog/src/commands/CreateProvisioningArtifactCommand.ts b/clients/client-service-catalog/src/commands/CreateProvisioningArtifactCommand.ts
index 443c66da46a2..1f0c7ad30c3b 100644
--- a/clients/client-service-catalog/src/commands/CreateProvisioningArtifactCommand.ts
+++ b/clients/client-service-catalog/src/commands/CreateProvisioningArtifactCommand.ts
@@ -31,7 +31,6 @@ export interface CreateProvisioningArtifactCommandOutput extends CreateProvision
/**
*
Creates a provisioning artifact (also known as a version) for the specified product.
*You cannot create a provisioning artifact for a product that was shared with you.
- * *The user or role that performs this operation must have the cloudformation:GetTemplate
* IAM policy permission. This policy permission is required when using the
* ImportFromPhysicalId
template source in the information data section.
Gets information about the specified product.
+ *+ * Running this operation + * with administrator access + * results + * in a failure. + * DescribeProductAsAdmin should be used instead. + *
+ *Requests the import of a resource as an Service Catalog provisioned product that is - * associated to an Service Catalog product and provisioning artifact. Once imported, all - * supported Service Catalog governance actions are supported on the provisioned - * product.
- *Resource import only supports CloudFormation stack ARNs. CloudFormation StackSets and - * non-root nested stacks are not supported.
- *The CloudFormation stack must have one of the following statuses to be imported:
- * CREATE_COMPLETE
, UPDATE_COMPLETE
, UPDATE_ROLLBACK_COMPLETE
, IMPORT_COMPLETE
,
- * IMPORT_ROLLBACK_COMPLETE
.
Import of the resource requires that the CloudFormation stack template matches the - * associated Service Catalog product provisioning artifact.
- * - *The user or role that performs this operation must have the cloudformation:GetTemplate
- * and cloudformation:DescribeStacks
IAM policy permissions.
+ * Requests the import + * of a resource + * as an Service Catalog provisioned product + * that is associated + * to an Service Catalog product and provisioning artifact. + * Once imported, + * all supported governance actions are supported + * on the provisioned product. + *
+ *+ * Resource import only supports CloudFormation stack ARNs. CloudFormation StackSets, and non-root nested stacks are not supported. + *
+ *
+ * The CloudFormation stack must have one
+ * of the following statuses
+ * to be imported: CREATE_COMPLETE
, UPDATE_COMPLETE
, UPDATE_ROLLBACK_COMPLETE
, IMPORT_COMPLETE
, and IMPORT_ROLLBACK_COMPLETE
.
+ *
+ * Import + * of the resource requires + * that the CloudFormation stack template matches the associated Service Catalog product provisioning artifact. + *
+ *
+ * When you import an existing CloudFormation stack
+ * into a portfolio,
+ * constraints
+ * that are associated
+ * with the product
+ * aren't applied
+ * during the import process.
+ * The constraints are applied
+ * after you call UpdateProvisionedProduct
+ * for the provisioned product.
+ *
+ * The user or role
+ * that performs this operation
+ * must have the cloudformation:GetTemplate
and cloudformation:DescribeStacks
IAM policy permissions.
+ *
Lists the paths to the specified product. A path is how the user - * has access to a specified product, and is necessary when provisioning a product. A path - * also determines the constraints put on the product.
+ *+ * Lists the paths + * to the specified product. + * A path describes + * how the user + * gets access + * to a specified product + * and is necessary + * when provisioning a product. + * A path also determines the constraints + * that are put on a product. + * A path is dependent + * on a specific product, porfolio, and principal. + *
+ *+ * When provisioning a product + * that's been added + * to a portfolio, + * you must grant your user, group, or role access + * to the portfolio. + * For more information, + * see Granting users access + * in the Service Catalog User Guide. + *
+ *Provisions the specified product.
- *A provisioned product is a resourced instance of a product. - * For example, provisioning a product based on a CloudFormation template launches a - * CloudFormation stack and its underlying resources. - * You can check the status of this request using DescribeRecord.
- *If the request contains a tag key with an empty list of values, there is a - * tag conflict for that key. Do not include conflicted keys as tags, or this causes - * the error "Parameter validation failed: Missing required parameter in - * Tags[N]:Value".
+ *+ * Provisions the specified product. + *
+ *+ * A provisioned product is a resourced instance + * of a product. + * For example, + * provisioning a product + * that's based + * on an CloudFormation template + * launches an CloudFormation stack and its underlying resources. + * You can check the status + * of this request + * using DescribeRecord. + *
+ *+ * If the request contains a tag key + * with an empty list + * of values, + * there's a tag conflict + * for that key. + * Don't include conflicted keys + * as tags, + * or this will cause the error "Parameter validation failed: Missing required parameter in Tags[N]:Value". + *
+ *+ * When provisioning a product + * that's been added + * to a portfolio, + * you must grant your user, group, or role access + * to the portfolio. + * For more information, + * see Granting users access + * in the Service Catalog User Guide. + *
+ *Gets information about the provisioned products that meet the specified criteria.
- * - *To ensure a complete list of provisioned products and remove duplicate products, use
- * sort-by createdTime
.
Here is a CLI example:
- *
- * aws servicecatalog search-provisioned-products --sort-by createdTime
- *
Updates the specified portfolio share. You can use this API to enable or disable TagOptions
sharing
* or Principal sharing for an existing portfolio share.
The portfolio share cannot be updated if the CreatePortfolioShare
operation is IN_PROGRESS
, as the share is not available to recipient entities. In this case, you must wait for the portfolio share to be COMPLETED.
You must provide the accountId
or organization node in the input, but not both.
If the portfolio is shared to both an external account and an organization node, and both shares need to be updated, you must invoke UpdatePortfolioShare
separately for each share type.
This API cannot be used for removing the portfolio share. You must use DeletePortfolioShare
API for that action.
When you associate a principal with portfolio, a potential privilege escalation path may occur when that portfolio is * then shared with other accounts. For a user in a recipient account who is not an Service Catalog Admin, diff --git a/clients/client-service-catalog/src/endpoint/ruleset.ts b/clients/client-service-catalog/src/endpoint/ruleset.ts index 0f957f391b88..b9b163bef70f 100644 --- a/clients/client-service-catalog/src/endpoint/ruleset.ts +++ b/clients/client-service-catalog/src/endpoint/ruleset.ts @@ -6,24 +6,25 @@ import { RuleSetObject } from "@aws-sdk/util-endpoints"; or see "smithy.rules#endpointRuleSet" in codegen/sdk-codegen/aws-models/service-catalog.json */ -const p="required", -q="fn", -r="argv", -s="ref"; -const a="PartitionResult", +const q="required", +r="fn", +s="argv", +t="ref"; +const a="isSet", b="tree", c="error", d="endpoint", -e={[p]:false,"type":"String"}, -f={[p]:true,"default":false,"type":"Boolean"}, -g={[s]:"Endpoint"}, -h={[q]:"booleanEquals",[r]:[{[s]:"UseFIPS"},true]}, -i={[q]:"booleanEquals",[r]:[{[s]:"UseDualStack"},true]}, -j={}, -k={[q]:"booleanEquals",[r]:[true,{[q]:"getAttr",[r]:[{[s]:a},"supportsFIPS"]}]}, -l={[q]:"booleanEquals",[r]:[true,{[q]:"getAttr",[r]:[{[s]:a},"supportsDualStack"]}]}, -m=[g], -n=[h], -o=[i]; -const _data={version:"1.0",parameters:{Region:e,UseDualStack:f,UseFIPS:f,Endpoint:e},rules:[{conditions:[{[q]:"aws.partition",[r]:[{[s]:"Region"}],assign:a}],type:b,rules:[{conditions:[{[q]:"isSet",[r]:m},{[q]:"parseURL",[r]:m,assign:"url"}],type:b,rules:[{conditions:n,error:"Invalid Configuration: FIPS and custom endpoint are not supported",type:c},{type:b,rules:[{conditions:o,error:"Invalid Configuration: Dualstack and custom endpoint are not supported",type:c},{endpoint:{url:g,properties:j,headers:j},type:d}]}]},{conditions:[h,i],type:b,rules:[{conditions:[k,l],type:b,rules:[{endpoint:{url:"https://servicecatalog-fips.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:j,headers:j},type:d}]},{error:"FIPS and DualStack are enabled, but this partition does not support one or both",type:c}]},{conditions:n,type:b,rules:[{conditions:[k],type:b,rules:[{type:b,rules:[{endpoint:{url:"https://servicecatalog-fips.{Region}.{PartitionResult#dnsSuffix}",properties:j,headers:j},type:d}]}]},{error:"FIPS is enabled but this partition does not support FIPS",type:c}]},{conditions:o,type:b,rules:[{conditions:[l],type:b,rules:[{endpoint:{url:"https://servicecatalog.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:j,headers:j},type:d}]},{error:"DualStack is enabled but this partition does not support DualStack",type:c}]},{endpoint:{url:"https://servicecatalog.{Region}.{PartitionResult#dnsSuffix}",properties:j,headers:j},type:d}]}]}; +e="PartitionResult", +f={[q]:false,"type":"String"}, +g={[q]:true,"default":false,"type":"Boolean"}, +h={[t]:"Endpoint"}, +i={[r]:"booleanEquals",[s]:[{[t]:"UseFIPS"},true]}, +j={[r]:"booleanEquals",[s]:[{[t]:"UseDualStack"},true]}, +k={}, +l={[r]:"booleanEquals",[s]:[true,{[r]:"getAttr",[s]:[{[t]:e},"supportsFIPS"]}]}, +m={[r]:"booleanEquals",[s]:[true,{[r]:"getAttr",[s]:[{[t]:e},"supportsDualStack"]}]}, +n=[i], +o=[j], +p=[{[t]:"Region"}]; +const _data={version:"1.0",parameters:{Region:f,UseDualStack:g,UseFIPS:g,Endpoint:f},rules:[{conditions:[{[r]:a,[s]:[h]}],type:b,rules:[{conditions:n,error:"Invalid Configuration: FIPS and custom endpoint are not supported",type:c},{type:b,rules:[{conditions:o,error:"Invalid Configuration: Dualstack and custom endpoint are not supported",type:c},{endpoint:{url:h,properties:k,headers:k},type:d}]}]},{type:b,rules:[{conditions:[{[r]:a,[s]:p}],type:b,rules:[{conditions:[{[r]:"aws.partition",[s]:p,assign:e}],type:b,rules:[{conditions:[i,j],type:b,rules:[{conditions:[l,m],type:b,rules:[{type:b,rules:[{endpoint:{url:"https://servicecatalog-fips.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:k,headers:k},type:d}]}]},{error:"FIPS and DualStack are enabled, but this partition does not support one or both",type:c}]},{conditions:n,type:b,rules:[{conditions:[l],type:b,rules:[{type:b,rules:[{endpoint:{url:"https://servicecatalog-fips.{Region}.{PartitionResult#dnsSuffix}",properties:k,headers:k},type:d}]}]},{error:"FIPS is enabled but this partition does not support FIPS",type:c}]},{conditions:o,type:b,rules:[{conditions:[m],type:b,rules:[{type:b,rules:[{endpoint:{url:"https://servicecatalog.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:k,headers:k},type:d}]}]},{error:"DualStack is enabled but this partition does not support DualStack",type:c}]},{type:b,rules:[{endpoint:{url:"https://servicecatalog.{Region}.{PartitionResult#dnsSuffix}",properties:k,headers:k},type:d}]}]}]},{error:"Invalid Configuration: Missing Region",type:c}]}]}; export const ruleSet: RuleSetObject = _data; diff --git a/clients/client-service-catalog/src/models/models_0.ts b/clients/client-service-catalog/src/models/models_0.ts index 8d8ed7dfb605..7b75c32eec3d 100644 --- a/clients/client-service-catalog/src/models/models_0.ts +++ b/clients/client-service-catalog/src/models/models_0.ts @@ -3361,13 +3361,10 @@ export interface ParameterConstraints { /** *
A string that explains a constraint when the constraint is violated. For example, without a constraint description, a parameter that has an allowed pattern of [A-Za-z0-9]+
displays the following error message when the user specifies an invalid value:
* Malformed input-Parameter MyParameter must match pattern [A-Za-z0-9]+
*
By adding a constraint description, such as must only contain letters (uppercase and lowercase) and numbers, you can display the following customized error message:
- * *
* Malformed input-Parameter MyParameter must only contain uppercase and lowercase letters and numbers.
*
UpdateProvisionedProduct
,
* TerminateProvisionedProduct
, or
* ExecuteProvisionedProductServiceAction
. Only a role ARN is valid. A user ARN is invalid.
- *
* The OWNER
key accepts IAM user ARNs, IAM role ARNs, and STS
* assumed-role ARNs. The owner is the user that has permission to see, update, terminate, and
* execute service actions in the provisioned product.
The type of shared portfolios to accept. The default is to accept imported portfolios.
\n\n AWS_ORGANIZATIONS
- Accept portfolios shared by the management account of your\n organization.
\n IMPORTED
- Accept imported portfolios.
\n AWS_SERVICECATALOG
- Not supported. (Throws ResourceNotFoundException.)
For example, aws servicecatalog accept-portfolio-share --portfolio-id \"port-2qwzkwxt3y5fk\" --portfolio-share-type AWS_ORGANIZATIONS
\n
Associates the specified principal ARN with the specified portfolio.
\nIf you share the portfolio with principal name sharing enabled, the PrincipalARN
association is \n included in the share.
The PortfolioID
, PrincipalARN
, and PrincipalType
parameters are\n required.
You can associate a maximum of 10 Principals with a portfolio using PrincipalType
as IAM_PATTERN
\n
When you associate a principal with portfolio, a potential privilege escalation path may occur when that portfolio is \n then shared with other accounts. For a user in a recipient account who is not an Service Catalog Admin, \n but still has the ability to create Principals (Users/Groups/Roles), that user could create a role that matches a principal \n name association for the portfolio. Although this user may not know which principal names are associated through \n Service Catalog, they may be able to guess the user. If this potential escalation path is a concern, then \n Service Catalog recommends using PrincipalType
as IAM
. With this configuration, \n the PrincipalARN
must already exist in the recipient account before it can be associated.
Associates the specified principal ARN with the specified portfolio.
\nIf you share the portfolio with principal name sharing enabled, the PrincipalARN
association is \n included in the share.
The PortfolioID
, PrincipalARN
, and PrincipalType
parameters are\n required.
You can associate a maximum of 10 Principals with a portfolio using PrincipalType
as IAM_PATTERN
\n
When you associate a principal with portfolio, a potential privilege escalation path may occur when that portfolio is \n then shared with other accounts. For a user in a recipient account who is not an Service Catalog Admin, \n but still has the ability to create Principals (Users/Groups/Roles), that user could create a role that matches a principal \n name association for the portfolio. Although this user may not know which principal names are associated through \n Service Catalog, they may be able to guess the user. If this potential escalation path is a concern, then \n Service Catalog recommends using PrincipalType
as IAM
. With this configuration, \n the PrincipalARN
must already exist in the recipient account before it can be associated.
The identifier of the source portfolio.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.servicecatalog#AssociateProductWithPortfolioOutput": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.servicecatalog#AssociateServiceActionWithProvisioningArtifact": { "type": "operation", @@ -2405,11 +1684,17 @@ "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
An object that contains a list of errors, along with information to help you identify the self-service action.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.servicecatalog#BatchDisassociateServiceActionFromProvisioningArtifact": { @@ -2548,6 +1845,9 @@ "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
An object that contains a list of errors, along with information to help you identify the self-service action.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.servicecatalog#Boolean": { @@ -2822,7 +2125,7 @@ } ], "traits": { - "smithy.api#documentation": "Copies the specified source product to the specified target product or a new\n product.
\nYou can copy a product to the same account or another account. You can copy a product\n to the same Region or another Region. If you copy a product to another account, you must\n first share the product in a portfolio using CreatePortfolioShare.
\nThis operation is performed asynchronously. To track the progress of the\n operation, use DescribeCopyProductStatus.
" + "smithy.api#documentation": "Copies the specified source product to the specified target product or a new\n product.
\nYou can copy a product to the same account or another account. You can copy a product\n to the same Region or another Region. If you copy a product to another account, you must\n first share the product in a portfolio using CreatePortfolioShare.
\nThis operation is performed asynchronously. To track the progress of the\n operation, use DescribeCopyProductStatus.
" } }, "com.amazonaws.servicecatalog#CopyProductInput": { @@ -2873,6 +2176,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.servicecatalog#CopyProductOutput": { @@ -2884,6 +2190,9 @@ "smithy.api#documentation": "The token to use to track the progress of the operation.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.servicecatalog#CopyProductStatus": { @@ -2986,6 +2295,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.servicecatalog#CreateConstraintOutput": { @@ -3009,6 +2321,9 @@ "smithy.api#documentation": "The status of the current request.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.servicecatalog#CreatePortfolio": { @@ -3077,6 +2392,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.servicecatalog#CreatePortfolioOutput": { @@ -3094,6 +2412,9 @@ "smithy.api#documentation": "Information about the tags associated with the portfolio.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.servicecatalog#CreatePortfolioShare": { @@ -3122,7 +2443,7 @@ } ], "traits": { - "smithy.api#documentation": "Shares the specified portfolio with the specified account or organization node.\n Shares to an organization node can only be created by the management account of an\n organization or by a delegated administrator. You can share portfolios to an organization,\n an organizational unit, or a specific account.
\nNote that if a delegated admin is de-registered, they can no longer create portfolio shares.
\n\n AWSOrganizationsAccess
must be enabled in order to create a portfolio share to an organization node.
You can't share a shared resource, including portfolios that contain a shared product.
\nIf the portfolio share with the specified account or organization node already exists, this action will have no effect \n and will not return an error. To update an existing share, you must use the UpdatePortfolioShare
API instead.
When you associate a principal with portfolio, a potential privilege escalation path may occur when that portfolio is \n then shared with other accounts. For a user in a recipient account who is not an Service Catalog Admin, \n but still has the ability to create Principals (Users/Groups/Roles), that user could create a role that matches a principal \n name association for the portfolio. Although this user may not know which principal names are associated through \n Service Catalog, they may be able to guess the user. If this potential escalation path is a concern, then \n Service Catalog recommends using PrincipalType
as IAM
. With this configuration, \n the PrincipalARN
must already exist in the recipient account before it can be associated.
Shares the specified portfolio with the specified account or organization node.\n Shares to an organization node can only be created by the management account of an\n organization or by a delegated administrator. You can share portfolios to an organization,\n an organizational unit, or a specific account.
\nNote that if a delegated admin is de-registered, they can no longer create portfolio shares.
\n\n AWSOrganizationsAccess
must be enabled in order to create a portfolio share to an organization node.
You can't share a shared resource, including portfolios that contain a shared product.
\nIf the portfolio share with the specified account or organization node already exists, this action will have no effect \n and will not return an error. To update an existing share, you must use the UpdatePortfolioShare
API instead.
When you associate a principal with portfolio, a potential privilege escalation path may occur when that portfolio is \n then shared with other accounts. For a user in a recipient account who is not an Service Catalog Admin, \n but still has the ability to create Principals (Users/Groups/Roles), that user could create a role that matches a principal \n name association for the portfolio. Although this user may not know which principal names are associated through \n Service Catalog, they may be able to guess the user. If this potential escalation path is a concern, then \n Service Catalog recommends using PrincipalType
as IAM
. With this configuration, \n the PrincipalARN
must already exist in the recipient account before it can be associated.
Enables or disables Principal
sharing when creating the portfolio share. If this flag is not provided,\n principal sharing is disabled.
When you enable Principal Name Sharing for a portfolio share, the share recipient\n account end users with a principal that matches any of the associated IAM\n patterns can provision products from the portfolio. Once\n shared, the share recipient can view associations of PrincipalType
: \n IAM_PATTERN
on their portfolio. You can create the principals in the recipient account before or \n after creating the share.
The portfolio shares a unique identifier that only returns if the portfolio is shared to an organization node.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.servicecatalog#CreateProduct": { @@ -3200,7 +2527,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a product.
\nA delegated admin is authorized to invoke this command.
\n \nThe user or role that performs this operation must have the\n cloudformation:GetTemplate
IAM policy permission. This policy permission is\n required when using the ImportFromPhysicalId
template source in the\n information data section.
Creates a product.
\nA delegated admin is authorized to invoke this command.
\nThe user or role that performs this operation must have the\n cloudformation:GetTemplate
IAM policy permission. This policy permission is\n required when using the ImportFromPhysicalId
template source in the\n information data section.
Specifies connection details for the created product and syncs the product to the connection source\n artifact. This automatically manages the product's artifacts based on changes to the source.\n The SourceConnection
parameter consists of the following sub-fields.
\n Type
\n
\n ConnectionParamters
\n
Information about the tags associated with the product.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.servicecatalog#CreateProvisionedProductPlan": { @@ -3334,7 +2667,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a plan.
\nA plan includes the list of resources to be \n created (when provisioning a new product) or modified (when updating a provisioned product)\n when the plan is executed.
\nYou can create one plan for each provisioned product. To create a plan for an existing \n provisioned product, the product status must be AVAILABLE or TAINTED.
\nTo view the resource changes in the change set, use DescribeProvisionedProductPlan.\n To create or modify the provisioned product, use ExecuteProvisionedProductPlan.
" + "smithy.api#documentation": "Creates a plan.
\nA plan includes the list of resources to be \n created (when provisioning a new product) or modified (when updating a provisioned product)\n when the plan is executed.
\nYou can create one plan for each provisioned product. To create a plan for an existing \n provisioned product, the product status must be AVAILABLE or TAINTED.
\nTo view the resource changes in the change set, use DescribeProvisionedProductPlan.\n To create or modify the provisioned product, use ExecuteProvisionedProductPlan.
" } }, "com.amazonaws.servicecatalog#CreateProvisionedProductPlanInput": { @@ -3413,6 +2746,9 @@ "smithy.api#documentation": "One or more tags.
\nIf the plan is for an existing provisioned product, the product must have a RESOURCE_UPDATE
constraint with TagUpdatesOnProvisionedProduct
set to ALLOWED
to allow tag updates.
The identifier of the provisioning artifact.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.servicecatalog#CreateProvisioningArtifact": { @@ -3470,7 +2809,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a provisioning artifact (also known as a version) for the specified product.
\nYou cannot create a provisioning artifact for a product that was shared with you.
\n \nThe user or role that performs this operation must have the cloudformation:GetTemplate
\n IAM policy permission. This policy permission is required when using the\n ImportFromPhysicalId
template source in the information data section.
Creates a provisioning artifact (also known as a version) for the specified product.
\nYou cannot create a provisioning artifact for a product that was shared with you.
\nThe user or role that performs this operation must have the cloudformation:GetTemplate
\n IAM policy permission. This policy permission is required when using the\n ImportFromPhysicalId
template source in the information data section.
The status of the current request.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.servicecatalog#CreateServiceAction": { @@ -3593,6 +2938,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.servicecatalog#CreateServiceActionOutput": { @@ -3604,6 +2952,9 @@ "smithy.api#documentation": "An object containing information about the self-service action.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.servicecatalog#CreateTagOption": { @@ -3646,6 +2997,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.servicecatalog#CreateTagOptionOutput": { @@ -3657,6 +3011,9 @@ "smithy.api#documentation": "Information about the TagOption.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.servicecatalog#CreatedTime": { @@ -3704,11 +3061,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.servicecatalog#DeleteConstraintOutput": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.servicecatalog#DeletePortfolio": { "type": "operation", @@ -3752,11 +3115,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.servicecatalog#DeletePortfolioOutput": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.servicecatalog#DeletePortfolioShare": { "type": "operation", @@ -3812,6 +3181,9 @@ "smithy.api#documentation": "The organization node to whom you are going to stop sharing.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.servicecatalog#DeletePortfolioShareOutput": { @@ -3823,6 +3195,9 @@ "smithy.api#documentation": "The portfolio share unique identifier. This will only be returned if delete is made to an organization node.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.servicecatalog#DeleteProduct": { @@ -3867,11 +3242,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.servicecatalog#DeleteProductOutput": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.servicecatalog#DeleteProvisionedProductPlan": { "type": "operation", @@ -3916,11 +3297,17 @@ "smithy.api#documentation": "If set to true, Service Catalog stops managing the specified provisioned product even\n if it cannot delete the underlying resources.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.servicecatalog#DeleteProvisionedProductPlanOutput": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.servicecatalog#DeleteProvisioningArtifact": { "type": "operation", @@ -3942,7 +3329,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes the specified provisioning artifact (also known as a version) for the specified product.
\nYou cannot delete a provisioning artifact associated with a product that was shared with you. \n You cannot delete the last provisioning artifact for a product, because a product must have at \n least one provisioning artifact.
" + "smithy.api#documentation": "Deletes the specified provisioning artifact (also known as a version) for the specified product.
\nYou cannot delete a provisioning artifact associated with a product that was shared with you. \n You cannot delete the last provisioning artifact for a product, because a product must have at \n least one provisioning artifact.
" } }, "com.amazonaws.servicecatalog#DeleteProvisioningArtifactInput": { @@ -3968,11 +3355,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.servicecatalog#DeleteProvisioningArtifactOutput": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.servicecatalog#DeleteServiceAction": { "type": "operation", @@ -4010,11 +3403,17 @@ "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The status of the current request.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.servicecatalog#DescribeCopyProductStatus": { @@ -4147,6 +3558,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.servicecatalog#DescribeCopyProductStatusOutput": { @@ -4170,6 +3584,9 @@ "smithy.api#documentation": "The status message.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.servicecatalog#DescribePortfolio": { @@ -4205,6 +3622,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.servicecatalog#DescribePortfolioOutput": { @@ -4234,6 +3654,9 @@ "smithy.api#documentation": "Information about the associated budgets.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.servicecatalog#DescribePortfolioShareStatus": { @@ -4269,6 +3692,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.servicecatalog#DescribePortfolioShareStatusOutput": { @@ -4304,6 +3730,9 @@ "smithy.api#documentation": "Information about the portfolio share operation.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.servicecatalog#DescribePortfolioShareType": { @@ -4390,6 +3819,9 @@ "smithy.api#documentation": "The maximum number of items to return with this call.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.servicecatalog#DescribePortfolioSharesOutput": { @@ -4407,6 +3839,9 @@ "smithy.api#documentation": "Summaries about each of the portfolio shares.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.servicecatalog#DescribeProduct": { @@ -4426,7 +3861,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets information about the specified product.
" + "smithy.api#documentation": "Gets information about the specified product.
\n\n Running this operation \n with administrator access \n results \n in a failure. \n DescribeProductAsAdmin should be used instead. \n
\nThe unique identifier of the shared portfolio that the specified product is associated\n with.
\nYou can provide this parameter to retrieve the shared TagOptions associated with the\n product. If this parameter is provided and if TagOptions sharing is enabled in the\n portfolio share, the API returns both local and shared TagOptions associated with the\n product. Otherwise only local TagOptions will be returned.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.servicecatalog#DescribeProductAsAdminOutput": { @@ -4511,6 +3949,9 @@ "smithy.api#documentation": "Information about the associated budgets.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.servicecatalog#DescribeProductInput": { @@ -4534,6 +3975,9 @@ "smithy.api#documentation": "The product name.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.servicecatalog#DescribeProductOutput": { @@ -4563,6 +4007,9 @@ "smithy.api#documentation": "Information about the associated launch paths.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.servicecatalog#DescribeProductView": { @@ -4601,6 +4048,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.servicecatalog#DescribeProductViewOutput": { @@ -4618,6 +4068,9 @@ "smithy.api#documentation": "Information about the provisioning artifacts for the product.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.servicecatalog#DescribeProvisionedProduct": { @@ -4663,7 +4116,8 @@ } }, "traits": { - "smithy.api#documentation": "DescribeProvisionedProductAPI input structure.\n\n AcceptLanguage - [Optional]\n The language code for localization.\n\n Id - [Optional]\n The provisioned product identifier.\n\n Name - [Optional]\n Another provisioned product identifier. Customers must provide either Id or Name." + "smithy.api#documentation": "DescribeProvisionedProductAPI input structure.\n\n AcceptLanguage - [Optional]\n The language code for localization.\n\n Id - [Optional]\n The provisioned product identifier.\n\n Name - [Optional]\n Another provisioned product identifier. Customers must provide either Id or Name.", + "smithy.api#input": {} } }, "com.amazonaws.servicecatalog#DescribeProvisionedProductOutput": { @@ -4681,6 +4135,9 @@ "smithy.api#documentation": "Any CloudWatch dashboards that were created when provisioning the product.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.servicecatalog#DescribeProvisionedProductPlan": { @@ -4732,6 +4189,9 @@ "smithy.api#documentation": "The page token for the next set of results. To retrieve the first set of results, use null.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.servicecatalog#DescribeProvisionedProductPlanOutput": { @@ -4755,6 +4215,9 @@ "smithy.api#documentation": "The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.servicecatalog#DescribeProvisioningArtifact": { @@ -4817,6 +4280,9 @@ "smithy.api#documentation": "Indicates whether a verbose level of detail is enabled.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.servicecatalog#DescribeProvisioningArtifactOutput": { @@ -4840,6 +4306,9 @@ "smithy.api#documentation": "The status of the current request.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.servicecatalog#DescribeProvisioningParameters": { @@ -4907,6 +4376,9 @@ "smithy.api#documentation": "The name of the path. You must provide the name or ID, but not both.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.servicecatalog#DescribeProvisioningParametersOutput": { @@ -4957,6 +4429,9 @@ "smithy.api#documentation": "A list of the keys and descriptions of the outputs. These outputs can be referenced from a provisioned product launched from this provisioning artifact.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.servicecatalog#DescribeRecord": { @@ -4973,7 +4448,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets information about the specified request operation.
\nUse this operation after calling a request operation (for example, ProvisionProduct, \n TerminateProvisionedProduct, or UpdateProvisionedProduct).\n
\nIf a provisioned product was transferred to a new owner using UpdateProvisionedProductProperties, the new owner \n will be able to describe all past records for that product. The previous owner will no longer be able to describe the records, but will be able to \n use ListRecordHistory to see the product's history from when he was the owner.
\nGets information about the specified request operation.
\nUse this operation after calling a request operation (for example, ProvisionProduct, \n TerminateProvisionedProduct, or UpdateProvisionedProduct).\n
\nIf a provisioned product was transferred to a new owner using UpdateProvisionedProductProperties, the new owner \n will be able to describe all past records for that product. The previous owner will no longer be able to describe the records, but will be able to \n use ListRecordHistory to see the product's history from when he was the owner.
\nThe maximum number of items to return with this call.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.servicecatalog#DescribeRecordOutput": { @@ -5028,6 +4506,9 @@ "smithy.api#documentation": "The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.servicecatalog#DescribeServiceAction": { @@ -5090,6 +4571,9 @@ "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The parameters of the self-service action.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.servicecatalog#DescribeServiceActionInput": { @@ -5119,6 +4606,9 @@ "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
Detailed information about the self-service action.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.servicecatalog#DescribeTagOption": { @@ -5163,6 +4656,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.servicecatalog#DescribeTagOptionOutput": { @@ -5174,6 +4670,9 @@ "smithy.api#documentation": "Information about the TagOption.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.servicecatalog#Description": { @@ -5204,11 +4703,17 @@ }, "com.amazonaws.servicecatalog#DisableAWSOrganizationsAccessInput": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#input": {} + } }, "com.amazonaws.servicecatalog#DisableAWSOrganizationsAccessOutput": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.servicecatalog#DisableTemplateValidation": { "type": "boolean", @@ -5250,11 +4755,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.servicecatalog#DisassociateBudgetFromResourceOutput": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.servicecatalog#DisassociatePrincipalFromPortfolio": { "type": "operation", @@ -5305,11 +4816,17 @@ "smithy.api#documentation": "The supported value is IAM
if you use a fully defined ARN, or IAM_PATTERN
\n if you use no accountID
.
The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
Information about the result of provisioning the product.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.servicecatalog#ExecuteProvisionedProductServiceAction": { @@ -5659,6 +5206,9 @@ "smithy.api#documentation": "A map of all self-service action parameters and their values. If a provided parameter is of a special type, such as TARGET
, the provided value will \n override the default value generated by Service Catalog. If the parameters field is not provided, no additional parameters are passed and default values will be used for \n any special parameters such as TARGET
.
An object containing detailed information about the result of provisioning the product.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.servicecatalog#ExecutionParameter": { @@ -5830,7 +5383,10 @@ }, "com.amazonaws.servicecatalog#GetAWSOrganizationsAccessStatusInput": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#input": {} + } }, "com.amazonaws.servicecatalog#GetAWSOrganizationsAccessStatusOutput": { "type": "structure", @@ -5841,6 +5397,9 @@ "smithy.api#documentation": "The status of the portfolio share feature.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.servicecatalog#GetProvisionedProductOutputs": { @@ -5908,6 +5467,9 @@ "smithy.api#documentation": "The page token for the next set of results. To retrieve the first set of results, use null.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.servicecatalog#GetProvisionedProductOutputsOutput": { @@ -5925,6 +5487,9 @@ "smithy.api#documentation": "The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.servicecatalog#HasDefaultPath": { @@ -5982,7 +5547,7 @@ } ], "traits": { - "smithy.api#documentation": "Requests the import of a resource as an Service Catalog provisioned product that is\n associated to an Service Catalog product and provisioning artifact. Once imported, all\n supported Service Catalog governance actions are supported on the provisioned\n product.
\nResource import only supports CloudFormation stack ARNs. CloudFormation StackSets and\n non-root nested stacks are not supported.
\nThe CloudFormation stack must have one of the following statuses to be imported:\n CREATE_COMPLETE
, UPDATE_COMPLETE
, UPDATE_ROLLBACK_COMPLETE
, IMPORT_COMPLETE
,\n IMPORT_ROLLBACK_COMPLETE
.
Import of the resource requires that the CloudFormation stack template matches the\n associated Service Catalog product provisioning artifact.
\n \nThe user or role that performs this operation must have the cloudformation:GetTemplate
\n and cloudformation:DescribeStacks
IAM policy permissions.
\n Requests the import \n of a resource \n as an Service Catalog provisioned product \n that is associated \n to an Service Catalog product and provisioning artifact. \n Once imported, \n all supported governance actions are supported \n on the provisioned product.\n
\n\n Resource import only supports CloudFormation stack ARNs. CloudFormation StackSets, and non-root nested stacks are not supported.\n
\n\n The CloudFormation stack must have one \n of the following statuses \n to be imported: CREATE_COMPLETE
, UPDATE_COMPLETE
, UPDATE_ROLLBACK_COMPLETE
, IMPORT_COMPLETE
, and IMPORT_ROLLBACK_COMPLETE
.\n
\n Import \n of the resource requires \n that the CloudFormation stack template matches the associated Service Catalog product provisioning artifact.\n
\n\n When you import an existing CloudFormation stack \n into a portfolio, \n constraints \n that are associated \n with the product \n aren't applied \n during the import process. \n The constraints are applied \n after you call UpdateProvisionedProduct
\n for the provisioned product.\n
\n The user or role \n that performs this operation \n must have the cloudformation:GetTemplate
and cloudformation:DescribeStacks
IAM policy permissions.\n
The type of shared portfolios to list. The default is to list imported portfolios.
\n\n AWS_ORGANIZATIONS
- List portfolios accepted and shared via organizational sharing by the management account or delegated administrator of your organization.
\n AWS_SERVICECATALOG
- Deprecated type.
\n IMPORTED
- List imported portfolios that have been accepted and\n shared through account-to-account sharing.
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.servicecatalog#ListBudgetsForResource": { @@ -6339,6 +5916,9 @@ "smithy.api#documentation": "The page token for the next set of results. To retrieve the first set of results, use null.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.servicecatalog#ListBudgetsForResourceOutput": { @@ -6356,6 +5936,9 @@ "smithy.api#documentation": "The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.servicecatalog#ListConstraintsForPortfolio": { @@ -6418,6 +6001,9 @@ "smithy.api#documentation": "The page token for the next set of results. To retrieve the first set of results, use null.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.servicecatalog#ListConstraintsForPortfolioOutput": { @@ -6435,6 +6021,9 @@ "smithy.api#documentation": "The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.servicecatalog#ListLaunchPaths": { @@ -6454,7 +6043,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists the paths to the specified product. A path is how the user\n has access to a specified product, and is necessary when provisioning a product. A path\n also determines the constraints put on the product.
", + "smithy.api#documentation": "\n Lists the paths \n to the specified product. \n A path describes\n how the user\n gets access \n to a specified product\n and is necessary \n when provisioning a product. \n A path also determines the constraints \n that are put on a product. \n A path is dependent \n on a specific product, porfolio, and principal.\n
\n\n When provisioning a product \n that's been added \n to a portfolio, \n you must grant your user, group, or role access \n to the portfolio. \n For more information, \n see Granting users access \n in the Service Catalog User Guide.\n
\nThe page token for the next set of results. To retrieve the first set of results, use null.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.servicecatalog#ListLaunchPathsOutput": { @@ -6508,6 +6100,9 @@ "smithy.api#documentation": "The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.servicecatalog#ListOrganizationPortfolioAccess": { @@ -6574,6 +6169,9 @@ "smithy.api#documentation": "The maximum number of items to return with this call.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.servicecatalog#ListOrganizationPortfolioAccessOutput": { @@ -6591,6 +6189,9 @@ "smithy.api#documentation": "The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.servicecatalog#ListPortfolioAccess": { @@ -6653,6 +6254,9 @@ "smithy.api#documentation": "The maximum number of items to return with this call.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.servicecatalog#ListPortfolioAccessOutput": { @@ -6670,6 +6274,9 @@ "smithy.api#documentation": "The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.servicecatalog#ListPortfolios": { @@ -6748,6 +6355,9 @@ "smithy.api#documentation": "The maximum number of items to return with this call.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.servicecatalog#ListPortfoliosForProductOutput": { @@ -6765,6 +6375,9 @@ "smithy.api#documentation": "The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.servicecatalog#ListPortfoliosInput": { @@ -6789,6 +6402,9 @@ "smithy.api#documentation": "The maximum number of items to return with this call.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.servicecatalog#ListPortfoliosOutput": { @@ -6806,6 +6422,9 @@ "smithy.api#documentation": "The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.servicecatalog#ListPrincipalsForPortfolio": { @@ -6862,6 +6481,9 @@ "smithy.api#documentation": "The page token for the next set of results. To retrieve the first set of results, use null.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.servicecatalog#ListPrincipalsForPortfolioOutput": { @@ -6879,6 +6501,9 @@ "smithy.api#documentation": "The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.servicecatalog#ListProvisionedProductPlans": { @@ -6935,6 +6560,9 @@ "smithy.api#documentation": "The access level to use to obtain results. The default is User
.
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.servicecatalog#ListProvisioningArtifacts": { @@ -7028,6 +6659,9 @@ "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.servicecatalog#ListProvisioningArtifactsInput": { @@ -7063,6 +6700,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.servicecatalog#ListProvisioningArtifactsOutput": { @@ -7080,6 +6720,9 @@ "smithy.api#documentation": "The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.servicecatalog#ListRecordHistory": { @@ -7133,6 +6776,9 @@ "smithy.api#documentation": "The page token for the next set of results. To retrieve the first set of results, use null.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.servicecatalog#ListRecordHistoryOutput": { @@ -7150,6 +6796,9 @@ "smithy.api#documentation": "The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.servicecatalog#ListRecordHistorySearchFilter": { @@ -7233,6 +6882,9 @@ "smithy.api#httpQuery": "pageToken" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.servicecatalog#ListResourcesForTagOptionOutput": { @@ -7250,6 +6902,9 @@ "smithy.api#documentation": "The page token for the next set of results. To retrieve the first set of results, use null.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.servicecatalog#ListServiceActions": { @@ -7335,6 +6990,9 @@ "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.servicecatalog#ListServiceActionsInput": { @@ -7376,6 +7037,9 @@ "smithy.api#documentation": "The page token for the next set of results. To retrieve the first set of results, use null.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.servicecatalog#ListServiceActionsOutput": { @@ -7393,6 +7057,9 @@ "smithy.api#documentation": "The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.servicecatalog#ListStackInstancesForProvisionedProduct": { @@ -7444,6 +7111,9 @@ "smithy.api#documentation": "The maximum number of items to return with this call.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.servicecatalog#ListStackInstancesForProvisionedProductOutput": { @@ -7461,6 +7131,9 @@ "smithy.api#documentation": "The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.servicecatalog#ListTagOptions": { @@ -7536,6 +7209,9 @@ "smithy.api#documentation": "The page token for the next set of results. To retrieve the first set of results, use null.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.servicecatalog#ListTagOptionsOutput": { @@ -7553,6 +7229,9 @@ "smithy.api#documentation": "The page token for the next set of results. To retrieve the first set of results, use null.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.servicecatalog#LogicalResourceId": { @@ -7743,7 +7422,7 @@ "ConstraintDescription": { "target": "com.amazonaws.servicecatalog#String", "traits": { - "smithy.api#documentation": "A string that explains a constraint when the constraint is violated. For example, without a constraint description, a parameter that has an allowed pattern of [A-Za-z0-9]+
displays the following error message when the user specifies an invalid value:
\n Malformed input-Parameter MyParameter must match pattern [A-Za-z0-9]+
\n
By adding a constraint description, such as must only contain letters (uppercase and lowercase) and numbers, you can display the following customized error message:
\n \n\n Malformed input-Parameter MyParameter must only contain uppercase and lowercase letters and numbers.
\n
A string that explains a constraint when the constraint is violated. For example, without a constraint description, a parameter that has an allowed pattern of [A-Za-z0-9]+
displays the following error message when the user specifies an invalid value:
\n Malformed input-Parameter MyParameter must match pattern [A-Za-z0-9]+
\n
By adding a constraint description, such as must only contain letters (uppercase and lowercase) and numbers, you can display the following customized error message:
\n\n Malformed input-Parameter MyParameter must only contain uppercase and lowercase letters and numbers.
\n
Provisions the specified product.
\nA provisioned product is a resourced instance of a product. \n For example, provisioning a product based on a CloudFormation template launches a\n CloudFormation stack and its underlying resources.\n You can check the status of this request using DescribeRecord.
\nIf the request contains a tag key with an empty list of values, there is a\n tag conflict for that key. Do not include conflicted keys as tags, or this causes\n the error \"Parameter validation failed: Missing required parameter in\n Tags[N]:Value\".
" + "smithy.api#documentation": "\n Provisions the specified product.\n
\n\n A provisioned product is a resourced instance \n of a product. \n For example, \n provisioning a product \n that's based \n on an CloudFormation template \n launches an CloudFormation stack and its underlying resources.\n You can check the status \n of this request \n using DescribeRecord.\n
\n\n If the request contains a tag key \n with an empty list \n of values, \n there's a tag conflict \n for that key. \n Don't include conflicted keys \n as tags, \n or this will cause the error \"Parameter validation failed: Missing required parameter in Tags[N]:Value\".\n
\n\n When provisioning a product \n that's been added \n to a portfolio, \n you must grant your user, group, or role access \n to the portfolio. \n For more information, \n see Granting users access \n in the Service Catalog User Guide.\n
\nInformation about the result of provisioning the product.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.servicecatalog#ProvisionedProductAttribute": { @@ -9306,7 +8991,7 @@ "Info": { "target": "com.amazonaws.servicecatalog#ProvisioningArtifactInfo", "traits": { - "smithy.api#documentation": "Specify the template source with one of the following options, but not both.\n Keys accepted: [ LoadTemplateFromURL
, ImportFromPhysicalId
]
The URL of the CloudFormation template in Amazon S3 or GitHub in JSON format.\n Specify the URL in JSON format as follows:
\n\n \"LoadTemplateFromURL\": \"https://s3.amazonaws.com/cf-templates-ozkq9d3hgiq2-us-east-1/...\"
\n
\n ImportFromPhysicalId
: The physical id of the resource that contains the\n template. Currently only supports CloudFormation stack arn. Specify the physical id in JSON\n format as follows: ImportFromPhysicalId: “arn:aws:cloudformation:[us-east-1]:[accountId]:stack/[StackName]/[resourceId]
\n
Specify the template source with one of the following options, but not both.\n Keys accepted: [ LoadTemplateFromURL
, ImportFromPhysicalId
]
The URL of the CloudFormation template in Amazon S3 or GitHub in JSON format.\n Specify the URL in JSON format as follows:
\n\n \"LoadTemplateFromURL\": \"https://s3.amazonaws.com/cf-templates-ozkq9d3hgiq2-us-east-1/...\"
\n
\n ImportFromPhysicalId
: The physical id of the resource that contains the\n template. Currently only supports CloudFormation stack arn. Specify the physical id in JSON\n format as follows: ImportFromPhysicalId: “arn:aws:cloudformation:[us-east-1]:[accountId]:stack/[StackName]/[resourceId]
\n
The type of shared portfolios to reject. The default is to reject imported portfolios.
\n\n AWS_ORGANIZATIONS
- Reject portfolios shared by the management account of your\n organization.
\n IMPORTED
- Reject imported portfolios.
\n AWS_SERVICECATALOG
- Not supported. (Throws ResourceNotFoundException.)
For example, aws servicecatalog reject-portfolio-share --portfolio-id \"port-2qwzkwxt3y5fk\" --portfolio-share-type AWS_ORGANIZATIONS
\n
The page token for the next set of results. To retrieve the first set of results, use null.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.servicecatalog#ScanProvisionedProductsOutput": { @@ -10208,6 +9902,9 @@ "smithy.api#documentation": "The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.servicecatalog#Scope": { @@ -10321,6 +10018,9 @@ "smithy.api#documentation": "Access level of the source of the product.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.servicecatalog#SearchProductsAsAdminOutput": { @@ -10338,6 +10038,9 @@ "smithy.api#documentation": "The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.servicecatalog#SearchProductsInput": { @@ -10380,6 +10083,9 @@ "smithy.api#documentation": "The page token for the next set of results. To retrieve the first set of results, use null.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.servicecatalog#SearchProductsOutput": { @@ -10403,6 +10109,9 @@ "smithy.api#documentation": "The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.servicecatalog#SearchProvisionedProducts": { @@ -10419,7 +10128,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets information about the provisioned products that meet the specified criteria.
\n \nTo ensure a complete list of provisioned products and remove duplicate products, use\n sort-by createdTime
.
Here is a CLI example:
\n
\n aws servicecatalog search-provisioned-products --sort-by createdTime
\n
Gets information about the provisioned products that meet the specified criteria.
", "smithy.api#paginated": { "inputToken": "PageToken", "outputToken": "NextPageToken", @@ -10445,7 +10154,7 @@ "Filters": { "target": "com.amazonaws.servicecatalog#ProvisionedProductFilters", "traits": { - "smithy.api#documentation": "The search filters.
\nWhen the key is SearchQuery
, the searchable fields are arn
, \n createdTime
, id
, lastRecordId
,\n idempotencyToken
, name
, physicalId
, productId
, \n provisioningArtifact
, type
, status
,\n tags
, userArn
, userArnSession
, lastProvisioningRecordId
, lastSuccessfulProvisioningRecordId
, \n productName
, and provisioningArtifactName
.
Example: \"SearchQuery\":[\"status:AVAILABLE\"]
\n
The search filters.
\nWhen the key is SearchQuery
, the searchable fields are arn
, \n createdTime
, id
, lastRecordId
,\n idempotencyToken
, name
, physicalId
, productId
, \n provisioningArtifact
, type
, status
,\n tags
, userArn
, userArnSession
, lastProvisioningRecordId
, lastSuccessfulProvisioningRecordId
, \n productName
, and provisioningArtifactName
.
Example: \"SearchQuery\":[\"status:AVAILABLE\"]
\n
The page token for the next set of results. To retrieve the first set of results, use null.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.servicecatalog#SearchProvisionedProductsOutput": { @@ -10497,6 +10209,9 @@ "smithy.api#documentation": "The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.servicecatalog#SearchProvisionedProductsPageSize": { @@ -11370,6 +11085,9 @@ "smithy.api#documentation": "When this boolean parameter is set to true, the TerminateProvisionedProduct
API deletes\n the Service Catalog provisioned product. However, it does not remove the CloudFormation\n stack, stack set, or the underlying resources of the deleted provisioned product. The\n default value is false.
Information about the result of this request.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.servicecatalog#TotalResultsCount": { @@ -11437,6 +11158,9 @@ "smithy.api#documentation": "The constraint parameters, in JSON format. The syntax depends on the constraint type as follows:
\nYou are required to specify either the RoleArn
or the LocalRoleName
but can't use both.
Specify the RoleArn
property as follows:
\n {\"RoleArn\" : \"arn:aws:iam::123456789012:role/LaunchRole\"}
\n
Specify the LocalRoleName
property as follows:
\n {\"LocalRoleName\": \"SCBasicLaunchRole\"}
\n
If you specify the LocalRoleName
property, when an account uses the launch constraint, the IAM role with that name in the account will be used. This allows launch-role constraints to be \n account-agnostic so the administrator can create fewer resources per shared account.
The given role name must exist in the account used to create the launch constraint and the account of the user who launches a product with this launch constraint.
\nYou cannot have both a LAUNCH
and a STACKSET
constraint.
You also cannot have more than one LAUNCH
constraint on a product and portfolio.
Specify the NotificationArns
property as follows:
\n {\"NotificationArns\" : [\"arn:aws:sns:us-east-1:123456789012:Topic\"]}
\n
Specify the TagUpdatesOnProvisionedProduct
property as follows:
\n {\"Version\":\"2.0\",\"Properties\":{\"TagUpdateOnProvisionedProduct\":\"String\"}}
\n
The TagUpdatesOnProvisionedProduct
property accepts a string value of ALLOWED
or NOT_ALLOWED
.
Specify the Parameters
property as follows:
\n {\"Version\": \"String\", \"Properties\": {\"AccountList\": [ \"String\" ], \"RegionList\": [ \"String\" ], \"AdminRole\": \"String\", \"ExecutionRole\": \"String\"}}
\n
You cannot have both a LAUNCH
and a STACKSET
constraint.
You also cannot have more than one STACKSET
constraint on a product and portfolio.
Products with a STACKSET
constraint will launch an CloudFormation stack set.
Specify the Rules
property. For more information, see\n Template Constraint Rules.
The status of the current request.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.servicecatalog#UpdatePortfolio": { @@ -11534,6 +11261,9 @@ "smithy.api#documentation": "The tags to remove.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.servicecatalog#UpdatePortfolioOutput": { @@ -11551,6 +11281,9 @@ "smithy.api#documentation": "Information about the tags associated with the portfolio.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.servicecatalog#UpdatePortfolioShare": { @@ -11576,7 +11309,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates the specified portfolio share. You can use this API to enable or disable TagOptions
sharing \n or Principal sharing for an existing portfolio share.
The portfolio share cannot be updated if the CreatePortfolioShare
operation is IN_PROGRESS
, as the share is not available to recipient entities. In this case, you must wait for the portfolio share to be COMPLETED.
You must provide the accountId
or organization node in the input, but not both.
If the portfolio is shared to both an external account and an organization node, and both shares need to be updated, you must invoke UpdatePortfolioShare
separately for each share type.
This API cannot be used for removing the portfolio share. You must use DeletePortfolioShare
API for that action.
When you associate a principal with portfolio, a potential privilege escalation path may occur when that portfolio is \n then shared with other accounts. For a user in a recipient account who is not an Service Catalog Admin, \n but still has the ability to create Principals (Users/Groups/Roles), that user could create a role that matches a principal \n name association for the portfolio. Although this user may not know which principal names are associated through \n Service Catalog, they may be able to guess the user. If this potential escalation path is a concern, then \n Service Catalog recommends using PrincipalType
as IAM
. With this configuration, \n the PrincipalARN
must already exist in the recipient account before it can be associated.
Updates the specified portfolio share. You can use this API to enable or disable TagOptions
sharing \n or Principal sharing for an existing portfolio share.
The portfolio share cannot be updated if the CreatePortfolioShare
operation is IN_PROGRESS
, as the share is not available to recipient entities. In this case, you must wait for the portfolio share to be COMPLETED.
You must provide the accountId
or organization node in the input, but not both.
If the portfolio is shared to both an external account and an organization node, and both shares need to be updated, you must invoke UpdatePortfolioShare
separately for each share type.
This API cannot be used for removing the portfolio share. You must use DeletePortfolioShare
API for that action.
When you associate a principal with portfolio, a potential privilege escalation path may occur when that portfolio is \n then shared with other accounts. For a user in a recipient account who is not an Service Catalog Admin, \n but still has the ability to create Principals (Users/Groups/Roles), that user could create a role that matches a principal \n name association for the portfolio. Although this user may not know which principal names are associated through \n Service Catalog, they may be able to guess the user. If this potential escalation path is a concern, then \n Service Catalog recommends using PrincipalType
as IAM
. With this configuration, \n the PrincipalARN
must already exist in the recipient account before it can be associated.
A flag to enables or disables Principals
sharing in the portfolio. If this field is not provided,\n the current state of the Principals
sharing on the portfolio share will not be modified.
The status of UpdatePortfolioShare
operation.\n You can also obtain the operation status using DescribePortfolioShareStatus
API. \n
Specifies connection details for the updated product and syncs the product to the connection source\n artifact. This automatically manages the product's artifacts based on changes to the source.\n The SourceConnection
parameter consists of the following sub-fields.
\n Type
\n
\n ConnectionParamters
\n
Information about the tags associated with the product.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.servicecatalog#UpdateProvisionedProduct": { @@ -11856,6 +11601,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.servicecatalog#UpdateProvisionedProductOutput": { @@ -11867,6 +11615,9 @@ "smithy.api#documentation": "Information about the result of the request.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.servicecatalog#UpdateProvisionedProductProperties": { @@ -11911,7 +11662,7 @@ "ProvisionedProductProperties": { "target": "com.amazonaws.servicecatalog#ProvisionedProductProperties", "traits": { - "smithy.api#documentation": "A map that contains the provisioned product properties to be updated.
\nThe LAUNCH_ROLE
key accepts role ARNs. This key allows an\n administrator to call UpdateProvisionedProductProperties
to update the launch\n role that is associated with a provisioned product. This role is used when an end user\n calls a provisioning operation such as UpdateProvisionedProduct
,\n TerminateProvisionedProduct
, or\n ExecuteProvisionedProductServiceAction
. Only a role ARN is valid. A user ARN is invalid.
The OWNER
key accepts IAM user ARNs, IAM role ARNs, and STS \n assumed-role ARNs. The owner is the user that has permission to see, update, terminate, and \n execute service actions in the provisioned product.
The administrator can change the owner of a provisioned product to another IAM or STS entity within the \n same account. Both end user owners and administrators can see ownership history of the provisioned \n product using the ListRecordHistory
API. The new owner can describe all past records \n for the provisioned product using the DescribeRecord
API. The previous owner can no \n longer use DescribeRecord
, but can still see the product's history from when he was \n an owner using ListRecordHistory
.
If a provisioned product ownership is assigned to an end user, they can see and perform any action through the API or \n Service Catalog console such as update, terminate, and execute service actions. \n If an end user provisions a product and the owner is updated to someone else, they will no longer be able to see or perform any actions through \n API or the Service Catalog console on that provisioned product.
", + "smithy.api#documentation": "A map that contains the provisioned product properties to be updated.
\nThe LAUNCH_ROLE
key accepts role ARNs. This key allows an\n administrator to call UpdateProvisionedProductProperties
to update the launch\n role that is associated with a provisioned product. This role is used when an end user\n calls a provisioning operation such as UpdateProvisionedProduct
,\n TerminateProvisionedProduct
, or\n ExecuteProvisionedProductServiceAction
. Only a role ARN is valid. A user ARN is invalid.
The OWNER
key accepts IAM user ARNs, IAM role ARNs, and STS \n assumed-role ARNs. The owner is the user that has permission to see, update, terminate, and \n execute service actions in the provisioned product.
The administrator can change the owner of a provisioned product to another IAM or STS entity within the \n same account. Both end user owners and administrators can see ownership history of the provisioned \n product using the ListRecordHistory
API. The new owner can describe all past records \n for the provisioned product using the DescribeRecord
API. The previous owner can no \n longer use DescribeRecord
, but can still see the product's history from when he was \n an owner using ListRecordHistory
.
If a provisioned product ownership is assigned to an end user, they can see and perform any action through the API or \n Service Catalog console such as update, terminate, and execute service actions. \n If an end user provisions a product and the owner is updated to someone else, they will no longer be able to see or perform any actions through \n API or the Service Catalog console on that provisioned product.
", "smithy.api#required": {} } }, @@ -11923,6 +11674,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.servicecatalog#UpdateProvisionedProductPropertiesOutput": { @@ -11952,6 +11706,9 @@ "smithy.api#documentation": "The status of the request.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.servicecatalog#UpdateProvisioningArtifact": { @@ -11971,7 +11728,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates the specified provisioning artifact (also known as a version) for the specified product.
\nYou cannot update a provisioning artifact for a product that was shared with you.
" + "smithy.api#documentation": "Updates the specified provisioning artifact (also known as a version) for the specified product.
\nYou cannot update a provisioning artifact for a product that was shared with you.
" } }, "com.amazonaws.servicecatalog#UpdateProvisioningArtifactInput": { @@ -12021,6 +11778,9 @@ "smithy.api#documentation": "Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.
\nThe DEFAULT
value indicates that the product version is active.
The administrator can set the guidance to DEPRECATED
to inform\n users that the product version is deprecated. Users are able to make updates to a provisioned product \n of a deprecated version but cannot launch new provisioned products using a deprecated version.
The status of the current request.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.servicecatalog#UpdateProvisioningParameter": { @@ -12183,6 +11946,9 @@ "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
Detailed information about the self-service action.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.servicecatalog#UpdateTagOption": { @@ -12244,6 +12013,9 @@ "smithy.api#documentation": "The updated active state.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.servicecatalog#UpdateTagOptionOutput": { @@ -12255,6 +12027,9 @@ "smithy.api#documentation": "Information about the TagOption.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.servicecatalog#UpdatedTime": {