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.
395 396 397 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 395 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.
6305 6306 6307 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 6305 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.
6308 6309 6310 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 6308 def errors_module Errors end |
Instance Method Details
#accept_portfolio_share(params = {}) ⇒ Struct
Accepts an offer to share the specified portfolio.
442 443 444 445 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 442 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.
468 469 470 471 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 468 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>
589 590 591 592 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 589 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.
629 630 631 632 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 629 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.
678 679 680 681 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 678 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.
705 706 707 708 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 705 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.
753 754 755 756 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 753 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.
802 803 804 805 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 802 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.
6283 6284 6285 6286 6287 6288 6289 6290 6291 6292 6293 6294 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 6283 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.92.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.
881 882 883 884 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 881 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.
1035 1036 1037 1038 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 1035 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.
1108 1109 1110 1111 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 1108 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>
1215 1216 1217 1218 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 1215 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.
1375 1376 1377 1378 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 1375 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.
1494 1495 1496 1497 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 1494 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.
1572 1573 1574 1575 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 1572 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.
1665 1666 1667 1668 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 1665 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.
1701 1702 1703 1704 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 1701 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.
1733 1734 1735 1736 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 1733 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.
1768 1769 1770 1771 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 1768 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.
1821 1822 1823 1824 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 1821 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.
1856 1857 1858 1859 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 1856 def delete_product(params = {}, = {}) req = build_request(:delete_product, params) req.send_request() end |
#delete_provisioned_product_plan(params = {}) ⇒ Struct
Deletes the specified plan.
1891 1892 1893 1894 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 1891 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.
1931 1932 1933 1934 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 1931 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.
1971 1972 1973 1974 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 1971 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.
1996 1997 1998 1999 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 1996 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.
2041 2042 2043 2044 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 2041 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.
2082 2083 2084 2085 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 2082 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.
2139 2140 2141 2142 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 2139 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.
2184 2185 2186 2187 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 2184 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.
2255 2256 2257 2258 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 2255 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>
2324 2325 2326 2327 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 2324 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.
2421 2422 2423 2424 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 2421 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.
2474 2475 2476 2477 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 2474 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.
2538 2539 2540 2541 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 2538 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.
2620 2621 2622 2623 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 2620 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.
2705 2706 2707 2708 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 2705 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`.
2816 2817 2818 2819 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 2816 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>
2899 2900 2901 2902 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 2899 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.
2940 2941 2942 2943 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 2940 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.
2986 2987 2988 2989 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 2986 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.
3018 3019 3020 3021 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 3018 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.
3049 3050 3051 3052 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 3049 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.
3076 3077 3078 3079 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 3076 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>
3147 3148 3149 3150 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 3147 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.
3183 3184 3185 3186 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 3183 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.
3233 3234 3235 3236 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 3233 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.
3259 3260 3261 3262 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 3259 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.
3293 3294 3295 3296 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 3293 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.
3356 3357 3358 3359 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 3356 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.
3431 3432 3433 3434 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 3431 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.
3452 3453 3454 3455 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 3452 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.
3517 3518 3519 3520 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 3517 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.
3624 3625 3626 3627 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 3624 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.
3692 3693 3694 3695 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 3692 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.
3742 3743 3744 3745 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 3742 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.
3801 3802 3803 3804 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 3801 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.
3873 3874 3875 3876 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 3873 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.
3941 3942 3943 3944 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 3941 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.
4001 4002 4003 4004 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 4001 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.
4052 4053 4054 4055 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 4052 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.
4107 4108 4109 4110 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 4107 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.
4159 4160 4161 4162 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 4159 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.
4220 4221 4222 4223 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 4220 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.
4267 4268 4269 4270 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 4267 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.
4333 4334 4335 4336 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 4333 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.
4408 4409 4410 4411 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 4408 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.
4462 4463 4464 4465 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 4462 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.
4511 4512 4513 4514 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 4511 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.
4570 4571 4572 4573 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 4570 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.
4623 4624 4625 4626 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 4623 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.
4674 4675 4676 4677 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 4674 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.
4738 4739 4740 4741 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 4738 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.
4781 4782 4783 4784 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 4781 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.
4834 4835 4836 4837 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 4834 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
4985 4986 4987 4988 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 4985 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.
5031 5032 5033 5034 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 5031 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.
5097 5098 5099 5100 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 5097 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.
5173 5174 5175 5176 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 5173 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.
5266 5267 5268 5269 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 5266 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.
5366 5367 5368 5369 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 5366 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.
5453 5454 5455 5456 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 5453 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.
5578 5579 5580 5581 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 5578 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.
5650 5651 5652 5653 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 5650 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>
5745 5746 5747 5748 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 5745 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.
5870 5871 5872 5873 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 5870 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.
6008 6009 6010 6011 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 6008 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.
6095 6096 6097 6098 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 6095 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.
6179 6180 6181 6182 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 6179 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.
6234 6235 6236 6237 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 6234 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.
6274 6275 6276 6277 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 6274 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.
6298 6299 6300 |
# File 'lib/aws-sdk-servicecatalog/client.rb', line 6298 def waiter_names [] end |