Class: Aws::ServiceCatalog::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::ServiceCatalog::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-servicecatalog/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.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
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 aProvisionedProductName
, 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 correspondingPrincipalType
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.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
451 452 453 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 451 def initialize(*args) super end |
Instance Method Details
#accept_portfolio_share(params = {}) ⇒ Struct
Accepts an offer to share the specified portfolio.
498 499 500 501 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 498 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.
524 525 526 527 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 524 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
.
PrincipalType
as
IAM
. With this configuration, the PrincipalARN
must already exist
in the recipient account before it can be associated.
645 646 647 648 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 645 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.
685 686 687 688 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 685 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.
734 735 736 737 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 734 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.
761 762 763 764 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 761 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.
809 810 811 812 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 809 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.
858 859 860 861 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 858 def batch_disassociate_service_action_from_provisioning_artifact(params = {}, = {}) req = build_request(:batch_disassociate_service_action_from_provisioning_artifact, params) req.send_request() 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.
937 938 939 940 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 937 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.
1091 1092 1093 1094 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 1091 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.
1164 1165 1166 1167 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 1164 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.
PrincipalType
as
IAM
. With this configuration, the PrincipalARN
must already exist
in the recipient account before it can be associated.
1271 1272 1273 1274 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 1271 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.
1431 1432 1433 1434 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 1431 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.
1550 1551 1552 1553 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 1550 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.
1628 1629 1630 1631 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 1628 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.
1721 1722 1723 1724 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 1721 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.
1757 1758 1759 1760 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 1757 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.
1789 1790 1791 1792 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 1789 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.
1824 1825 1826 1827 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 1824 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.
1877 1878 1879 1880 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 1877 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.
1912 1913 1914 1915 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 1912 def delete_product(params = {}, = {}) req = build_request(:delete_product, params) req.send_request() end |
#delete_provisioned_product_plan(params = {}) ⇒ Struct
Deletes the specified plan.
1947 1948 1949 1950 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 1947 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.
1987 1988 1989 1990 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 1987 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.
2027 2028 2029 2030 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2027 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.
2052 2053 2054 2055 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2052 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.
2097 2098 2099 2100 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2097 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.
2138 2139 2140 2141 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2138 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.
2195 2196 2197 2198 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2195 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.
2240 2241 2242 2243 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2240 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.
2311 2312 2313 2314 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2311 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.
2380 2381 2382 2383 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2380 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.
2477 2478 2479 2480 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2477 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.
2530 2531 2532 2533 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2530 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.
2594 2595 2596 2597 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2594 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.
2676 2677 2678 2679 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2676 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.
2761 2762 2763 2764 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2761 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
.
2872 2873 2874 2875 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2872 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).
2955 2956 2957 2958 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2955 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.
2996 2997 2998 2999 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2996 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.
3042 3043 3044 3045 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 3042 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.
3074 3075 3076 3077 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 3074 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.
3105 3106 3107 3108 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 3105 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.
3132 3133 3134 3135 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 3132 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.
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.
3203 3204 3205 3206 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 3203 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.
3239 3240 3241 3242 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 3239 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.
3289 3290 3291 3292 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 3289 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.
3315 3316 3317 3318 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 3315 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.
3349 3350 3351 3352 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 3349 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.
3412 3413 3414 3415 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 3412 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.
3487 3488 3489 3490 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 3487 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.
3508 3509 3510 3511 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 3508 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.
3573 3574 3575 3576 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 3573 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.
UpdateProvisionedProduct
for the provisioned product.
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.
3680 3681 3682 3683 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 3680 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.
3748 3749 3750 3751 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 3748 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.
3798 3799 3800 3801 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 3798 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.
3857 3858 3859 3860 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 3857 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3929 3930 3931 3932 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 3929 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.
3997 3998 3999 4000 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 3997 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.
4057 4058 4059 4060 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 4057 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.
4108 4109 4110 4111 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 4108 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.
4163 4164 4165 4166 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 4163 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.
4215 4216 4217 4218 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 4215 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.
4276 4277 4278 4279 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 4276 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.
4323 4324 4325 4326 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 4323 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.
4389 4390 4391 4392 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 4389 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.
4464 4465 4466 4467 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 4464 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.
4518 4519 4520 4521 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 4518 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.
4567 4568 4569 4570 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 4567 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.
4626 4627 4628 4629 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 4626 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.
4679 4680 4681 4682 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 4679 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.
4730 4731 4732 4733 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 4730 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.
4794 4795 4796 4797 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 4794 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.
4837 4838 4839 4840 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 4837 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.
4890 4891 4892 4893 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 4890 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".
5041 5042 5043 5044 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 5041 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.
5087 5088 5089 5090 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 5087 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.
5153 5154 5155 5156 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 5153 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.
5229 5230 5231 5232 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 5229 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.
5322 5323 5324 5325 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 5322 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.
5422 5423 5424 5425 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 5422 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.
5509 5510 5511 5512 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 5509 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.
5634 5635 5636 5637 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 5634 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.
5706 5707 5708 5709 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 5706 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.
PrincipalType
as
IAM
. With this configuration, the PrincipalARN
must already exist
in the recipient account before it can be associated.
5801 5802 5803 5804 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 5801 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.
5926 5927 5928 5929 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 5926 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.
6064 6065 6066 6067 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 6064 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.