@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAWSServiceCatalog extends Object implements AWSServiceCatalog
AWSServiceCatalog
. Convenient method forms pass through to the corresponding
overload that takes a request object, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
public void setEndpoint(String endpoint)
AWSServiceCatalog
Callers can pass in just the endpoint (ex: "servicecatalog.us-east-1.amazonaws.com") or a full URL, including the
protocol (ex: "servicecatalog.us-east-1.amazonaws.com"). If the protocol is not specified here, the default
protocol from this client's ClientConfiguration
will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setEndpoint
in interface AWSServiceCatalog
endpoint
- The endpoint (ex: "servicecatalog.us-east-1.amazonaws.com") or a full URL, including the protocol (ex:
"servicecatalog.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate
with.public void setRegion(Region region)
AWSServiceCatalog
AWSServiceCatalog.setEndpoint(String)
, sets the regional endpoint for this client's
service calls. Callers can use this method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration
supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setRegion
in interface AWSServiceCatalog
region
- The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.Region.getRegion(com.amazonaws.regions.Regions)
,
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
,
Region.isServiceSupported(String)
public AcceptPortfolioShareResult acceptPortfolioShare(AcceptPortfolioShareRequest request)
AWSServiceCatalog
Accepts an offer to share a portfolio.
acceptPortfolioShare
in interface AWSServiceCatalog
public AssociatePrincipalWithPortfolioResult associatePrincipalWithPortfolio(AssociatePrincipalWithPortfolioRequest request)
AWSServiceCatalog
Associates the specified principal ARN with the specified portfolio.
associatePrincipalWithPortfolio
in interface AWSServiceCatalog
public AssociateProductWithPortfolioResult associateProductWithPortfolio(AssociateProductWithPortfolioRequest request)
AWSServiceCatalog
Associates a product with a portfolio.
associateProductWithPortfolio
in interface AWSServiceCatalog
public AssociateTagOptionWithResourceResult associateTagOptionWithResource(AssociateTagOptionWithResourceRequest request)
AWSServiceCatalog
Associate a TagOption identifier with a resource identifier.
associateTagOptionWithResource
in interface AWSServiceCatalog
public CopyProductResult copyProduct(CopyProductRequest request)
AWSServiceCatalog
Copies the specified source product to the specified target product or a new product.
You can copy the product to the same account or another account. You can copy the product to the same region or another region.
This operation is performed asynchronously. To track the progress of the operation, use DescribeCopyProductStatus.
copyProduct
in interface AWSServiceCatalog
public CreateConstraintResult createConstraint(CreateConstraintRequest request)
AWSServiceCatalog
Creates a new constraint. For more information, see Using Constraints.
createConstraint
in interface AWSServiceCatalog
public CreatePortfolioResult createPortfolio(CreatePortfolioRequest request)
AWSServiceCatalog
Creates a new portfolio.
createPortfolio
in interface AWSServiceCatalog
public CreatePortfolioShareResult createPortfolioShare(CreatePortfolioShareRequest request)
AWSServiceCatalog
Creates a new portfolio share.
createPortfolioShare
in interface AWSServiceCatalog
public CreateProductResult createProduct(CreateProductRequest request)
AWSServiceCatalog
Creates a new product.
createProduct
in interface AWSServiceCatalog
public CreateProvisioningArtifactResult createProvisioningArtifact(CreateProvisioningArtifactRequest request)
AWSServiceCatalog
Create a new provisioning artifact for the specified product. This operation does not work with a product that has been shared with you.
createProvisioningArtifact
in interface AWSServiceCatalog
public CreateTagOptionResult createTagOption(CreateTagOptionRequest request)
AWSServiceCatalog
Create a new TagOption.
createTagOption
in interface AWSServiceCatalog
public DeleteConstraintResult deleteConstraint(DeleteConstraintRequest request)
AWSServiceCatalog
Deletes the specified constraint.
deleteConstraint
in interface AWSServiceCatalog
public DeletePortfolioResult deletePortfolio(DeletePortfolioRequest request)
AWSServiceCatalog
Deletes the specified portfolio. This operation does not work with a portfolio that has been shared with you or if it has products, users, constraints, or shared accounts associated with it.
deletePortfolio
in interface AWSServiceCatalog
public DeletePortfolioShareResult deletePortfolioShare(DeletePortfolioShareRequest request)
AWSServiceCatalog
Deletes the specified portfolio share.
deletePortfolioShare
in interface AWSServiceCatalog
public DeleteProductResult deleteProduct(DeleteProductRequest request)
AWSServiceCatalog
Deletes the specified product. This operation does not work with a product that has been shared with you or is associated with a portfolio.
deleteProduct
in interface AWSServiceCatalog
public DeleteProvisioningArtifactResult deleteProvisioningArtifact(DeleteProvisioningArtifactRequest request)
AWSServiceCatalog
Deletes the specified provisioning artifact. This operation does not work on a provisioning artifact associated with a product that has been shared with you, or on the last provisioning artifact associated with a product (a product must have at least one provisioning artifact).
deleteProvisioningArtifact
in interface AWSServiceCatalog
public DescribeConstraintResult describeConstraint(DescribeConstraintRequest request)
AWSServiceCatalog
Retrieves detailed information for a specified constraint.
describeConstraint
in interface AWSServiceCatalog
public DescribeCopyProductStatusResult describeCopyProductStatus(DescribeCopyProductStatusRequest request)
AWSServiceCatalog
Describes the status of the specified copy product operation.
describeCopyProductStatus
in interface AWSServiceCatalog
public DescribePortfolioResult describePortfolio(DescribePortfolioRequest request)
AWSServiceCatalog
Retrieves detailed information and any tags associated with the specified portfolio.
describePortfolio
in interface AWSServiceCatalog
public DescribeProductResult describeProduct(DescribeProductRequest request)
AWSServiceCatalog
Retrieves information about a specified product.
This operation is functionally identical to DescribeProductView except that it takes as input
ProductId
instead of ProductViewId
.
describeProduct
in interface AWSServiceCatalog
public DescribeProductAsAdminResult describeProductAsAdmin(DescribeProductAsAdminRequest request)
AWSServiceCatalog
Retrieves information about a specified product, run with administrator access.
describeProductAsAdmin
in interface AWSServiceCatalog
public DescribeProductViewResult describeProductView(DescribeProductViewRequest request)
AWSServiceCatalog
Retrieves information about a specified product.
This operation is functionally identical to DescribeProduct except that it takes as input
ProductViewId
instead of ProductId
.
describeProductView
in interface AWSServiceCatalog
public DescribeProvisionedProductResult describeProvisionedProduct(DescribeProvisionedProductRequest request)
AWSServiceCatalog
Retrieve detailed information about the provisioned product.
describeProvisionedProduct
in interface AWSServiceCatalog
public DescribeProvisioningArtifactResult describeProvisioningArtifact(DescribeProvisioningArtifactRequest request)
AWSServiceCatalog
Retrieves detailed information about the specified provisioning artifact.
describeProvisioningArtifact
in interface AWSServiceCatalog
public DescribeProvisioningParametersResult describeProvisioningParameters(DescribeProvisioningParametersRequest request)
AWSServiceCatalog
Provides information about parameters required to provision a specified product in a specified manner. Use this
operation to obtain the list of ProvisioningArtifactParameters
parameters available to call the
ProvisionProduct operation for the specified product.
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 the
ProvisionProduct
operation, do not include conflicted TagOption keys as tags. Calls to
ProvisionProduct
with empty TagOption values cause the error
"Parameter validation failed: Missing required parameter in Tags[N]:Value ". Calls to
ProvisionProduct
with conflicted TagOption keys automatically tag the provisioned product with the
conflicted keys with the value "sc-tagoption-conflict-portfolioId-productId
".
describeProvisioningParameters
in interface AWSServiceCatalog
public DescribeRecordResult describeRecord(DescribeRecordRequest request)
AWSServiceCatalog
Retrieves a paginated list of the full details of a specific request. Use this operation after calling a request operation (ProvisionProduct, TerminateProvisionedProduct, or UpdateProvisionedProduct).
describeRecord
in interface AWSServiceCatalog
public DescribeTagOptionResult describeTagOption(DescribeTagOptionRequest request)
AWSServiceCatalog
Describes a TagOption.
describeTagOption
in interface AWSServiceCatalog
public DisassociatePrincipalFromPortfolioResult disassociatePrincipalFromPortfolio(DisassociatePrincipalFromPortfolioRequest request)
AWSServiceCatalog
Disassociates a previously associated principal ARN from a specified portfolio.
disassociatePrincipalFromPortfolio
in interface AWSServiceCatalog
public DisassociateProductFromPortfolioResult disassociateProductFromPortfolio(DisassociateProductFromPortfolioRequest request)
AWSServiceCatalog
Disassociates the specified product from the specified portfolio.
disassociateProductFromPortfolio
in interface AWSServiceCatalog
public DisassociateTagOptionFromResourceResult disassociateTagOptionFromResource(DisassociateTagOptionFromResourceRequest request)
AWSServiceCatalog
Disassociates a TagOption from a resource.
disassociateTagOptionFromResource
in interface AWSServiceCatalog
public ListAcceptedPortfolioSharesResult listAcceptedPortfolioShares(ListAcceptedPortfolioSharesRequest request)
AWSServiceCatalog
Lists details of all portfolios for which sharing was accepted by this account.
listAcceptedPortfolioShares
in interface AWSServiceCatalog
public ListConstraintsForPortfolioResult listConstraintsForPortfolio(ListConstraintsForPortfolioRequest request)
AWSServiceCatalog
Retrieves detailed constraint information for the specified portfolio and product.
listConstraintsForPortfolio
in interface AWSServiceCatalog
public ListLaunchPathsResult listLaunchPaths(ListLaunchPathsRequest request)
AWSServiceCatalog
Returns a paginated list of all paths to a 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.
listLaunchPaths
in interface AWSServiceCatalog
public ListPortfolioAccessResult listPortfolioAccess(ListPortfolioAccessRequest request)
AWSServiceCatalog
Lists the account IDs that have been authorized sharing of the specified portfolio.
listPortfolioAccess
in interface AWSServiceCatalog
public ListPortfoliosResult listPortfolios(ListPortfoliosRequest request)
AWSServiceCatalog
Lists all portfolios in the catalog.
listPortfolios
in interface AWSServiceCatalog
public ListPortfoliosForProductResult listPortfoliosForProduct(ListPortfoliosForProductRequest request)
AWSServiceCatalog
Lists all portfolios that the specified product is associated with.
listPortfoliosForProduct
in interface AWSServiceCatalog
public ListPrincipalsForPortfolioResult listPrincipalsForPortfolio(ListPrincipalsForPortfolioRequest request)
AWSServiceCatalog
Lists all principal ARNs associated with the specified portfolio.
listPrincipalsForPortfolio
in interface AWSServiceCatalog
public ListProvisioningArtifactsResult listProvisioningArtifacts(ListProvisioningArtifactsRequest request)
AWSServiceCatalog
Lists all provisioning artifacts associated with the specified product.
listProvisioningArtifacts
in interface AWSServiceCatalog
public ListRecordHistoryResult listRecordHistory(ListRecordHistoryRequest request)
AWSServiceCatalog
Returns a paginated list of all performed requests, in the form of RecordDetails objects that are filtered as specified.
listRecordHistory
in interface AWSServiceCatalog
public ListResourcesForTagOptionResult listResourcesForTagOption(ListResourcesForTagOptionRequest request)
AWSServiceCatalog
Lists resources associated with a TagOption.
listResourcesForTagOption
in interface AWSServiceCatalog
public ListTagOptionsResult listTagOptions(ListTagOptionsRequest request)
AWSServiceCatalog
Lists detailed TagOptions information.
listTagOptions
in interface AWSServiceCatalog
public ProvisionProductResult provisionProduct(ProvisionProductRequest request)
AWSServiceCatalog
Requests a provision of a specified product. A provisioned product is a resourced instance for a product. For example, provisioning a CloudFormation-template-backed product results in launching a CloudFormation stack and all the underlying resources that come with it.
You can check the status of this request using the DescribeRecord operation. The error
"Parameter validation failed: Missing required parameter in Tags[N]:Value" indicates that your
request contains a tag which has a tag key but no corresponding tag value (value is empty or null). Your call may
have included values returned from a DescribeProvisioningParameters
call that resulted in a
TagOption key with an empty list. This happens when TagOption keys are in conflict. For more information, see
DescribeProvisioningParameters.
provisionProduct
in interface AWSServiceCatalog
public RejectPortfolioShareResult rejectPortfolioShare(RejectPortfolioShareRequest request)
AWSServiceCatalog
Rejects an offer to share a portfolio.
rejectPortfolioShare
in interface AWSServiceCatalog
public ScanProvisionedProductsResult scanProvisionedProducts(ScanProvisionedProductsRequest request)
AWSServiceCatalog
Returns a paginated list of all the ProvisionedProduct objects that are currently available (not terminated).
scanProvisionedProducts
in interface AWSServiceCatalog
public SearchProductsResult searchProducts(SearchProductsRequest request)
AWSServiceCatalog
Returns a paginated list all of the Products
objects to which the caller has access.
The output of this operation can be used as input for other operations, such as DescribeProductView.
searchProducts
in interface AWSServiceCatalog
public SearchProductsAsAdminResult searchProductsAsAdmin(SearchProductsAsAdminRequest request)
AWSServiceCatalog
Retrieves summary and status information about all products created within the caller's account. If a portfolio ID is provided, this operation retrieves information for only those products that are associated with the specified portfolio.
searchProductsAsAdmin
in interface AWSServiceCatalog
public TerminateProvisionedProductResult terminateProvisionedProduct(TerminateProvisionedProductRequest request)
AWSServiceCatalog
Requests termination of an existing ProvisionedProduct object. If there are Tags
associated with the
object, they are terminated when the ProvisionedProduct object is terminated.
This operation does not delete any records associated with the ProvisionedProduct object.
You can check the status of this request using the DescribeRecord operation.
terminateProvisionedProduct
in interface AWSServiceCatalog
public UpdateConstraintResult updateConstraint(UpdateConstraintRequest request)
AWSServiceCatalog
Updates an existing constraint.
updateConstraint
in interface AWSServiceCatalog
public UpdatePortfolioResult updatePortfolio(UpdatePortfolioRequest request)
AWSServiceCatalog
Updates the specified portfolio's details. This operation does not work with a product that has been shared with you.
updatePortfolio
in interface AWSServiceCatalog
public UpdateProductResult updateProduct(UpdateProductRequest request)
AWSServiceCatalog
Updates an existing product.
updateProduct
in interface AWSServiceCatalog
public UpdateProvisionedProductResult updateProvisionedProduct(UpdateProvisionedProductRequest request)
AWSServiceCatalog
Requests updates to the configuration of an existing ProvisionedProduct object. If there are tags associated with the object, they cannot be updated or added with this operation. Depending on the specific updates requested, this operation may update with no interruption, with some interruption, or replace the ProvisionedProduct object entirely.
You can check the status of this request using the DescribeRecord operation.
updateProvisionedProduct
in interface AWSServiceCatalog
public UpdateProvisioningArtifactResult updateProvisioningArtifact(UpdateProvisioningArtifactRequest request)
AWSServiceCatalog
Updates an existing provisioning artifact's information. This operation does not work on a provisioning artifact associated with a product that has been shared with you.
updateProvisioningArtifact
in interface AWSServiceCatalog
public UpdateTagOptionResult updateTagOption(UpdateTagOptionRequest request)
AWSServiceCatalog
Updates an existing TagOption.
updateTagOption
in interface AWSServiceCatalog
public void shutdown()
AWSServiceCatalog
shutdown
in interface AWSServiceCatalog
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSServiceCatalog
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata
in interface AWSServiceCatalog
request
- The originally executed request.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.