AWS Service Catalog
Service Catalog
Service Catalog enables organizations to create and manage catalogs of IT services that are approved for Amazon Web Services. To get the most out of this documentation, you should be familiar with the terminology discussed in Service Catalog Concepts.
servicecatalog( config = list(), credentials = list(), endpoint = NULL, region = NULL )
config: Optional configuration of credentials, endpoint, and/or region.
credentials :
creds :
profile : The name of a profile to use. If not given, then the default profile is used.
anonymous : Set anonymous credentials.
endpoint : The complete URL to use for the constructed client.
region : The AWS Region used in instantiating the client.
close_connection : Immediately close all HTTP connections.
timeout : The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style : Set this to true to force the request to use path-style addressing, i.e. http://s3.amazonaws.com/BUCKET/KEY.
sts_regional_endpoint : Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html
credentials: Optional credentials shorthand for the config parameter
creds :
profile : The name of a profile to use. If not given, then the default profile is used.
anonymous : Set anonymous credentials.
endpoint: Optional shorthand for complete URL to use for the constructed client.
region: Optional shorthand for AWS Region used in instantiating the client.
A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.
svc <- servicecatalog(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical",
sts_regional_endpoint = "string"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string"
)
| accept_portfolio_share | Accepts an offer to share the specified portfolio |
| associate_budget_with_resource | Associates the specified budget with the specified resource |
| associate_principal_with_portfolio | Associates the specified principal ARN with the specified portfolio |
| associate_product_with_portfolio | Associates the specified product with the specified portfolio |
| associate_service_action_with_provisioning_artifact | Associates a self-service action with a provisioning artifact |
| associate_tag_option_with_resource | Associate the specified TagOption with the specified portfolio or product |
| batch_associate_service_action_with_provisioning_artifact | Associates multiple self-service actions with provisioning artifacts |
| batch_disassociate_service_action_from_provisioning_artifact | Disassociates a batch of self-service actions from the specified provisioning artifact |
| copy_product | Copies the specified source product to the specified target product or a new product |
| create_constraint | Creates a constraint |
| create_portfolio | Creates a portfolio |
| create_portfolio_share | Shares the specified portfolio with the specified account or organization node |
| create_product | Creates a product |
| create_provisioned_product_plan | Creates a plan |
| create_provisioning_artifact | Creates a provisioning artifact (also known as a version) for the specified product |
| create_service_action | Creates a self-service action |
| create_tag_option | Creates a TagOption |
| delete_constraint | Deletes the specified constraint |
| delete_portfolio | Deletes the specified portfolio |
| delete_portfolio_share | Stops sharing the specified portfolio with the specified account or organization node |
| delete_product | Deletes the specified product |
| delete_provisioned_product_plan | Deletes the specified plan |
| delete_provisioning_artifact | Deletes the specified provisioning artifact (also known as a version) for the specified product |
| delete_service_action | Deletes a self-service action |
| delete_tag_option | Deletes the specified TagOption |
| describe_constraint | Gets information about the specified constraint |
| describe_copy_product_status | Gets the status of the specified copy product operation |
| describe_portfolio | Gets information about the specified portfolio |
| describe_portfolio_shares | Returns a summary of each of the portfolio shares that were created for the specified portfolio |
| describe_portfolio_share_status | Gets the status of the specified portfolio share operation |
| describe_product | Gets information about the specified product |
| describe_product_as_admin | Gets information about the specified product |
| describe_product_view | Gets information about the specified product |
| describe_provisioned_product | Gets information about the specified provisioned product |
| describe_provisioned_product_plan | Gets information about the resource changes for the specified plan |
| describe_provisioning_artifact | Gets information about the specified provisioning artifact (also known as a version) for the specified product |
| describe_provisioning_parameters | Gets information about the configuration required to provision the specified product using the specified provisioning artifact |
| describe_record | Gets information about the specified request operation |
| describe_service_action | Describes a self-service action |
| describe_service_action_execution_parameters | 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 | Gets information about the specified TagOption |
| disable_aws_organizations_access | Disable portfolio sharing through the Organizations service |
| disassociate_budget_from_resource | Disassociates the specified budget from the specified resource |
| disassociate_principal_from_portfolio | Disassociates a previously associated principal ARN from a specified portfolio |
| disassociate_product_from_portfolio | Disassociates the specified product from the specified portfolio |
| disassociate_service_action_from_provisioning_artifact | Disassociates the specified self-service action association from the specified provisioning artifact |
| disassociate_tag_option_from_resource | Disassociates the specified TagOption from the specified resource |
| enable_aws_organizations_access | Enable portfolio sharing feature through Organizations |
| execute_provisioned_product_plan | Provisions or modifies a product based on the resource changes for the specified plan |
| execute_provisioned_product_service_action | Executes a self-service action against a provisioned product |
| get_aws_organizations_access_status | Get the Access Status for Organizations portfolio share feature |
| get_provisioned_product_outputs | 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 | 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 | Lists all imported portfolios for which account-to-account shares were accepted by this account |
| list_budgets_for_resource | Lists all the budgets associated to the specified resource |
| list_constraints_for_portfolio | Lists the constraints for the specified portfolio and product |
| list_launch_paths | Lists the paths to the specified product |
| list_organization_portfolio_access | Lists the organization nodes that have access to the specified portfolio |
| list_portfolio_access | Lists the account IDs that have access to the specified portfolio |
| list_portfolios | Lists all portfolios in the catalog |
| list_portfolios_for_product | Lists all portfolios that the specified product is associated with |
| list_principals_for_portfolio | Lists all PrincipalARNs and corresponding PrincipalTypes associated with the specified portfolio |
| list_provisioned_product_plans | Lists the plans for the specified provisioned product or all plans to which the user has access |
| list_provisioning_artifacts | Lists all provisioning artifacts (also known as versions) for the specified product |
| list_provisioning_artifacts_for_service_action | Lists all provisioning artifacts (also known as versions) for the specified self-service action |
| list_record_history | Lists the specified requests or all performed requests |
| list_resources_for_tag_option | Lists the resources associated with the specified TagOption |
| list_service_actions | Lists all self-service actions |
| list_service_actions_for_provisioning_artifact | Returns a paginated list of self-service actions associated with the specified Product ID and Provisioning Artifact ID |
| list_stack_instances_for_provisioned_product | Returns summary information about stack instances that are associated with the specified CFN_STACKSET type provisioned product |
| list_tag_options | Lists the specified TagOptions or all TagOptions |
| notify_provision_product_engine_workflow_result | Notifies the result of the provisioning engine execution |
| notify_terminate_provisioned_product_engine_workflow_result | Notifies the result of the terminate engine execution |
| notify_update_provisioned_product_engine_workflow_result | Notifies the result of the update engine execution |
| provision_product | Provisions the specified product |
| reject_portfolio_share | Rejects an offer to share the specified portfolio |
| scan_provisioned_products | Lists the provisioned products that are available (not terminated) |
| search_products | Gets information about the products to which the caller has access |
| search_products_as_admin | Gets information about the products for the specified portfolio or all products |
| search_provisioned_products | Gets information about the provisioned products that meet the specified criteria |
| terminate_provisioned_product | Terminates the specified provisioned product |
| update_constraint | Updates the specified constraint |
| update_portfolio | Updates the specified portfolio |
| update_portfolio_share | Updates the specified portfolio share |
| update_product | Updates the specified product |
| update_provisioned_product | Requests updates to the configuration of the specified provisioned product |
| update_provisioned_product_properties | Requests updates to the properties of the specified provisioned product |
| update_provisioning_artifact | Updates the specified provisioning artifact (also known as a version) for the specified product |
| update_service_action | Updates a self-service action |
| update_tag_option | Updates the specified TagOption |
## Not run: svc <- servicecatalog() svc$accept_portfolio_share( Foo = 123 ) ## End(Not run)
Useful links