You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::ServiceCatalog::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::ServiceCatalog::Client
- Defined in:
- (unknown)
Overview
An API client for AWS Service Catalog. To construct a client, you need to configure a :region
and :credentials
.
servicecatalog = Aws::ServiceCatalog::Client.new(
region: region_name,
credentials: credentials,
# ...
)
See #initialize for a full list of supported configuration options.
Region
You can configure a default region in the following locations:
ENV['AWS_REGION']
Aws.config[:region]
Go here for a list of supported regions.
Credentials
Default credentials are loaded automatically from the following locations:
ENV['AWS_ACCESS_KEY_ID']
andENV['AWS_SECRET_ACCESS_KEY']
Aws.config[:credentials]
- The shared credentials ini file at
~/.aws/credentials
(more information) - From an instance profile when running on EC2
You can also construct a credentials object from one of the following classes:
Alternatively, you configure credentials with :access_key_id
and
:secret_access_key
:
# load credentials from disk
creds = YAML.load(File.read('/path/to/secrets'))
Aws::ServiceCatalog::Client.new(
access_key_id: creds['access_key_id'],
secret_access_key: creds['secret_access_key']
)
Always load your credentials from outside your application. Avoid configuring credentials statically and never commit them to source control.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
Constructor collapse
-
#initialize(options = {}) ⇒ Aws::ServiceCatalog::Client
constructor
Constructs an API client.
API Operations collapse
-
#accept_portfolio_share(options = {}) ⇒ Struct
Accepts an offer to share the specified portfolio.
.
-
#associate_budget_with_resource(options = {}) ⇒ Struct
Associates the specified budget with the specified resource.
.
-
#associate_principal_with_portfolio(options = {}) ⇒ Struct
Associates the specified principal ARN with the specified portfolio.
.
-
#associate_product_with_portfolio(options = {}) ⇒ Struct
Associates the specified product with the specified portfolio.
A delegated admin is authorized to invoke this command.
. -
#associate_service_action_with_provisioning_artifact(options = {}) ⇒ Struct
Associates a self-service action with a provisioning artifact.
.
-
#associate_tag_option_with_resource(options = {}) ⇒ Struct
Associate the specified TagOption with the specified portfolio or product.
.
-
#batch_associate_service_action_with_provisioning_artifact(options = {}) ⇒ Types::BatchAssociateServiceActionWithProvisioningArtifactOutput
Associates multiple self-service actions with provisioning artifacts.
.
-
#batch_disassociate_service_action_from_provisioning_artifact(options = {}) ⇒ Types::BatchDisassociateServiceActionFromProvisioningArtifactOutput
Disassociates a batch of self-service actions from the specified provisioning artifact.
.
-
#copy_product(options = {}) ⇒ 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.
-
#create_constraint(options = {}) ⇒ Types::CreateConstraintOutput
Creates a constraint.
A delegated admin is authorized to invoke this command.
. -
#create_portfolio(options = {}) ⇒ Types::CreatePortfolioOutput
Creates a portfolio.
A delegated admin is authorized to invoke this command.
. -
#create_portfolio_share(options = {}) ⇒ Types::CreatePortfolioShareOutput
Shares the specified portfolio with the specified account or organization node.
-
#create_product(options = {}) ⇒ Types::CreateProductOutput
Creates a product.
A delegated admin is authorized to invoke this command.
. -
#create_provisioned_product_plan(options = {}) ⇒ Types::CreateProvisionedProductPlanOutput
Creates a plan.
-
#create_provisioning_artifact(options = {}) ⇒ 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.
. -
#create_service_action(options = {}) ⇒ Types::CreateServiceActionOutput
Creates a self-service action.
.
-
#create_tag_option(options = {}) ⇒ Types::CreateTagOptionOutput
Creates a TagOption.
.
-
#delete_constraint(options = {}) ⇒ Struct
Deletes the specified constraint.
A delegated admin is authorized to invoke this command.
. -
#delete_portfolio(options = {}) ⇒ 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.
. -
#delete_portfolio_share(options = {}) ⇒ Types::DeletePortfolioShareOutput
Stops sharing the specified portfolio with the specified account or organization node.
-
#delete_product(options = {}) ⇒ 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.
. -
#delete_provisioned_product_plan(options = {}) ⇒ Struct
Deletes the specified plan.
.
-
#delete_provisioning_artifact(options = {}) ⇒ 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.
-
#delete_service_action(options = {}) ⇒ Struct
Deletes a self-service action.
.
-
#delete_tag_option(options = {}) ⇒ Struct
Deletes the specified TagOption.
You cannot delete a TagOption if it is associated with a product or portfolio.
. -
#describe_constraint(options = {}) ⇒ Types::DescribeConstraintOutput
Gets information about the specified constraint.
.
-
#describe_copy_product_status(options = {}) ⇒ Types::DescribeCopyProductStatusOutput
Gets the status of the specified copy product operation.
.
-
#describe_portfolio(options = {}) ⇒ Types::DescribePortfolioOutput
Gets information about the specified portfolio.
A delegated admin is authorized to invoke this command.
. -
#describe_portfolio_share_status(options = {}) ⇒ Types::DescribePortfolioShareStatusOutput
Gets the status of the specified portfolio share operation.
-
#describe_product(options = {}) ⇒ Types::DescribeProductOutput
Gets information about the specified product.
.
-
#describe_product_as_admin(options = {}) ⇒ Types::DescribeProductAsAdminOutput
Gets information about the specified product.
-
#describe_product_view(options = {}) ⇒ Types::DescribeProductViewOutput
Gets information about the specified product.
.
-
#describe_provisioned_product(options = {}) ⇒ Types::DescribeProvisionedProductOutput
Gets information about the specified provisioned product.
.
-
#describe_provisioned_product_plan(options = {}) ⇒ Types::DescribeProvisionedProductPlanOutput
Gets information about the resource changes for the specified plan.
.
-
#describe_provisioning_artifact(options = {}) ⇒ Types::DescribeProvisioningArtifactOutput
Gets information about the specified provisioning artifact (also known as a version) for the specified product.
.
-
#describe_provisioning_parameters(options = {}) ⇒ 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.
-
#describe_record(options = {}) ⇒ Types::DescribeRecordOutput
Gets information about the specified request operation.
Use this operation after calling a request operation (for example, ProvisionProduct, TerminateProvisionedProduct, or UpdateProvisionedProduct).
-
#describe_service_action(options = {}) ⇒ Types::DescribeServiceActionOutput
Describes a self-service action.
.
-
#describe_service_action_execution_parameters(options = {}) ⇒ 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(options = {}) ⇒ Types::DescribeTagOptionOutput
Gets information about the specified TagOption.
.
-
#disable_aws_organizations_access(options = {}) ⇒ Struct
Disable portfolio sharing through AWS Organizations feature.
-
#disassociate_budget_from_resource(options = {}) ⇒ Struct
Disassociates the specified budget from the specified resource.
.
-
#disassociate_principal_from_portfolio(options = {}) ⇒ Struct
Disassociates a previously associated principal ARN from a specified portfolio.
.
-
#disassociate_product_from_portfolio(options = {}) ⇒ Struct
Disassociates the specified product from the specified portfolio.
-
#disassociate_service_action_from_provisioning_artifact(options = {}) ⇒ Struct
Disassociates the specified self-service action association from the specified provisioning artifact.
.
-
#disassociate_tag_option_from_resource(options = {}) ⇒ Struct
Disassociates the specified TagOption from the specified resource.
.
-
#enable_aws_organizations_access(options = {}) ⇒ Struct
Enable portfolio sharing feature through AWS Organizations.
-
#execute_provisioned_product_plan(options = {}) ⇒ Types::ExecuteProvisionedProductPlanOutput
Provisions or modifies a product based on the resource changes for the specified plan.
.
-
#execute_provisioned_product_service_action(options = {}) ⇒ Types::ExecuteProvisionedProductServiceActionOutput
Executes a self-service action against a provisioned product.
.
-
#get_aws_organizations_access_status(options = {}) ⇒ Types::GetAWSOrganizationsAccessStatusOutput
Get the Access Status for AWS Organization portfolio share feature.
-
#get_provisioned_product_outputs(options = {}) ⇒ 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(options = {}) ⇒ Types::ImportAsProvisionedProductOutput
Requests the import of a resource as a Service Catalog provisioned product that is associated to a Service Catalog product and provisioning artifact.
-
#list_accepted_portfolio_shares(options = {}) ⇒ Types::ListAcceptedPortfolioSharesOutput
Lists all portfolios for which sharing was accepted by this account.
.
-
#list_budgets_for_resource(options = {}) ⇒ Types::ListBudgetsForResourceOutput
Lists all the budgets associated to the specified resource.
.
-
#list_constraints_for_portfolio(options = {}) ⇒ Types::ListConstraintsForPortfolioOutput
Lists the constraints for the specified portfolio and product.
.
-
#list_launch_paths(options = {}) ⇒ Types::ListLaunchPathsOutput
Lists the paths to the specified product.
-
#list_organization_portfolio_access(options = {}) ⇒ Types::ListOrganizationPortfolioAccessOutput
Lists the organization nodes that have access to the specified portfolio.
-
#list_portfolio_access(options = {}) ⇒ 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.
-
#list_portfolios(options = {}) ⇒ Types::ListPortfoliosOutput
Lists all portfolios in the catalog.
.
-
#list_portfolios_for_product(options = {}) ⇒ Types::ListPortfoliosForProductOutput
Lists all portfolios that the specified product is associated with.
.
-
#list_principals_for_portfolio(options = {}) ⇒ Types::ListPrincipalsForPortfolioOutput
Lists all principal ARNs associated with the specified portfolio.
.
-
#list_provisioned_product_plans(options = {}) ⇒ Types::ListProvisionedProductPlansOutput
Lists the plans for the specified provisioned product or all plans to which the user has access.
.
-
#list_provisioning_artifacts(options = {}) ⇒ Types::ListProvisioningArtifactsOutput
Lists all provisioning artifacts (also known as versions) for the specified product.
.
-
#list_provisioning_artifacts_for_service_action(options = {}) ⇒ Types::ListProvisioningArtifactsForServiceActionOutput
Lists all provisioning artifacts (also known as versions) for the specified self-service action.
.
-
#list_record_history(options = {}) ⇒ Types::ListRecordHistoryOutput
Lists the specified requests or all performed requests.
.
-
#list_resources_for_tag_option(options = {}) ⇒ Types::ListResourcesForTagOptionOutput
Lists the resources associated with the specified TagOption.
.
-
#list_service_actions(options = {}) ⇒ Types::ListServiceActionsOutput
Lists all self-service actions.
.
-
#list_service_actions_for_provisioning_artifact(options = {}) ⇒ 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(options = {}) ⇒ Types::ListStackInstancesForProvisionedProductOutput
Returns summary information about stack instances that are associated with the specified
CFN_STACKSET
type provisioned product. -
#list_tag_options(options = {}) ⇒ Types::ListTagOptionsOutput
Lists the specified TagOptions or all TagOptions.
.
-
#provision_product(options = {}) ⇒ Types::ProvisionProductOutput
Provisions the specified product.
A provisioned product is a resourced instance of a product.
-
#reject_portfolio_share(options = {}) ⇒ Struct
Rejects an offer to share the specified portfolio.
.
-
#scan_provisioned_products(options = {}) ⇒ Types::ScanProvisionedProductsOutput
Lists the provisioned products that are available (not terminated).
To use additional filtering, see SearchProvisionedProducts.
. -
#search_products(options = {}) ⇒ Types::SearchProductsOutput
Gets information about the products to which the caller has access.
.
-
#search_products_as_admin(options = {}) ⇒ Types::SearchProductsAsAdminOutput
Gets information about the products for the specified portfolio or all products.
.
-
#search_provisioned_products(options = {}) ⇒ Types::SearchProvisionedProductsOutput
Gets information about the provisioned products that meet the specified criteria.
.
-
#terminate_provisioned_product(options = {}) ⇒ 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.
. -
#update_constraint(options = {}) ⇒ Types::UpdateConstraintOutput
Updates the specified constraint.
.
-
#update_portfolio(options = {}) ⇒ Types::UpdatePortfolioOutput
Updates the specified portfolio.
You cannot update a product that was shared with you.
. -
#update_product(options = {}) ⇒ Types::UpdateProductOutput
Updates the specified product.
.
-
#update_provisioned_product(options = {}) ⇒ 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.
-
#update_provisioned_product_properties(options = {}) ⇒ Types::UpdateProvisionedProductPropertiesOutput
Requests updates to the properties of the specified provisioned product.
.
-
#update_provisioning_artifact(options = {}) ⇒ 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.
. -
#update_service_action(options = {}) ⇒ Types::UpdateServiceActionOutput
Updates a self-service action.
.
-
#update_tag_option(options = {}) ⇒ Types::UpdateTagOptionOutput
Updates the specified TagOption.
.
Instance Method Summary collapse
-
#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean
Waiters polls an API operation until a resource enters a desired state.
-
#waiter_names ⇒ Array<Symbol>
Returns the list of supported waiters.
Methods inherited from Seahorse::Client::Base
add_plugin, api, #build_request, clear_plugins, define, new, #operation, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options = {}) ⇒ Aws::ServiceCatalog::Client
Constructs an API client.
Instance Method Details
#accept_portfolio_share(options = {}) ⇒ Struct
Accepts an offer to share the specified portfolio.
#associate_budget_with_resource(options = {}) ⇒ Struct
Associates the specified budget with the specified resource.
#associate_principal_with_portfolio(options = {}) ⇒ Struct
Associates the specified principal ARN with the specified portfolio.
#associate_product_with_portfolio(options = {}) ⇒ Struct
Associates the specified product with the specified portfolio.
A delegated admin is authorized to invoke this command.
#associate_service_action_with_provisioning_artifact(options = {}) ⇒ Struct
Associates a self-service action with a provisioning artifact.
#associate_tag_option_with_resource(options = {}) ⇒ Struct
Associate the specified TagOption with the specified portfolio or product.
#batch_associate_service_action_with_provisioning_artifact(options = {}) ⇒ Types::BatchAssociateServiceActionWithProvisioningArtifactOutput
Associates multiple self-service actions with provisioning artifacts.
#batch_disassociate_service_action_from_provisioning_artifact(options = {}) ⇒ Types::BatchDisassociateServiceActionFromProvisioningArtifactOutput
Disassociates a batch of self-service actions from the specified provisioning artifact.
#copy_product(options = {}) ⇒ 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.
This operation is performed asynchronously. To track the progress of the operation, use DescribeCopyProductStatus.
#create_constraint(options = {}) ⇒ Types::CreateConstraintOutput
Creates a constraint.
A delegated admin is authorized to invoke this command.
#create_portfolio(options = {}) ⇒ Types::CreatePortfolioOutput
Creates a portfolio.
A delegated admin is authorized to invoke this command.
#create_portfolio_share(options = {}) ⇒ 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. This includes portfolios that contain a shared product.
#create_product(options = {}) ⇒ Types::CreateProductOutput
Creates a product.
A delegated admin is authorized to invoke this command.
#create_provisioned_product_plan(options = {}) ⇒ 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 per provisioned product. To create a plan for an existing provisioned product, the product status must be AVAILBLE or TAINTED.
To view the resource changes in the change set, use DescribeProvisionedProductPlan. To create or modify the provisioned product, use ExecuteProvisionedProductPlan.
#create_provisioning_artifact(options = {}) ⇒ 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.
#create_service_action(options = {}) ⇒ Types::CreateServiceActionOutput
Creates a self-service action.
#create_tag_option(options = {}) ⇒ Types::CreateTagOptionOutput
Creates a TagOption.
#delete_constraint(options = {}) ⇒ Struct
Deletes the specified constraint.
A delegated admin is authorized to invoke this command.
#delete_portfolio(options = {}) ⇒ 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.
#delete_portfolio_share(options = {}) ⇒ 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.
#delete_product(options = {}) ⇒ 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.
#delete_provisioned_product_plan(options = {}) ⇒ Struct
Deletes the specified plan.
#delete_provisioning_artifact(options = {}) ⇒ 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.
#delete_service_action(options = {}) ⇒ Struct
Deletes a self-service action.
#delete_tag_option(options = {}) ⇒ Struct
Deletes the specified TagOption.
You cannot delete a TagOption if it is associated with a product or portfolio.
#describe_constraint(options = {}) ⇒ Types::DescribeConstraintOutput
Gets information about the specified constraint.
#describe_copy_product_status(options = {}) ⇒ Types::DescribeCopyProductStatusOutput
Gets the status of the specified copy product operation.
#describe_portfolio(options = {}) ⇒ Types::DescribePortfolioOutput
Gets information about the specified portfolio.
A delegated admin is authorized to invoke this command.
#describe_portfolio_share_status(options = {}) ⇒ 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.
#describe_product(options = {}) ⇒ Types::DescribeProductOutput
Gets information about the specified product.
#describe_product_as_admin(options = {}) ⇒ Types::DescribeProductAsAdminOutput
Gets information about the specified product. This operation is run with administrator access.
#describe_product_view(options = {}) ⇒ Types::DescribeProductViewOutput
Gets information about the specified product.
#describe_provisioned_product(options = {}) ⇒ Types::DescribeProvisionedProductOutput
Gets information about the specified provisioned product.
#describe_provisioned_product_plan(options = {}) ⇒ Types::DescribeProvisionedProductPlanOutput
Gets information about the resource changes for the specified plan.
#describe_provisioning_artifact(options = {}) ⇒ Types::DescribeProvisioningArtifactOutput
Gets information about the specified provisioning artifact (also known as a version) for the specified product.
#describe_provisioning_parameters(options = {}) ⇒ 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
.
#describe_record(options = {}) ⇒ Types::DescribeRecordOutput
Gets information about the specified request operation.
Use this operation after calling a request operation (for example, ProvisionProduct, TerminateProvisionedProduct, or UpdateProvisionedProduct).
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.
#describe_service_action(options = {}) ⇒ Types::DescribeServiceActionOutput
Describes a self-service action.
#describe_service_action_execution_parameters(options = {}) ⇒ 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(options = {}) ⇒ Types::DescribeTagOptionOutput
Gets information about the specified TagOption.
#disable_aws_organizations_access(options = {}) ⇒ Struct
Disable portfolio sharing through AWS Organizations feature. This feature will not delete your current shares but it will prevent you from creating new shares throughout your organization. Current shares will not be in sync with your organization structure if it changes after calling this API. This API can only be called by the management account in the organization.
This API can't be invoked if there are active delegated administrators in the organization.
Note that a delegated administrator is not authorized to invoke DisableAWSOrganizationsAccess
.
#disassociate_budget_from_resource(options = {}) ⇒ Struct
Disassociates the specified budget from the specified resource.
#disassociate_principal_from_portfolio(options = {}) ⇒ Struct
Disassociates a previously associated principal ARN from a specified portfolio.
#disassociate_product_from_portfolio(options = {}) ⇒ Struct
Disassociates the specified product from the specified portfolio.
A delegated admin is authorized to invoke this command.
#disassociate_service_action_from_provisioning_artifact(options = {}) ⇒ Struct
Disassociates the specified self-service action association from the specified provisioning artifact.
#disassociate_tag_option_from_resource(options = {}) ⇒ Struct
Disassociates the specified TagOption from the specified resource.
#enable_aws_organizations_access(options = {}) ⇒ Struct
Enable portfolio sharing feature through AWS 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.
By calling this API Service Catalog will make a call to organizations:EnableAWSServiceAccess on your behalf so that your shares can be in sync with any changes in your AWS Organizations structure.
Note that a delegated administrator is not authorized to invoke EnableAWSOrganizationsAccess
.
#execute_provisioned_product_plan(options = {}) ⇒ Types::ExecuteProvisionedProductPlanOutput
Provisions or modifies a product based on the resource changes for the specified plan.
#execute_provisioned_product_service_action(options = {}) ⇒ Types::ExecuteProvisionedProductServiceActionOutput
Executes a self-service action against a provisioned product.
#get_aws_organizations_access_status(options = {}) ⇒ Types::GetAWSOrganizationsAccessStatusOutput
Get the Access Status for AWS Organization portfolio share feature. This API can only be called by the management account in the organization or by a delegated admin.
#get_provisioned_product_outputs(options = {}) ⇒ 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(options = {}) ⇒ Types::ImportAsProvisionedProductOutput
Requests the import of a resource as a Service Catalog provisioned product that is associated to a Service Catalog product and provisioning artifact. Once imported all supported Service Catalog governance actions are supported on the provisioned product.
Resource import only supports CloudFormation stack ARNs. CloudFormation StackSets and non-root nested stacks are not supported.
The CloudFormation stack must have one of the following statuses to be imported: CREATE_COMPLETE, UPDATE_COMPLETE, UPDATE_ROLLBACK_COMPLETE, IMPORT_COMPLETE, IMPORT_ROLLBACK_COMPLETE.
Import of the resource requires that the CloudFormation stack template matches the associated Service Catalog product provisioning artifact.
#list_accepted_portfolio_shares(options = {}) ⇒ Types::ListAcceptedPortfolioSharesOutput
Lists all portfolios for which sharing was accepted by this account.
#list_budgets_for_resource(options = {}) ⇒ Types::ListBudgetsForResourceOutput
Lists all the budgets associated to the specified resource.
#list_constraints_for_portfolio(options = {}) ⇒ Types::ListConstraintsForPortfolioOutput
Lists the constraints for the specified portfolio and product.
#list_launch_paths(options = {}) ⇒ Types::ListLaunchPathsOutput
Lists the paths to the specified product. A path is how the user has access to a specified product, and is necessary when provisioning a product. A path also determines the constraints put on the product.
#list_organization_portfolio_access(options = {}) ⇒ 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.
#list_portfolio_access(options = {}) ⇒ 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.
#list_portfolios(options = {}) ⇒ Types::ListPortfoliosOutput
Lists all portfolios in the catalog.
#list_portfolios_for_product(options = {}) ⇒ Types::ListPortfoliosForProductOutput
Lists all portfolios that the specified product is associated with.
#list_principals_for_portfolio(options = {}) ⇒ Types::ListPrincipalsForPortfolioOutput
Lists all principal ARNs associated with the specified portfolio.
#list_provisioned_product_plans(options = {}) ⇒ Types::ListProvisionedProductPlansOutput
Lists the plans for the specified provisioned product or all plans to which the user has access.
#list_provisioning_artifacts(options = {}) ⇒ Types::ListProvisioningArtifactsOutput
Lists all provisioning artifacts (also known as versions) for the specified product.
#list_provisioning_artifacts_for_service_action(options = {}) ⇒ Types::ListProvisioningArtifactsForServiceActionOutput
Lists all provisioning artifacts (also known as versions) for the specified self-service action.
#list_record_history(options = {}) ⇒ Types::ListRecordHistoryOutput
Lists the specified requests or all performed requests.
#list_resources_for_tag_option(options = {}) ⇒ Types::ListResourcesForTagOptionOutput
Lists the resources associated with the specified TagOption.
#list_service_actions(options = {}) ⇒ Types::ListServiceActionsOutput
Lists all self-service actions.
#list_service_actions_for_provisioning_artifact(options = {}) ⇒ 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(options = {}) ⇒ 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 AWS account name or region.
#list_tag_options(options = {}) ⇒ Types::ListTagOptionsOutput
Lists the specified TagOptions or all TagOptions.
#provision_product(options = {}) ⇒ Types::ProvisionProductOutput
Provisions the specified product.
A provisioned product is a resourced instance of a product. For example, provisioning a product based on a CloudFormation template launches a CloudFormation stack and its underlying resources. You can check the status of this request using DescribeRecord.
If the request contains a tag key with an empty list of values, there is a tag conflict for that key. Do not include conflicted keys as tags, or this causes the error "Parameter validation failed: Missing required parameter in Tags[N]:Value".
#reject_portfolio_share(options = {}) ⇒ Struct
Rejects an offer to share the specified portfolio.
#scan_provisioned_products(options = {}) ⇒ Types::ScanProvisionedProductsOutput
Lists the provisioned products that are available (not terminated).
To use additional filtering, see SearchProvisionedProducts.
#search_products(options = {}) ⇒ Types::SearchProductsOutput
Gets information about the products to which the caller has access.
#search_products_as_admin(options = {}) ⇒ Types::SearchProductsAsAdminOutput
Gets information about the products for the specified portfolio or all products.
#search_provisioned_products(options = {}) ⇒ Types::SearchProvisionedProductsOutput
Gets information about the provisioned products that meet the specified criteria.
#terminate_provisioned_product(options = {}) ⇒ 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.
#update_constraint(options = {}) ⇒ Types::UpdateConstraintOutput
Updates the specified constraint.
#update_portfolio(options = {}) ⇒ Types::UpdatePortfolioOutput
Updates the specified portfolio.
You cannot update a product that was shared with you.
#update_product(options = {}) ⇒ Types::UpdateProductOutput
Updates the specified product.
#update_provisioned_product(options = {}) ⇒ 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.
#update_provisioned_product_properties(options = {}) ⇒ Types::UpdateProvisionedProductPropertiesOutput
Requests updates to the properties of the specified provisioned product.
#update_provisioning_artifact(options = {}) ⇒ 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.
#update_service_action(options = {}) ⇒ Types::UpdateServiceActionOutput
Updates a self-service action.
#update_tag_option(options = {}) ⇒ Types::UpdateTagOptionOutput
Updates the specified TagOption.
#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean
Waiters polls an API operation until a resource enters a desired state.
Basic Usage
Waiters will poll until they are succesful, they fail by entering a terminal state, or until a maximum number of attempts are made.
# polls in a loop, sleeping between attempts client.waiter_until(waiter_name, params)
Configuration
You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You configure waiters by passing a block to #wait_until:
# poll for ~25 seconds
client.wait_until(...) do |w|
w.max_attempts = 5
w.delay = 5
end
Callbacks
You can be notified before each polling attempt and before each
delay. If you throw :success
or :failure
from these callbacks,
it will terminate the waiter.
started_at = Time.now
client.wait_until(...) do |w|
# disable max attempts
w.max_attempts = nil
# poll for 1 hour, instead of a number of attempts
w.before_wait do |attempts, response|
throw :failure if Time.now - started_at > 3600
end
end
Handling Errors
When a waiter is successful, it returns true
. When a waiter
fails, it raises an error. All errors raised extend from
Waiters::Errors::WaiterFailed.
begin
client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
# resource did not enter the desired state in time
end
#waiter_names ⇒ Array<Symbol>
Returns the list of supported waiters. The following table lists the supported waiters and the client method they call:
Waiter Name | Client Method | Default Delay: | Default Max Attempts: |
---|