Amazonka.ServiceCatalog.Lens

Operations

AcceptPortfolioShare

acceptPortfolioShare_acceptLanguage :: Lens' AcceptPortfolioShare (Maybe Text)

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

acceptPortfolioShare_portfolioShareType :: Lens' AcceptPortfolioShare (Maybe PortfolioShareType)

The type of shared portfolios to accept. The default is to accept imported portfolios.

• AWS_ORGANIZATIONS - Accept portfolios shared by the management account of your organization.
• IMPORTED - Accept imported portfolios.
• AWS_SERVICECATALOG - Not supported. (Throws ResourceNotFoundException.)

For example, aws servicecatalog accept-portfolio-share --portfolio-id "port-2qwzkwxt3y5fk" --portfolio-share-type AWS_ORGANIZATIONS

acceptPortfolioShare_portfolioId :: Lens' AcceptPortfolioShare Text

The portfolio identifier.

acceptPortfolioShareResponse_httpStatus :: Lens' AcceptPortfolioShareResponse Int

The response's http status code.

AssociateBudgetWithResource

associateBudgetWithResource_budgetName :: Lens' AssociateBudgetWithResource Text

The name of the budget you want to associate.

associateBudgetWithResource_resourceId :: Lens' AssociateBudgetWithResource Text

The resource identifier. Either a portfolio-id or a product-id.

associateBudgetWithResourceResponse_httpStatus :: Lens' AssociateBudgetWithResourceResponse Int

The response's http status code.

AssociatePrincipalWithPortfolio

associatePrincipalWithPortfolio_acceptLanguage :: Lens' AssociatePrincipalWithPortfolio (Maybe Text)

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

associatePrincipalWithPortfolio_portfolioId :: Lens' AssociatePrincipalWithPortfolio Text

The portfolio identifier.

associatePrincipalWithPortfolio_principalARN :: Lens' AssociatePrincipalWithPortfolio Text

The ARN of the principal (IAM user, role, or group). This field allows an ARN with no accountID if PrincipalType is IAM_PATTERN.

You can associate multiple IAM 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.

associatePrincipalWithPortfolio_principalType :: Lens' AssociatePrincipalWithPortfolio PrincipalType

The principal type. The supported value is IAM if you use a fully defined ARN, or IAM_PATTERN if you use an ARN with no accountID.

associatePrincipalWithPortfolioResponse_httpStatus :: Lens' AssociatePrincipalWithPortfolioResponse Int

The response's http status code.

AssociateProductWithPortfolio

associateProductWithPortfolio_acceptLanguage :: Lens' AssociateProductWithPortfolio (Maybe Text)

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

associateProductWithPortfolio_sourcePortfolioId :: Lens' AssociateProductWithPortfolio (Maybe Text)

The identifier of the source portfolio.

associateProductWithPortfolio_productId :: Lens' AssociateProductWithPortfolio Text

The product identifier.

associateProductWithPortfolio_portfolioId :: Lens' AssociateProductWithPortfolio Text

The portfolio identifier.

associateProductWithPortfolioResponse_httpStatus :: Lens' AssociateProductWithPortfolioResponse Int

The response's http status code.

AssociateServiceActionWithProvisioningArtifact

associateServiceActionWithProvisioningArtifact_acceptLanguage :: Lens' AssociateServiceActionWithProvisioningArtifact (Maybe Text)

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

associateServiceActionWithProvisioningArtifact_productId :: Lens' AssociateServiceActionWithProvisioningArtifact Text

The product identifier. For example, prod-abcdzk7xy33qa.

associateServiceActionWithProvisioningArtifact_provisioningArtifactId :: Lens' AssociateServiceActionWithProvisioningArtifact Text

The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne.

associateServiceActionWithProvisioningArtifact_serviceActionId :: Lens' AssociateServiceActionWithProvisioningArtifact Text

The self-service action identifier. For example, act-fs7abcd89wxyz.

associateServiceActionWithProvisioningArtifactResponse_httpStatus :: Lens' AssociateServiceActionWithProvisioningArtifactResponse Int

The response's http status code.

AssociateTagOptionWithResource

associateTagOptionWithResource_resourceId :: Lens' AssociateTagOptionWithResource Text

The resource identifier.

associateTagOptionWithResource_tagOptionId :: Lens' AssociateTagOptionWithResource Text

The TagOption identifier.

associateTagOptionWithResourceResponse_httpStatus :: Lens' AssociateTagOptionWithResourceResponse Int

The response's http status code.

BatchAssociateServiceActionWithProvisioningArtifact

batchAssociateServiceActionWithProvisioningArtifact_acceptLanguage :: Lens' BatchAssociateServiceActionWithProvisioningArtifact (Maybe Text)

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

batchAssociateServiceActionWithProvisioningArtifact_serviceActionAssociations :: Lens' BatchAssociateServiceActionWithProvisioningArtifact (NonEmpty ServiceActionAssociation)

One or more associations, each consisting of the Action ID, the Product ID, and the Provisioning Artifact ID.

batchAssociateServiceActionWithProvisioningArtifactResponse_failedServiceActionAssociations :: Lens' BatchAssociateServiceActionWithProvisioningArtifactResponse (Maybe [FailedServiceActionAssociation])

An object that contains a list of errors, along with information to help you identify the self-service action.

batchAssociateServiceActionWithProvisioningArtifactResponse_httpStatus :: Lens' BatchAssociateServiceActionWithProvisioningArtifactResponse Int

The response's http status code.

BatchDisassociateServiceActionFromProvisioningArtifact

batchDisassociateServiceActionFromProvisioningArtifact_acceptLanguage :: Lens' BatchDisassociateServiceActionFromProvisioningArtifact (Maybe Text)

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

batchDisassociateServiceActionFromProvisioningArtifact_serviceActionAssociations :: Lens' BatchDisassociateServiceActionFromProvisioningArtifact (NonEmpty ServiceActionAssociation)

One or more associations, each consisting of the Action ID, the Product ID, and the Provisioning Artifact ID.

batchDisassociateServiceActionFromProvisioningArtifactResponse_failedServiceActionAssociations :: Lens' BatchDisassociateServiceActionFromProvisioningArtifactResponse (Maybe [FailedServiceActionAssociation])

An object that contains a list of errors, along with information to help you identify the self-service action.

batchDisassociateServiceActionFromProvisioningArtifactResponse_httpStatus :: Lens' BatchDisassociateServiceActionFromProvisioningArtifactResponse Int

The response's http status code.

CopyProduct

copyProduct_acceptLanguage :: Lens' CopyProduct (Maybe Text)

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

copyProduct_copyOptions :: Lens' CopyProduct (Maybe [CopyOption])

The copy options. If the value is CopyTags, the tags from the source product are copied to the target product.

copyProduct_sourceProvisioningArtifactIdentifiers :: Lens' CopyProduct (Maybe [HashMap ProvisioningArtifactPropertyName Text])

The identifiers of the provisioning artifacts (also known as versions) of the product to copy. By default, all provisioning artifacts are copied.

copyProduct_targetProductId :: Lens' CopyProduct (Maybe Text)

The identifier of the target product. By default, a new product is created.

copyProduct_targetProductName :: Lens' CopyProduct (Maybe Text)

A name for the target product. The default is the name of the source product.

copyProduct_sourceProductArn :: Lens' CopyProduct Text

The Amazon Resource Name (ARN) of the source product.

copyProduct_idempotencyToken :: Lens' CopyProduct Text

A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

copyProductResponse_copyProductToken :: Lens' CopyProductResponse (Maybe Text)

The token to use to track the progress of the operation.

copyProductResponse_httpStatus :: Lens' CopyProductResponse Int

The response's http status code.

CreateConstraint

createConstraint_acceptLanguage :: Lens' CreateConstraint (Maybe Text)

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

createConstraint_description :: Lens' CreateConstraint (Maybe Text)

The description of the constraint.

createConstraint_portfolioId :: Lens' CreateConstraint Text

The portfolio identifier.

createConstraint_productId :: Lens' CreateConstraint Text

The product identifier.

createConstraint_parameters :: Lens' CreateConstraint Text

The constraint parameters, in JSON format. The syntax depends on the constraint type as follows:

LAUNCH

You are required to specify either the RoleArn or the LocalRoleName but can't use both.

Specify the RoleArn property as follows:

{"RoleArn" : "arn:aws:iam::123456789012:role/LaunchRole"}

Specify the LocalRoleName property as follows:

{"LocalRoleName": "SCBasicLaunchRole"}

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 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.

You cannot have both a LAUNCH and a STACKSET constraint.

You also cannot have more than one LAUNCH constraint on a product and portfolio.

NOTIFICATION

Specify the NotificationArns property as follows:

{"NotificationArns" : ["arn:aws:sns:us-east-1:123456789012:Topic"]}

RESOURCE_UPDATE

Specify the TagUpdatesOnProvisionedProduct property as follows:

{"Version":"2.0","Properties":{"TagUpdateOnProvisionedProduct":"String"}}

The TagUpdatesOnProvisionedProduct property accepts a string value of ALLOWED or NOT_ALLOWED.

STACKSET

Specify the Parameters property as follows:

{"Version": "String", "Properties": {"AccountList": [ "String" ], "RegionList": [ "String" ], "AdminRole": "String", "ExecutionRole": "String"}}

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.

TEMPLATE

Specify the Rules property. For more information, see Template Constraint Rules.

createConstraint_type :: Lens' CreateConstraint Text

The type of constraint.

• LAUNCH

• NOTIFICATION

• RESOURCE_UPDATE

• STACKSET

• TEMPLATE

createConstraint_idempotencyToken :: Lens' CreateConstraint Text

A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

createConstraintResponse_constraintDetail :: Lens' CreateConstraintResponse (Maybe ConstraintDetail)

Information about the constraint.

createConstraintResponse_constraintParameters :: Lens' CreateConstraintResponse (Maybe Text)

The constraint parameters.

createConstraintResponse_status :: Lens' CreateConstraintResponse (Maybe RequestStatus)

The status of the current request.

createConstraintResponse_httpStatus :: Lens' CreateConstraintResponse Int

The response's http status code.

CreatePortfolio

createPortfolio_acceptLanguage :: Lens' CreatePortfolio (Maybe Text)

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

createPortfolio_description :: Lens' CreatePortfolio (Maybe Text)

The description of the portfolio.

createPortfolio_tags :: Lens' CreatePortfolio (Maybe [Tag])

One or more tags.

createPortfolio_displayName :: Lens' CreatePortfolio Text

The name to use for display purposes.

createPortfolio_providerName :: Lens' CreatePortfolio Text

The name of the portfolio provider.

createPortfolio_idempotencyToken :: Lens' CreatePortfolio Text

A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

createPortfolioResponse_portfolioDetail :: Lens' CreatePortfolioResponse (Maybe PortfolioDetail)

Information about the portfolio.

createPortfolioResponse_tags :: Lens' CreatePortfolioResponse (Maybe [Tag])

Information about the tags associated with the portfolio.

createPortfolioResponse_httpStatus :: Lens' CreatePortfolioResponse Int

The response's http status code.

CreatePortfolioShare

createPortfolioShare_acceptLanguage :: Lens' CreatePortfolioShare (Maybe Text)

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

createPortfolioShare_accountId :: Lens' CreatePortfolioShare (Maybe Text)

The Amazon Web Services account ID. For example, 123456789012.

createPortfolioShare_organizationNode :: Lens' CreatePortfolioShare (Maybe OrganizationNode)

The organization node to whom you are going to share. When you pass OrganizationNode, it creates PortfolioShare for all of the Amazon Web Services accounts that are associated to the OrganizationNode. The output returns a PortfolioShareToken, which enables the administrator to monitor the status of the PortfolioShare creation process.

createPortfolioShare_sharePrincipals :: Lens' CreatePortfolioShare (Maybe Bool)

Enables or disables Principal sharing when creating the portfolio share. If this flag is not provided, principal sharing is disabled.

When you enable Principal Name Sharing for a portfolio share, the share recipient account end users with a principal that matches any of the associated IAM patterns can provision products from the portfolio. Once shared, the share recipient can view associations of PrincipalType: IAM_PATTERN on their portfolio. You can create the principals in the recipient account before or after creating the share.

createPortfolioShare_shareTagOptions :: Lens' CreatePortfolioShare (Maybe Bool)

Enables or disables TagOptions sharing when creating the portfolio share. If this flag is not provided, TagOptions sharing is disabled.

createPortfolioShare_portfolioId :: Lens' CreatePortfolioShare Text

The portfolio identifier.

createPortfolioShareResponse_portfolioShareToken :: Lens' CreatePortfolioShareResponse (Maybe Text)

The portfolio shares a unique identifier that only returns if the portfolio is shared to an organization node.

createPortfolioShareResponse_httpStatus :: Lens' CreatePortfolioShareResponse Int

The response's http status code.

CreateProduct

createProduct_acceptLanguage :: Lens' CreateProduct (Maybe Text)

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

createProduct_description :: Lens' CreateProduct (Maybe Text)

The description of the product.

createProduct_distributor :: Lens' CreateProduct (Maybe Text)

The distributor of the product.

createProduct_provisioningArtifactParameters :: Lens' CreateProduct (Maybe ProvisioningArtifactProperties)

The configuration of the provisioning artifact.

createProduct_sourceConnection :: Lens' CreateProduct (Maybe SourceConnection)

Specifies connection details for the created product and syncs the product to the connection source artifact. This automatically manages the product's artifacts based on changes to the source. The SourceConnection parameter consists of the following sub-fields.

• Type

• ConnectionParamters

createProduct_supportDescription :: Lens' CreateProduct (Maybe Text)

The support information about the product.

createProduct_supportEmail :: Lens' CreateProduct (Maybe Text)

The contact email for product support.

createProduct_supportUrl :: Lens' CreateProduct (Maybe Text)

The contact URL for product support.

^https?:\/\// / is the pattern used to validate SupportUrl.

createProduct_tags :: Lens' CreateProduct (Maybe [Tag])

One or more tags.

createProduct_name :: Lens' CreateProduct Text

The name of the product.

createProduct_owner :: Lens' CreateProduct Text

The owner of the product.

createProduct_productType :: Lens' CreateProduct ProductType

The type of product.

createProduct_idempotencyToken :: Lens' CreateProduct Text

A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

createProductResponse_productViewDetail :: Lens' CreateProductResponse (Maybe ProductViewDetail)

Information about the product view.

createProductResponse_provisioningArtifactDetail :: Lens' CreateProductResponse (Maybe ProvisioningArtifactDetail)

Information about the provisioning artifact.

createProductResponse_tags :: Lens' CreateProductResponse (Maybe [Tag])

Information about the tags associated with the product.

createProductResponse_httpStatus :: Lens' CreateProductResponse Int

The response's http status code.

CreateProvisionedProductPlan

createProvisionedProductPlan_acceptLanguage :: Lens' CreateProvisionedProductPlan (Maybe Text)

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

createProvisionedProductPlan_notificationArns :: Lens' CreateProvisionedProductPlan (Maybe [Text])

Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events.

createProvisionedProductPlan_pathId :: Lens' CreateProvisionedProductPlan (Maybe Text)

The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths.

createProvisionedProductPlan_provisioningParameters :: Lens' CreateProvisionedProductPlan (Maybe [UpdateProvisioningParameter])

Parameters specified by the administrator that are required for provisioning the product.

createProvisionedProductPlan_tags :: Lens' CreateProvisionedProductPlan (Maybe [Tag])

One or more tags.

If 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.

createProvisionedProductPlan_planName :: Lens' CreateProvisionedProductPlan Text

The name of the plan.

createProvisionedProductPlan_planType :: Lens' CreateProvisionedProductPlan ProvisionedProductPlanType

The plan type.

createProvisionedProductPlan_productId :: Lens' CreateProvisionedProductPlan Text

The product identifier.

createProvisionedProductPlan_provisionedProductName :: Lens' CreateProvisionedProductPlan Text

A user-friendly name for the provisioned product. This value must be unique for the Amazon Web Services account and cannot be updated after the product is provisioned.

createProvisionedProductPlan_provisioningArtifactId :: Lens' CreateProvisionedProductPlan Text

The identifier of the provisioning artifact.

createProvisionedProductPlan_idempotencyToken :: Lens' CreateProvisionedProductPlan Text

A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

createProvisionedProductPlanResponse_planId :: Lens' CreateProvisionedProductPlanResponse (Maybe Text)

The plan identifier.

createProvisionedProductPlanResponse_planName :: Lens' CreateProvisionedProductPlanResponse (Maybe Text)

The name of the plan.

createProvisionedProductPlanResponse_provisionProductId :: Lens' CreateProvisionedProductPlanResponse (Maybe Text)

The product identifier.

createProvisionedProductPlanResponse_provisionedProductName :: Lens' CreateProvisionedProductPlanResponse (Maybe Text)

The user-friendly name of the provisioned product.

createProvisionedProductPlanResponse_provisioningArtifactId :: Lens' CreateProvisionedProductPlanResponse (Maybe Text)

The identifier of the provisioning artifact.

createProvisionedProductPlanResponse_httpStatus :: Lens' CreateProvisionedProductPlanResponse Int

The response's http status code.

CreateProvisioningArtifact

createProvisioningArtifact_acceptLanguage :: Lens' CreateProvisioningArtifact (Maybe Text)

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

createProvisioningArtifact_productId :: Lens' CreateProvisioningArtifact Text

The product identifier.

createProvisioningArtifact_parameters :: Lens' CreateProvisioningArtifact ProvisioningArtifactProperties

The configuration for the provisioning artifact.

createProvisioningArtifact_idempotencyToken :: Lens' CreateProvisioningArtifact Text

A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

createProvisioningArtifactResponse_info :: Lens' CreateProvisioningArtifactResponse (Maybe (HashMap Text Text))

Specify the template source with one of the following options, but not both. Keys accepted: [ LoadTemplateFromURL, ImportFromPhysicalId ].

Use the URL of the CloudFormation template in Amazon S3 or GitHub in JSON format.

LoadTemplateFromURL

Use the URL of the CloudFormation template in Amazon S3 or GitHub in JSON format.

ImportFromPhysicalId

Use the physical id of the resource that contains the template; currently supports CloudFormation stack ARN.

createProvisioningArtifactResponse_provisioningArtifactDetail :: Lens' CreateProvisioningArtifactResponse (Maybe ProvisioningArtifactDetail)

Information about the provisioning artifact.

createProvisioningArtifactResponse_status :: Lens' CreateProvisioningArtifactResponse (Maybe RequestStatus)

The status of the current request.

createProvisioningArtifactResponse_httpStatus :: Lens' CreateProvisioningArtifactResponse Int

The response's http status code.

CreateServiceAction

createServiceAction_acceptLanguage :: Lens' CreateServiceAction (Maybe Text)

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

createServiceAction_description :: Lens' CreateServiceAction (Maybe Text)

The self-service action description.

createServiceAction_name :: Lens' CreateServiceAction Text

The self-service action name.

createServiceAction_definitionType :: Lens' CreateServiceAction ServiceActionDefinitionType

The service action definition type. For example, SSM_AUTOMATION.

createServiceAction_definition :: Lens' CreateServiceAction (HashMap ServiceActionDefinitionKey Text)

The self-service action definition. Can be one of the following:

Name

The name of the Amazon Web Services Systems Manager document (SSM document). For example, AWS-RestartEC2Instance.

If you are using a shared SSM document, you must provide the ARN instead of the name.

Version

The Amazon Web Services Systems Manager automation document version. For example, "Version": "1"

AssumeRole

The Amazon Resource Name (ARN) of the role that performs the self-service actions on your behalf. For example, "AssumeRole": "arn:aws:iam::12345678910:role/ActionRole".

To reuse the provisioned product launch role, set to "AssumeRole": "LAUNCH_ROLE".

Parameters

The list of parameters in JSON format.

For example: [{\"Name\":\"InstanceId\",\"Type\":\"TARGET\"}] or [{\"Name\":\"InstanceId\",\"Type\":\"TEXT_VALUE\"}].

createServiceAction_idempotencyToken :: Lens' CreateServiceAction Text

A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

createServiceActionResponse_serviceActionDetail :: Lens' CreateServiceActionResponse (Maybe ServiceActionDetail)

An object containing information about the self-service action.

createServiceActionResponse_httpStatus :: Lens' CreateServiceActionResponse Int

The response's http status code.

CreateTagOption

createTagOption_key :: Lens' CreateTagOption Text

The TagOption key.

createTagOption_value :: Lens' CreateTagOption Text

The TagOption value.

createTagOptionResponse_tagOptionDetail :: Lens' CreateTagOptionResponse (Maybe TagOptionDetail)

Information about the TagOption.

createTagOptionResponse_httpStatus :: Lens' CreateTagOptionResponse Int

The response's http status code.

DeleteConstraint

deleteConstraint_acceptLanguage :: Lens' DeleteConstraint (Maybe Text)

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

deleteConstraint_id :: Lens' DeleteConstraint Text

The identifier of the constraint.

deleteConstraintResponse_httpStatus :: Lens' DeleteConstraintResponse Int

The response's http status code.

DeletePortfolio

deletePortfolio_acceptLanguage :: Lens' DeletePortfolio (Maybe Text)

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

deletePortfolio_id :: Lens' DeletePortfolio Text

The portfolio identifier.

deletePortfolioResponse_httpStatus :: Lens' DeletePortfolioResponse Int

The response's http status code.

DeletePortfolioShare

deletePortfolioShare_acceptLanguage :: Lens' DeletePortfolioShare (Maybe Text)

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

deletePortfolioShare_accountId :: Lens' DeletePortfolioShare (Maybe Text)

The Amazon Web Services account ID.

deletePortfolioShare_organizationNode :: Lens' DeletePortfolioShare (Maybe OrganizationNode)

The organization node to whom you are going to stop sharing.

deletePortfolioShare_portfolioId :: Lens' DeletePortfolioShare Text

The portfolio identifier.

deletePortfolioShareResponse_portfolioShareToken :: Lens' DeletePortfolioShareResponse (Maybe Text)

The portfolio share unique identifier. This will only be returned if delete is made to an organization node.

deletePortfolioShareResponse_httpStatus :: Lens' DeletePortfolioShareResponse Int

The response's http status code.

DeleteProduct

deleteProduct_acceptLanguage :: Lens' DeleteProduct (Maybe Text)

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

deleteProduct_id :: Lens' DeleteProduct Text

The product identifier.

deleteProductResponse_httpStatus :: Lens' DeleteProductResponse Int

The response's http status code.

DeleteProvisionedProductPlan

deleteProvisionedProductPlan_acceptLanguage :: Lens' DeleteProvisionedProductPlan (Maybe Text)

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

deleteProvisionedProductPlan_ignoreErrors :: Lens' DeleteProvisionedProductPlan (Maybe Bool)

If set to true, Service Catalog stops managing the specified provisioned product even if it cannot delete the underlying resources.

deleteProvisionedProductPlan_planId :: Lens' DeleteProvisionedProductPlan Text

The plan identifier.

deleteProvisionedProductPlanResponse_httpStatus :: Lens' DeleteProvisionedProductPlanResponse Int

The response's http status code.

DeleteProvisioningArtifact

deleteProvisioningArtifact_acceptLanguage :: Lens' DeleteProvisioningArtifact (Maybe Text)

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

deleteProvisioningArtifact_productId :: Lens' DeleteProvisioningArtifact Text

The product identifier.

deleteProvisioningArtifact_provisioningArtifactId :: Lens' DeleteProvisioningArtifact Text

The identifier of the provisioning artifact.

deleteProvisioningArtifactResponse_httpStatus :: Lens' DeleteProvisioningArtifactResponse Int

The response's http status code.

DeleteServiceAction

deleteServiceAction_acceptLanguage :: Lens' DeleteServiceAction (Maybe Text)

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

deleteServiceAction_id :: Lens' DeleteServiceAction Text

The self-service action identifier. For example, act-fs7abcd89wxyz.

deleteServiceActionResponse_httpStatus :: Lens' DeleteServiceActionResponse Int

The response's http status code.

DeleteTagOption

deleteTagOption_id :: Lens' DeleteTagOption Text

The TagOption identifier.

deleteTagOptionResponse_httpStatus :: Lens' DeleteTagOptionResponse Int

The response's http status code.

DescribeConstraint

describeConstraint_acceptLanguage :: Lens' DescribeConstraint (Maybe Text)

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

describeConstraint_id :: Lens' DescribeConstraint Text

The identifier of the constraint.

describeConstraintResponse_constraintDetail :: Lens' DescribeConstraintResponse (Maybe ConstraintDetail)

Information about the constraint.

describeConstraintResponse_constraintParameters :: Lens' DescribeConstraintResponse (Maybe Text)

The constraint parameters.

describeConstraintResponse_status :: Lens' DescribeConstraintResponse (Maybe RequestStatus)

The status of the current request.

describeConstraintResponse_httpStatus :: Lens' DescribeConstraintResponse Int

The response's http status code.

DescribeCopyProductStatus

describeCopyProductStatus_acceptLanguage :: Lens' DescribeCopyProductStatus (Maybe Text)

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

describeCopyProductStatus_copyProductToken :: Lens' DescribeCopyProductStatus Text

The token for the copy product operation. This token is returned by CopyProduct.

describeCopyProductStatusResponse_copyProductStatus :: Lens' DescribeCopyProductStatusResponse (Maybe CopyProductStatus)

The status of the copy product operation.

describeCopyProductStatusResponse_statusDetail :: Lens' DescribeCopyProductStatusResponse (Maybe Text)

The status message.

describeCopyProductStatusResponse_targetProductId :: Lens' DescribeCopyProductStatusResponse (Maybe Text)

The identifier of the copied product.

describeCopyProductStatusResponse_httpStatus :: Lens' DescribeCopyProductStatusResponse Int

The response's http status code.

DescribePortfolio

describePortfolio_acceptLanguage :: Lens' DescribePortfolio (Maybe Text)

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

describePortfolio_id :: Lens' DescribePortfolio Text

The portfolio identifier.

describePortfolioResponse_budgets :: Lens' DescribePortfolioResponse (Maybe [BudgetDetail])

Information about the associated budgets.

describePortfolioResponse_portfolioDetail :: Lens' DescribePortfolioResponse (Maybe PortfolioDetail)

Information about the portfolio.

describePortfolioResponse_tagOptions :: Lens' DescribePortfolioResponse (Maybe [TagOptionDetail])

Information about the TagOptions associated with the portfolio.

describePortfolioResponse_tags :: Lens' DescribePortfolioResponse (Maybe [Tag])

Information about the tags associated with the portfolio.

describePortfolioResponse_httpStatus :: Lens' DescribePortfolioResponse Int

The response's http status code.

DescribePortfolioShareStatus

describePortfolioShareStatus_portfolioShareToken :: Lens' DescribePortfolioShareStatus Text

The token for the portfolio share operation. This token is returned either by CreatePortfolioShare or by DeletePortfolioShare.

describePortfolioShareStatusResponse_organizationNodeValue :: Lens' DescribePortfolioShareStatusResponse (Maybe Text)

Organization node identifier. It can be either account id, organizational unit id or organization id.

describePortfolioShareStatusResponse_portfolioId :: Lens' DescribePortfolioShareStatusResponse (Maybe Text)

The portfolio identifier.

describePortfolioShareStatusResponse_portfolioShareToken :: Lens' DescribePortfolioShareStatusResponse (Maybe Text)

The token for the portfolio share operation. For example, share-6v24abcdefghi.

describePortfolioShareStatusResponse_shareDetails :: Lens' DescribePortfolioShareStatusResponse (Maybe ShareDetails)

Information about the portfolio share operation.

describePortfolioShareStatusResponse_status :: Lens' DescribePortfolioShareStatusResponse (Maybe ShareStatus)

Status of the portfolio share operation.

describePortfolioShareStatusResponse_httpStatus :: Lens' DescribePortfolioShareStatusResponse Int

The response's http status code.

DescribePortfolioShares

describePortfolioShares_pageSize :: Lens' DescribePortfolioShares (Maybe Natural)

The maximum number of items to return with this call.

describePortfolioShares_pageToken :: Lens' DescribePortfolioShares (Maybe Text)

The page token for the next set of results. To retrieve the first set of results, use null.

describePortfolioShares_portfolioId :: Lens' DescribePortfolioShares Text

The unique identifier of the portfolio for which shares will be retrieved.

describePortfolioShares_type :: Lens' DescribePortfolioShares DescribePortfolioShareType

The type of portfolio share to summarize. This field acts as a filter on the type of portfolio share, which can be one of the following:

1. ACCOUNT - Represents an external account to account share.
2. ORGANIZATION - Represents a share to an organization. This share is available to every account in the organization.
3. ORGANIZATIONAL_UNIT - Represents a share to an organizational unit.
4. ORGANIZATION_MEMBER_ACCOUNT - Represents a share to an account in the organization.

describePortfolioSharesResponse_nextPageToken :: Lens' DescribePortfolioSharesResponse (Maybe Text)

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

describePortfolioSharesResponse_portfolioShareDetails :: Lens' DescribePortfolioSharesResponse (Maybe [PortfolioShareDetail])

Summaries about each of the portfolio shares.

describePortfolioSharesResponse_httpStatus :: Lens' DescribePortfolioSharesResponse Int

The response's http status code.

DescribeProduct

describeProduct_acceptLanguage :: Lens' DescribeProduct (Maybe Text)

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

describeProduct_id :: Lens' DescribeProduct (Maybe Text)

The product identifier.

describeProduct_name :: Lens' DescribeProduct (Maybe Text)

The product name.

describeProductResponse_budgets :: Lens' DescribeProductResponse (Maybe [BudgetDetail])

Information about the associated budgets.

describeProductResponse_launchPaths :: Lens' DescribeProductResponse (Maybe [LaunchPath])

Information about the associated launch paths.

describeProductResponse_productViewSummary :: Lens' DescribeProductResponse (Maybe ProductViewSummary)

Summary information about the product view.

describeProductResponse_provisioningArtifacts :: Lens' DescribeProductResponse (Maybe [ProvisioningArtifact])

Information about the provisioning artifacts for the specified product.

describeProductResponse_httpStatus :: Lens' DescribeProductResponse Int

The response's http status code.

DescribeProductAsAdmin

describeProductAsAdmin_acceptLanguage :: Lens' DescribeProductAsAdmin (Maybe Text)

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

describeProductAsAdmin_id :: Lens' DescribeProductAsAdmin (Maybe Text)

The product identifier.

describeProductAsAdmin_name :: Lens' DescribeProductAsAdmin (Maybe Text)

The product name.

describeProductAsAdmin_sourcePortfolioId :: Lens' DescribeProductAsAdmin (Maybe Text)

The unique identifier of the shared portfolio that the specified product is associated with.

You can provide this parameter to retrieve the shared TagOptions associated with the product. If this parameter is provided and if TagOptions sharing is enabled in the portfolio share, the API returns both local and shared TagOptions associated with the product. Otherwise only local TagOptions will be returned.

describeProductAsAdminResponse_budgets :: Lens' DescribeProductAsAdminResponse (Maybe [BudgetDetail])

Information about the associated budgets.

describeProductAsAdminResponse_productViewDetail :: Lens' DescribeProductAsAdminResponse (Maybe ProductViewDetail)

Information about the product view.

describeProductAsAdminResponse_provisioningArtifactSummaries :: Lens' DescribeProductAsAdminResponse (Maybe [ProvisioningArtifactSummary])

Information about the provisioning artifacts (also known as versions) for the specified product.

describeProductAsAdminResponse_tagOptions :: Lens' DescribeProductAsAdminResponse (Maybe [TagOptionDetail])

Information about the TagOptions associated with the product.

describeProductAsAdminResponse_tags :: Lens' DescribeProductAsAdminResponse (Maybe [Tag])

Information about the tags associated with the product.

describeProductAsAdminResponse_httpStatus :: Lens' DescribeProductAsAdminResponse Int

The response's http status code.

DescribeProductView

describeProductView_acceptLanguage :: Lens' DescribeProductView (Maybe Text)

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

describeProductView_id :: Lens' DescribeProductView Text

The product view identifier.

describeProductViewResponse_productViewSummary :: Lens' DescribeProductViewResponse (Maybe ProductViewSummary)

Summary information about the product.

describeProductViewResponse_provisioningArtifacts :: Lens' DescribeProductViewResponse (Maybe [ProvisioningArtifact])

Information about the provisioning artifacts for the product.

describeProductViewResponse_httpStatus :: Lens' DescribeProductViewResponse Int

The response's http status code.

DescribeProvisionedProduct

describeProvisionedProduct_acceptLanguage :: Lens' DescribeProvisionedProduct (Maybe Text)

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

describeProvisionedProduct_id :: Lens' DescribeProvisionedProduct (Maybe Text)

The provisioned product identifier. You must provide the name or ID, but not both.

If you do not provide a name or ID, or you provide both name and ID, an InvalidParametersException will occur.

describeProvisionedProduct_name :: Lens' DescribeProvisionedProduct (Maybe Text)

The name of the provisioned product. You must provide the name or ID, but not both.

If you do not provide a name or ID, or you provide both name and ID, an InvalidParametersException will occur.

describeProvisionedProductResponse_cloudWatchDashboards :: Lens' DescribeProvisionedProductResponse (Maybe [CloudWatchDashboard])

Any CloudWatch dashboards that were created when provisioning the product.

describeProvisionedProductResponse_provisionedProductDetail :: Lens' DescribeProvisionedProductResponse (Maybe ProvisionedProductDetail)

Information about the provisioned product.

describeProvisionedProductResponse_httpStatus :: Lens' DescribeProvisionedProductResponse Int

The response's http status code.

DescribeProvisionedProductPlan

describeProvisionedProductPlan_acceptLanguage :: Lens' DescribeProvisionedProductPlan (Maybe Text)

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

describeProvisionedProductPlan_pageSize :: Lens' DescribeProvisionedProductPlan (Maybe Natural)

The maximum number of items to return with this call.

describeProvisionedProductPlan_pageToken :: Lens' DescribeProvisionedProductPlan (Maybe Text)

The page token for the next set of results. To retrieve the first set of results, use null.

describeProvisionedProductPlan_planId :: Lens' DescribeProvisionedProductPlan Text

The plan identifier.

describeProvisionedProductPlanResponse_nextPageToken :: Lens' DescribeProvisionedProductPlanResponse (Maybe Text)

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

describeProvisionedProductPlanResponse_provisionedProductPlanDetails :: Lens' DescribeProvisionedProductPlanResponse (Maybe ProvisionedProductPlanDetails)

Information about the plan.

describeProvisionedProductPlanResponse_resourceChanges :: Lens' DescribeProvisionedProductPlanResponse (Maybe [ResourceChange])

Information about the resource changes that will occur when the plan is executed.

describeProvisionedProductPlanResponse_httpStatus :: Lens' DescribeProvisionedProductPlanResponse Int

The response's http status code.

DescribeProvisioningArtifact

describeProvisioningArtifact_acceptLanguage :: Lens' DescribeProvisioningArtifact (Maybe Text)

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

describeProvisioningArtifact_productId :: Lens' DescribeProvisioningArtifact (Maybe Text)

The product identifier.

describeProvisioningArtifact_productName :: Lens' DescribeProvisioningArtifact (Maybe Text)

The product name.

describeProvisioningArtifact_provisioningArtifactId :: Lens' DescribeProvisioningArtifact (Maybe Text)

The identifier of the provisioning artifact.

describeProvisioningArtifact_provisioningArtifactName :: Lens' DescribeProvisioningArtifact (Maybe Text)

The provisioning artifact name.

describeProvisioningArtifact_verbose :: Lens' DescribeProvisioningArtifact (Maybe Bool)

Indicates whether a verbose level of detail is enabled.

describeProvisioningArtifactResponse_info :: Lens' DescribeProvisioningArtifactResponse (Maybe (HashMap Text Text))

The URL of the CloudFormation template in Amazon S3 or GitHub in JSON format.

describeProvisioningArtifactResponse_provisioningArtifactDetail :: Lens' DescribeProvisioningArtifactResponse (Maybe ProvisioningArtifactDetail)

Information about the provisioning artifact.

describeProvisioningArtifactResponse_status :: Lens' DescribeProvisioningArtifactResponse (Maybe RequestStatus)

The status of the current request.

describeProvisioningArtifactResponse_httpStatus :: Lens' DescribeProvisioningArtifactResponse Int

The response's http status code.

DescribeProvisioningParameters

describeProvisioningParameters_acceptLanguage :: Lens' DescribeProvisioningParameters (Maybe Text)

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

describeProvisioningParameters_pathId :: Lens' DescribeProvisioningParameters (Maybe Text)

The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths. You must provide the name or ID, but not both.

describeProvisioningParameters_pathName :: Lens' DescribeProvisioningParameters (Maybe Text)

The name of the path. You must provide the name or ID, but not both.

describeProvisioningParameters_productId :: Lens' DescribeProvisioningParameters (Maybe Text)

The product identifier. You must provide the product name or ID, but not both.

describeProvisioningParameters_productName :: Lens' DescribeProvisioningParameters (Maybe Text)

The name of the product. You must provide the name or ID, but not both.

describeProvisioningParameters_provisioningArtifactId :: Lens' DescribeProvisioningParameters (Maybe Text)

The identifier of the provisioning artifact. You must provide the name or ID, but not both.

describeProvisioningParameters_provisioningArtifactName :: Lens' DescribeProvisioningParameters (Maybe Text)

The name of the provisioning artifact. You must provide the name or ID, but not both.

describeProvisioningParametersResponse_constraintSummaries :: Lens' DescribeProvisioningParametersResponse (Maybe [ConstraintSummary])

Information about the constraints used to provision the product.

describeProvisioningParametersResponse_provisioningArtifactOutputKeys :: Lens' DescribeProvisioningParametersResponse (Maybe [ProvisioningArtifactOutput])

A list of the keys and descriptions of the outputs. These outputs can be referenced from a provisioned product launched from this provisioning artifact.

describeProvisioningParametersResponse_provisioningArtifactOutputs :: Lens' DescribeProvisioningParametersResponse (Maybe [ProvisioningArtifactOutput])

The output of the provisioning artifact.

describeProvisioningParametersResponse_provisioningArtifactParameters :: Lens' DescribeProvisioningParametersResponse (Maybe [ProvisioningArtifactParameter])

Information about the parameters used to provision the product.

describeProvisioningParametersResponse_provisioningArtifactPreferences :: Lens' DescribeProvisioningParametersResponse (Maybe ProvisioningArtifactPreferences)

An object that contains information about preferences, such as Regions and accounts, for the provisioning artifact.

describeProvisioningParametersResponse_tagOptions :: Lens' DescribeProvisioningParametersResponse (Maybe [TagOptionSummary])

Information about the TagOptions associated with the resource.

describeProvisioningParametersResponse_usageInstructions :: Lens' DescribeProvisioningParametersResponse (Maybe [UsageInstruction])

Any additional metadata specifically related to the provisioning of the product. For example, see the Version field of the CloudFormation template.

describeProvisioningParametersResponse_httpStatus :: Lens' DescribeProvisioningParametersResponse Int

The response's http status code.

DescribeRecord

describeRecord_acceptLanguage :: Lens' DescribeRecord (Maybe Text)

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

describeRecord_pageSize :: Lens' DescribeRecord (Maybe Natural)

The maximum number of items to return with this call.

describeRecord_pageToken :: Lens' DescribeRecord (Maybe Text)

The page token for the next set of results. To retrieve the first set of results, use null.

describeRecord_id :: Lens' DescribeRecord Text

The record identifier of the provisioned product. This identifier is returned by the request operation.

describeRecordResponse_nextPageToken :: Lens' DescribeRecordResponse (Maybe Text)

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

describeRecordResponse_recordDetail :: Lens' DescribeRecordResponse (Maybe RecordDetail)

Information about the product.

describeRecordResponse_recordOutputs :: Lens' DescribeRecordResponse (Maybe [RecordOutput])

Information about the product created as the result of a request. For example, the output for a CloudFormation-backed product that creates an S3 bucket would include the S3 bucket URL.

describeRecordResponse_httpStatus :: Lens' DescribeRecordResponse Int

The response's http status code.

DescribeServiceAction

describeServiceAction_acceptLanguage :: Lens' DescribeServiceAction (Maybe Text)

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

describeServiceAction_id :: Lens' DescribeServiceAction Text

The self-service action identifier.

describeServiceActionResponse_serviceActionDetail :: Lens' DescribeServiceActionResponse (Maybe ServiceActionDetail)

Detailed information about the self-service action.

describeServiceActionResponse_httpStatus :: Lens' DescribeServiceActionResponse Int

The response's http status code.

DescribeServiceActionExecutionParameters

describeServiceActionExecutionParameters_acceptLanguage :: Lens' DescribeServiceActionExecutionParameters (Maybe Text)

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

describeServiceActionExecutionParameters_provisionedProductId :: Lens' DescribeServiceActionExecutionParameters Text

The identifier of the provisioned product.

describeServiceActionExecutionParameters_serviceActionId :: Lens' DescribeServiceActionExecutionParameters Text

The self-service action identifier.

describeServiceActionExecutionParametersResponse_serviceActionParameters :: Lens' DescribeServiceActionExecutionParametersResponse (Maybe [ExecutionParameter])

The parameters of the self-service action.

describeServiceActionExecutionParametersResponse_httpStatus :: Lens' DescribeServiceActionExecutionParametersResponse Int

The response's http status code.

DescribeTagOption

describeTagOption_id :: Lens' DescribeTagOption Text

The TagOption identifier.

describeTagOptionResponse_tagOptionDetail :: Lens' DescribeTagOptionResponse (Maybe TagOptionDetail)

Information about the TagOption.

describeTagOptionResponse_httpStatus :: Lens' DescribeTagOptionResponse Int

The response's http status code.

DisableAWSOrganizationsAccess

disableAWSOrganizationsAccessResponse_httpStatus :: Lens' DisableAWSOrganizationsAccessResponse Int

The response's http status code.

DisassociateBudgetFromResource

disassociateBudgetFromResource_budgetName :: Lens' DisassociateBudgetFromResource Text

The name of the budget you want to disassociate.

disassociateBudgetFromResource_resourceId :: Lens' DisassociateBudgetFromResource Text

The resource identifier you want to disassociate from. Either a portfolio-id or a product-id.

disassociateBudgetFromResourceResponse_httpStatus :: Lens' DisassociateBudgetFromResourceResponse Int

The response's http status code.

DisassociatePrincipalFromPortfolio

disassociatePrincipalFromPortfolio_acceptLanguage :: Lens' DisassociatePrincipalFromPortfolio (Maybe Text)

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

disassociatePrincipalFromPortfolio_principalType :: Lens' DisassociatePrincipalFromPortfolio (Maybe PrincipalType)

The supported value is IAM if you use a fully defined ARN, or IAM_PATTERN if you use no accountID.

disassociatePrincipalFromPortfolio_portfolioId :: Lens' DisassociatePrincipalFromPortfolio Text

The portfolio identifier.

disassociatePrincipalFromPortfolio_principalARN :: Lens' DisassociatePrincipalFromPortfolio Text

The ARN of the principal (IAM user, role, or group). This field allows an ARN with no accountID if PrincipalType is IAM_PATTERN.

disassociatePrincipalFromPortfolioResponse_httpStatus :: Lens' DisassociatePrincipalFromPortfolioResponse Int

The response's http status code.

DisassociateProductFromPortfolio

disassociateProductFromPortfolio_acceptLanguage :: Lens' DisassociateProductFromPortfolio (Maybe Text)

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

disassociateProductFromPortfolio_productId :: Lens' DisassociateProductFromPortfolio Text

The product identifier.

disassociateProductFromPortfolio_portfolioId :: Lens' DisassociateProductFromPortfolio Text

The portfolio identifier.

disassociateProductFromPortfolioResponse_httpStatus :: Lens' DisassociateProductFromPortfolioResponse Int

The response's http status code.

DisassociateServiceActionFromProvisioningArtifact

disassociateServiceActionFromProvisioningArtifact_acceptLanguage :: Lens' DisassociateServiceActionFromProvisioningArtifact (Maybe Text)

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

disassociateServiceActionFromProvisioningArtifact_productId :: Lens' DisassociateServiceActionFromProvisioningArtifact Text

The product identifier. For example, prod-abcdzk7xy33qa.

disassociateServiceActionFromProvisioningArtifact_provisioningArtifactId :: Lens' DisassociateServiceActionFromProvisioningArtifact Text

The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne.

disassociateServiceActionFromProvisioningArtifact_serviceActionId :: Lens' DisassociateServiceActionFromProvisioningArtifact Text

The self-service action identifier. For example, act-fs7abcd89wxyz.

disassociateServiceActionFromProvisioningArtifactResponse_httpStatus :: Lens' DisassociateServiceActionFromProvisioningArtifactResponse Int

The response's http status code.

DisassociateTagOptionFromResource

disassociateTagOptionFromResource_resourceId :: Lens' DisassociateTagOptionFromResource Text

The resource identifier.

disassociateTagOptionFromResource_tagOptionId :: Lens' DisassociateTagOptionFromResource Text

The TagOption identifier.

disassociateTagOptionFromResourceResponse_httpStatus :: Lens' DisassociateTagOptionFromResourceResponse Int

The response's http status code.

EnableAWSOrganizationsAccess

enableAWSOrganizationsAccessResponse_httpStatus :: Lens' EnableAWSOrganizationsAccessResponse Int

The response's http status code.

ExecuteProvisionedProductPlan

executeProvisionedProductPlan_acceptLanguage :: Lens' ExecuteProvisionedProductPlan (Maybe Text)

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

executeProvisionedProductPlan_planId :: Lens' ExecuteProvisionedProductPlan Text

The plan identifier.

executeProvisionedProductPlan_idempotencyToken :: Lens' ExecuteProvisionedProductPlan Text

A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

executeProvisionedProductPlanResponse_recordDetail :: Lens' ExecuteProvisionedProductPlanResponse (Maybe RecordDetail)

Information about the result of provisioning the product.

executeProvisionedProductPlanResponse_httpStatus :: Lens' ExecuteProvisionedProductPlanResponse Int

The response's http status code.

ExecuteProvisionedProductServiceAction

executeProvisionedProductServiceAction_acceptLanguage :: Lens' ExecuteProvisionedProductServiceAction (Maybe Text)

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

executeProvisionedProductServiceAction_parameters :: Lens' ExecuteProvisionedProductServiceAction (Maybe (HashMap Text [Text]))

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 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 any special parameters such as TARGET.

executeProvisionedProductServiceAction_provisionedProductId :: Lens' ExecuteProvisionedProductServiceAction Text

The identifier of the provisioned product.

executeProvisionedProductServiceAction_serviceActionId :: Lens' ExecuteProvisionedProductServiceAction Text

The self-service action identifier. For example, act-fs7abcd89wxyz.

executeProvisionedProductServiceAction_executeToken :: Lens' ExecuteProvisionedProductServiceAction Text

An idempotency token that uniquely identifies the execute request.

executeProvisionedProductServiceActionResponse_recordDetail :: Lens' ExecuteProvisionedProductServiceActionResponse (Maybe RecordDetail)

An object containing detailed information about the result of provisioning the product.

executeProvisionedProductServiceActionResponse_httpStatus :: Lens' ExecuteProvisionedProductServiceActionResponse Int

The response's http status code.

GetAWSOrganizationsAccessStatus

getAWSOrganizationsAccessStatusResponse_accessStatus :: Lens' GetAWSOrganizationsAccessStatusResponse (Maybe AccessStatus)

The status of the portfolio share feature.

getAWSOrganizationsAccessStatusResponse_httpStatus :: Lens' GetAWSOrganizationsAccessStatusResponse Int

The response's http status code.

GetProvisionedProductOutputs

getProvisionedProductOutputs_acceptLanguage :: Lens' GetProvisionedProductOutputs (Maybe Text)

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

getProvisionedProductOutputs_outputKeys :: Lens' GetProvisionedProductOutputs (Maybe [Text])

The list of keys that the API should return with their values. If none are provided, the API will return all outputs of the provisioned product.

getProvisionedProductOutputs_pageSize :: Lens' GetProvisionedProductOutputs (Maybe Natural)

The maximum number of items to return with this call.

getProvisionedProductOutputs_pageToken :: Lens' GetProvisionedProductOutputs (Maybe Text)

The page token for the next set of results. To retrieve the first set of results, use null.

getProvisionedProductOutputs_provisionedProductId :: Lens' GetProvisionedProductOutputs (Maybe Text)

The identifier of the provisioned product that you want the outputs from.

getProvisionedProductOutputs_provisionedProductName :: Lens' GetProvisionedProductOutputs (Maybe Text)

The name of the provisioned product that you want the outputs from.

getProvisionedProductOutputsResponse_nextPageToken :: Lens' GetProvisionedProductOutputsResponse (Maybe Text)

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

getProvisionedProductOutputsResponse_outputs :: Lens' GetProvisionedProductOutputsResponse (Maybe [RecordOutput])

Information about the product created as the result of a request. For example, the output for a CloudFormation-backed product that creates an S3 bucket would include the S3 bucket URL.

getProvisionedProductOutputsResponse_httpStatus :: Lens' GetProvisionedProductOutputsResponse Int

The response's http status code.

ImportAsProvisionedProduct

importAsProvisionedProduct_acceptLanguage :: Lens' ImportAsProvisionedProduct (Maybe Text)

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

importAsProvisionedProduct_productId :: Lens' ImportAsProvisionedProduct Text

The product identifier.

importAsProvisionedProduct_provisioningArtifactId :: Lens' ImportAsProvisionedProduct Text

The identifier of the provisioning artifact.

importAsProvisionedProduct_provisionedProductName :: Lens' ImportAsProvisionedProduct Text

The user-friendly name of the provisioned product. The value must be unique for the Amazon Web Services account. The name cannot be updated after the product is provisioned.

importAsProvisionedProduct_physicalId :: Lens' ImportAsProvisionedProduct Text

The unique identifier of the resource to be imported. It only currently supports CloudFormation stack IDs.

importAsProvisionedProduct_idempotencyToken :: Lens' ImportAsProvisionedProduct Text

A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

importAsProvisionedProductResponse_recordDetail :: Lens' ImportAsProvisionedProductResponse (Maybe RecordDetail)

Undocumented member.

importAsProvisionedProductResponse_httpStatus :: Lens' ImportAsProvisionedProductResponse Int

The response's http status code.

ListAcceptedPortfolioShares

listAcceptedPortfolioShares_acceptLanguage :: Lens' ListAcceptedPortfolioShares (Maybe Text)

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

listAcceptedPortfolioShares_pageSize :: Lens' ListAcceptedPortfolioShares (Maybe Natural)

The maximum number of items to return with this call.

listAcceptedPortfolioShares_pageToken :: Lens' ListAcceptedPortfolioShares (Maybe Text)

The page token for the next set of results. To retrieve the first set of results, use null.

listAcceptedPortfolioShares_portfolioShareType :: Lens' ListAcceptedPortfolioShares (Maybe PortfolioShareType)

The type of shared portfolios to list. The default is to list imported portfolios.

• AWS_ORGANIZATIONS - List portfolios accepted and shared via organizational sharing by the management account or delegated administrator of your organization.
• AWS_SERVICECATALOG - Deprecated type.
• IMPORTED - List imported portfolios that have been accepted and shared through account-to-account sharing.

listAcceptedPortfolioSharesResponse_nextPageToken :: Lens' ListAcceptedPortfolioSharesResponse (Maybe Text)

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

listAcceptedPortfolioSharesResponse_portfolioDetails :: Lens' ListAcceptedPortfolioSharesResponse (Maybe [PortfolioDetail])

Information about the portfolios.

listAcceptedPortfolioSharesResponse_httpStatus :: Lens' ListAcceptedPortfolioSharesResponse Int

The response's http status code.

ListBudgetsForResource

listBudgetsForResource_acceptLanguage :: Lens' ListBudgetsForResource (Maybe Text)

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

listBudgetsForResource_pageSize :: Lens' ListBudgetsForResource (Maybe Natural)

The maximum number of items to return with this call.

listBudgetsForResource_pageToken :: Lens' ListBudgetsForResource (Maybe Text)

The page token for the next set of results. To retrieve the first set of results, use null.

listBudgetsForResource_resourceId :: Lens' ListBudgetsForResource Text

The resource identifier.

listBudgetsForResourceResponse_budgets :: Lens' ListBudgetsForResourceResponse (Maybe [BudgetDetail])

Information about the associated budgets.

listBudgetsForResourceResponse_nextPageToken :: Lens' ListBudgetsForResourceResponse (Maybe Text)

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

listBudgetsForResourceResponse_httpStatus :: Lens' ListBudgetsForResourceResponse Int

The response's http status code.

ListConstraintsForPortfolio

listConstraintsForPortfolio_acceptLanguage :: Lens' ListConstraintsForPortfolio (Maybe Text)

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

listConstraintsForPortfolio_pageSize :: Lens' ListConstraintsForPortfolio (Maybe Natural)

The maximum number of items to return with this call.

listConstraintsForPortfolio_pageToken :: Lens' ListConstraintsForPortfolio (Maybe Text)

The page token for the next set of results. To retrieve the first set of results, use null.

listConstraintsForPortfolio_productId :: Lens' ListConstraintsForPortfolio (Maybe Text)

The product identifier.

listConstraintsForPortfolio_portfolioId :: Lens' ListConstraintsForPortfolio Text

The portfolio identifier.

listConstraintsForPortfolioResponse_constraintDetails :: Lens' ListConstraintsForPortfolioResponse (Maybe [ConstraintDetail])

Information about the constraints.

listConstraintsForPortfolioResponse_nextPageToken :: Lens' ListConstraintsForPortfolioResponse (Maybe Text)

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

listConstraintsForPortfolioResponse_httpStatus :: Lens' ListConstraintsForPortfolioResponse Int

The response's http status code.

ListLaunchPaths

listLaunchPaths_acceptLanguage :: Lens' ListLaunchPaths (Maybe Text)

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

listLaunchPaths_pageSize :: Lens' ListLaunchPaths (Maybe Natural)

The maximum number of items to return with this call.

listLaunchPaths_pageToken :: Lens' ListLaunchPaths (Maybe Text)

The page token for the next set of results. To retrieve the first set of results, use null.

listLaunchPaths_productId :: Lens' ListLaunchPaths Text

The product identifier.

listLaunchPathsResponse_launchPathSummaries :: Lens' ListLaunchPathsResponse (Maybe [LaunchPathSummary])

Information about the launch path.

listLaunchPathsResponse_nextPageToken :: Lens' ListLaunchPathsResponse (Maybe Text)

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

listLaunchPathsResponse_httpStatus :: Lens' ListLaunchPathsResponse Int

The response's http status code.

ListOrganizationPortfolioAccess

listOrganizationPortfolioAccess_acceptLanguage :: Lens' ListOrganizationPortfolioAccess (Maybe Text)

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

listOrganizationPortfolioAccess_pageSize :: Lens' ListOrganizationPortfolioAccess (Maybe Natural)

The maximum number of items to return with this call.

listOrganizationPortfolioAccess_pageToken :: Lens' ListOrganizationPortfolioAccess (Maybe Text)

The page token for the next set of results. To retrieve the first set of results, use null.

listOrganizationPortfolioAccess_portfolioId :: Lens' ListOrganizationPortfolioAccess Text

The portfolio identifier. For example, port-2abcdext3y5fk.

listOrganizationPortfolioAccess_organizationNodeType :: Lens' ListOrganizationPortfolioAccess OrganizationNodeType

The organization node type that will be returned in the output.

• ORGANIZATION - Organization that has access to the portfolio.
• ORGANIZATIONAL_UNIT - Organizational unit that has access to the portfolio within your organization.
• ACCOUNT - Account that has access to the portfolio within your organization.

listOrganizationPortfolioAccessResponse_nextPageToken :: Lens' ListOrganizationPortfolioAccessResponse (Maybe Text)

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

listOrganizationPortfolioAccessResponse_organizationNodes :: Lens' ListOrganizationPortfolioAccessResponse (Maybe [OrganizationNode])

Displays information about the organization nodes.

listOrganizationPortfolioAccessResponse_httpStatus :: Lens' ListOrganizationPortfolioAccessResponse Int

The response's http status code.

ListPortfolioAccess

listPortfolioAccess_acceptLanguage :: Lens' ListPortfolioAccess (Maybe Text)

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

listPortfolioAccess_organizationParentId :: Lens' ListPortfolioAccess (Maybe Text)

The ID of an organization node the portfolio is shared with. All children of this node with an inherited portfolio share will be returned.

listPortfolioAccess_pageSize :: Lens' ListPortfolioAccess (Maybe Natural)

The maximum number of items to return with this call.

listPortfolioAccess_pageToken :: Lens' ListPortfolioAccess (Maybe Text)

The page token for the next set of results. To retrieve the first set of results, use null.

listPortfolioAccess_portfolioId :: Lens' ListPortfolioAccess Text

The portfolio identifier.

listPortfolioAccessResponse_accountIds :: Lens' ListPortfolioAccessResponse (Maybe [Text])

Information about the Amazon Web Services accounts with access to the portfolio.

listPortfolioAccessResponse_nextPageToken :: Lens' ListPortfolioAccessResponse (Maybe Text)

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

listPortfolioAccessResponse_httpStatus :: Lens' ListPortfolioAccessResponse Int

The response's http status code.

ListPortfolios

listPortfolios_acceptLanguage :: Lens' ListPortfolios (Maybe Text)

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

listPortfolios_pageSize :: Lens' ListPortfolios (Maybe Natural)

The maximum number of items to return with this call.

listPortfolios_pageToken :: Lens' ListPortfolios (Maybe Text)

The page token for the next set of results. To retrieve the first set of results, use null.

listPortfoliosResponse_nextPageToken :: Lens' ListPortfoliosResponse (Maybe Text)

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

listPortfoliosResponse_portfolioDetails :: Lens' ListPortfoliosResponse (Maybe [PortfolioDetail])

Information about the portfolios.

listPortfoliosResponse_httpStatus :: Lens' ListPortfoliosResponse Int

The response's http status code.

ListPortfoliosForProduct

listPortfoliosForProduct_acceptLanguage :: Lens' ListPortfoliosForProduct (Maybe Text)

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

listPortfoliosForProduct_pageSize :: Lens' ListPortfoliosForProduct (Maybe Natural)

The maximum number of items to return with this call.

listPortfoliosForProduct_pageToken :: Lens' ListPortfoliosForProduct (Maybe Text)

The page token for the next set of results. To retrieve the first set of results, use null.

listPortfoliosForProduct_productId :: Lens' ListPortfoliosForProduct Text

The product identifier.

listPortfoliosForProductResponse_nextPageToken :: Lens' ListPortfoliosForProductResponse (Maybe Text)

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

listPortfoliosForProductResponse_portfolioDetails :: Lens' ListPortfoliosForProductResponse (Maybe [PortfolioDetail])

Information about the portfolios.

listPortfoliosForProductResponse_httpStatus :: Lens' ListPortfoliosForProductResponse Int

The response's http status code.

ListPrincipalsForPortfolio

listPrincipalsForPortfolio_acceptLanguage :: Lens' ListPrincipalsForPortfolio (Maybe Text)

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

listPrincipalsForPortfolio_pageSize :: Lens' ListPrincipalsForPortfolio (Maybe Natural)

The maximum number of items to return with this call.

listPrincipalsForPortfolio_pageToken :: Lens' ListPrincipalsForPortfolio (Maybe Text)

The page token for the next set of results. To retrieve the first set of results, use null.

listPrincipalsForPortfolio_portfolioId :: Lens' ListPrincipalsForPortfolio Text

The portfolio identifier.

listPrincipalsForPortfolioResponse_nextPageToken :: Lens' ListPrincipalsForPortfolioResponse (Maybe Text)

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

listPrincipalsForPortfolioResponse_principals :: Lens' ListPrincipalsForPortfolioResponse (Maybe [Principal])

The PrincipalARNs and corresponding PrincipalTypes associated with the portfolio.

listPrincipalsForPortfolioResponse_httpStatus :: Lens' ListPrincipalsForPortfolioResponse Int

The response's http status code.

ListProvisionedProductPlans

listProvisionedProductPlans_acceptLanguage :: Lens' ListProvisionedProductPlans (Maybe Text)

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

listProvisionedProductPlans_accessLevelFilter :: Lens' ListProvisionedProductPlans (Maybe AccessLevelFilter)

The access level to use to obtain results. The default is User.

listProvisionedProductPlans_pageSize :: Lens' ListProvisionedProductPlans (Maybe Natural)

The maximum number of items to return with this call.

listProvisionedProductPlans_pageToken :: Lens' ListProvisionedProductPlans (Maybe Text)

The page token for the next set of results. To retrieve the first set of results, use null.

listProvisionedProductPlans_provisionProductId :: Lens' ListProvisionedProductPlans (Maybe Text)

The product identifier.

listProvisionedProductPlansResponse_nextPageToken :: Lens' ListProvisionedProductPlansResponse (Maybe Text)

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

listProvisionedProductPlansResponse_provisionedProductPlans :: Lens' ListProvisionedProductPlansResponse (Maybe [ProvisionedProductPlanSummary])

Information about the plans.

listProvisionedProductPlansResponse_httpStatus :: Lens' ListProvisionedProductPlansResponse Int

The response's http status code.

ListProvisioningArtifacts

listProvisioningArtifacts_acceptLanguage :: Lens' ListProvisioningArtifacts (Maybe Text)

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

listProvisioningArtifacts_productId :: Lens' ListProvisioningArtifacts Text

The product identifier.

listProvisioningArtifactsResponse_nextPageToken :: Lens' ListProvisioningArtifactsResponse (Maybe Text)

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

listProvisioningArtifactsResponse_provisioningArtifactDetails :: Lens' ListProvisioningArtifactsResponse (Maybe [ProvisioningArtifactDetail])

Information about the provisioning artifacts.

listProvisioningArtifactsResponse_httpStatus :: Lens' ListProvisioningArtifactsResponse Int

The response's http status code.

ListProvisioningArtifactsForServiceAction

listProvisioningArtifactsForServiceAction_acceptLanguage :: Lens' ListProvisioningArtifactsForServiceAction (Maybe Text)

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

listProvisioningArtifactsForServiceAction_pageSize :: Lens' ListProvisioningArtifactsForServiceAction (Maybe Natural)

The maximum number of items to return with this call.

listProvisioningArtifactsForServiceAction_pageToken :: Lens' ListProvisioningArtifactsForServiceAction (Maybe Text)

The page token for the next set of results. To retrieve the first set of results, use null.

listProvisioningArtifactsForServiceAction_serviceActionId :: Lens' ListProvisioningArtifactsForServiceAction Text

The self-service action identifier. For example, act-fs7abcd89wxyz.

listProvisioningArtifactsForServiceActionResponse_nextPageToken :: Lens' ListProvisioningArtifactsForServiceActionResponse (Maybe Text)

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

listProvisioningArtifactsForServiceActionResponse_provisioningArtifactViews :: Lens' ListProvisioningArtifactsForServiceActionResponse (Maybe [ProvisioningArtifactView])

An array of objects with information about product views and provisioning artifacts.

listProvisioningArtifactsForServiceActionResponse_httpStatus :: Lens' ListProvisioningArtifactsForServiceActionResponse Int

The response's http status code.

ListRecordHistory

listRecordHistory_acceptLanguage :: Lens' ListRecordHistory (Maybe Text)

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

listRecordHistory_accessLevelFilter :: Lens' ListRecordHistory (Maybe AccessLevelFilter)

The access level to use to obtain results. The default is User.

listRecordHistory_pageSize :: Lens' ListRecordHistory (Maybe Natural)

The maximum number of items to return with this call.

listRecordHistory_pageToken :: Lens' ListRecordHistory (Maybe Text)

The page token for the next set of results. To retrieve the first set of results, use null.

listRecordHistory_searchFilter :: Lens' ListRecordHistory (Maybe ListRecordHistorySearchFilter)

The search filter to scope the results.

listRecordHistoryResponse_nextPageToken :: Lens' ListRecordHistoryResponse (Maybe Text)

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

listRecordHistoryResponse_recordDetails :: Lens' ListRecordHistoryResponse (Maybe [RecordDetail])

The records, in reverse chronological order.

listRecordHistoryResponse_httpStatus :: Lens' ListRecordHistoryResponse Int

The response's http status code.

ListResourcesForTagOption

listResourcesForTagOption_pageSize :: Lens' ListResourcesForTagOption (Maybe Natural)

The maximum number of items to return with this call.

listResourcesForTagOption_pageToken :: Lens' ListResourcesForTagOption (Maybe Text)

The page token for the next set of results. To retrieve the first set of results, use null.

listResourcesForTagOption_resourceType :: Lens' ListResourcesForTagOption (Maybe Text)

The resource type.

• Portfolio

• Product

listResourcesForTagOption_tagOptionId :: Lens' ListResourcesForTagOption Text

The TagOption identifier.

listResourcesForTagOptionResponse_pageToken :: Lens' ListResourcesForTagOptionResponse (Maybe Text)

The page token for the next set of results. To retrieve the first set of results, use null.

listResourcesForTagOptionResponse_resourceDetails :: Lens' ListResourcesForTagOptionResponse (Maybe [ResourceDetail])

Information about the resources.

listResourcesForTagOptionResponse_httpStatus :: Lens' ListResourcesForTagOptionResponse Int

The response's http status code.

ListServiceActions

listServiceActions_acceptLanguage :: Lens' ListServiceActions (Maybe Text)

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

listServiceActions_pageSize :: Lens' ListServiceActions (Maybe Natural)

The maximum number of items to return with this call.

listServiceActions_pageToken :: Lens' ListServiceActions (Maybe Text)

The page token for the next set of results. To retrieve the first set of results, use null.

listServiceActionsResponse_nextPageToken :: Lens' ListServiceActionsResponse (Maybe Text)

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

listServiceActionsResponse_serviceActionSummaries :: Lens' ListServiceActionsResponse (Maybe [ServiceActionSummary])

An object containing information about the service actions associated with the provisioning artifact.

listServiceActionsResponse_httpStatus :: Lens' ListServiceActionsResponse Int

The response's http status code.

ListServiceActionsForProvisioningArtifact

listServiceActionsForProvisioningArtifact_acceptLanguage :: Lens' ListServiceActionsForProvisioningArtifact (Maybe Text)

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

listServiceActionsForProvisioningArtifact_pageSize :: Lens' ListServiceActionsForProvisioningArtifact (Maybe Natural)

The maximum number of items to return with this call.

listServiceActionsForProvisioningArtifact_pageToken :: Lens' ListServiceActionsForProvisioningArtifact (Maybe Text)

The page token for the next set of results. To retrieve the first set of results, use null.

listServiceActionsForProvisioningArtifact_productId :: Lens' ListServiceActionsForProvisioningArtifact Text

The product identifier. For example, prod-abcdzk7xy33qa.

listServiceActionsForProvisioningArtifact_provisioningArtifactId :: Lens' ListServiceActionsForProvisioningArtifact Text

The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne.

listServiceActionsForProvisioningArtifactResponse_nextPageToken :: Lens' ListServiceActionsForProvisioningArtifactResponse (Maybe Text)

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

listServiceActionsForProvisioningArtifactResponse_serviceActionSummaries :: Lens' ListServiceActionsForProvisioningArtifactResponse (Maybe [ServiceActionSummary])

An object containing information about the self-service actions associated with the provisioning artifact.

listServiceActionsForProvisioningArtifactResponse_httpStatus :: Lens' ListServiceActionsForProvisioningArtifactResponse Int

The response's http status code.

ListStackInstancesForProvisionedProduct

listStackInstancesForProvisionedProduct_acceptLanguage :: Lens' ListStackInstancesForProvisionedProduct (Maybe Text)

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

listStackInstancesForProvisionedProduct_pageSize :: Lens' ListStackInstancesForProvisionedProduct (Maybe Natural)

The maximum number of items to return with this call.

listStackInstancesForProvisionedProduct_pageToken :: Lens' ListStackInstancesForProvisionedProduct (Maybe Text)

The page token for the next set of results. To retrieve the first set of results, use null.

listStackInstancesForProvisionedProduct_provisionedProductId :: Lens' ListStackInstancesForProvisionedProduct Text

The identifier of the provisioned product.

listStackInstancesForProvisionedProductResponse_nextPageToken :: Lens' ListStackInstancesForProvisionedProductResponse (Maybe Text)

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

listStackInstancesForProvisionedProductResponse_stackInstances :: Lens' ListStackInstancesForProvisionedProductResponse (Maybe [StackInstance])

List of stack instances.

listStackInstancesForProvisionedProductResponse_httpStatus :: Lens' ListStackInstancesForProvisionedProductResponse Int

The response's http status code.

ListTagOptions

listTagOptions_filters :: Lens' ListTagOptions (Maybe ListTagOptionsFilters)

The search filters. If no search filters are specified, the output includes all TagOptions.

listTagOptions_pageSize :: Lens' ListTagOptions (Maybe Natural)

The maximum number of items to return with this call.

listTagOptions_pageToken :: Lens' ListTagOptions (Maybe Text)

The page token for the next set of results. To retrieve the first set of results, use null.

listTagOptionsResponse_pageToken :: Lens' ListTagOptionsResponse (Maybe Text)

The page token for the next set of results. To retrieve the first set of results, use null.

listTagOptionsResponse_tagOptionDetails :: Lens' ListTagOptionsResponse (Maybe [TagOptionDetail])

Information about the TagOptions.

listTagOptionsResponse_httpStatus :: Lens' ListTagOptionsResponse Int

The response's http status code.

ProvisionProduct

provisionProduct_acceptLanguage :: Lens' ProvisionProduct (Maybe Text)

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

provisionProduct_notificationArns :: Lens' ProvisionProduct (Maybe [Text])

Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events.

provisionProduct_pathId :: Lens' ProvisionProduct (Maybe Text)

The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths. You must provide the name or ID, but not both.

provisionProduct_pathName :: Lens' ProvisionProduct (Maybe Text)

The name of the path. You must provide the name or ID, but not both.

provisionProduct_productId :: Lens' ProvisionProduct (Maybe Text)

The product identifier. You must provide the name or ID, but not both.

provisionProduct_productName :: Lens' ProvisionProduct (Maybe Text)

The name of the product. You must provide the name or ID, but not both.

provisionProduct_provisioningArtifactId :: Lens' ProvisionProduct (Maybe Text)

The identifier of the provisioning artifact. You must provide the name or ID, but not both.

provisionProduct_provisioningArtifactName :: Lens' ProvisionProduct (Maybe Text)

The name of the provisioning artifact. You must provide the name or ID, but not both.

provisionProduct_provisioningParameters :: Lens' ProvisionProduct (Maybe [ProvisioningParameter])

Parameters specified by the administrator that are required for provisioning the product.

provisionProduct_provisioningPreferences :: Lens' ProvisionProduct (Maybe ProvisioningPreferences)

An object that contains information about the provisioning preferences for a stack set.

provisionProduct_tags :: Lens' ProvisionProduct (Maybe [Tag])

One or more tags.

provisionProduct_provisionedProductName :: Lens' ProvisionProduct Text

A user-friendly name for the provisioned product. This value must be unique for the Amazon Web Services account and cannot be updated after the product is provisioned.

provisionProduct_provisionToken :: Lens' ProvisionProduct Text

An idempotency token that uniquely identifies the provisioning request.

provisionProductResponse_recordDetail :: Lens' ProvisionProductResponse (Maybe RecordDetail)

Information about the result of provisioning the product.

provisionProductResponse_httpStatus :: Lens' ProvisionProductResponse Int

The response's http status code.

RejectPortfolioShare

rejectPortfolioShare_acceptLanguage :: Lens' RejectPortfolioShare (Maybe Text)

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

rejectPortfolioShare_portfolioShareType :: Lens' RejectPortfolioShare (Maybe PortfolioShareType)

The type of shared portfolios to reject. The default is to reject imported portfolios.

• AWS_ORGANIZATIONS - Reject portfolios shared by the management account of your organization.
• IMPORTED - Reject imported portfolios.
• AWS_SERVICECATALOG - Not supported. (Throws ResourceNotFoundException.)

For example, aws servicecatalog reject-portfolio-share --portfolio-id "port-2qwzkwxt3y5fk" --portfolio-share-type AWS_ORGANIZATIONS

rejectPortfolioShare_portfolioId :: Lens' RejectPortfolioShare Text

The portfolio identifier.

rejectPortfolioShareResponse_httpStatus :: Lens' RejectPortfolioShareResponse Int

The response's http status code.

ScanProvisionedProducts

scanProvisionedProducts_acceptLanguage :: Lens' ScanProvisionedProducts (Maybe Text)

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

scanProvisionedProducts_accessLevelFilter :: Lens' ScanProvisionedProducts (Maybe AccessLevelFilter)

The access level to use to obtain results. The default is User.

scanProvisionedProducts_pageSize :: Lens' ScanProvisionedProducts (Maybe Natural)

The maximum number of items to return with this call.

scanProvisionedProducts_pageToken :: Lens' ScanProvisionedProducts (Maybe Text)

The page token for the next set of results. To retrieve the first set of results, use null.

scanProvisionedProductsResponse_nextPageToken :: Lens' ScanProvisionedProductsResponse (Maybe Text)

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

scanProvisionedProductsResponse_provisionedProducts :: Lens' ScanProvisionedProductsResponse (Maybe [ProvisionedProductDetail])

Information about the provisioned products.

scanProvisionedProductsResponse_httpStatus :: Lens' ScanProvisionedProductsResponse Int

The response's http status code.

SearchProducts

searchProducts_acceptLanguage :: Lens' SearchProducts (Maybe Text)

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

searchProducts_filters :: Lens' SearchProducts (Maybe (HashMap ProductViewFilterBy [Text]))

The search filters. If no search filters are specified, the output includes all products to which the caller has access.

searchProducts_pageSize :: Lens' SearchProducts (Maybe Natural)

The maximum number of items to return with this call.

searchProducts_pageToken :: Lens' SearchProducts (Maybe Text)

The page token for the next set of results. To retrieve the first set of results, use null.

searchProducts_sortBy :: Lens' SearchProducts (Maybe ProductViewSortBy)

The sort field. If no value is specified, the results are not sorted.

searchProducts_sortOrder :: Lens' SearchProducts (Maybe SortOrder)

The sort order. If no value is specified, the results are not sorted.

searchProductsResponse_nextPageToken :: Lens' SearchProductsResponse (Maybe Text)

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

searchProductsResponse_productViewAggregations :: Lens' SearchProductsResponse (Maybe (HashMap Text [ProductViewAggregationValue]))

The product view aggregations.

searchProductsResponse_productViewSummaries :: Lens' SearchProductsResponse (Maybe [ProductViewSummary])

Information about the product views.

searchProductsResponse_httpStatus :: Lens' SearchProductsResponse Int

The response's http status code.

SearchProductsAsAdmin

searchProductsAsAdmin_acceptLanguage :: Lens' SearchProductsAsAdmin (Maybe Text)

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

searchProductsAsAdmin_filters :: Lens' SearchProductsAsAdmin (Maybe (HashMap ProductViewFilterBy [Text]))

The search filters. If no search filters are specified, the output includes all products to which the administrator has access.

searchProductsAsAdmin_pageSize :: Lens' SearchProductsAsAdmin (Maybe Natural)

The maximum number of items to return with this call.

searchProductsAsAdmin_pageToken :: Lens' SearchProductsAsAdmin (Maybe Text)

The page token for the next set of results. To retrieve the first set of results, use null.

searchProductsAsAdmin_portfolioId :: Lens' SearchProductsAsAdmin (Maybe Text)

The portfolio identifier.

searchProductsAsAdmin_productSource :: Lens' SearchProductsAsAdmin (Maybe ProductSource)

Access level of the source of the product.

searchProductsAsAdmin_sortBy :: Lens' SearchProductsAsAdmin (Maybe ProductViewSortBy)

The sort field. If no value is specified, the results are not sorted.

searchProductsAsAdmin_sortOrder :: Lens' SearchProductsAsAdmin (Maybe SortOrder)

The sort order. If no value is specified, the results are not sorted.

searchProductsAsAdminResponse_nextPageToken :: Lens' SearchProductsAsAdminResponse (Maybe Text)

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

searchProductsAsAdminResponse_productViewDetails :: Lens' SearchProductsAsAdminResponse (Maybe [ProductViewDetail])

Information about the product views.

searchProductsAsAdminResponse_httpStatus :: Lens' SearchProductsAsAdminResponse Int

The response's http status code.

SearchProvisionedProducts

searchProvisionedProducts_acceptLanguage :: Lens' SearchProvisionedProducts (Maybe Text)

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

searchProvisionedProducts_accessLevelFilter :: Lens' SearchProvisionedProducts (Maybe AccessLevelFilter)

The access level to use to obtain results. The default is User.

searchProvisionedProducts_filters :: Lens' SearchProvisionedProducts (Maybe (HashMap ProvisionedProductViewFilterBy [Text]))

The search filters.

When the key is SearchQuery, the searchable fields are arn, createdTime, id, lastRecordId, idempotencyToken, name, physicalId, productId, provisioningArtifact, type, status, tags, userArn, userArnSession, lastProvisioningRecordId, lastSuccessfulProvisioningRecordId, productName, and provisioningArtifactName.

Example: "SearchQuery":["status:AVAILABLE"]

searchProvisionedProducts_pageSize :: Lens' SearchProvisionedProducts (Maybe Natural)

The maximum number of items to return with this call.

searchProvisionedProducts_pageToken :: Lens' SearchProvisionedProducts (Maybe Text)

The page token for the next set of results. To retrieve the first set of results, use null.

searchProvisionedProducts_sortBy :: Lens' SearchProvisionedProducts (Maybe Text)

The sort field. If no value is specified, the results are not sorted. The valid values are arn, id, name, and lastRecordId.

searchProvisionedProducts_sortOrder :: Lens' SearchProvisionedProducts (Maybe SortOrder)

The sort order. If no value is specified, the results are not sorted.

searchProvisionedProductsResponse_nextPageToken :: Lens' SearchProvisionedProductsResponse (Maybe Text)

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

searchProvisionedProductsResponse_provisionedProducts :: Lens' SearchProvisionedProductsResponse (Maybe [ProvisionedProductAttribute])

Information about the provisioned products.

searchProvisionedProductsResponse_totalResultsCount :: Lens' SearchProvisionedProductsResponse (Maybe Int)

The number of provisioned products found.

searchProvisionedProductsResponse_httpStatus :: Lens' SearchProvisionedProductsResponse Int

The response's http status code.

TerminateProvisionedProduct

terminateProvisionedProduct_acceptLanguage :: Lens' TerminateProvisionedProduct (Maybe Text)

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

terminateProvisionedProduct_ignoreErrors :: Lens' TerminateProvisionedProduct (Maybe Bool)

If set to true, Service Catalog stops managing the specified provisioned product even if it cannot delete the underlying resources.

terminateProvisionedProduct_provisionedProductId :: Lens' TerminateProvisionedProduct (Maybe Text)

The identifier of the provisioned product. You cannot specify both ProvisionedProductName and ProvisionedProductId.

terminateProvisionedProduct_provisionedProductName :: Lens' TerminateProvisionedProduct (Maybe Text)

The name of the provisioned product. You cannot specify both ProvisionedProductName and ProvisionedProductId.

terminateProvisionedProduct_retainPhysicalResources :: Lens' TerminateProvisionedProduct (Maybe Bool)

When this boolean parameter is set to true, the TerminateProvisionedProduct API deletes the Service Catalog provisioned product. However, it does not remove the CloudFormation stack, stack set, or the underlying resources of the deleted provisioned product. The default value is false.

terminateProvisionedProduct_terminateToken :: Lens' TerminateProvisionedProduct Text

An idempotency token that uniquely identifies the termination request. This token is only valid during the termination process. After the provisioned product is terminated, subsequent requests to terminate the same provisioned product always return ResourceNotFound.

terminateProvisionedProductResponse_recordDetail :: Lens' TerminateProvisionedProductResponse (Maybe RecordDetail)

Information about the result of this request.

terminateProvisionedProductResponse_httpStatus :: Lens' TerminateProvisionedProductResponse Int

The response's http status code.

UpdateConstraint

updateConstraint_acceptLanguage :: Lens' UpdateConstraint (Maybe Text)

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

updateConstraint_description :: Lens' UpdateConstraint (Maybe Text)

The updated description of the constraint.

updateConstraint_parameters :: Lens' UpdateConstraint (Maybe Text)

The constraint parameters, in JSON format. The syntax depends on the constraint type as follows:

LAUNCH

You are required to specify either the RoleArn or the LocalRoleName but can't use both.

Specify the RoleArn property as follows:

{"RoleArn" : "arn:aws:iam::123456789012:role/LaunchRole"}

Specify the LocalRoleName property as follows:

{"LocalRoleName": "SCBasicLaunchRole"}

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 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.

You cannot have both a LAUNCH and a STACKSET constraint.

You also cannot have more than one LAUNCH constraint on a product and portfolio.

NOTIFICATION

Specify the NotificationArns property as follows:

{"NotificationArns" : ["arn:aws:sns:us-east-1:123456789012:Topic"]}

RESOURCE_UPDATE

Specify the TagUpdatesOnProvisionedProduct property as follows:

{"Version":"2.0","Properties":{"TagUpdateOnProvisionedProduct":"String"}}

The TagUpdatesOnProvisionedProduct property accepts a string value of ALLOWED or NOT_ALLOWED.

STACKSET

Specify the Parameters property as follows:

{"Version": "String", "Properties": {"AccountList": [ "String" ], "RegionList": [ "String" ], "AdminRole": "String", "ExecutionRole": "String"}}

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.

TEMPLATE

Specify the Rules property. For more information, see Template Constraint Rules.

updateConstraint_id :: Lens' UpdateConstraint Text

The identifier of the constraint.

updateConstraintResponse_constraintDetail :: Lens' UpdateConstraintResponse (Maybe ConstraintDetail)

Information about the constraint.

updateConstraintResponse_constraintParameters :: Lens' UpdateConstraintResponse (Maybe Text)

The constraint parameters.

updateConstraintResponse_status :: Lens' UpdateConstraintResponse (Maybe RequestStatus)

The status of the current request.

updateConstraintResponse_httpStatus :: Lens' UpdateConstraintResponse Int

The response's http status code.

UpdatePortfolio

updatePortfolio_acceptLanguage :: Lens' UpdatePortfolio (Maybe Text)

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

updatePortfolio_addTags :: Lens' UpdatePortfolio (Maybe [Tag])

The tags to add.

updatePortfolio_description :: Lens' UpdatePortfolio (Maybe Text)

The updated description of the portfolio.

updatePortfolio_displayName :: Lens' UpdatePortfolio (Maybe Text)

The name to use for display purposes.

updatePortfolio_providerName :: Lens' UpdatePortfolio (Maybe Text)

The updated name of the portfolio provider.

updatePortfolio_removeTags :: Lens' UpdatePortfolio (Maybe [Text])

The tags to remove.

updatePortfolio_id :: Lens' UpdatePortfolio Text

The portfolio identifier.

updatePortfolioResponse_portfolioDetail :: Lens' UpdatePortfolioResponse (Maybe PortfolioDetail)

Information about the portfolio.

updatePortfolioResponse_tags :: Lens' UpdatePortfolioResponse (Maybe [Tag])

Information about the tags associated with the portfolio.

updatePortfolioResponse_httpStatus :: Lens' UpdatePortfolioResponse Int

The response's http status code.

UpdatePortfolioShare

updatePortfolioShare_acceptLanguage :: Lens' UpdatePortfolioShare (Maybe Text)

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

updatePortfolioShare_accountId :: Lens' UpdatePortfolioShare (Maybe Text)

The Amazon Web Services account Id of the recipient account. This field is required when updating an external account to account type share.

updatePortfolioShare_organizationNode :: Lens' UpdatePortfolioShare (Maybe OrganizationNode)

Undocumented member.

updatePortfolioShare_sharePrincipals :: Lens' UpdatePortfolioShare (Maybe Bool)

A flag to enables or disables Principals sharing in the portfolio. If this field is not provided, the current state of the Principals sharing on the portfolio share will not be modified.

updatePortfolioShare_shareTagOptions :: Lens' UpdatePortfolioShare (Maybe Bool)

Enables or disables TagOptions sharing for the portfolio share. If this field is not provided, the current state of TagOptions sharing on the portfolio share will not be modified.

updatePortfolioShare_portfolioId :: Lens' UpdatePortfolioShare Text

The unique identifier of the portfolio for which the share will be updated.

updatePortfolioShareResponse_portfolioShareToken :: Lens' UpdatePortfolioShareResponse (Maybe Text)

The token that tracks the status of the UpdatePortfolioShare operation for external account to account or organizational type sharing.

updatePortfolioShareResponse_status :: Lens' UpdatePortfolioShareResponse (Maybe ShareStatus)

The status of UpdatePortfolioShare operation. You can also obtain the operation status using DescribePortfolioShareStatus API.

updatePortfolioShareResponse_httpStatus :: Lens' UpdatePortfolioShareResponse Int

The response's http status code.

UpdateProduct

updateProduct_acceptLanguage :: Lens' UpdateProduct (Maybe Text)

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

updateProduct_addTags :: Lens' UpdateProduct (Maybe [Tag])

The tags to add to the product.

updateProduct_description :: Lens' UpdateProduct (Maybe Text)

The updated description of the product.

updateProduct_distributor :: Lens' UpdateProduct (Maybe Text)

The updated distributor of the product.

updateProduct_name :: Lens' UpdateProduct (Maybe Text)

The updated product name.

updateProduct_owner :: Lens' UpdateProduct (Maybe Text)

The updated owner of the product.

updateProduct_removeTags :: Lens' UpdateProduct (Maybe [Text])

The tags to remove from the product.

updateProduct_sourceConnection :: Lens' UpdateProduct (Maybe SourceConnection)

Specifies connection details for the updated product and syncs the product to the connection source artifact. This automatically manages the product's artifacts based on changes to the source. The SourceConnection parameter consists of the following sub-fields.

• Type

• ConnectionParamters

updateProduct_supportDescription :: Lens' UpdateProduct (Maybe Text)

The updated support description for the product.

updateProduct_supportEmail :: Lens' UpdateProduct (Maybe Text)

The updated support email for the product.

updateProduct_supportUrl :: Lens' UpdateProduct (Maybe Text)

The updated support URL for the product.

updateProduct_id :: Lens' UpdateProduct Text

The product identifier.

updateProductResponse_productViewDetail :: Lens' UpdateProductResponse (Maybe ProductViewDetail)

Information about the product view.

updateProductResponse_tags :: Lens' UpdateProductResponse (Maybe [Tag])

Information about the tags associated with the product.

updateProductResponse_httpStatus :: Lens' UpdateProductResponse Int

The response's http status code.

UpdateProvisionedProduct

updateProvisionedProduct_acceptLanguage :: Lens' UpdateProvisionedProduct (Maybe Text)

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

updateProvisionedProduct_pathId :: Lens' UpdateProvisionedProduct (Maybe Text)

The path identifier. This value is optional if the product has a default path, and required if the product has more than one path. You must provide the name or ID, but not both.

updateProvisionedProduct_pathName :: Lens' UpdateProvisionedProduct (Maybe Text)

The name of the path. You must provide the name or ID, but not both.

updateProvisionedProduct_productId :: Lens' UpdateProvisionedProduct (Maybe Text)

The identifier of the product. You must provide the name or ID, but not both.

updateProvisionedProduct_productName :: Lens' UpdateProvisionedProduct (Maybe Text)

The name of the product. You must provide the name or ID, but not both.

updateProvisionedProduct_provisionedProductId :: Lens' UpdateProvisionedProduct (Maybe Text)

The identifier of the provisioned product. You must provide the name or ID, but not both.

updateProvisionedProduct_provisionedProductName :: Lens' UpdateProvisionedProduct (Maybe Text)

The name of the provisioned product. You cannot specify both ProvisionedProductName and ProvisionedProductId.

updateProvisionedProduct_provisioningArtifactId :: Lens' UpdateProvisionedProduct (Maybe Text)

The identifier of the provisioning artifact.

updateProvisionedProduct_provisioningArtifactName :: Lens' UpdateProvisionedProduct (Maybe Text)

The name of the provisioning artifact. You must provide the name or ID, but not both.

updateProvisionedProduct_provisioningParameters :: Lens' UpdateProvisionedProduct (Maybe [UpdateProvisioningParameter])

The new parameters.

updateProvisionedProduct_provisioningPreferences :: Lens' UpdateProvisionedProduct (Maybe UpdateProvisioningPreferences)

An object that contains information about the provisioning preferences for a stack set.

updateProvisionedProduct_tags :: Lens' UpdateProvisionedProduct (Maybe [Tag])

One or more tags. Requires the product to have RESOURCE_UPDATE constraint with TagUpdatesOnProvisionedProduct set to ALLOWED to allow tag updates.

updateProvisionedProduct_updateToken :: Lens' UpdateProvisionedProduct Text

The idempotency token that uniquely identifies the provisioning update request.

updateProvisionedProductResponse_recordDetail :: Lens' UpdateProvisionedProductResponse (Maybe RecordDetail)

Information about the result of the request.

updateProvisionedProductResponse_httpStatus :: Lens' UpdateProvisionedProductResponse Int

The response's http status code.

UpdateProvisionedProductProperties

updateProvisionedProductProperties_acceptLanguage :: Lens' UpdateProvisionedProductProperties (Maybe Text)

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

updateProvisionedProductProperties_provisionedProductId :: Lens' UpdateProvisionedProductProperties Text

The identifier of the provisioned product.

updateProvisionedProductProperties_provisionedProductProperties :: Lens' UpdateProvisionedProductProperties (HashMap PropertyKey Text)

A map that contains the provisioned product properties to be updated.

The LAUNCH_ROLE key accepts role ARNs. This key allows an administrator to call UpdateProvisionedProductProperties to update the launch role that is associated with a provisioned product. This role is used when an end user calls a provisioning operation such as 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 administrator can change the owner of a provisioned product to another IAM or STS entity within the same account. Both end user owners and administrators can see ownership history of the provisioned product using the ListRecordHistory API. The new owner can describe all past records for the provisioned product using the DescribeRecord API. The previous owner can no longer use DescribeRecord, but can still see the product's history from when he was 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 Service Catalog console such as update, terminate, and execute service actions. 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 API or the Service Catalog console on that provisioned product.

updateProvisionedProductProperties_idempotencyToken :: Lens' UpdateProvisionedProductProperties Text

The idempotency token that uniquely identifies the provisioning product update request.

updateProvisionedProductPropertiesResponse_provisionedProductId :: Lens' UpdateProvisionedProductPropertiesResponse (Maybe Text)

The provisioned product identifier.

updateProvisionedProductPropertiesResponse_provisionedProductProperties :: Lens' UpdateProvisionedProductPropertiesResponse (Maybe (HashMap PropertyKey Text))

A map that contains the properties updated.

updateProvisionedProductPropertiesResponse_recordId :: Lens' UpdateProvisionedProductPropertiesResponse (Maybe Text)

The identifier of the record.

updateProvisionedProductPropertiesResponse_status :: Lens' UpdateProvisionedProductPropertiesResponse (Maybe RecordStatus)

The status of the request.

updateProvisionedProductPropertiesResponse_httpStatus :: Lens' UpdateProvisionedProductPropertiesResponse Int

The response's http status code.

UpdateProvisioningArtifact

updateProvisioningArtifact_acceptLanguage :: Lens' UpdateProvisioningArtifact (Maybe Text)

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

updateProvisioningArtifact_active :: Lens' UpdateProvisioningArtifact (Maybe Bool)

Indicates whether the product version is active.

Inactive provisioning artifacts are invisible to end users. End users cannot launch or update a provisioned product from an inactive provisioning artifact.

updateProvisioningArtifact_description :: Lens' UpdateProvisioningArtifact (Maybe Text)

The updated description of the provisioning artifact.

updateProvisioningArtifact_guidance :: Lens' UpdateProvisioningArtifact (Maybe ProvisioningArtifactGuidance)

Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.

The DEFAULT value indicates that the product version is active.

The administrator can set the guidance to DEPRECATED to inform users that the product version is deprecated. Users are able to make updates to a provisioned product of a deprecated version but cannot launch new provisioned products using a deprecated version.

updateProvisioningArtifact_name :: Lens' UpdateProvisioningArtifact (Maybe Text)

The updated name of the provisioning artifact.

updateProvisioningArtifact_productId :: Lens' UpdateProvisioningArtifact Text

The product identifier.

updateProvisioningArtifact_provisioningArtifactId :: Lens' UpdateProvisioningArtifact Text

The identifier of the provisioning artifact.

updateProvisioningArtifactResponse_info :: Lens' UpdateProvisioningArtifactResponse (Maybe (HashMap Text Text))

The URL of the CloudFormation template in Amazon S3 or GitHub in JSON format.

updateProvisioningArtifactResponse_provisioningArtifactDetail :: Lens' UpdateProvisioningArtifactResponse (Maybe ProvisioningArtifactDetail)

Information about the provisioning artifact.

updateProvisioningArtifactResponse_status :: Lens' UpdateProvisioningArtifactResponse (Maybe RequestStatus)

The status of the current request.

updateProvisioningArtifactResponse_httpStatus :: Lens' UpdateProvisioningArtifactResponse Int

The response's http status code.

UpdateServiceAction

updateServiceAction_acceptLanguage :: Lens' UpdateServiceAction (Maybe Text)

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

updateServiceAction_definition :: Lens' UpdateServiceAction (Maybe (HashMap ServiceActionDefinitionKey Text))

A map that defines the self-service action.

updateServiceAction_description :: Lens' UpdateServiceAction (Maybe Text)

The self-service action description.

updateServiceAction_name :: Lens' UpdateServiceAction (Maybe Text)

The self-service action name.

updateServiceAction_id :: Lens' UpdateServiceAction Text

The self-service action identifier.

updateServiceActionResponse_serviceActionDetail :: Lens' UpdateServiceActionResponse (Maybe ServiceActionDetail)

Detailed information about the self-service action.

updateServiceActionResponse_httpStatus :: Lens' UpdateServiceActionResponse Int

The response's http status code.

UpdateTagOption

updateTagOption_active :: Lens' UpdateTagOption (Maybe Bool)

The updated active state.

updateTagOption_value :: Lens' UpdateTagOption (Maybe Text)

The updated value.

updateTagOption_id :: Lens' UpdateTagOption Text

The TagOption identifier.

updateTagOptionResponse_tagOptionDetail :: Lens' UpdateTagOptionResponse (Maybe TagOptionDetail)

Information about the TagOption.

updateTagOptionResponse_httpStatus :: Lens' UpdateTagOptionResponse Int

The response's http status code.

Types

AccessLevelFilter

accessLevelFilter_key :: Lens' AccessLevelFilter (Maybe AccessLevelFilterKey)

The access level.

• Account - Filter results based on the account.
• Role - Filter results based on the federated role of the specified user.
• User - Filter results based on the specified user.

accessLevelFilter_value :: Lens' AccessLevelFilter (Maybe Text)

The user to which the access level applies. The only supported value is Self.

BudgetDetail

budgetDetail_budgetName :: Lens' BudgetDetail (Maybe Text)

Name of the associated budget.

CloudWatchDashboard

cloudWatchDashboard_name :: Lens' CloudWatchDashboard (Maybe Text)

The name of the CloudWatch dashboard.

CodeStarParameters

codeStarParameters_connectionArn :: Lens' CodeStarParameters Text

The CodeStar ARN, which is the connection between Service Catalog and the external repository.

codeStarParameters_repository :: Lens' CodeStarParameters Text

The specific repository where the product’s artifact-to-be-synced resides, formatted as "Account/Repo."

codeStarParameters_branch :: Lens' CodeStarParameters Text

The specific branch where the artifact resides.

codeStarParameters_artifactPath :: Lens' CodeStarParameters Text

The absolute path wehre the artifact resides within the repo and branch, formatted as "folder/file.json."

ConstraintDetail

constraintDetail_constraintId :: Lens' ConstraintDetail (Maybe Text)

The identifier of the constraint.

constraintDetail_description :: Lens' ConstraintDetail (Maybe Text)

The description of the constraint.

constraintDetail_owner :: Lens' ConstraintDetail (Maybe Text)

The owner of the constraint.

constraintDetail_portfolioId :: Lens' ConstraintDetail (Maybe Text)

The identifier of the portfolio the product resides in. The constraint applies only to the instance of the product that lives within this portfolio.

constraintDetail_productId :: Lens' ConstraintDetail (Maybe Text)

The identifier of the product the constraint applies to. Note that a constraint applies to a specific instance of a product within a certain portfolio.

constraintDetail_type :: Lens' ConstraintDetail (Maybe Text)

The type of constraint.

• LAUNCH

• NOTIFICATION

• STACKSET

• TEMPLATE

ConstraintSummary

constraintSummary_description :: Lens' ConstraintSummary (Maybe Text)

The description of the constraint.

constraintSummary_type :: Lens' ConstraintSummary (Maybe Text)

The type of constraint.

• LAUNCH

• NOTIFICATION

• STACKSET

• TEMPLATE

ExecutionParameter

executionParameter_defaultValues :: Lens' ExecutionParameter (Maybe [Text])

The default values for the execution parameter.

executionParameter_name :: Lens' ExecutionParameter (Maybe Text)

The name of the execution parameter.

executionParameter_type :: Lens' ExecutionParameter (Maybe Text)

The execution parameter type.

FailedServiceActionAssociation

failedServiceActionAssociation_errorCode :: Lens' FailedServiceActionAssociation (Maybe ServiceActionAssociationErrorCode)

The error code. Valid values are listed below.

failedServiceActionAssociation_errorMessage :: Lens' FailedServiceActionAssociation (Maybe Text)

A text description of the error.

failedServiceActionAssociation_productId :: Lens' FailedServiceActionAssociation (Maybe Text)

The product identifier. For example, prod-abcdzk7xy33qa.

failedServiceActionAssociation_provisioningArtifactId :: Lens' FailedServiceActionAssociation (Maybe Text)

The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne.

failedServiceActionAssociation_serviceActionId :: Lens' FailedServiceActionAssociation (Maybe Text)

The self-service action identifier. For example, act-fs7abcd89wxyz.

LastSync

lastSync_lastSuccessfulSyncProvisioningArtifactId :: Lens' LastSync (Maybe Text)

The ProvisioningArtifactID of the ProvisioningArtifact created from the latest successful sync.

lastSync_lastSuccessfulSyncTime :: Lens' LastSync (Maybe UTCTime)

The time of the latest successful sync from the source repo artifact to the Service Catalog product.

lastSync_lastSyncStatus :: Lens' LastSync (Maybe LastSyncStatus)

The current status of the sync. Responses include SUCCEEDED or FAILED.

lastSync_lastSyncStatusMessage :: Lens' LastSync (Maybe Text)

The sync's status message.

lastSync_lastSyncTime :: Lens' LastSync (Maybe UTCTime)

The time of the last attempted sync from the repository to the Service Catalog product.

LaunchPath

launchPath_id :: Lens' LaunchPath (Maybe Text)

The identifier of the launch path.

launchPath_name :: Lens' LaunchPath (Maybe Text)

The name of the launch path.

LaunchPathSummary

launchPathSummary_constraintSummaries :: Lens' LaunchPathSummary (Maybe [ConstraintSummary])

The constraints on the portfolio-product relationship.

launchPathSummary_id :: Lens' LaunchPathSummary (Maybe Text)

The identifier of the product path.

launchPathSummary_name :: Lens' LaunchPathSummary (Maybe Text)

The name of the portfolio that contains the product.

launchPathSummary_tags :: Lens' LaunchPathSummary (Maybe [Tag])

The tags associated with this product path.

ListRecordHistorySearchFilter

listRecordHistorySearchFilter_key :: Lens' ListRecordHistorySearchFilter (Maybe Text)

The filter key.

• product - Filter results based on the specified product identifier.
• provisionedproduct - Filter results based on the provisioned product identifier.

listRecordHistorySearchFilter_value :: Lens' ListRecordHistorySearchFilter (Maybe Text)

The filter value.

ListTagOptionsFilters

listTagOptionsFilters_active :: Lens' ListTagOptionsFilters (Maybe Bool)

The active state.

listTagOptionsFilters_key :: Lens' ListTagOptionsFilters (Maybe Text)

The TagOption key.

listTagOptionsFilters_value :: Lens' ListTagOptionsFilters (Maybe Text)

The TagOption value.

OrganizationNode

organizationNode_type :: Lens' OrganizationNode (Maybe OrganizationNodeType)

The organization node type.

organizationNode_value :: Lens' OrganizationNode (Maybe Text)

The identifier of the organization node.

ParameterConstraints

parameterConstraints_allowedPattern :: Lens' ParameterConstraints (Maybe Text)

A regular expression that represents the patterns that allow for String types. The pattern must match the entire parameter value provided.

parameterConstraints_allowedValues :: Lens' ParameterConstraints (Maybe [Text])

The values that the administrator has allowed for the parameter.

parameterConstraints_constraintDescription :: Lens' ParameterConstraints (Maybe Text)

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.

parameterConstraints_maxLength :: Lens' ParameterConstraints (Maybe Text)

An integer value that determines the largest number of characters you want to allow for String types.

parameterConstraints_maxValue :: Lens' ParameterConstraints (Maybe Text)

A numeric value that determines the largest numeric value you want to allow for Number types.

parameterConstraints_minLength :: Lens' ParameterConstraints (Maybe Text)

An integer value that determines the smallest number of characters you want to allow for String types.

parameterConstraints_minValue :: Lens' ParameterConstraints (Maybe Text)

A numeric value that determines the smallest numeric value you want to allow for Number types.

PortfolioDetail

portfolioDetail_arn :: Lens' PortfolioDetail (Maybe Text)

The ARN assigned to the portfolio.

portfolioDetail_createdTime :: Lens' PortfolioDetail (Maybe UTCTime)

The UTC time stamp of the creation time.

portfolioDetail_description :: Lens' PortfolioDetail (Maybe Text)

The description of the portfolio.

portfolioDetail_displayName :: Lens' PortfolioDetail (Maybe Text)

The name to use for display purposes.

portfolioDetail_id :: Lens' PortfolioDetail (Maybe Text)

The portfolio identifier.

portfolioDetail_providerName :: Lens' PortfolioDetail (Maybe Text)

The name of the portfolio provider.

PortfolioShareDetail

portfolioShareDetail_accepted :: Lens' PortfolioShareDetail (Maybe Bool)

Indicates whether the shared portfolio is imported by the recipient account. If the recipient is in an organization node, the share is automatically imported, and the field is always set to true.

portfolioShareDetail_principalId :: Lens' PortfolioShareDetail (Maybe Text)

The identifier of the recipient entity that received the portfolio share. The recipient entity can be one of the following:

1. An external account.
2. An organziation member account.
3. An organzational unit (OU).
4. The organization itself. (This shares with every account in the organization).

portfolioShareDetail_sharePrincipals :: Lens' PortfolioShareDetail (Maybe Bool)

Indicates if Principal sharing is enabled or disabled for the portfolio share.

portfolioShareDetail_shareTagOptions :: Lens' PortfolioShareDetail (Maybe Bool)

Indicates whether TagOptions sharing is enabled or disabled for the portfolio share.

portfolioShareDetail_type :: Lens' PortfolioShareDetail (Maybe DescribePortfolioShareType)

The type of the portfolio share.

Principal

principal_principalARN :: Lens' Principal (Maybe Text)

The ARN of the principal (IAM user, role, or group). This field allows for an ARN with no accountID if the PrincipalType is an IAM_PATTERN.

principal_principalType :: Lens' Principal (Maybe PrincipalType)

The principal type. The supported value is IAM if you use a fully defined ARN, or IAM_PATTERN if you use an ARN with no accountID.

ProductViewAggregationValue

productViewAggregationValue_approximateCount :: Lens' ProductViewAggregationValue (Maybe Int)

An approximate count of the products that match the value.

productViewAggregationValue_value :: Lens' ProductViewAggregationValue (Maybe Text)

The value of the product view aggregation.

ProductViewDetail

productViewDetail_createdTime :: Lens' ProductViewDetail (Maybe UTCTime)

The UTC time stamp of the creation time.

productViewDetail_productARN :: Lens' ProductViewDetail (Maybe Text)

The ARN of the product.

productViewDetail_productViewSummary :: Lens' ProductViewDetail (Maybe ProductViewSummary)

Summary information about the product view.

productViewDetail_sourceConnection :: Lens' ProductViewDetail (Maybe SourceConnectionDetail)

A top level ProductViewDetail response containing details about the product’s connection. Service Catalog returns this field for the CreateProduct, UpdateProduct, DescribeProductAsAdmin, and SearchProductAsAdmin APIs. This response contains the same fields as the ConnectionParameters request, with the addition of the LastSync response.

productViewDetail_status :: Lens' ProductViewDetail (Maybe RequestStatus)

The status of the product.

• AVAILABLE - The product is ready for use.
• CREATING - Product creation has started; the product is not ready for use.
• FAILED - An action failed.

ProductViewSummary

productViewSummary_distributor :: Lens' ProductViewSummary (Maybe Text)

The distributor of the product. Contact the product administrator for the significance of this value.

productViewSummary_hasDefaultPath :: Lens' ProductViewSummary (Maybe Bool)

Indicates whether the product has a default path. If the product does not have a default path, call ListLaunchPaths to disambiguate between paths. Otherwise, ListLaunchPaths is not required, and the output of ProductViewSummary can be used directly with DescribeProvisioningParameters.

productViewSummary_id :: Lens' ProductViewSummary (Maybe Text)

The product view identifier.

productViewSummary_name :: Lens' ProductViewSummary (Maybe Text)

The name of the product.

productViewSummary_owner :: Lens' ProductViewSummary (Maybe Text)

The owner of the product. Contact the product administrator for the significance of this value.

productViewSummary_productId :: Lens' ProductViewSummary (Maybe Text)

The product identifier.

productViewSummary_shortDescription :: Lens' ProductViewSummary (Maybe Text)

Short description of the product.

productViewSummary_supportDescription :: Lens' ProductViewSummary (Maybe Text)

The description of the support for this Product.

productViewSummary_supportEmail :: Lens' ProductViewSummary (Maybe Text)

The email contact information to obtain support for this Product.

productViewSummary_supportUrl :: Lens' ProductViewSummary (Maybe Text)

The URL information to obtain support for this Product.

productViewSummary_type :: Lens' ProductViewSummary (Maybe ProductType)

The product type. Contact the product administrator for the significance of this value. If this value is MARKETPLACE, the product was created by Amazon Web Services Marketplace.

ProvisionedProductAttribute

provisionedProductAttribute_arn :: Lens' ProvisionedProductAttribute (Maybe Text)

The ARN of the provisioned product.

provisionedProductAttribute_createdTime :: Lens' ProvisionedProductAttribute (Maybe UTCTime)

The UTC time stamp of the creation time.

provisionedProductAttribute_id :: Lens' ProvisionedProductAttribute (Maybe Text)

The identifier of the provisioned product.

provisionedProductAttribute_idempotencyToken :: Lens' ProvisionedProductAttribute (Maybe Text)

A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

provisionedProductAttribute_lastProvisioningRecordId :: Lens' ProvisionedProductAttribute (Maybe Text)

The record identifier of the last request performed on this provisioned product of the following types:

• ProvisionedProduct
• UpdateProvisionedProduct
• ExecuteProvisionedProductPlan
• TerminateProvisionedProduct

provisionedProductAttribute_lastRecordId :: Lens' ProvisionedProductAttribute (Maybe Text)

The record identifier of the last request performed on this provisioned product.

provisionedProductAttribute_lastSuccessfulProvisioningRecordId :: Lens' ProvisionedProductAttribute (Maybe Text)

The record identifier of the last successful request performed on this provisioned product of the following types:

• ProvisionedProduct
• UpdateProvisionedProduct
• ExecuteProvisionedProductPlan
• TerminateProvisionedProduct

provisionedProductAttribute_name :: Lens' ProvisionedProductAttribute (Maybe Text)

The user-friendly name of the provisioned product.

provisionedProductAttribute_physicalId :: Lens' ProvisionedProductAttribute (Maybe Text)

The assigned identifier for the resource, such as an EC2 instance ID or an S3 bucket name.

provisionedProductAttribute_productId :: Lens' ProvisionedProductAttribute (Maybe Text)

The product identifier.

provisionedProductAttribute_productName :: Lens' ProvisionedProductAttribute (Maybe Text)

The name of the product.

provisionedProductAttribute_provisioningArtifactId :: Lens' ProvisionedProductAttribute (Maybe Text)

The identifier of the provisioning artifact.

provisionedProductAttribute_provisioningArtifactName :: Lens' ProvisionedProductAttribute (Maybe Text)

The name of the provisioning artifact.

provisionedProductAttribute_status :: Lens' ProvisionedProductAttribute (Maybe ProvisionedProductStatus)

The current status of the provisioned product.

• AVAILABLE - Stable state, ready to perform any operation. The most recent operation succeeded and completed.
• UNDER_CHANGE - Transitive state. Operations performed might not have valid results. Wait for an AVAILABLE status before performing operations.
• TAINTED - Stable state, ready to perform any operation. The stack has completed the requested operation but is not exactly what was requested. For example, a request to update to a new version failed and the stack rolled back to the current version.
• ERROR - An unexpected error occurred. The provisioned product exists but the stack is not running. For example, CloudFormation received a parameter value that was not valid and could not launch the stack.
• PLAN_IN_PROGRESS - Transitive state. The plan operations were performed to provision a new product, but resources have not yet been created. After reviewing the list of resources to be created, execute the plan. Wait for an AVAILABLE status before performing operations.

provisionedProductAttribute_statusMessage :: Lens' ProvisionedProductAttribute (Maybe Text)

The current status message of the provisioned product.

provisionedProductAttribute_tags :: Lens' ProvisionedProductAttribute (Maybe [Tag])

One or more tags.

provisionedProductAttribute_type :: Lens' ProvisionedProductAttribute (Maybe Text)

The type of provisioned product. The supported values are CFN_STACK and CFN_STACKSET.

provisionedProductAttribute_userArn :: Lens' ProvisionedProductAttribute (Maybe Text)

The Amazon Resource Name (ARN) of the IAM user.

provisionedProductAttribute_userArnSession :: Lens' ProvisionedProductAttribute (Maybe Text)

The ARN of the IAM user in the session. This ARN might contain a session ID.

ProvisionedProductDetail

provisionedProductDetail_arn :: Lens' ProvisionedProductDetail (Maybe Text)

The ARN of the provisioned product.

provisionedProductDetail_createdTime :: Lens' ProvisionedProductDetail (Maybe UTCTime)

The UTC time stamp of the creation time.

provisionedProductDetail_id :: Lens' ProvisionedProductDetail (Maybe Text)

The identifier of the provisioned product.

provisionedProductDetail_idempotencyToken :: Lens' ProvisionedProductDetail (Maybe Text)

A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

provisionedProductDetail_lastProvisioningRecordId :: Lens' ProvisionedProductDetail (Maybe Text)

The record identifier of the last request performed on this provisioned product of the following types:

• ProvisionedProduct
• UpdateProvisionedProduct
• ExecuteProvisionedProductPlan
• TerminateProvisionedProduct

provisionedProductDetail_lastRecordId :: Lens' ProvisionedProductDetail (Maybe Text)

The record identifier of the last request performed on this provisioned product.

provisionedProductDetail_lastSuccessfulProvisioningRecordId :: Lens' ProvisionedProductDetail (Maybe Text)

The record identifier of the last successful request performed on this provisioned product of the following types:

• ProvisionedProduct
• UpdateProvisionedProduct
• ExecuteProvisionedProductPlan
• TerminateProvisionedProduct

provisionedProductDetail_launchRoleArn :: Lens' ProvisionedProductDetail (Maybe Text)

The ARN of the launch role associated with the provisioned product.

provisionedProductDetail_name :: Lens' ProvisionedProductDetail (Maybe Text)

The user-friendly name of the provisioned product.

provisionedProductDetail_productId :: Lens' ProvisionedProductDetail (Maybe Text)

The product identifier. For example, prod-abcdzk7xy33qa.

provisionedProductDetail_provisioningArtifactId :: Lens' ProvisionedProductDetail (Maybe Text)

The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne.

provisionedProductDetail_status :: Lens' ProvisionedProductDetail (Maybe ProvisionedProductStatus)

The current status of the provisioned product.

• AVAILABLE - Stable state, ready to perform any operation. The most recent operation succeeded and completed.
• UNDER_CHANGE - Transitive state. Operations performed might not have valid results. Wait for an AVAILABLE status before performing operations.
• TAINTED - Stable state, ready to perform any operation. The stack has completed the requested operation but is not exactly what was requested. For example, a request to update to a new version failed and the stack rolled back to the current version.
• ERROR - An unexpected error occurred. The provisioned product exists but the stack is not running. For example, CloudFormation received a parameter value that was not valid and could not launch the stack.
• PLAN_IN_PROGRESS - Transitive state. The plan operations were performed to provision a new product, but resources have not yet been created. After reviewing the list of resources to be created, execute the plan. Wait for an AVAILABLE status before performing operations.

provisionedProductDetail_statusMessage :: Lens' ProvisionedProductDetail (Maybe Text)

The current status message of the provisioned product.

provisionedProductDetail_type :: Lens' ProvisionedProductDetail (Maybe Text)

The type of provisioned product. The supported values are CFN_STACK and CFN_STACKSET.

ProvisionedProductPlanDetails

provisionedProductPlanDetails_createdTime :: Lens' ProvisionedProductPlanDetails (Maybe UTCTime)

The UTC time stamp of the creation time.

provisionedProductPlanDetails_notificationArns :: Lens' ProvisionedProductPlanDetails (Maybe [Text])

Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events.

provisionedProductPlanDetails_pathId :: Lens' ProvisionedProductPlanDetails (Maybe Text)

The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths.

provisionedProductPlanDetails_planId :: Lens' ProvisionedProductPlanDetails (Maybe Text)

The plan identifier.

provisionedProductPlanDetails_planName :: Lens' ProvisionedProductPlanDetails (Maybe Text)

The name of the plan.

provisionedProductPlanDetails_planType :: Lens' ProvisionedProductPlanDetails (Maybe ProvisionedProductPlanType)

The plan type.

provisionedProductPlanDetails_productId :: Lens' ProvisionedProductPlanDetails (Maybe Text)

The product identifier.

provisionedProductPlanDetails_provisionProductId :: Lens' ProvisionedProductPlanDetails (Maybe Text)

The product identifier.

provisionedProductPlanDetails_provisionProductName :: Lens' ProvisionedProductPlanDetails (Maybe Text)

The user-friendly name of the provisioned product.

provisionedProductPlanDetails_provisioningArtifactId :: Lens' ProvisionedProductPlanDetails (Maybe Text)

The identifier of the provisioning artifact.

provisionedProductPlanDetails_provisioningParameters :: Lens' ProvisionedProductPlanDetails (Maybe [UpdateProvisioningParameter])

Parameters specified by the administrator that are required for provisioning the product.

provisionedProductPlanDetails_status :: Lens' ProvisionedProductPlanDetails (Maybe ProvisionedProductPlanStatus)

The status.

provisionedProductPlanDetails_statusMessage :: Lens' ProvisionedProductPlanDetails (Maybe Text)

The status message.

provisionedProductPlanDetails_tags :: Lens' ProvisionedProductPlanDetails (Maybe [Tag])

One or more tags.

provisionedProductPlanDetails_updatedTime :: Lens' ProvisionedProductPlanDetails (Maybe UTCTime)

The UTC time stamp when the plan was last updated.

ProvisionedProductPlanSummary

provisionedProductPlanSummary_planId :: Lens' ProvisionedProductPlanSummary (Maybe Text)

The plan identifier.

provisionedProductPlanSummary_planName :: Lens' ProvisionedProductPlanSummary (Maybe Text)

The name of the plan.

provisionedProductPlanSummary_planType :: Lens' ProvisionedProductPlanSummary (Maybe ProvisionedProductPlanType)

The plan type.

provisionedProductPlanSummary_provisionProductId :: Lens' ProvisionedProductPlanSummary (Maybe Text)

The product identifier.

provisionedProductPlanSummary_provisionProductName :: Lens' ProvisionedProductPlanSummary (Maybe Text)

The user-friendly name of the provisioned product.

provisionedProductPlanSummary_provisioningArtifactId :: Lens' ProvisionedProductPlanSummary (Maybe Text)

The identifier of the provisioning artifact.

ProvisioningArtifact

provisioningArtifact_createdTime :: Lens' ProvisioningArtifact (Maybe UTCTime)

The UTC time stamp of the creation time.

provisioningArtifact_description :: Lens' ProvisioningArtifact (Maybe Text)

The description of the provisioning artifact.

provisioningArtifact_guidance :: Lens' ProvisioningArtifact (Maybe ProvisioningArtifactGuidance)

Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.

provisioningArtifact_id :: Lens' ProvisioningArtifact (Maybe Text)

The identifier of the provisioning artifact.

provisioningArtifact_name :: Lens' ProvisioningArtifact (Maybe Text)

The name of the provisioning artifact.

ProvisioningArtifactDetail

provisioningArtifactDetail_active :: Lens' ProvisioningArtifactDetail (Maybe Bool)

Indicates whether the product version is active.

provisioningArtifactDetail_createdTime :: Lens' ProvisioningArtifactDetail (Maybe UTCTime)

The UTC time stamp of the creation time.

provisioningArtifactDetail_description :: Lens' ProvisioningArtifactDetail (Maybe Text)

The description of the provisioning artifact.

provisioningArtifactDetail_guidance :: Lens' ProvisioningArtifactDetail (Maybe ProvisioningArtifactGuidance)

Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.

provisioningArtifactDetail_id :: Lens' ProvisioningArtifactDetail (Maybe Text)

The identifier of the provisioning artifact.

provisioningArtifactDetail_name :: Lens' ProvisioningArtifactDetail (Maybe Text)

The name of the provisioning artifact.

provisioningArtifactDetail_sourceRevision :: Lens' ProvisioningArtifactDetail (Maybe Text)

Specifies the revision of the external artifact that was used to automatically sync the Service Catalog product and create the provisioning artifact. Service Catalog includes this response parameter as a high level field to the existing ProvisioningArtifactDetail type, which is returned as part of the response for CreateProduct, UpdateProduct, DescribeProductAsAdmin, DescribeProvisioningArtifact, ListProvisioningArtifact, and UpdateProvisioningArticat APIs.

This field only exists for Repo-Synced products.

provisioningArtifactDetail_type :: Lens' ProvisioningArtifactDetail (Maybe ProvisioningArtifactType)

The type of provisioning artifact.

• CLOUD_FORMATION_TEMPLATE - CloudFormation template
• MARKETPLACE_AMI - Amazon Web Services Marketplace AMI
• MARKETPLACE_CAR - Amazon Web Services Marketplace Clusters and Amazon Web Services Resources

ProvisioningArtifactOutput

provisioningArtifactOutput_description :: Lens' ProvisioningArtifactOutput (Maybe Text)

Description of the provisioning artifact output key.

provisioningArtifactOutput_key :: Lens' ProvisioningArtifactOutput (Maybe Text)

The provisioning artifact output key.

ProvisioningArtifactParameter

provisioningArtifactParameter_defaultValue :: Lens' ProvisioningArtifactParameter (Maybe Text)

The default value.

provisioningArtifactParameter_description :: Lens' ProvisioningArtifactParameter (Maybe Text)

The description of the parameter.

provisioningArtifactParameter_isNoEcho :: Lens' ProvisioningArtifactParameter (Maybe Bool)

If this value is true, the value for this parameter is obfuscated from view when the parameter is retrieved. This parameter is used to hide sensitive information.

provisioningArtifactParameter_parameterConstraints :: Lens' ProvisioningArtifactParameter (Maybe ParameterConstraints)

Constraints that the administrator has put on a parameter.

provisioningArtifactParameter_parameterKey :: Lens' ProvisioningArtifactParameter (Maybe Text)

The parameter key.

provisioningArtifactParameter_parameterType :: Lens' ProvisioningArtifactParameter (Maybe Text)

The parameter type.

ProvisioningArtifactPreferences

provisioningArtifactPreferences_stackSetAccounts :: Lens' ProvisioningArtifactPreferences (Maybe [Text])

One or more Amazon Web Services accounts where stack instances are deployed from the stack set. These accounts can be scoped in ProvisioningPreferences$StackSetAccounts and UpdateProvisioningPreferences$StackSetAccounts.

Applicable only to a CFN_STACKSET provisioned product type.

provisioningArtifactPreferences_stackSetRegions :: Lens' ProvisioningArtifactPreferences (Maybe [Text])

One or more Amazon Web Services Regions where stack instances are deployed from the stack set. These Regions can be scoped in ProvisioningPreferences$StackSetRegions and UpdateProvisioningPreferences$StackSetRegions.

Applicable only to a CFN_STACKSET provisioned product type.

ProvisioningArtifactProperties

provisioningArtifactProperties_description :: Lens' ProvisioningArtifactProperties (Maybe Text)

The description of the provisioning artifact, including how it differs from the previous provisioning artifact.

provisioningArtifactProperties_disableTemplateValidation :: Lens' ProvisioningArtifactProperties (Maybe Bool)

If set to true, Service Catalog stops validating the specified provisioning artifact even if it is invalid.

provisioningArtifactProperties_info :: Lens' ProvisioningArtifactProperties (Maybe (HashMap Text Text))

Specify the template source with one of the following options, but not both. Keys accepted: [ LoadTemplateFromURL, ImportFromPhysicalId ]

The URL of the CloudFormation template in Amazon S3 or GitHub in JSON format. Specify the URL in JSON format as follows:

"LoadTemplateFromURL": "https://s3.amazonaws.com/cf-templates-ozkq9d3hgiq2-us-east-1/..."

ImportFromPhysicalId: The physical id of the resource that contains the template. Currently only supports CloudFormation stack arn. Specify the physical id in JSON format as follows: ImportFromPhysicalId: “arn:aws:cloudformation:[us-east-1]:[accountId]:stack/[StackName]/[resourceId]

provisioningArtifactProperties_name :: Lens' ProvisioningArtifactProperties (Maybe Text)

The name of the provisioning artifact (for example, v1 v2beta). No spaces are allowed.

provisioningArtifactProperties_type :: Lens' ProvisioningArtifactProperties (Maybe ProvisioningArtifactType)

The type of provisioning artifact.

• CLOUD_FORMATION_TEMPLATE - CloudFormation template
• MARKETPLACE_AMI - Amazon Web Services Marketplace AMI
• MARKETPLACE_CAR - Amazon Web Services Marketplace Clusters and Amazon Web Services Resources

ProvisioningArtifactSummary

provisioningArtifactSummary_createdTime :: Lens' ProvisioningArtifactSummary (Maybe UTCTime)

The UTC time stamp of the creation time.

provisioningArtifactSummary_description :: Lens' ProvisioningArtifactSummary (Maybe Text)

The description of the provisioning artifact.

provisioningArtifactSummary_id :: Lens' ProvisioningArtifactSummary (Maybe Text)

The identifier of the provisioning artifact.

provisioningArtifactSummary_name :: Lens' ProvisioningArtifactSummary (Maybe Text)

The name of the provisioning artifact.

provisioningArtifactSummary_provisioningArtifactMetadata :: Lens' ProvisioningArtifactSummary (Maybe (HashMap Text Text))

The metadata for the provisioning artifact. This is used with Amazon Web Services Marketplace products.

ProvisioningArtifactView

provisioningArtifactView_productViewSummary :: Lens' ProvisioningArtifactView (Maybe ProductViewSummary)

Summary information about a product view.

provisioningArtifactView_provisioningArtifact :: Lens' ProvisioningArtifactView (Maybe ProvisioningArtifact)

Information about a provisioning artifact. A provisioning artifact is also known as a product version.

ProvisioningParameter

provisioningParameter_key :: Lens' ProvisioningParameter (Maybe Text)

The parameter key.

provisioningParameter_value :: Lens' ProvisioningParameter (Maybe Text)

The parameter value.

ProvisioningPreferences

provisioningPreferences_stackSetAccounts :: Lens' ProvisioningPreferences (Maybe [Text])

One or more Amazon Web Services accounts where the provisioned product will be available.

Applicable only to a CFN_STACKSET provisioned product type.

The specified accounts should be within the list of accounts from the STACKSET constraint. To get the list of accounts in the STACKSET constraint, use the DescribeProvisioningParameters operation.

If no values are specified, the default value is all acounts from the STACKSET constraint.

provisioningPreferences_stackSetFailureToleranceCount :: Lens' ProvisioningPreferences (Maybe Natural)

The number of accounts, per Region, for which this operation can fail before Service Catalog stops the operation in that Region. If the operation is stopped in a Region, Service Catalog doesn't attempt the operation in any subsequent Regions.

Applicable only to a CFN_STACKSET provisioned product type.

Conditional: You must specify either StackSetFailureToleranceCount or StackSetFailureTolerancePercentage, but not both.

The default value is 0 if no value is specified.

provisioningPreferences_stackSetFailureTolerancePercentage :: Lens' ProvisioningPreferences (Maybe Natural)

The percentage of accounts, per Region, for which this stack operation can fail before Service Catalog stops the operation in that Region. If the operation is stopped in a Region, Service Catalog doesn't attempt the operation in any subsequent Regions.

When calculating the number of accounts based on the specified percentage, Service Catalog rounds down to the next whole number.

Applicable only to a CFN_STACKSET provisioned product type.

Conditional: You must specify either StackSetFailureToleranceCount or StackSetFailureTolerancePercentage, but not both.

provisioningPreferences_stackSetMaxConcurrencyCount :: Lens' ProvisioningPreferences (Maybe Natural)

The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of StackSetFailureToleranceCount. StackSetMaxConcurrentCount is at most one more than the StackSetFailureToleranceCount.

Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

Applicable only to a CFN_STACKSET provisioned product type.

Conditional: You must specify either StackSetMaxConcurrentCount or StackSetMaxConcurrentPercentage, but not both.

provisioningPreferences_stackSetMaxConcurrencyPercentage :: Lens' ProvisioningPreferences (Maybe Natural)

The maximum percentage of accounts in which to perform this operation at one time.

When calculating the number of accounts based on the specified percentage, Service Catalog rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, Service Catalog sets the number as 1 instead.

Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

Applicable only to a CFN_STACKSET provisioned product type.

Conditional: You must specify either StackSetMaxConcurrentCount or StackSetMaxConcurrentPercentage, but not both.

provisioningPreferences_stackSetRegions :: Lens' ProvisioningPreferences (Maybe [Text])

One or more Amazon Web Services Regions where the provisioned product will be available.

Applicable only to a CFN_STACKSET provisioned product type.

The specified Regions should be within the list of Regions from the STACKSET constraint. To get the list of Regions in the STACKSET constraint, use the DescribeProvisioningParameters operation.

If no values are specified, the default value is all Regions from the STACKSET constraint.

RecordDetail

recordDetail_createdTime :: Lens' RecordDetail (Maybe UTCTime)

The UTC time stamp of the creation time.

recordDetail_launchRoleArn :: Lens' RecordDetail (Maybe Text)

The ARN of the launch role associated with the provisioned product.

recordDetail_pathId :: Lens' RecordDetail (Maybe Text)

The path identifier.

recordDetail_productId :: Lens' RecordDetail (Maybe Text)

The product identifier.

recordDetail_provisionedProductId :: Lens' RecordDetail (Maybe Text)

The identifier of the provisioned product.

recordDetail_provisionedProductName :: Lens' RecordDetail (Maybe Text)

The user-friendly name of the provisioned product.

recordDetail_provisionedProductType :: Lens' RecordDetail (Maybe Text)

The type of provisioned product. The supported values are CFN_STACK and CFN_STACKSET.

recordDetail_provisioningArtifactId :: Lens' RecordDetail (Maybe Text)

The identifier of the provisioning artifact.

recordDetail_recordErrors :: Lens' RecordDetail (Maybe [RecordError])

The errors that occurred.

recordDetail_recordId :: Lens' RecordDetail (Maybe Text)

The identifier of the record.

recordDetail_recordTags :: Lens' RecordDetail (Maybe [RecordTag])

One or more tags.

recordDetail_recordType :: Lens' RecordDetail (Maybe Text)

The record type.

• PROVISION_PRODUCT

• UPDATE_PROVISIONED_PRODUCT

• TERMINATE_PROVISIONED_PRODUCT

recordDetail_status :: Lens' RecordDetail (Maybe RecordStatus)

The status of the provisioned product.

• CREATED - The request was created but the operation has not started.
• IN_PROGRESS - The requested operation is in progress.
• IN_PROGRESS_IN_ERROR - The provisioned product is under change but the requested operation failed and some remediation is occurring. For example, a rollback.
• SUCCEEDED - The requested operation has successfully completed.
• FAILED - The requested operation has unsuccessfully completed. Investigate using the error messages returned.

recordDetail_updatedTime :: Lens' RecordDetail (Maybe UTCTime)

The time when the record was last updated.

RecordError

recordError_code :: Lens' RecordError (Maybe Text)

The numeric value of the error.

recordError_description :: Lens' RecordError (Maybe Text)

The description of the error.

RecordOutput

recordOutput_description :: Lens' RecordOutput (Maybe Text)

The description of the output.

recordOutput_outputKey :: Lens' RecordOutput (Maybe Text)

The output key.

recordOutput_outputValue :: Lens' RecordOutput (Maybe Text)

The output value.

RecordTag

recordTag_key :: Lens' RecordTag (Maybe Text)

The key for this tag.

recordTag_value :: Lens' RecordTag (Maybe Text)

The value for this tag.

ResourceChange

resourceChange_action :: Lens' ResourceChange (Maybe ChangeAction)

The change action.

resourceChange_details :: Lens' ResourceChange (Maybe [ResourceChangeDetail])

Information about the resource changes.

resourceChange_logicalResourceId :: Lens' ResourceChange (Maybe Text)

The ID of the resource, as defined in the CloudFormation template.

resourceChange_physicalResourceId :: Lens' ResourceChange (Maybe Text)

The ID of the resource, if it was already created.

resourceChange_replacement :: Lens' ResourceChange (Maybe Replacement)

If the change type is Modify, indicates whether the existing resource is deleted and replaced with a new one.

resourceChange_resourceType :: Lens' ResourceChange (Maybe Text)

The type of resource.

resourceChange_scope :: Lens' ResourceChange (Maybe [ResourceAttribute])

The change scope.

ResourceChangeDetail

resourceChangeDetail_causingEntity :: Lens' ResourceChangeDetail (Maybe Text)

The ID of the entity that caused the change.

resourceChangeDetail_evaluation :: Lens' ResourceChangeDetail (Maybe EvaluationType)

For static evaluations, the value of the resource attribute will change and the new value is known. For dynamic evaluations, the value might change, and any new value will be determined when the plan is updated.

resourceChangeDetail_target :: Lens' ResourceChangeDetail (Maybe ResourceTargetDefinition)

Information about the resource attribute to be modified.

ResourceDetail

resourceDetail_arn :: Lens' ResourceDetail (Maybe Text)

The ARN of the resource.

resourceDetail_createdTime :: Lens' ResourceDetail (Maybe UTCTime)

The creation time of the resource.

resourceDetail_description :: Lens' ResourceDetail (Maybe Text)

The description of the resource.

resourceDetail_id :: Lens' ResourceDetail (Maybe Text)

The identifier of the resource.

resourceDetail_name :: Lens' ResourceDetail (Maybe Text)

The name of the resource.

ResourceTargetDefinition

resourceTargetDefinition_attribute :: Lens' ResourceTargetDefinition (Maybe ResourceAttribute)

The attribute to be changed.

resourceTargetDefinition_name :: Lens' ResourceTargetDefinition (Maybe Text)

If the attribute is Properties, the value is the name of the property. Otherwise, the value is null.

resourceTargetDefinition_requiresRecreation :: Lens' ResourceTargetDefinition (Maybe RequiresRecreation)

If the attribute is Properties, indicates whether a change to this property causes the resource to be re-created.

ServiceActionAssociation

serviceActionAssociation_serviceActionId :: Lens' ServiceActionAssociation Text

The self-service action identifier. For example, act-fs7abcd89wxyz.

serviceActionAssociation_productId :: Lens' ServiceActionAssociation Text

The product identifier. For example, prod-abcdzk7xy33qa.

serviceActionAssociation_provisioningArtifactId :: Lens' ServiceActionAssociation Text

The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne.

ServiceActionDetail

serviceActionDetail_definition :: Lens' ServiceActionDetail (Maybe (HashMap ServiceActionDefinitionKey Text))

A map that defines the self-service action.

serviceActionDetail_serviceActionSummary :: Lens' ServiceActionDetail (Maybe ServiceActionSummary)

Summary information about the self-service action.

ServiceActionSummary

serviceActionSummary_definitionType :: Lens' ServiceActionSummary (Maybe ServiceActionDefinitionType)

The self-service action definition type. For example, SSM_AUTOMATION.

serviceActionSummary_description :: Lens' ServiceActionSummary (Maybe Text)

The self-service action description.

serviceActionSummary_id :: Lens' ServiceActionSummary (Maybe Text)

The self-service action identifier.

serviceActionSummary_name :: Lens' ServiceActionSummary (Maybe Text)

The self-service action name.

ShareDetails

shareDetails_shareErrors :: Lens' ShareDetails (Maybe [ShareError])

List of errors.

shareDetails_successfulShares :: Lens' ShareDetails (Maybe [Text])

List of accounts for whom the operation succeeded.

ShareError

shareError_accounts :: Lens' ShareError (Maybe [Text])

List of accounts impacted by the error.

shareError_error :: Lens' ShareError (Maybe Text)

Error type that happened when processing the operation.

shareError_message :: Lens' ShareError (Maybe Text)

Information about the error.

SourceConnection

sourceConnection_type :: Lens' SourceConnection (Maybe SourceType)

The only supported SourceConnection type is Codestar.

sourceConnection_connectionParameters :: Lens' SourceConnection SourceConnectionParameters

The connection details based on the connection Type.

SourceConnectionDetail

sourceConnectionDetail_connectionParameters :: Lens' SourceConnectionDetail (Maybe SourceConnectionParameters)

The connection details based on the connection Type.

sourceConnectionDetail_lastSync :: Lens' SourceConnectionDetail (Maybe LastSync)

Provides details about the product's connection sync and contains the following sub-fields.

• LastSyncTime

• LastSyncStatus

• LastSyncStatusMessage

• LastSuccessfulSyncTime

• LastSuccessfulSyncProvisioningArtifactID

sourceConnectionDetail_type :: Lens' SourceConnectionDetail (Maybe SourceType)

The only supported SourceConnection type is Codestar.

SourceConnectionParameters

sourceConnectionParameters_codeStar :: Lens' SourceConnectionParameters (Maybe CodeStarParameters)

Provides ConnectionType details.

StackInstance

stackInstance_account :: Lens' StackInstance (Maybe Text)

The name of the Amazon Web Services account that the stack instance is associated with.

stackInstance_region :: Lens' StackInstance (Maybe Text)

The name of the Amazon Web Services Region that the stack instance is associated with.

stackInstance_stackInstanceStatus :: Lens' StackInstance (Maybe StackInstanceStatus)

The status of the stack instance, in terms of its synchronization with its associated stack set.

• INOPERABLE: A DeleteStackInstances operation has failed and left the stack in an unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You might need to perform a DeleteStackInstances operation, with RetainStacks set to true, to delete the stack instance, and then delete the stack manually.
• OUTDATED: The stack isn't currently up to date with the stack set because either the associated stack failed during a CreateStackSet or UpdateStackSet operation, or the stack was part of a CreateStackSet or UpdateStackSet operation that failed or was stopped before the stack was created or updated.
• CURRENT: The stack is currently up to date with the stack set.

Tag

tag_key :: Lens' Tag Text

The tag key.

tag_value :: Lens' Tag Text

The value for this key.

TagOptionDetail

tagOptionDetail_active :: Lens' TagOptionDetail (Maybe Bool)

The TagOption active state.

tagOptionDetail_id :: Lens' TagOptionDetail (Maybe Text)

The TagOption identifier.

tagOptionDetail_key :: Lens' TagOptionDetail (Maybe Text)

The TagOption key.

tagOptionDetail_owner :: Lens' TagOptionDetail (Maybe Text)

The Amazon Web Services account Id of the owner account that created the TagOption.

tagOptionDetail_value :: Lens' TagOptionDetail (Maybe Text)

The TagOption value.

TagOptionSummary

tagOptionSummary_key :: Lens' TagOptionSummary (Maybe Text)

The TagOption key.

tagOptionSummary_values :: Lens' TagOptionSummary (Maybe [Text])

The TagOption value.

UpdateProvisioningParameter

updateProvisioningParameter_key :: Lens' UpdateProvisioningParameter (Maybe Text)

The parameter key.

updateProvisioningParameter_usePreviousValue :: Lens' UpdateProvisioningParameter (Maybe Bool)

If set to true, Value is ignored and the previous parameter value is kept.

updateProvisioningParameter_value :: Lens' UpdateProvisioningParameter (Maybe Text)

The parameter value.

UpdateProvisioningPreferences

updateProvisioningPreferences_stackSetAccounts :: Lens' UpdateProvisioningPreferences (Maybe [Text])

One or more Amazon Web Services accounts that will have access to the provisioned product.

Applicable only to a CFN_STACKSET provisioned product type.

The Amazon Web Services accounts specified should be within the list of accounts in the STACKSET constraint. To get the list of accounts in the STACKSET constraint, use the DescribeProvisioningParameters operation.

If no values are specified, the default value is all accounts from the STACKSET constraint.

updateProvisioningPreferences_stackSetFailureToleranceCount :: Lens' UpdateProvisioningPreferences (Maybe Natural)

The number of accounts, per Region, for which this operation can fail before Service Catalog stops the operation in that Region. If the operation is stopped in a Region, Service Catalog doesn't attempt the operation in any subsequent Regions.

Applicable only to a CFN_STACKSET provisioned product type.

Conditional: You must specify either StackSetFailureToleranceCount or StackSetFailureTolerancePercentage, but not both.

The default value is 0 if no value is specified.

updateProvisioningPreferences_stackSetFailureTolerancePercentage :: Lens' UpdateProvisioningPreferences (Maybe Natural)

The percentage of accounts, per Region, for which this stack operation can fail before Service Catalog stops the operation in that Region. If the operation is stopped in a Region, Service Catalog doesn't attempt the operation in any subsequent Regions.

When calculating the number of accounts based on the specified percentage, Service Catalog rounds down to the next whole number.

Applicable only to a CFN_STACKSET provisioned product type.

Conditional: You must specify either StackSetFailureToleranceCount or StackSetFailureTolerancePercentage, but not both.

updateProvisioningPreferences_stackSetMaxConcurrencyCount :: Lens' UpdateProvisioningPreferences (Maybe Natural)

The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of StackSetFailureToleranceCount. StackSetMaxConcurrentCount is at most one more than the StackSetFailureToleranceCount.

Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

Applicable only to a CFN_STACKSET provisioned product type.

Conditional: You must specify either StackSetMaxConcurrentCount or StackSetMaxConcurrentPercentage, but not both.

updateProvisioningPreferences_stackSetMaxConcurrencyPercentage :: Lens' UpdateProvisioningPreferences (Maybe Natural)

The maximum percentage of accounts in which to perform this operation at one time.

When calculating the number of accounts based on the specified percentage, Service Catalog rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, Service Catalog sets the number as 1 instead.

Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

Applicable only to a CFN_STACKSET provisioned product type.

Conditional: You must specify either StackSetMaxConcurrentCount or StackSetMaxConcurrentPercentage, but not both.

updateProvisioningPreferences_stackSetOperationType :: Lens' UpdateProvisioningPreferences (Maybe StackSetOperationType)

Determines what action Service Catalog performs to a stack set or a stack instance represented by the provisioned product. The default value is UPDATE if nothing is specified.

Applicable only to a CFN_STACKSET provisioned product type.

CREATE

Creates a new stack instance in the stack set represented by the provisioned product. In this case, only new stack instances are created based on accounts and Regions; if new ProductId or ProvisioningArtifactID are passed, they will be ignored.

UPDATE

Updates the stack set represented by the provisioned product and also its stack instances.

DELETE

Deletes a stack instance in the stack set represented by the provisioned product.

updateProvisioningPreferences_stackSetRegions :: Lens' UpdateProvisioningPreferences (Maybe [Text])

One or more Amazon Web Services Regions where the provisioned product will be available.

Applicable only to a CFN_STACKSET provisioned product type.

The specified Regions should be within the list of Regions from the STACKSET constraint. To get the list of Regions in the STACKSET constraint, use the DescribeProvisioningParameters operation.

If no values are specified, the default value is all Regions from the STACKSET constraint.

UsageInstruction

usageInstruction_type :: Lens' UsageInstruction (Maybe Text)

The usage instruction type for the value.

usageInstruction_value :: Lens' UsageInstruction (Maybe Text)

The usage instruction value for this type.