AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Implementation for accessing ServiceCatalog
Service CatalogService 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.
Namespace: Amazon.ServiceCatalog
Assembly: AWSSDK.ServiceCatalog.dll
Version: 3.x.y.z
public class AmazonServiceCatalogClient : AmazonServiceClient IAmazonService, IAmazonServiceCatalog, IDisposable
The AmazonServiceCatalogClient type exposes the following members
Name | Description | |
---|---|---|
AmazonServiceCatalogClient() |
Constructs AmazonServiceCatalogClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> |
|
AmazonServiceCatalogClient(RegionEndpoint) |
Constructs AmazonServiceCatalogClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> |
|
AmazonServiceCatalogClient(AmazonServiceCatalogConfig) |
Constructs AmazonServiceCatalogClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> |
|
AmazonServiceCatalogClient(AWSCredentials) |
Constructs AmazonServiceCatalogClient with AWS Credentials |
|
AmazonServiceCatalogClient(AWSCredentials, RegionEndpoint) |
Constructs AmazonServiceCatalogClient with AWS Credentials |
|
AmazonServiceCatalogClient(AWSCredentials, AmazonServiceCatalogConfig) |
Constructs AmazonServiceCatalogClient with AWS Credentials and an AmazonServiceCatalogClient Configuration object. |
|
AmazonServiceCatalogClient(string, string) |
Constructs AmazonServiceCatalogClient with AWS Access Key ID and AWS Secret Key |
|
AmazonServiceCatalogClient(string, string, RegionEndpoint) |
Constructs AmazonServiceCatalogClient with AWS Access Key ID and AWS Secret Key |
|
AmazonServiceCatalogClient(string, string, AmazonServiceCatalogConfig) |
Constructs AmazonServiceCatalogClient with AWS Access Key ID, AWS Secret Key and an AmazonServiceCatalogClient Configuration object. |
|
AmazonServiceCatalogClient(string, string, string) |
Constructs AmazonServiceCatalogClient with AWS Access Key ID and AWS Secret Key |
|
AmazonServiceCatalogClient(string, string, string, RegionEndpoint) |
Constructs AmazonServiceCatalogClient with AWS Access Key ID and AWS Secret Key |
|
AmazonServiceCatalogClient(string, string, string, AmazonServiceCatalogConfig) |
Constructs AmazonServiceCatalogClient with AWS Access Key ID, AWS Secret Key and an AmazonServiceCatalogClient Configuration object. |
Name | Type | Description | |
---|---|---|---|
Config | Amazon.Runtime.IClientConfig | Inherited from Amazon.Runtime.AmazonServiceClient. | |
Paginators | Amazon.ServiceCatalog.Model.IServiceCatalogPaginatorFactory |
Paginators for the service |
Name | Description | |
---|---|---|
AcceptPortfolioShare(AcceptPortfolioShareRequest) |
Accepts an offer to share the specified portfolio. |
|
AcceptPortfolioShareAsync(AcceptPortfolioShareRequest, CancellationToken) |
Accepts an offer to share the specified portfolio. |
|
AssociateBudgetWithResource(AssociateBudgetWithResourceRequest) |
Associates the specified budget with the specified resource. |
|
AssociateBudgetWithResourceAsync(AssociateBudgetWithResourceRequest, CancellationToken) |
Associates the specified budget with the specified resource. |
|
AssociatePrincipalWithPortfolio(AssociatePrincipalWithPortfolioRequest) |
Associates the specified principal ARN with the specified portfolio.
If you share the portfolio with principal name sharing enabled, the
The
You can associate a maximum of 10 Principals with a portfolio using
When you associate a principal with portfolio, a potential privilege escalation path
may occur when that portfolio is then shared with other accounts. For a user in a
recipient account who is not an Service Catalog Admin, but still has the ability
to create Principals (Users/Groups/Roles), that user could create a role that matches
a principal name association for the portfolio. Although this user may not know which
principal names are associated through Service Catalog, they may be able to guess
the user. If this potential escalation path is a concern, then Service Catalog recommends
using |
|
AssociatePrincipalWithPortfolioAsync(AssociatePrincipalWithPortfolioRequest, CancellationToken) |
Associates the specified principal ARN with the specified portfolio.
If you share the portfolio with principal name sharing enabled, the
The
You can associate a maximum of 10 Principals with a portfolio using
When you associate a principal with portfolio, a potential privilege escalation path
may occur when that portfolio is then shared with other accounts. For a user in a
recipient account who is not an Service Catalog Admin, but still has the ability
to create Principals (Users/Groups/Roles), that user could create a role that matches
a principal name association for the portfolio. Although this user may not know which
principal names are associated through Service Catalog, they may be able to guess
the user. If this potential escalation path is a concern, then Service Catalog recommends
using |
|
AssociateProductWithPortfolio(AssociateProductWithPortfolioRequest) |
Associates the specified product with the specified portfolio. A delegated admin is authorized to invoke this command. |
|
AssociateProductWithPortfolioAsync(AssociateProductWithPortfolioRequest, CancellationToken) |
Associates the specified product with the specified portfolio. A delegated admin is authorized to invoke this command. |
|
AssociateServiceActionWithProvisioningArtifact(AssociateServiceActionWithProvisioningArtifactRequest) |
Associates a self-service action with a provisioning artifact. |
|
AssociateServiceActionWithProvisioningArtifactAsync(AssociateServiceActionWithProvisioningArtifactRequest, CancellationToken) |
Associates a self-service action with a provisioning artifact. |
|
AssociateTagOptionWithResource(AssociateTagOptionWithResourceRequest) |
Associate the specified TagOption with the specified portfolio or product. |
|
AssociateTagOptionWithResourceAsync(AssociateTagOptionWithResourceRequest, CancellationToken) |
Associate the specified TagOption with the specified portfolio or product. |
|
BatchAssociateServiceActionWithProvisioningArtifact(BatchAssociateServiceActionWithProvisioningArtifactRequest) |
Associates multiple self-service actions with provisioning artifacts. |
|
BatchAssociateServiceActionWithProvisioningArtifactAsync(BatchAssociateServiceActionWithProvisioningArtifactRequest, CancellationToken) |
Associates multiple self-service actions with provisioning artifacts. |
|
BatchDisassociateServiceActionFromProvisioningArtifact(BatchDisassociateServiceActionFromProvisioningArtifactRequest) |
Disassociates a batch of self-service actions from the specified provisioning artifact. |
|
BatchDisassociateServiceActionFromProvisioningArtifactAsync(BatchDisassociateServiceActionFromProvisioningArtifactRequest, CancellationToken) |
Disassociates a batch of self-service actions from the specified provisioning artifact. |
|
CopyProduct(CopyProductRequest) |
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. |
|
CopyProductAsync(CopyProductRequest, CancellationToken) |
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. |
|
CreateConstraint(CreateConstraintRequest) |
Creates a constraint. A delegated admin is authorized to invoke this command. |
|
CreateConstraintAsync(CreateConstraintRequest, CancellationToken) |
Creates a constraint. A delegated admin is authorized to invoke this command. |
|
CreatePortfolio(CreatePortfolioRequest) |
Creates a portfolio. A delegated admin is authorized to invoke this command. |
|
CreatePortfolioAsync(CreatePortfolioRequest, CancellationToken) |
Creates a portfolio. A delegated admin is authorized to invoke this command. |
|
CreatePortfolioShare(CreatePortfolioShareRequest) |
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.
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
When you associate a principal with portfolio, a potential privilege escalation path
may occur when that portfolio is then shared with other accounts. For a user in a
recipient account who is not an Service Catalog Admin, but still has the ability
to create Principals (Users/Groups/Roles), that user could create a role that matches
a principal name association for the portfolio. Although this user may not know which
principal names are associated through Service Catalog, they may be able to guess
the user. If this potential escalation path is a concern, then Service Catalog recommends
using |
|
CreatePortfolioShareAsync(CreatePortfolioShareRequest, CancellationToken) |
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.
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
When you associate a principal with portfolio, a potential privilege escalation path
may occur when that portfolio is then shared with other accounts. For a user in a
recipient account who is not an Service Catalog Admin, but still has the ability
to create Principals (Users/Groups/Roles), that user could create a role that matches
a principal name association for the portfolio. Although this user may not know which
principal names are associated through Service Catalog, they may be able to guess
the user. If this potential escalation path is a concern, then Service Catalog recommends
using |
|
CreateProduct(CreateProductRequest) |
Creates a product. A delegated admin is authorized to invoke this command.
The user or role that performs this operation must have the |
|
CreateProductAsync(CreateProductRequest, CancellationToken) |
Creates a product. A delegated admin is authorized to invoke this command.
The user or role that performs this operation must have the |
|
CreateProvisionedProductPlan(CreateProvisionedProductPlanRequest) |
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. |
|
CreateProvisionedProductPlanAsync(CreateProvisionedProductPlanRequest, CancellationToken) |
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. |
|
CreateProvisioningArtifact(CreateProvisioningArtifactRequest) |
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 |
|
CreateProvisioningArtifactAsync(CreateProvisioningArtifactRequest, CancellationToken) |
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 |
|
CreateServiceAction(CreateServiceActionRequest) |
Creates a self-service action. |
|
CreateServiceActionAsync(CreateServiceActionRequest, CancellationToken) |
Creates a self-service action. |
|
CreateTagOption(CreateTagOptionRequest) |
Creates a TagOption. |
|
CreateTagOptionAsync(CreateTagOptionRequest, CancellationToken) |
Creates a TagOption. |
|
DeleteConstraint(DeleteConstraintRequest) |
Deletes the specified constraint. A delegated admin is authorized to invoke this command. |
|
DeleteConstraintAsync(DeleteConstraintRequest, CancellationToken) |
Deletes the specified constraint. A delegated admin is authorized to invoke this command. |
|
DeletePortfolio(DeletePortfolioRequest) |
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. |
|
DeletePortfolioAsync(DeletePortfolioRequest, CancellationToken) |
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. |
|
DeletePortfolioShare(DeletePortfolioShareRequest) |
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. |
|
DeletePortfolioShareAsync(DeletePortfolioShareRequest, CancellationToken) |
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. |
|
DeleteProduct(DeleteProductRequest) |
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. |
|
DeleteProductAsync(DeleteProductRequest, CancellationToken) |
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. |
|
DeleteProvisionedProductPlan(DeleteProvisionedProductPlanRequest) |
Deletes the specified plan. |
|
DeleteProvisionedProductPlanAsync(DeleteProvisionedProductPlanRequest, CancellationToken) |
Deletes the specified plan. |
|
DeleteProvisioningArtifact(DeleteProvisioningArtifactRequest) |
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. |
|
DeleteProvisioningArtifactAsync(DeleteProvisioningArtifactRequest, CancellationToken) |
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. |
|
DeleteServiceAction(DeleteServiceActionRequest) |
Deletes a self-service action. |
|
DeleteServiceActionAsync(DeleteServiceActionRequest, CancellationToken) |
Deletes a self-service action. |
|
DeleteTagOption(DeleteTagOptionRequest) |
Deletes the specified TagOption. You cannot delete a TagOption if it is associated with a product or portfolio. |
|
DeleteTagOptionAsync(DeleteTagOptionRequest, CancellationToken) |
Deletes the specified TagOption. You cannot delete a TagOption if it is associated with a product or portfolio. |
|
DescribeConstraint(DescribeConstraintRequest) |
Gets information about the specified constraint. |
|
DescribeConstraintAsync(DescribeConstraintRequest, CancellationToken) |
Gets information about the specified constraint. |
|
DescribeCopyProductStatus(DescribeCopyProductStatusRequest) |
Gets the status of the specified copy product operation. |
|
DescribeCopyProductStatusAsync(DescribeCopyProductStatusRequest, CancellationToken) |
Gets the status of the specified copy product operation. |
|
DescribePortfolio(DescribePortfolioRequest) |
Gets information about the specified portfolio. A delegated admin is authorized to invoke this command. |
|
DescribePortfolioAsync(DescribePortfolioRequest, CancellationToken) |
Gets information about the specified portfolio. A delegated admin is authorized to invoke this command. |
|
DescribePortfolioShares(DescribePortfolioSharesRequest) |
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 |
|
DescribePortfolioSharesAsync(DescribePortfolioSharesRequest, CancellationToken) |
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 |
|
DescribePortfolioShareStatus(DescribePortfolioShareStatusRequest) |
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. |
|
DescribePortfolioShareStatusAsync(DescribePortfolioShareStatusRequest, CancellationToken) |
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. |
|
DescribeProduct(DescribeProductRequest) |
Gets information about the specified product.
Running this operation with administrator access results in a failure. DescribeProductAsAdmin
should be used instead.
|
|
DescribeProductAsAdmin(DescribeProductAsAdminRequest) |
Gets information about the specified product. This operation is run with administrator access. |
|
DescribeProductAsAdminAsync(DescribeProductAsAdminRequest, CancellationToken) |
Gets information about the specified product. This operation is run with administrator access. |
|
DescribeProductAsync(DescribeProductRequest, CancellationToken) |
Gets information about the specified product.
Running this operation with administrator access results in a failure. DescribeProductAsAdmin
should be used instead.
|
|
DescribeProductView(DescribeProductViewRequest) |
Gets information about the specified product. |
|
DescribeProductViewAsync(DescribeProductViewRequest, CancellationToken) |
Gets information about the specified product. |
|
DescribeProvisionedProduct(DescribeProvisionedProductRequest) |
Gets information about the specified provisioned product. |
|
DescribeProvisionedProductAsync(DescribeProvisionedProductRequest, CancellationToken) |
Gets information about the specified provisioned product. |
|
DescribeProvisionedProductPlan(DescribeProvisionedProductPlanRequest) |
Gets information about the resource changes for the specified plan. |
|
DescribeProvisionedProductPlanAsync(DescribeProvisionedProductPlanRequest, CancellationToken) |
Gets information about the resource changes for the specified plan. |
|
DescribeProvisioningArtifact(DescribeProvisioningArtifactRequest) |
Gets information about the specified provisioning artifact (also known as a version) for the specified product. |
|
DescribeProvisioningArtifactAsync(DescribeProvisioningArtifactRequest, CancellationToken) |
Gets information about the specified provisioning artifact (also known as a version) for the specified product. |
|
DescribeProvisioningParameters(DescribeProvisioningParametersRequest) |
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 |
|
DescribeProvisioningParametersAsync(DescribeProvisioningParametersRequest, CancellationToken) |
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 |
|
DescribeRecord(DescribeRecordRequest) |
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. |
|
DescribeRecordAsync(DescribeRecordRequest, CancellationToken) |
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. |
|
DescribeServiceAction(DescribeServiceActionRequest) |
Describes a self-service action. |
|
DescribeServiceActionAsync(DescribeServiceActionRequest, CancellationToken) |
Describes a self-service action. |
|
DescribeServiceActionExecutionParameters(DescribeServiceActionExecutionParametersRequest) |
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. |
|
DescribeServiceActionExecutionParametersAsync(DescribeServiceActionExecutionParametersRequest, CancellationToken) |
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. |
|
DescribeTagOption(DescribeTagOptionRequest) |
Gets information about the specified TagOption. |
|
DescribeTagOptionAsync(DescribeTagOptionRequest, CancellationToken) |
Gets information about the specified TagOption. |
|
DetermineServiceOperationEndpoint(AmazonWebServiceRequest) |
Returns the endpoint that will be used for a particular request. |
|
DisableAWSOrganizationsAccess(DisableAWSOrganizationsAccessRequest) |
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 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. |
|
DisableAWSOrganizationsAccessAsync(DisableAWSOrganizationsAccessRequest, CancellationToken) |
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 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. |
|
DisassociateBudgetFromResource(DisassociateBudgetFromResourceRequest) |
Disassociates the specified budget from the specified resource. |
|
DisassociateBudgetFromResourceAsync(DisassociateBudgetFromResourceRequest, CancellationToken) |
Disassociates the specified budget from the specified resource. |
|
DisassociatePrincipalFromPortfolio(DisassociatePrincipalFromPortfolioRequest) |
Disassociates a previously associated principal ARN from a specified portfolio.
The 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.
If you disassociate a principal from a portfolio, with PrincipalType as |
|
DisassociatePrincipalFromPortfolioAsync(DisassociatePrincipalFromPortfolioRequest, CancellationToken) |
Disassociates a previously associated principal ARN from a specified portfolio.
The 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.
If you disassociate a principal from a portfolio, with PrincipalType as |
|
DisassociateProductFromPortfolio(DisassociateProductFromPortfolioRequest) |
Disassociates the specified product from the specified portfolio. A delegated admin is authorized to invoke this command. |
|
DisassociateProductFromPortfolioAsync(DisassociateProductFromPortfolioRequest, CancellationToken) |
Disassociates the specified product from the specified portfolio. A delegated admin is authorized to invoke this command. |
|
DisassociateServiceActionFromProvisioningArtifact(DisassociateServiceActionFromProvisioningArtifactRequest) |
Disassociates the specified self-service action association from the specified provisioning artifact. |
|
DisassociateServiceActionFromProvisioningArtifactAsync(DisassociateServiceActionFromProvisioningArtifactRequest, CancellationToken) |
Disassociates the specified self-service action association from the specified provisioning artifact. |
|
DisassociateTagOptionFromResource(DisassociateTagOptionFromResourceRequest) |
Disassociates the specified TagOption from the specified resource. |
|
DisassociateTagOptionFromResourceAsync(DisassociateTagOptionFromResourceRequest, CancellationToken) |
Disassociates the specified TagOption from the specified resource. |
|
Dispose() | Inherited from Amazon.Runtime.AmazonServiceClient. | |
EnableAWSOrganizationsAccess(EnableAWSOrganizationsAccessRequest) |
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
Note that a delegated administrator is not authorized to invoke 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. |
|
EnableAWSOrganizationsAccessAsync(EnableAWSOrganizationsAccessRequest, CancellationToken) |
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
Note that a delegated administrator is not authorized to invoke 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. |
|
ExecuteProvisionedProductPlan(ExecuteProvisionedProductPlanRequest) |
Provisions or modifies a product based on the resource changes for the specified plan. |
|
ExecuteProvisionedProductPlanAsync(ExecuteProvisionedProductPlanRequest, CancellationToken) |
Provisions or modifies a product based on the resource changes for the specified plan. |
|
ExecuteProvisionedProductServiceAction(ExecuteProvisionedProductServiceActionRequest) |
Executes a self-service action against a provisioned product. |
|
ExecuteProvisionedProductServiceActionAsync(ExecuteProvisionedProductServiceActionRequest, CancellationToken) |
Executes a self-service action against a provisioned product. |
|
GetAWSOrganizationsAccessStatus(GetAWSOrganizationsAccessStatusRequest) |
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. |
|
GetAWSOrganizationsAccessStatusAsync(GetAWSOrganizationsAccessStatusRequest, CancellationToken) |
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. |
|
GetProvisionedProductOutputs(GetProvisionedProductOutputsRequest) |
This API takes either a |
|
GetProvisionedProductOutputsAsync(GetProvisionedProductOutputsRequest, CancellationToken) |
This API takes either a |
|
ImportAsProvisionedProduct(ImportAsProvisionedProductRequest) |
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:
Import of the resource requires that the CloudFormation stack template matches the associated Service Catalog product provisioning artifact.
When you import an existing CloudFormation stack into a portfolio, Service Catalog
does not apply the product's associated constraints during the import process. Service
Catalog applies the constraints after you call
The user or role that performs this operation must have the
You can only import one provisioned product at a time. The product's CloudFormation
stack must have the |
|
ImportAsProvisionedProductAsync(ImportAsProvisionedProductRequest, CancellationToken) |
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:
Import of the resource requires that the CloudFormation stack template matches the associated Service Catalog product provisioning artifact.
When you import an existing CloudFormation stack into a portfolio, Service Catalog
does not apply the product's associated constraints during the import process. Service
Catalog applies the constraints after you call
The user or role that performs this operation must have the
You can only import one provisioned product at a time. The product's CloudFormation
stack must have the |
|
ListAcceptedPortfolioShares(ListAcceptedPortfolioSharesRequest) |
Lists all imported portfolios for which account-to-account shares were accepted by
this account. By specifying the |
|
ListAcceptedPortfolioSharesAsync(ListAcceptedPortfolioSharesRequest, CancellationToken) |
Lists all imported portfolios for which account-to-account shares were accepted by
this account. By specifying the |
|
ListBudgetsForResource(ListBudgetsForResourceRequest) |
Lists all the budgets associated to the specified resource. |
|
ListBudgetsForResourceAsync(ListBudgetsForResourceRequest, CancellationToken) |
Lists all the budgets associated to the specified resource. |
|
ListConstraintsForPortfolio(ListConstraintsForPortfolioRequest) |
Lists the constraints for the specified portfolio and product. |
|
ListConstraintsForPortfolioAsync(ListConstraintsForPortfolioRequest, CancellationToken) |
Lists the constraints for the specified portfolio and product. |
|
ListLaunchPaths(ListLaunchPathsRequest) |
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.
When provisioning a product that's been added to a portfolio, you must grant your
user, group, or role access to the portfolio. For more information, see Granting
users access in the Service Catalog User Guide.
|
|
ListLaunchPathsAsync(ListLaunchPathsRequest, CancellationToken) |
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.
When provisioning a product that's been added to a portfolio, you must grant your
user, group, or role access to the portfolio. For more information, see Granting
users access in the Service Catalog User Guide.
|
|
ListOrganizationPortfolioAccess(ListOrganizationPortfolioAccessRequest) |
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. |
|
ListOrganizationPortfolioAccessAsync(ListOrganizationPortfolioAccessRequest, CancellationToken) |
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. |
|
ListPortfolioAccess(ListPortfolioAccessRequest) |
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. |
|
ListPortfolioAccessAsync(ListPortfolioAccessRequest, CancellationToken) |
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. |
|
ListPortfolios(ListPortfoliosRequest) |
Lists all portfolios in the catalog. |
|
ListPortfoliosAsync(ListPortfoliosRequest, CancellationToken) |
Lists all portfolios in the catalog. |
|
ListPortfoliosForProduct(ListPortfoliosForProductRequest) |
Lists all portfolios that the specified product is associated with. |
|
ListPortfoliosForProductAsync(ListPortfoliosForProductRequest, CancellationToken) |
Lists all portfolios that the specified product is associated with. |
|
ListPrincipalsForPortfolio(ListPrincipalsForPortfolioRequest) |
Lists all |
|
ListPrincipalsForPortfolioAsync(ListPrincipalsForPortfolioRequest, CancellationToken) |
Lists all |
|
ListProvisionedProductPlans(ListProvisionedProductPlansRequest) |
Lists the plans for the specified provisioned product or all plans to which the user has access. |
|
ListProvisionedProductPlansAsync(ListProvisionedProductPlansRequest, CancellationToken) |
Lists the plans for the specified provisioned product or all plans to which the user has access. |
|
ListProvisioningArtifacts(ListProvisioningArtifactsRequest) |
Lists all provisioning artifacts (also known as versions) for the specified product. |
|
ListProvisioningArtifactsAsync(ListProvisioningArtifactsRequest, CancellationToken) |
Lists all provisioning artifacts (also known as versions) for the specified product. |
|
ListProvisioningArtifactsForServiceAction(ListProvisioningArtifactsForServiceActionRequest) |
Lists all provisioning artifacts (also known as versions) for the specified self-service action. |
|
ListProvisioningArtifactsForServiceActionAsync(ListProvisioningArtifactsForServiceActionRequest, CancellationToken) |
Lists all provisioning artifacts (also known as versions) for the specified self-service action. |
|
ListRecordHistory(ListRecordHistoryRequest) |
Lists the specified requests or all performed requests. |
|
ListRecordHistoryAsync(ListRecordHistoryRequest, CancellationToken) |
Lists the specified requests or all performed requests. |
|
ListResourcesForTagOption(ListResourcesForTagOptionRequest) |
Lists the resources associated with the specified TagOption. |
|
ListResourcesForTagOptionAsync(ListResourcesForTagOptionRequest, CancellationToken) |
Lists the resources associated with the specified TagOption. |
|
ListServiceActions(ListServiceActionsRequest) |
Lists all self-service actions. |
|
ListServiceActionsAsync(ListServiceActionsRequest, CancellationToken) |
Lists all self-service actions. |
|
ListServiceActionsForProvisioningArtifact(ListServiceActionsForProvisioningArtifactRequest) |
Returns a paginated list of self-service actions associated with the specified Product ID and Provisioning Artifact ID. |
|
ListServiceActionsForProvisioningArtifactAsync(ListServiceActionsForProvisioningArtifactRequest, CancellationToken) |
Returns a paginated list of self-service actions associated with the specified Product ID and Provisioning Artifact ID. |
|
ListStackInstancesForProvisionedProduct(ListStackInstancesForProvisionedProductRequest) |
Returns summary information about stack instances that are associated with the specified
|
|
ListStackInstancesForProvisionedProductAsync(ListStackInstancesForProvisionedProductRequest, CancellationToken) |
Returns summary information about stack instances that are associated with the specified
|
|
ListTagOptions(ListTagOptionsRequest) |
Lists the specified TagOptions or all TagOptions. |
|
ListTagOptionsAsync(ListTagOptionsRequest, CancellationToken) |
Lists the specified TagOptions or all TagOptions. |
|
NotifyProvisionProductEngineWorkflowResult(NotifyProvisionProductEngineWorkflowResultRequest) |
Notifies the result of the provisioning engine execution. |
|
NotifyProvisionProductEngineWorkflowResultAsync(NotifyProvisionProductEngineWorkflowResultRequest, CancellationToken) |
Notifies the result of the provisioning engine execution. |
|
NotifyTerminateProvisionedProductEngineWorkflowResult(NotifyTerminateProvisionedProductEngineWorkflowResultRequest) |
Notifies the result of the terminate engine execution. |
|
NotifyTerminateProvisionedProductEngineWorkflowResultAsync(NotifyTerminateProvisionedProductEngineWorkflowResultRequest, CancellationToken) |
Notifies the result of the terminate engine execution. |
|
NotifyUpdateProvisionedProductEngineWorkflowResult(NotifyUpdateProvisionedProductEngineWorkflowResultRequest) |
Notifies the result of the update engine execution. |
|
NotifyUpdateProvisionedProductEngineWorkflowResultAsync(NotifyUpdateProvisionedProductEngineWorkflowResultRequest, CancellationToken) |
Notifies the result of the update engine execution. |
|
ProvisionProduct(ProvisionProductRequest) |
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". When provisioning a product that's been added to a portfolio, you must grant your user, group, or role access to the portfolio. For more information, see Granting users access in the Service Catalog User Guide. |
|
ProvisionProductAsync(ProvisionProductRequest, CancellationToken) |
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". When provisioning a product that's been added to a portfolio, you must grant your user, group, or role access to the portfolio. For more information, see Granting users access in the Service Catalog User Guide. |
|
RejectPortfolioShare(RejectPortfolioShareRequest) |
Rejects an offer to share the specified portfolio. |
|
RejectPortfolioShareAsync(RejectPortfolioShareRequest, CancellationToken) |
Rejects an offer to share the specified portfolio. |
|
ScanProvisionedProducts(ScanProvisionedProductsRequest) |
Lists the provisioned products that are available (not terminated). To use additional filtering, see SearchProvisionedProducts. |
|
ScanProvisionedProductsAsync(ScanProvisionedProductsRequest, CancellationToken) |
Lists the provisioned products that are available (not terminated). To use additional filtering, see SearchProvisionedProducts. |
|
SearchProducts(SearchProductsRequest) |
Gets information about the products to which the caller has access. |
|
SearchProductsAsAdmin(SearchProductsAsAdminRequest) |
Gets information about the products for the specified portfolio or all products. |
|
SearchProductsAsAdminAsync(SearchProductsAsAdminRequest, CancellationToken) |
Gets information about the products for the specified portfolio or all products. |
|
SearchProductsAsync(SearchProductsRequest, CancellationToken) |
Gets information about the products to which the caller has access. |
|
SearchProvisionedProducts(SearchProvisionedProductsRequest) |
Gets information about the provisioned products that meet the specified criteria. |
|
SearchProvisionedProductsAsync(SearchProvisionedProductsRequest, CancellationToken) |
Gets information about the provisioned products that meet the specified criteria. |
|
TerminateProvisionedProduct(TerminateProvisionedProductRequest) |
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. |
|
TerminateProvisionedProductAsync(TerminateProvisionedProductRequest, CancellationToken) |
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. |
|
UpdateConstraint(UpdateConstraintRequest) |
Updates the specified constraint. |
|
UpdateConstraintAsync(UpdateConstraintRequest, CancellationToken) |
Updates the specified constraint. |
|
UpdatePortfolio(UpdatePortfolioRequest) |
Updates the specified portfolio. You cannot update a product that was shared with you. |
|
UpdatePortfolioAsync(UpdatePortfolioRequest, CancellationToken) |
Updates the specified portfolio. You cannot update a product that was shared with you. |
|
UpdatePortfolioShare(UpdatePortfolioShareRequest) |
Updates the specified portfolio share. You can use this API to enable or disable
The portfolio share cannot be updated if the
You must provide the
If the portfolio is shared to both an external account and an organization node, and
both shares need to be updated, you must invoke
This API cannot be used for removing the portfolio share. You must use
When you associate a principal with portfolio, a potential privilege escalation path
may occur when that portfolio is then shared with other accounts. For a user in a
recipient account who is not an Service Catalog Admin, but still has the ability
to create Principals (Users/Groups/Roles), that user could create a role that matches
a principal name association for the portfolio. Although this user may not know which
principal names are associated through Service Catalog, they may be able to guess
the user. If this potential escalation path is a concern, then Service Catalog recommends
using |
|
UpdatePortfolioShareAsync(UpdatePortfolioShareRequest, CancellationToken) |
Updates the specified portfolio share. You can use this API to enable or disable
The portfolio share cannot be updated if the
You must provide the
If the portfolio is shared to both an external account and an organization node, and
both shares need to be updated, you must invoke
This API cannot be used for removing the portfolio share. You must use
When you associate a principal with portfolio, a potential privilege escalation path
may occur when that portfolio is then shared with other accounts. For a user in a
recipient account who is not an Service Catalog Admin, but still has the ability
to create Principals (Users/Groups/Roles), that user could create a role that matches
a principal name association for the portfolio. Although this user may not know which
principal names are associated through Service Catalog, they may be able to guess
the user. If this potential escalation path is a concern, then Service Catalog recommends
using |
|
UpdateProduct(UpdateProductRequest) |
Updates the specified product. |
|
UpdateProductAsync(UpdateProductRequest, CancellationToken) |
Updates the specified product. |
|
UpdateProvisionedProduct(UpdateProvisionedProductRequest) |
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. |
|
UpdateProvisionedProductAsync(UpdateProvisionedProductRequest, CancellationToken) |
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. |
|
UpdateProvisionedProductProperties(UpdateProvisionedProductPropertiesRequest) |
Requests updates to the properties of the specified provisioned product. |
|
UpdateProvisionedProductPropertiesAsync(UpdateProvisionedProductPropertiesRequest, CancellationToken) |
Requests updates to the properties of the specified provisioned product. |
|
UpdateProvisioningArtifact(UpdateProvisioningArtifactRequest) |
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. |
|
UpdateProvisioningArtifactAsync(UpdateProvisioningArtifactRequest, CancellationToken) |
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. |
|
UpdateServiceAction(UpdateServiceActionRequest) |
Updates a self-service action. |
|
UpdateServiceActionAsync(UpdateServiceActionRequest, CancellationToken) |
Updates a self-service action. |
|
UpdateTagOption(UpdateTagOptionRequest) |
Updates the specified TagOption. |
|
UpdateTagOptionAsync(UpdateTagOptionRequest, CancellationToken) |
Updates the specified TagOption. |
Name | Description | |
---|---|---|
AfterResponseEvent | Inherited from Amazon.Runtime.AmazonServiceClient. | |
BeforeRequestEvent | Inherited from Amazon.Runtime.AmazonServiceClient. | |
ExceptionEvent | Inherited from Amazon.Runtime.AmazonServiceClient. |
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5