Class: Aws::ServiceCatalog::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::ServiceCatalog::Client
- Includes:
- ClientStubs
- Defined in:
- lib/aws-sdk-servicecatalog/client.rb
Overview
An API client for ServiceCatalog. To construct a client, you need to configure a ‘:region` and `:credentials`.
client = Aws::ServiceCatalog::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
See #initialize for a full list of supported configuration options.
Class Attribute Summary collapse
- .identifier ⇒ Object readonly private
API Operations collapse
-
#accept_portfolio_share(params = {}) ⇒ Struct
Accepts an offer to share the specified portfolio.
-
#associate_budget_with_resource(params = {}) ⇒ Struct
Associates the specified budget with the specified resource.
-
#associate_principal_with_portfolio(params = {}) ⇒ Struct
Associates the specified principal ARN with the specified portfolio.
-
#associate_product_with_portfolio(params = {}) ⇒ Struct
Associates the specified product with the specified portfolio.
-
#associate_service_action_with_provisioning_artifact(params = {}) ⇒ Struct
Associates a self-service action with a provisioning artifact.
-
#associate_tag_option_with_resource(params = {}) ⇒ Struct
Associate the specified TagOption with the specified portfolio or product.
-
#batch_associate_service_action_with_provisioning_artifact(params = {}) ⇒ Types::BatchAssociateServiceActionWithProvisioningArtifactOutput
Associates multiple self-service actions with provisioning artifacts.
-
#batch_disassociate_service_action_from_provisioning_artifact(params = {}) ⇒ Types::BatchDisassociateServiceActionFromProvisioningArtifactOutput
Disassociates a batch of self-service actions from the specified provisioning artifact.
-
#copy_product(params = {}) ⇒ Types::CopyProductOutput
Copies the specified source product to the specified target product or a new product.
-
#create_constraint(params = {}) ⇒ Types::CreateConstraintOutput
Creates a constraint.
-
#create_portfolio(params = {}) ⇒ Types::CreatePortfolioOutput
Creates a portfolio.
-
#create_portfolio_share(params = {}) ⇒ Types::CreatePortfolioShareOutput
Shares the specified portfolio with the specified account or organization node.
-
#create_product(params = {}) ⇒ Types::CreateProductOutput
Creates a product.
-
#create_provisioned_product_plan(params = {}) ⇒ Types::CreateProvisionedProductPlanOutput
Creates a plan.
-
#create_provisioning_artifact(params = {}) ⇒ Types::CreateProvisioningArtifactOutput
Creates a provisioning artifact (also known as a version) for the specified product.
-
#create_service_action(params = {}) ⇒ Types::CreateServiceActionOutput
Creates a self-service action.
-
#create_tag_option(params = {}) ⇒ Types::CreateTagOptionOutput
Creates a TagOption.
-
#delete_constraint(params = {}) ⇒ Struct
Deletes the specified constraint.
-
#delete_portfolio(params = {}) ⇒ Struct
Deletes the specified portfolio.
-
#delete_portfolio_share(params = {}) ⇒ Types::DeletePortfolioShareOutput
Stops sharing the specified portfolio with the specified account or organization node.
-
#delete_product(params = {}) ⇒ Struct
Deletes the specified product.
-
#delete_provisioned_product_plan(params = {}) ⇒ Struct
Deletes the specified plan.
-
#delete_provisioning_artifact(params = {}) ⇒ Struct
Deletes the specified provisioning artifact (also known as a version) for the specified product.
-
#delete_service_action(params = {}) ⇒ Struct
Deletes a self-service action.
-
#delete_tag_option(params = {}) ⇒ Struct
Deletes the specified TagOption.
-
#describe_constraint(params = {}) ⇒ Types::DescribeConstraintOutput
Gets information about the specified constraint.
-
#describe_copy_product_status(params = {}) ⇒ Types::DescribeCopyProductStatusOutput
Gets the status of the specified copy product operation.
-
#describe_portfolio(params = {}) ⇒ Types::DescribePortfolioOutput
Gets information about the specified portfolio.
-
#describe_portfolio_share_status(params = {}) ⇒ Types::DescribePortfolioShareStatusOutput
Gets the status of the specified portfolio share operation.
-
#describe_portfolio_shares(params = {}) ⇒ Types::DescribePortfolioSharesOutput
Returns a summary of each of the portfolio shares that were created for the specified portfolio.
-
#describe_product(params = {}) ⇒ Types::DescribeProductOutput
Gets information about the specified product.
-
#describe_product_as_admin(params = {}) ⇒ Types::DescribeProductAsAdminOutput
Gets information about the specified product.
-
#describe_product_view(params = {}) ⇒ Types::DescribeProductViewOutput
Gets information about the specified product.
-
#describe_provisioned_product(params = {}) ⇒ Types::DescribeProvisionedProductOutput
Gets information about the specified provisioned product.
-
#describe_provisioned_product_plan(params = {}) ⇒ Types::DescribeProvisionedProductPlanOutput
Gets information about the resource changes for the specified plan.
-
#describe_provisioning_artifact(params = {}) ⇒ Types::DescribeProvisioningArtifactOutput
Gets information about the specified provisioning artifact (also known as a version) for the specified product.
-
#describe_provisioning_parameters(params = {}) ⇒ Types::DescribeProvisioningParametersOutput
Gets information about the configuration required to provision the specified product using the specified provisioning artifact.
-
#describe_record(params = {}) ⇒ Types::DescribeRecordOutput
Gets information about the specified request operation.
-
#describe_service_action(params = {}) ⇒ Types::DescribeServiceActionOutput
Describes a self-service action.
-
#describe_service_action_execution_parameters(params = {}) ⇒ Types::DescribeServiceActionExecutionParametersOutput
Finds the default parameters for a specific self-service action on a specific provisioned product and returns a map of the results to the user.
-
#describe_tag_option(params = {}) ⇒ Types::DescribeTagOptionOutput
Gets information about the specified TagOption.
-
#disable_aws_organizations_access(params = {}) ⇒ Struct
Disable portfolio sharing through the Organizations service.
-
#disassociate_budget_from_resource(params = {}) ⇒ Struct
Disassociates the specified budget from the specified resource.
-
#disassociate_principal_from_portfolio(params = {}) ⇒ Struct
Disassociates a previously associated principal ARN from a specified portfolio.
-
#disassociate_product_from_portfolio(params = {}) ⇒ Struct
Disassociates the specified product from the specified portfolio.
-
#disassociate_service_action_from_provisioning_artifact(params = {}) ⇒ Struct
Disassociates the specified self-service action association from the specified provisioning artifact.
-
#disassociate_tag_option_from_resource(params = {}) ⇒ Struct
Disassociates the specified TagOption from the specified resource.
-
#enable_aws_organizations_access(params = {}) ⇒ Struct
Enable portfolio sharing feature through Organizations.
-
#execute_provisioned_product_plan(params = {}) ⇒ Types::ExecuteProvisionedProductPlanOutput
Provisions or modifies a product based on the resource changes for the specified plan.
-
#execute_provisioned_product_service_action(params = {}) ⇒ Types::ExecuteProvisionedProductServiceActionOutput
Executes a self-service action against a provisioned product.
-
#get_aws_organizations_access_status(params = {}) ⇒ Types::GetAWSOrganizationsAccessStatusOutput
Get the Access Status for Organizations portfolio share feature.
-
#get_provisioned_product_outputs(params = {}) ⇒ Types::GetProvisionedProductOutputsOutput
This API takes either a ‘ProvisonedProductId` or a `ProvisionedProductName`, along with a list of one or more output keys, and responds with the key/value pairs of those outputs.
-
#import_as_provisioned_product(params = {}) ⇒ Types::ImportAsProvisionedProductOutput
Requests the import of a resource as an Service Catalog provisioned product that is associated to an Service Catalog product and provisioning artifact.
-
#list_accepted_portfolio_shares(params = {}) ⇒ Types::ListAcceptedPortfolioSharesOutput
Lists all imported portfolios for which account-to-account shares were accepted by this account.
-
#list_budgets_for_resource(params = {}) ⇒ Types::ListBudgetsForResourceOutput
Lists all the budgets associated to the specified resource.
-
#list_constraints_for_portfolio(params = {}) ⇒ Types::ListConstraintsForPortfolioOutput
Lists the constraints for the specified portfolio and product.
-
#list_launch_paths(params = {}) ⇒ Types::ListLaunchPathsOutput
Lists the paths to the specified product.
-
#list_organization_portfolio_access(params = {}) ⇒ Types::ListOrganizationPortfolioAccessOutput
Lists the organization nodes that have access to the specified portfolio.
-
#list_portfolio_access(params = {}) ⇒ Types::ListPortfolioAccessOutput
Lists the account IDs that have access to the specified portfolio.
-
#list_portfolios(params = {}) ⇒ Types::ListPortfoliosOutput
Lists all portfolios in the catalog.
-
#list_portfolios_for_product(params = {}) ⇒ Types::ListPortfoliosForProductOutput
Lists all portfolios that the specified product is associated with.
-
#list_principals_for_portfolio(params = {}) ⇒ Types::ListPrincipalsForPortfolioOutput
Lists all ‘PrincipalARN`s and corresponding `PrincipalType`s associated with the specified portfolio.
-
#list_provisioned_product_plans(params = {}) ⇒ Types::ListProvisionedProductPlansOutput
Lists the plans for the specified provisioned product or all plans to which the user has access.
-
#list_provisioning_artifacts(params = {}) ⇒ Types::ListProvisioningArtifactsOutput
Lists all provisioning artifacts (also known as versions) for the specified product.
-
#list_provisioning_artifacts_for_service_action(params = {}) ⇒ Types::ListProvisioningArtifactsForServiceActionOutput
Lists all provisioning artifacts (also known as versions) for the specified self-service action.
-
#list_record_history(params = {}) ⇒ Types::ListRecordHistoryOutput
Lists the specified requests or all performed requests.
-
#list_resources_for_tag_option(params = {}) ⇒ Types::ListResourcesForTagOptionOutput
Lists the resources associated with the specified TagOption.
-
#list_service_actions(params = {}) ⇒ Types::ListServiceActionsOutput
Lists all self-service actions.
-
#list_service_actions_for_provisioning_artifact(params = {}) ⇒ Types::ListServiceActionsForProvisioningArtifactOutput
Returns a paginated list of self-service actions associated with the specified Product ID and Provisioning Artifact ID.
-
#list_stack_instances_for_provisioned_product(params = {}) ⇒ Types::ListStackInstancesForProvisionedProductOutput
Returns summary information about stack instances that are associated with the specified ‘CFN_STACKSET` type provisioned product.
-
#list_tag_options(params = {}) ⇒ Types::ListTagOptionsOutput
Lists the specified TagOptions or all TagOptions.
-
#notify_provision_product_engine_workflow_result(params = {}) ⇒ Struct
Notifies the result of the provisioning engine execution.
-
#notify_terminate_provisioned_product_engine_workflow_result(params = {}) ⇒ Struct
Notifies the result of the terminate engine execution.
-
#notify_update_provisioned_product_engine_workflow_result(params = {}) ⇒ Struct
Notifies the result of the update engine execution.
-
#provision_product(params = {}) ⇒ Types::ProvisionProductOutput
Provisions the specified product.
-
#reject_portfolio_share(params = {}) ⇒ Struct
Rejects an offer to share the specified portfolio.
-
#scan_provisioned_products(params = {}) ⇒ Types::ScanProvisionedProductsOutput
Lists the provisioned products that are available (not terminated).
-
#search_products(params = {}) ⇒ Types::SearchProductsOutput
Gets information about the products to which the caller has access.
-
#search_products_as_admin(params = {}) ⇒ Types::SearchProductsAsAdminOutput
Gets information about the products for the specified portfolio or all products.
-
#search_provisioned_products(params = {}) ⇒ Types::SearchProvisionedProductsOutput
Gets information about the provisioned products that meet the specified criteria.
-
#terminate_provisioned_product(params = {}) ⇒ Types::TerminateProvisionedProductOutput
Terminates the specified provisioned product.
-
#update_constraint(params = {}) ⇒ Types::UpdateConstraintOutput
Updates the specified constraint.
-
#update_portfolio(params = {}) ⇒ Types::UpdatePortfolioOutput
Updates the specified portfolio.
-
#update_portfolio_share(params = {}) ⇒ Types::UpdatePortfolioShareOutput
Updates the specified portfolio share.
-
#update_product(params = {}) ⇒ Types::UpdateProductOutput
Updates the specified product.
-
#update_provisioned_product(params = {}) ⇒ Types::UpdateProvisionedProductOutput
Requests updates to the configuration of the specified provisioned product.
-
#update_provisioned_product_properties(params = {}) ⇒ Types::UpdateProvisionedProductPropertiesOutput
Requests updates to the properties of the specified provisioned product.
-
#update_provisioning_artifact(params = {}) ⇒ Types::UpdateProvisioningArtifactOutput
Updates the specified provisioning artifact (also known as a version) for the specified product.
-
#update_service_action(params = {}) ⇒ Types::UpdateServiceActionOutput
Updates a self-service action.
-
#update_tag_option(params = {}) ⇒ Types::UpdateTagOptionOutput
Updates the specified TagOption.
Class Method Summary collapse
- .errors_module ⇒ Object private
Instance Method Summary collapse
- #build_request(operation_name, params = {}) ⇒ Object private
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
- #waiter_names ⇒ Object deprecated private Deprecated.
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
429 430 431 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 429 def initialize(*args) super end |
Class Attribute Details
.identifier ⇒ Object (readonly)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
6339 6340 6341 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 6339 def identifier @identifier end |
Class Method Details
.errors_module ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
6342 6343 6344 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 6342 def errors_module Errors end |
Instance Method Details
#accept_portfolio_share(params = {}) ⇒ Struct
Accepts an offer to share the specified portfolio.
476 477 478 479 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 476 def accept_portfolio_share(params = {}, = {}) req = build_request(:accept_portfolio_share, params) req.send_request() end |
#associate_budget_with_resource(params = {}) ⇒ Struct
Associates the specified budget with the specified resource.
502 503 504 505 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 502 def associate_budget_with_resource(params = {}, = {}) req = build_request(:associate_budget_with_resource, params) req.send_request() end |
#associate_principal_with_portfolio(params = {}) ⇒ Struct
Associates the specified principal ARN with the specified portfolio.
If you share the portfolio with principal name sharing enabled, the ‘PrincipalARN` association is included in the share.
The ‘PortfolioID`, `PrincipalARN`, and `PrincipalType` parameters are required.
You can associate a maximum of 10 Principals with a portfolio using ‘PrincipalType` as `IAM_PATTERN`.
<note markdown=“1”> When you associate a principal with portfolio, a potential privilege escalation path may occur when that portfolio is then shared with other accounts. For a user in a recipient account who is not an Service Catalog Admin, but still has the ability to create Principals (Users/Groups/Roles), that user could create a role that matches a principal name association for the portfolio. Although this user may not know which principal names are associated through Service Catalog, they may be able to guess the user. If this potential escalation path is a concern, then Service Catalog recommends using ‘PrincipalType` as `IAM`. With this configuration, the `PrincipalARN` must already exist in the recipient account before it can be associated.
</note>
623 624 625 626 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 623 def associate_principal_with_portfolio(params = {}, = {}) req = build_request(:associate_principal_with_portfolio, params) req.send_request() end |
#associate_product_with_portfolio(params = {}) ⇒ Struct
Associates the specified product with the specified portfolio.
A delegated admin is authorized to invoke this command.
663 664 665 666 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 663 def associate_product_with_portfolio(params = {}, = {}) req = build_request(:associate_product_with_portfolio, params) req.send_request() end |
#associate_service_action_with_provisioning_artifact(params = {}) ⇒ Struct
Associates a self-service action with a provisioning artifact.
712 713 714 715 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 712 def associate_service_action_with_provisioning_artifact(params = {}, = {}) req = build_request(:associate_service_action_with_provisioning_artifact, params) req.send_request() end |
#associate_tag_option_with_resource(params = {}) ⇒ Struct
Associate the specified TagOption with the specified portfolio or product.
739 740 741 742 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 739 def associate_tag_option_with_resource(params = {}, = {}) req = build_request(:associate_tag_option_with_resource, params) req.send_request() end |
#batch_associate_service_action_with_provisioning_artifact(params = {}) ⇒ Types::BatchAssociateServiceActionWithProvisioningArtifactOutput
Associates multiple self-service actions with provisioning artifacts.
787 788 789 790 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 787 def batch_associate_service_action_with_provisioning_artifact(params = {}, = {}) req = build_request(:batch_associate_service_action_with_provisioning_artifact, params) req.send_request() end |
#batch_disassociate_service_action_from_provisioning_artifact(params = {}) ⇒ Types::BatchDisassociateServiceActionFromProvisioningArtifactOutput
Disassociates a batch of self-service actions from the specified provisioning artifact.
836 837 838 839 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 836 def batch_disassociate_service_action_from_provisioning_artifact(params = {}, = {}) req = build_request(:batch_disassociate_service_action_from_provisioning_artifact, params) req.send_request() end |
#build_request(operation_name, params = {}) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
6317 6318 6319 6320 6321 6322 6323 6324 6325 6326 6327 6328 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 6317 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-servicecatalog' context[:gem_version] = '1.99.0' Seahorse::Client::Request.new(handlers, context) end |
#copy_product(params = {}) ⇒ Types::CopyProductOutput
Copies the specified source product to the specified target product or a new product.
You can copy a product to the same account or another account. You can copy a product to the same Region or another Region. If you copy a product to another account, you must first share the product in a portfolio using CreatePortfolioShare.
This operation is performed asynchronously. To track the progress of the operation, use DescribeCopyProductStatus.
915 916 917 918 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 915 def copy_product(params = {}, = {}) req = build_request(:copy_product, params) req.send_request() end |
#create_constraint(params = {}) ⇒ Types::CreateConstraintOutput
Creates a constraint.
A delegated admin is authorized to invoke this command.
1069 1070 1071 1072 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 1069 def create_constraint(params = {}, = {}) req = build_request(:create_constraint, params) req.send_request() end |
#create_portfolio(params = {}) ⇒ Types::CreatePortfolioOutput
Creates a portfolio.
A delegated admin is authorized to invoke this command.
1142 1143 1144 1145 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 1142 def create_portfolio(params = {}, = {}) req = build_request(:create_portfolio, params) req.send_request() end |
#create_portfolio_share(params = {}) ⇒ Types::CreatePortfolioShareOutput
Shares the specified portfolio with the specified account or organization node. Shares to an organization node can only be created by the management account of an organization or by a delegated administrator. You can share portfolios to an organization, an organizational unit, or a specific account.
Note that if a delegated admin is de-registered, they can no longer create portfolio shares.
‘AWSOrganizationsAccess` must be enabled in order to create a portfolio share to an organization node.
You can’t share a shared resource, including portfolios that contain a shared product.
If the portfolio share with the specified account or organization node already exists, this action will have no effect and will not return an error. To update an existing share, you must use the ‘ UpdatePortfolioShare` API instead.
<note markdown=“1”> When you associate a principal with portfolio, a potential privilege escalation path may occur when that portfolio is then shared with other accounts. For a user in a recipient account who is not an Service Catalog Admin, but still has the ability to create Principals (Users/Groups/Roles), that user could create a role that matches a principal name association for the portfolio. Although this user may not know which principal names are associated through Service Catalog, they may be able to guess the user. If this potential escalation path is a concern, then Service Catalog recommends using ‘PrincipalType` as `IAM`. With this configuration, the `PrincipalARN` must already exist in the recipient account before it can be associated.
</note>
1249 1250 1251 1252 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 1249 def create_portfolio_share(params = {}, = {}) req = build_request(:create_portfolio_share, params) req.send_request() end |
#create_product(params = {}) ⇒ Types::CreateProductOutput
Creates a product.
A delegated admin is authorized to invoke this command.
The user or role that performs this operation must have the ‘cloudformation:GetTemplate` IAM policy permission. This policy permission is required when using the `ImportFromPhysicalId` template source in the information data section.
1409 1410 1411 1412 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 1409 def create_product(params = {}, = {}) req = build_request(:create_product, params) req.send_request() end |
#create_provisioned_product_plan(params = {}) ⇒ Types::CreateProvisionedProductPlanOutput
Creates a plan.
A plan includes the list of resources to be created (when provisioning a new product) or modified (when updating a provisioned product) when the plan is executed.
You can create one plan for each provisioned product. To create a plan for an existing provisioned product, the product status must be AVAILABLE or TAINTED.
To view the resource changes in the change set, use DescribeProvisionedProductPlan. To create or modify the provisioned product, use ExecuteProvisionedProductPlan.
1528 1529 1530 1531 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 1528 def create_provisioned_product_plan(params = {}, = {}) req = build_request(:create_provisioned_product_plan, params) req.send_request() end |
#create_provisioning_artifact(params = {}) ⇒ Types::CreateProvisioningArtifactOutput
Creates a provisioning artifact (also known as a version) for the specified product.
You cannot create a provisioning artifact for a product that was shared with you.
The user or role that performs this operation must have the ‘cloudformation:GetTemplate` IAM policy permission. This policy permission is required when using the `ImportFromPhysicalId` template source in the information data section.
1606 1607 1608 1609 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 1606 def create_provisioning_artifact(params = {}, = {}) req = build_request(:create_provisioning_artifact, params) req.send_request() end |
#create_service_action(params = {}) ⇒ Types::CreateServiceActionOutput
Creates a self-service action.
1699 1700 1701 1702 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 1699 def create_service_action(params = {}, = {}) req = build_request(:create_service_action, params) req.send_request() end |
#create_tag_option(params = {}) ⇒ Types::CreateTagOptionOutput
Creates a TagOption.
1735 1736 1737 1738 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 1735 def create_tag_option(params = {}, = {}) req = build_request(:create_tag_option, params) req.send_request() end |
#delete_constraint(params = {}) ⇒ Struct
Deletes the specified constraint.
A delegated admin is authorized to invoke this command.
1767 1768 1769 1770 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 1767 def delete_constraint(params = {}, = {}) req = build_request(:delete_constraint, params) req.send_request() end |
#delete_portfolio(params = {}) ⇒ Struct
Deletes the specified portfolio.
You cannot delete a portfolio if it was shared with you or if it has associated products, users, constraints, or shared accounts.
A delegated admin is authorized to invoke this command.
1802 1803 1804 1805 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 1802 def delete_portfolio(params = {}, = {}) req = build_request(:delete_portfolio, params) req.send_request() end |
#delete_portfolio_share(params = {}) ⇒ Types::DeletePortfolioShareOutput
Stops sharing the specified portfolio with the specified account or organization node. Shares to an organization node can only be deleted by the management account of an organization or by a delegated administrator.
Note that if a delegated admin is de-registered, portfolio shares created from that account are removed.
1855 1856 1857 1858 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 1855 def delete_portfolio_share(params = {}, = {}) req = build_request(:delete_portfolio_share, params) req.send_request() end |
#delete_product(params = {}) ⇒ Struct
Deletes the specified product.
You cannot delete a product if it was shared with you or is associated with a portfolio.
A delegated admin is authorized to invoke this command.
1890 1891 1892 1893 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 1890 def delete_product(params = {}, = {}) req = build_request(:delete_product, params) req.send_request() end |
#delete_provisioned_product_plan(params = {}) ⇒ Struct
Deletes the specified plan.
1925 1926 1927 1928 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 1925 def delete_provisioned_product_plan(params = {}, = {}) req = build_request(:delete_provisioned_product_plan, params) req.send_request() end |
#delete_provisioning_artifact(params = {}) ⇒ Struct
Deletes the specified provisioning artifact (also known as a version) for the specified product.
You cannot delete a provisioning artifact associated with a product that was shared with you. You cannot delete the last provisioning artifact for a product, because a product must have at least one provisioning artifact.
1965 1966 1967 1968 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 1965 def delete_provisioning_artifact(params = {}, = {}) req = build_request(:delete_provisioning_artifact, params) req.send_request() end |
#delete_service_action(params = {}) ⇒ Struct
Deletes a self-service action.
2005 2006 2007 2008 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 2005 def delete_service_action(params = {}, = {}) req = build_request(:delete_service_action, params) req.send_request() end |
#delete_tag_option(params = {}) ⇒ Struct
Deletes the specified TagOption.
You cannot delete a TagOption if it is associated with a product or portfolio.
2030 2031 2032 2033 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 2030 def delete_tag_option(params = {}, = {}) req = build_request(:delete_tag_option, params) req.send_request() end |
#describe_constraint(params = {}) ⇒ Types::DescribeConstraintOutput
Gets information about the specified constraint.
2075 2076 2077 2078 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 2075 def describe_constraint(params = {}, = {}) req = build_request(:describe_constraint, params) req.send_request() end |
#describe_copy_product_status(params = {}) ⇒ Types::DescribeCopyProductStatusOutput
Gets the status of the specified copy product operation.
2116 2117 2118 2119 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 2116 def describe_copy_product_status(params = {}, = {}) req = build_request(:describe_copy_product_status, params) req.send_request() end |
#describe_portfolio(params = {}) ⇒ Types::DescribePortfolioOutput
Gets information about the specified portfolio.
A delegated admin is authorized to invoke this command.
2173 2174 2175 2176 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 2173 def describe_portfolio(params = {}, = {}) req = build_request(:describe_portfolio, params) req.send_request() end |
#describe_portfolio_share_status(params = {}) ⇒ Types::DescribePortfolioShareStatusOutput
Gets the status of the specified portfolio share operation. This API can only be called by the management account in the organization or by a delegated admin.
2218 2219 2220 2221 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 2218 def describe_portfolio_share_status(params = {}, = {}) req = build_request(:describe_portfolio_share_status, params) req.send_request() end |
#describe_portfolio_shares(params = {}) ⇒ Types::DescribePortfolioSharesOutput
Returns a summary of each of the portfolio shares that were created for the specified portfolio.
You can use this API to determine which accounts or organizational nodes this portfolio have been shared, whether the recipient entity has imported the share, and whether TagOptions are included with the share.
The ‘PortfolioId` and `Type` parameters are both required.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2289 2290 2291 2292 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 2289 def describe_portfolio_shares(params = {}, = {}) req = build_request(:describe_portfolio_shares, params) req.send_request() end |
#describe_product(params = {}) ⇒ Types::DescribeProductOutput
Gets information about the specified product.
<note markdown=“1”> Running this operation with administrator access results in a failure. DescribeProductAsAdmin should be used instead.
</note>
2358 2359 2360 2361 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 2358 def describe_product(params = {}, = {}) req = build_request(:describe_product, params) req.send_request() end |
#describe_product_as_admin(params = {}) ⇒ Types::DescribeProductAsAdminOutput
Gets information about the specified product. This operation is run with administrator access.
2455 2456 2457 2458 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 2455 def describe_product_as_admin(params = {}, = {}) req = build_request(:describe_product_as_admin, params) req.send_request() end |
#describe_product_view(params = {}) ⇒ Types::DescribeProductViewOutput
Gets information about the specified product.
2508 2509 2510 2511 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 2508 def describe_product_view(params = {}, = {}) req = build_request(:describe_product_view, params) req.send_request() end |
#describe_provisioned_product(params = {}) ⇒ Types::DescribeProvisionedProductOutput
Gets information about the specified provisioned product.
2572 2573 2574 2575 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 2572 def describe_provisioned_product(params = {}, = {}) req = build_request(:describe_provisioned_product, params) req.send_request() end |
#describe_provisioned_product_plan(params = {}) ⇒ Types::DescribeProvisionedProductPlanOutput
Gets information about the resource changes for the specified plan.
2654 2655 2656 2657 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 2654 def describe_provisioned_product_plan(params = {}, = {}) req = build_request(:describe_provisioned_product_plan, params) req.send_request() end |
#describe_provisioning_artifact(params = {}) ⇒ Types::DescribeProvisioningArtifactOutput
Gets information about the specified provisioning artifact (also known as a version) for the specified product.
2739 2740 2741 2742 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 2739 def describe_provisioning_artifact(params = {}, = {}) req = build_request(:describe_provisioning_artifact, params) req.send_request() end |
#describe_provisioning_parameters(params = {}) ⇒ Types::DescribeProvisioningParametersOutput
Gets information about the configuration required to provision the specified product using the specified provisioning artifact.
If the output contains a TagOption key with an empty list of values, there is a TagOption conflict for that key. The end user cannot take action to fix the conflict, and launch is not blocked. In subsequent calls to ProvisionProduct, do not include conflicted TagOption keys as tags, or this causes the error “Parameter validation failed: Missing required parameter in Tags[N]:Value”. Tag the provisioned product with the value ‘sc-tagoption-conflict-portfolioId-productId`.
2850 2851 2852 2853 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 2850 def describe_provisioning_parameters(params = {}, = {}) req = build_request(:describe_provisioning_parameters, params) req.send_request() end |
#describe_record(params = {}) ⇒ Types::DescribeRecordOutput
Gets information about the specified request operation.
Use this operation after calling a request operation (for example, ProvisionProduct, TerminateProvisionedProduct, or UpdateProvisionedProduct).
<note markdown=“1”> If a provisioned product was transferred to a new owner using UpdateProvisionedProductProperties, the new owner will be able to describe all past records for that product. The previous owner will no longer be able to describe the records, but will be able to use ListRecordHistory to see the product’s history from when he was the owner.
</note>
2933 2934 2935 2936 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 2933 def describe_record(params = {}, = {}) req = build_request(:describe_record, params) req.send_request() end |
#describe_service_action(params = {}) ⇒ Types::DescribeServiceActionOutput
Describes a self-service action.
2974 2975 2976 2977 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 2974 def describe_service_action(params = {}, = {}) req = build_request(:describe_service_action, params) req.send_request() end |
#describe_service_action_execution_parameters(params = {}) ⇒ Types::DescribeServiceActionExecutionParametersOutput
Finds the default parameters for a specific self-service action on a specific provisioned product and returns a map of the results to the user.
3020 3021 3022 3023 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 3020 def describe_service_action_execution_parameters(params = {}, = {}) req = build_request(:describe_service_action_execution_parameters, params) req.send_request() end |
#describe_tag_option(params = {}) ⇒ Types::DescribeTagOptionOutput
Gets information about the specified TagOption.
3052 3053 3054 3055 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 3052 def describe_tag_option(params = {}, = {}) req = build_request(:describe_tag_option, params) req.send_request() end |
#disable_aws_organizations_access(params = {}) ⇒ Struct
Disable portfolio sharing through the Organizations service. This command will not delete your current shares, but prevents you from creating new shares throughout your organization. Current shares are not kept in sync with your organization structure if the structure changes after calling this API. Only the management account in the organization can call this API.
You cannot call this API if there are active delegated administrators in the organization.
Note that a delegated administrator is not authorized to invoke ‘DisableAWSOrganizationsAccess`.
If you share an Service Catalog portfolio in an organization within Organizations, and then disable Organizations access for Service Catalog, the portfolio access permissions will not sync with the latest changes to the organization structure. Specifically, accounts that you removed from the organization after disabling Service Catalog access will retain access to the previously shared portfolio.
3083 3084 3085 3086 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 3083 def disable_aws_organizations_access(params = {}, = {}) req = build_request(:disable_aws_organizations_access, params) req.send_request() end |
#disassociate_budget_from_resource(params = {}) ⇒ Struct
Disassociates the specified budget from the specified resource.
3110 3111 3112 3113 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 3110 def disassociate_budget_from_resource(params = {}, = {}) req = build_request(:disassociate_budget_from_resource, params) req.send_request() end |
#disassociate_principal_from_portfolio(params = {}) ⇒ Struct
Disassociates a previously associated principal ARN from a specified portfolio.
The ‘PrincipalType` and `PrincipalARN` must match the `AssociatePrincipalWithPortfolio` call request details. For example, to disassociate an association created with a `PrincipalARN` of `PrincipalType` IAM you must use the `PrincipalType` IAM when calling `DisassociatePrincipalFromPortfolio`.
For portfolios that have been shared with principal name sharing enabled: after disassociating a principal, share recipient accounts will no longer be able to provision products in this portfolio using a role matching the name of the associated principal.
For more information, review [associate-principal-with-portfolio] in the Amazon Web Services CLI Command Reference.
<note markdown=“1”> If you disassociate a principal from a portfolio, with PrincipalType as ‘IAM`, the same principal will still have access to the portfolio if it matches one of the associated principals of type `IAM_PATTERN`. To fully remove access for a principal, verify all the associated Principals of type `IAM_PATTERN`, and then ensure you disassociate any `IAM_PATTERN` principals that match the principal whose access you are removing.
</note>
3181 3182 3183 3184 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 3181 def disassociate_principal_from_portfolio(params = {}, = {}) req = build_request(:disassociate_principal_from_portfolio, params) req.send_request() end |
#disassociate_product_from_portfolio(params = {}) ⇒ Struct
Disassociates the specified product from the specified portfolio.
A delegated admin is authorized to invoke this command.
3217 3218 3219 3220 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 3217 def disassociate_product_from_portfolio(params = {}, = {}) req = build_request(:disassociate_product_from_portfolio, params) req.send_request() end |
#disassociate_service_action_from_provisioning_artifact(params = {}) ⇒ Struct
Disassociates the specified self-service action association from the specified provisioning artifact.
3267 3268 3269 3270 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 3267 def disassociate_service_action_from_provisioning_artifact(params = {}, = {}) req = build_request(:disassociate_service_action_from_provisioning_artifact, params) req.send_request() end |
#disassociate_tag_option_from_resource(params = {}) ⇒ Struct
Disassociates the specified TagOption from the specified resource.
3293 3294 3295 3296 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 3293 def disassociate_tag_option_from_resource(params = {}, = {}) req = build_request(:disassociate_tag_option_from_resource, params) req.send_request() end |
#enable_aws_organizations_access(params = {}) ⇒ Struct
Enable portfolio sharing feature through Organizations. This API will allow Service Catalog to receive updates on your organization in order to sync your shares with the current structure. This API can only be called by the management account in the organization.
When you call this API, Service Catalog calls ‘organizations:EnableAWSServiceAccess` on your behalf so that your shares stay in sync with any changes in your Organizations structure.
Note that a delegated administrator is not authorized to invoke ‘EnableAWSOrganizationsAccess`.
If you have previously disabled Organizations access for Service Catalog, and then enable access again, the portfolio access permissions might not sync with the latest changes to the organization structure. Specifically, accounts that you removed from the organization after disabling Service Catalog access, and before you enabled access again, can retain access to the previously shared portfolio. As a result, an account that has been removed from the organization might still be able to create or manage Amazon Web Services resources when it is no longer authorized to do so. Amazon Web Services is working to resolve this issue.
3327 3328 3329 3330 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 3327 def enable_aws_organizations_access(params = {}, = {}) req = build_request(:enable_aws_organizations_access, params) req.send_request() end |
#execute_provisioned_product_plan(params = {}) ⇒ Types::ExecuteProvisionedProductPlanOutput
Provisions or modifies a product based on the resource changes for the specified plan.
3390 3391 3392 3393 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 3390 def execute_provisioned_product_plan(params = {}, = {}) req = build_request(:execute_provisioned_product_plan, params) req.send_request() end |
#execute_provisioned_product_service_action(params = {}) ⇒ Types::ExecuteProvisionedProductServiceActionOutput
Executes a self-service action against a provisioned product.
3465 3466 3467 3468 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 3465 def execute_provisioned_product_service_action(params = {}, = {}) req = build_request(:execute_provisioned_product_service_action, params) req.send_request() end |
#get_aws_organizations_access_status(params = {}) ⇒ Types::GetAWSOrganizationsAccessStatusOutput
Get the Access Status for Organizations portfolio share feature. This API can only be called by the management account in the organization or by a delegated admin.
3486 3487 3488 3489 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 3486 def get_aws_organizations_access_status(params = {}, = {}) req = build_request(:get_aws_organizations_access_status, params) req.send_request() end |
#get_provisioned_product_outputs(params = {}) ⇒ Types::GetProvisionedProductOutputsOutput
This API takes either a ‘ProvisonedProductId` or a `ProvisionedProductName`, along with a list of one or more output keys, and responds with the key/value pairs of those outputs.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3551 3552 3553 3554 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 3551 def get_provisioned_product_outputs(params = {}, = {}) req = build_request(:get_provisioned_product_outputs, params) req.send_request() end |
#import_as_provisioned_product(params = {}) ⇒ Types::ImportAsProvisionedProductOutput
Requests the import of a resource as an Service Catalog provisioned product that is associated to an Service Catalog product and provisioning artifact. Once imported, all supported governance actions are supported on the provisioned product.
Resource import only supports CloudFormation stack ARNs. CloudFormation StackSets, and non-root nested stacks, are not supported.
The CloudFormation stack must have one of the following statuses to be imported: ‘CREATE_COMPLETE`, `UPDATE_COMPLETE`, `UPDATE_ROLLBACK_COMPLETE`, `IMPORT_COMPLETE`, and `IMPORT_ROLLBACK_COMPLETE`.
Import of the resource requires that the CloudFormation stack template matches the associated Service Catalog product provisioning artifact.
<note markdown=“1”> When you import an existing CloudFormation stack into a portfolio, Service Catalog does not apply the product’s associated constraints during the import process. Service Catalog applies the constraints after you call ‘UpdateProvisionedProduct` for the provisioned product.
</note>
The user or role that performs this operation must have the ‘cloudformation:GetTemplate` and `cloudformation:DescribeStacks` IAM policy permissions.
You can only import one provisioned product at a time. The product’s CloudFormation stack must have the ‘IMPORT_COMPLETE` status before you import another.
3658 3659 3660 3661 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 3658 def import_as_provisioned_product(params = {}, = {}) req = build_request(:import_as_provisioned_product, params) req.send_request() end |
#list_accepted_portfolio_shares(params = {}) ⇒ Types::ListAcceptedPortfolioSharesOutput
Lists all imported portfolios for which account-to-account shares were accepted by this account. By specifying the ‘PortfolioShareType`, you can list portfolios for which organizational shares were accepted by this account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3726 3727 3728 3729 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 3726 def list_accepted_portfolio_shares(params = {}, = {}) req = build_request(:list_accepted_portfolio_shares, params) req.send_request() end |
#list_budgets_for_resource(params = {}) ⇒ Types::ListBudgetsForResourceOutput
Lists all the budgets associated to the specified resource.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3776 3777 3778 3779 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 3776 def list_budgets_for_resource(params = {}, = {}) req = build_request(:list_budgets_for_resource, params) req.send_request() end |
#list_constraints_for_portfolio(params = {}) ⇒ Types::ListConstraintsForPortfolioOutput
Lists the constraints for the specified portfolio and product.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3835 3836 3837 3838 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 3835 def list_constraints_for_portfolio(params = {}, = {}) req = build_request(:list_constraints_for_portfolio, params) req.send_request() end |
#list_launch_paths(params = {}) ⇒ Types::ListLaunchPathsOutput
Lists the paths to the specified product. A path describes how the user gets access to a specified product and is necessary when provisioning a product. A path also determines the constraints that are put on a product. A path is dependent on a specific product, porfolio, and principal.
<note markdown=“1”> When provisioning a product that’s been added to a portfolio, you must grant your user, group, or role access to the portfolio. For more information, see [Granting users access] in the *Service Catalog User Guide*.
</note>
[1]: docs.aws.amazon.com/servicecatalog/latest/adminguide/catalogs_portfolios_users.html
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3907 3908 3909 3910 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 3907 def list_launch_paths(params = {}, = {}) req = build_request(:list_launch_paths, params) req.send_request() end |
#list_organization_portfolio_access(params = {}) ⇒ Types::ListOrganizationPortfolioAccessOutput
Lists the organization nodes that have access to the specified portfolio. This API can only be called by the management account in the organization or by a delegated admin.
If a delegated admin is de-registered, they can no longer perform this operation.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3975 3976 3977 3978 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 3975 def list_organization_portfolio_access(params = {}, = {}) req = build_request(:list_organization_portfolio_access, params) req.send_request() end |
#list_portfolio_access(params = {}) ⇒ Types::ListPortfolioAccessOutput
Lists the account IDs that have access to the specified portfolio.
A delegated admin can list the accounts that have access to the shared portfolio. Note that if a delegated admin is de-registered, they can no longer perform this operation.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4035 4036 4037 4038 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 4035 def list_portfolio_access(params = {}, = {}) req = build_request(:list_portfolio_access, params) req.send_request() end |
#list_portfolios(params = {}) ⇒ Types::ListPortfoliosOutput
Lists all portfolios in the catalog.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4086 4087 4088 4089 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 4086 def list_portfolios(params = {}, = {}) req = build_request(:list_portfolios, params) req.send_request() end |
#list_portfolios_for_product(params = {}) ⇒ Types::ListPortfoliosForProductOutput
Lists all portfolios that the specified product is associated with.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4141 4142 4143 4144 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 4141 def list_portfolios_for_product(params = {}, = {}) req = build_request(:list_portfolios_for_product, params) req.send_request() end |
#list_principals_for_portfolio(params = {}) ⇒ Types::ListPrincipalsForPortfolioOutput
Lists all ‘PrincipalARN`s and corresponding `PrincipalType`s associated with the specified portfolio.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4193 4194 4195 4196 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 4193 def list_principals_for_portfolio(params = {}, = {}) req = build_request(:list_principals_for_portfolio, params) req.send_request() end |
#list_provisioned_product_plans(params = {}) ⇒ Types::ListProvisionedProductPlansOutput
Lists the plans for the specified provisioned product or all plans to which the user has access.
4254 4255 4256 4257 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 4254 def list_provisioned_product_plans(params = {}, = {}) req = build_request(:list_provisioned_product_plans, params) req.send_request() end |
#list_provisioning_artifacts(params = {}) ⇒ Types::ListProvisioningArtifactsOutput
Lists all provisioning artifacts (also known as versions) for the specified product.
4301 4302 4303 4304 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 4301 def list_provisioning_artifacts(params = {}, = {}) req = build_request(:list_provisioning_artifacts, params) req.send_request() end |
#list_provisioning_artifacts_for_service_action(params = {}) ⇒ Types::ListProvisioningArtifactsForServiceActionOutput
Lists all provisioning artifacts (also known as versions) for the specified self-service action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4367 4368 4369 4370 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 4367 def list_provisioning_artifacts_for_service_action(params = {}, = {}) req = build_request(:list_provisioning_artifacts_for_service_action, params) req.send_request() end |
#list_record_history(params = {}) ⇒ Types::ListRecordHistoryOutput
Lists the specified requests or all performed requests.
4442 4443 4444 4445 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 4442 def list_record_history(params = {}, = {}) req = build_request(:list_record_history, params) req.send_request() end |
#list_resources_for_tag_option(params = {}) ⇒ Types::ListResourcesForTagOptionOutput
Lists the resources associated with the specified TagOption.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4496 4497 4498 4499 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 4496 def list_resources_for_tag_option(params = {}, = {}) req = build_request(:list_resources_for_tag_option, params) req.send_request() end |
#list_service_actions(params = {}) ⇒ Types::ListServiceActionsOutput
Lists all self-service actions.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4545 4546 4547 4548 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 4545 def list_service_actions(params = {}, = {}) req = build_request(:list_service_actions, params) req.send_request() end |
#list_service_actions_for_provisioning_artifact(params = {}) ⇒ Types::ListServiceActionsForProvisioningArtifactOutput
Returns a paginated list of self-service actions associated with the specified Product ID and Provisioning Artifact ID.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4604 4605 4606 4607 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 4604 def list_service_actions_for_provisioning_artifact(params = {}, = {}) req = build_request(:list_service_actions_for_provisioning_artifact, params) req.send_request() end |
#list_stack_instances_for_provisioned_product(params = {}) ⇒ Types::ListStackInstancesForProvisionedProductOutput
Returns summary information about stack instances that are associated with the specified ‘CFN_STACKSET` type provisioned product. You can filter for stack instances that are associated with a specific Amazon Web Services account name or Region.
4657 4658 4659 4660 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 4657 def list_stack_instances_for_provisioned_product(params = {}, = {}) req = build_request(:list_stack_instances_for_provisioned_product, params) req.send_request() end |
#list_tag_options(params = {}) ⇒ Types::ListTagOptionsOutput
Lists the specified TagOptions or all TagOptions.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4708 4709 4710 4711 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 4708 def (params = {}, = {}) req = build_request(:list_tag_options, params) req.send_request() end |
#notify_provision_product_engine_workflow_result(params = {}) ⇒ Struct
Notifies the result of the provisioning engine execution.
4772 4773 4774 4775 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 4772 def notify_provision_product_engine_workflow_result(params = {}, = {}) req = build_request(:notify_provision_product_engine_workflow_result, params) req.send_request() end |
#notify_terminate_provisioned_product_engine_workflow_result(params = {}) ⇒ Struct
Notifies the result of the terminate engine execution.
4815 4816 4817 4818 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 4815 def notify_terminate_provisioned_product_engine_workflow_result(params = {}, = {}) req = build_request(:notify_terminate_provisioned_product_engine_workflow_result, params) req.send_request() end |
#notify_update_provisioned_product_engine_workflow_result(params = {}) ⇒ Struct
Notifies the result of the update engine execution.
4868 4869 4870 4871 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 4868 def notify_update_provisioned_product_engine_workflow_result(params = {}, = {}) req = build_request(:notify_update_provisioned_product_engine_workflow_result, params) req.send_request() end |
#provision_product(params = {}) ⇒ Types::ProvisionProductOutput
Provisions the specified product.
A provisioned product is a resourced instance of a product. For example, provisioning a product that’s based on an CloudFormation template launches an CloudFormation stack and its underlying resources. You can check the status of this request using DescribeRecord.
If the request contains a tag key with an empty list of values, there’s a tag conflict for that key. Don’t include conflicted keys as tags, or this will cause the error “Parameter validation failed: Missing required parameter in Tags[N]:Value”.
<note markdown=“1”> When provisioning a product that’s been added to a portfolio, you must grant your user, group, or role access to the portfolio. For more information, see [Granting users access] in the *Service Catalog User Guide*.
</note>
[1]: docs.aws.amazon.com/servicecatalog/latest/adminguide/catalogs_portfolios_users.html
5019 5020 5021 5022 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 5019 def provision_product(params = {}, = {}) req = build_request(:provision_product, params) req.send_request() end |
#reject_portfolio_share(params = {}) ⇒ Struct
Rejects an offer to share the specified portfolio.
5065 5066 5067 5068 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 5065 def reject_portfolio_share(params = {}, = {}) req = build_request(:reject_portfolio_share, params) req.send_request() end |
#scan_provisioned_products(params = {}) ⇒ Types::ScanProvisionedProductsOutput
Lists the provisioned products that are available (not terminated).
To use additional filtering, see SearchProvisionedProducts.
5131 5132 5133 5134 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 5131 def scan_provisioned_products(params = {}, = {}) req = build_request(:scan_provisioned_products, params) req.send_request() end |
#search_products(params = {}) ⇒ Types::SearchProductsOutput
Gets information about the products to which the caller has access.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5207 5208 5209 5210 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 5207 def search_products(params = {}, = {}) req = build_request(:search_products, params) req.send_request() end |
#search_products_as_admin(params = {}) ⇒ Types::SearchProductsAsAdminOutput
Gets information about the products for the specified portfolio or all products.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5300 5301 5302 5303 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 5300 def search_products_as_admin(params = {}, = {}) req = build_request(:search_products_as_admin, params) req.send_request() end |
#search_provisioned_products(params = {}) ⇒ Types::SearchProvisionedProductsOutput
Gets information about the provisioned products that meet the specified criteria.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5400 5401 5402 5403 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 5400 def search_provisioned_products(params = {}, = {}) req = build_request(:search_provisioned_products, params) req.send_request() end |
#terminate_provisioned_product(params = {}) ⇒ Types::TerminateProvisionedProductOutput
Terminates the specified provisioned product.
This operation does not delete any records associated with the provisioned product.
You can check the status of this request using DescribeRecord.
5487 5488 5489 5490 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 5487 def terminate_provisioned_product(params = {}, = {}) req = build_request(:terminate_provisioned_product, params) req.send_request() end |
#update_constraint(params = {}) ⇒ Types::UpdateConstraintOutput
Updates the specified constraint.
5612 5613 5614 5615 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 5612 def update_constraint(params = {}, = {}) req = build_request(:update_constraint, params) req.send_request() end |
#update_portfolio(params = {}) ⇒ Types::UpdatePortfolioOutput
Updates the specified portfolio.
You cannot update a product that was shared with you.
5684 5685 5686 5687 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 5684 def update_portfolio(params = {}, = {}) req = build_request(:update_portfolio, params) req.send_request() end |
#update_portfolio_share(params = {}) ⇒ Types::UpdatePortfolioShareOutput
Updates the specified portfolio share. You can use this API to enable or disable ‘TagOptions` sharing or Principal sharing for an existing portfolio share.
The portfolio share cannot be updated if the ‘CreatePortfolioShare` operation is `IN_PROGRESS`, as the share is not available to recipient entities. In this case, you must wait for the portfolio share to be completed.
You must provide the ‘accountId` or organization node in the input, but not both.
If the portfolio is shared to both an external account and an organization node, and both shares need to be updated, you must invoke ‘UpdatePortfolioShare` separately for each share type.
This API cannot be used for removing the portfolio share. You must use ‘DeletePortfolioShare` API for that action.
<note markdown=“1”> When you associate a principal with portfolio, a potential privilege escalation path may occur when that portfolio is then shared with other accounts. For a user in a recipient account who is not an Service Catalog Admin, but still has the ability to create Principals (Users/Groups/Roles), that user could create a role that matches a principal name association for the portfolio. Although this user may not know which principal names are associated through Service Catalog, they may be able to guess the user. If this potential escalation path is a concern, then Service Catalog recommends using ‘PrincipalType` as `IAM`. With this configuration, the `PrincipalARN` must already exist in the recipient account before it can be associated.
</note>
5779 5780 5781 5782 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 5779 def update_portfolio_share(params = {}, = {}) req = build_request(:update_portfolio_share, params) req.send_request() end |
#update_product(params = {}) ⇒ Types::UpdateProductOutput
Updates the specified product.
5904 5905 5906 5907 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 5904 def update_product(params = {}, = {}) req = build_request(:update_product, params) req.send_request() end |
#update_provisioned_product(params = {}) ⇒ Types::UpdateProvisionedProductOutput
Requests updates to the configuration of the specified provisioned product.
If there are tags associated with the object, they cannot be updated or added. Depending on the specific updates requested, this operation can update with no interruption, with some interruption, or replace the provisioned product entirely.
You can check the status of this request using DescribeRecord.
6042 6043 6044 6045 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 6042 def update_provisioned_product(params = {}, = {}) req = build_request(:update_provisioned_product, params) req.send_request() end |
#update_provisioned_product_properties(params = {}) ⇒ Types::UpdateProvisionedProductPropertiesOutput
Requests updates to the properties of the specified provisioned product.
6129 6130 6131 6132 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 6129 def update_provisioned_product_properties(params = {}, = {}) req = build_request(:update_provisioned_product_properties, params) req.send_request() end |
#update_provisioning_artifact(params = {}) ⇒ Types::UpdateProvisioningArtifactOutput
Updates the specified provisioning artifact (also known as a version) for the specified product.
You cannot update a provisioning artifact for a product that was shared with you.
6213 6214 6215 6216 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 6213 def update_provisioning_artifact(params = {}, = {}) req = build_request(:update_provisioning_artifact, params) req.send_request() end |
#update_service_action(params = {}) ⇒ Types::UpdateServiceActionOutput
Updates a self-service action.
6268 6269 6270 6271 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 6268 def update_service_action(params = {}, = {}) req = build_request(:update_service_action, params) req.send_request() end |
#update_tag_option(params = {}) ⇒ Types::UpdateTagOptionOutput
Updates the specified TagOption.
6308 6309 6310 6311 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 6308 def update_tag_option(params = {}, = {}) req = build_request(:update_tag_option, params) req.send_request() end |
#waiter_names ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
6332 6333 6334 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 6332 def waiter_names [] end |