com.amazonaws.services.servicecatalog

Class AWSServiceCatalogClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.servicecatalog.AWSServiceCatalogClient

All Implemented Interfaces:

AWSServiceCatalog

Direct Known Subclasses:

AWSServiceCatalogAsyncClient

@ThreadSafe
public class AWSServiceCatalogClient
extends AmazonWebServiceClient
implements AWSServiceCatalog

Client for accessing AWS Service Catalog. All service calls made using this client are blocking, and will not return until the service call completes.

AWS Service Catalog

Overview

AWS Service Catalog allows organizations to create and manage catalogs of IT services that are approved for use on AWS. This documentation provides reference material for the AWS Service Catalog end user API. To get the most out of this documentation, you need to be familiar with the terminology discussed in AWS Service Catalog Concepts.

Additional Resources

• AWS Service Catalog Administrator Guide

• AWS Service Catalog User Guide

Field Summary

Fields

Modifier and Type	Field and Description
protected static ClientConfigurationFactory	configFactory Client configuration factory providing ClientConfigurations tailored to this client

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Fields inherited from interface com.amazonaws.services.servicecatalog.AWSServiceCatalog

ENDPOINT_PREFIX

Constructor Summary

Constructors

Constructor and Description
AWSServiceCatalogClient() Constructs a new client to invoke service methods on AWS Service Catalog.
AWSServiceCatalogClient(AWSCredentials awsCredentials) Constructs a new client to invoke service methods on AWS Service Catalog using the specified AWS account credentials.
AWSServiceCatalogClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AWS Service Catalog using the specified AWS account credentials and client configuration options.
AWSServiceCatalogClient(AWSCredentialsProvider awsCredentialsProvider) Constructs a new client to invoke service methods on AWS Service Catalog using the specified AWS account credentials provider.
AWSServiceCatalogClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AWS Service Catalog using the specified AWS account credentials provider and client configuration options.
AWSServiceCatalogClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Constructs a new client to invoke service methods on AWS Service Catalog using the specified AWS account credentials provider, client configuration options, and request metric collector.
AWSServiceCatalogClient(ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AWS Service Catalog.

Method Summary

Modifier and Type	Method and Description
AcceptPortfolioShareResult	acceptPortfolioShare(AcceptPortfolioShareRequest acceptPortfolioShareRequest) Accepts an offer to share a portfolio.
AssociatePrincipalWithPortfolioResult	associatePrincipalWithPortfolio(AssociatePrincipalWithPortfolioRequest associatePrincipalWithPortfolioRequest) Associates the specified principal ARN with the specified portfolio.
AssociateProductWithPortfolioResult	associateProductWithPortfolio(AssociateProductWithPortfolioRequest associateProductWithPortfolioRequest) Associates a product with a portfolio.
CreateConstraintResult	createConstraint(CreateConstraintRequest createConstraintRequest) Creates a new constraint.
CreatePortfolioResult	createPortfolio(CreatePortfolioRequest createPortfolioRequest) Creates a new portfolio.
CreatePortfolioShareResult	createPortfolioShare(CreatePortfolioShareRequest createPortfolioShareRequest) Creates a new portfolio share.
CreateProductResult	createProduct(CreateProductRequest createProductRequest) Creates a new product.
CreateProvisioningArtifactResult	createProvisioningArtifact(CreateProvisioningArtifactRequest createProvisioningArtifactRequest) Create a new provisioning artifact for the specified product.
DeleteConstraintResult	deleteConstraint(DeleteConstraintRequest deleteConstraintRequest) Deletes the specified constraint.
DeletePortfolioResult	deletePortfolio(DeletePortfolioRequest deletePortfolioRequest) Deletes the specified portfolio.
DeletePortfolioShareResult	deletePortfolioShare(DeletePortfolioShareRequest deletePortfolioShareRequest) Deletes the specified portfolio share.
DeleteProductResult	deleteProduct(DeleteProductRequest deleteProductRequest) Deletes the specified product.
DeleteProvisioningArtifactResult	deleteProvisioningArtifact(DeleteProvisioningArtifactRequest deleteProvisioningArtifactRequest) Deletes the specified provisioning artifact.
DescribeConstraintResult	describeConstraint(DescribeConstraintRequest describeConstraintRequest) Retrieves detailed information for a specified constraint.
DescribePortfolioResult	describePortfolio(DescribePortfolioRequest describePortfolioRequest) Retrieves detailed information and any tags associated with the specified portfolio.
DescribeProductResult	describeProduct(DescribeProductRequest describeProductRequest) Retrieves information about a specified product.
DescribeProductAsAdminResult	describeProductAsAdmin(DescribeProductAsAdminRequest describeProductAsAdminRequest) Retrieves information about a specified product, run with administrator access.
DescribeProductViewResult	describeProductView(DescribeProductViewRequest describeProductViewRequest) Retrieves information about a specified product.
DescribeProvisioningArtifactResult	describeProvisioningArtifact(DescribeProvisioningArtifactRequest describeProvisioningArtifactRequest) Retrieves detailed information about the specified provisioning artifact.
DescribeProvisioningParametersResult	describeProvisioningParameters(DescribeProvisioningParametersRequest describeProvisioningParametersRequest) Provides information about parameters required to provision a specified product in a specified manner.
DescribeRecordResult	describeRecord(DescribeRecordRequest describeRecordRequest) Retrieves a paginated list of the full details of a specific request.
DisassociatePrincipalFromPortfolioResult	disassociatePrincipalFromPortfolio(DisassociatePrincipalFromPortfolioRequest disassociatePrincipalFromPortfolioRequest) Disassociates a previously associated principal ARN from a specified portfolio.
DisassociateProductFromPortfolioResult	disassociateProductFromPortfolio(DisassociateProductFromPortfolioRequest disassociateProductFromPortfolioRequest) Disassociates the specified product from the specified portfolio.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
ListAcceptedPortfolioSharesResult	listAcceptedPortfolioShares(ListAcceptedPortfolioSharesRequest listAcceptedPortfolioSharesRequest) Lists details of all portfolios for which sharing was accepted by this account.
ListConstraintsForPortfolioResult	listConstraintsForPortfolio(ListConstraintsForPortfolioRequest listConstraintsForPortfolioRequest) Retrieves detailed constraint information for the specified portfolio and product.
ListLaunchPathsResult	listLaunchPaths(ListLaunchPathsRequest listLaunchPathsRequest) Returns a paginated list of all paths to a specified product.
ListPortfolioAccessResult	listPortfolioAccess(ListPortfolioAccessRequest listPortfolioAccessRequest) Lists the account IDs that have been authorized sharing of the specified portfolio.
ListPortfoliosResult	listPortfolios(ListPortfoliosRequest listPortfoliosRequest) Lists all portfolios in the catalog.
ListPortfoliosForProductResult	listPortfoliosForProduct(ListPortfoliosForProductRequest listPortfoliosForProductRequest) Lists all portfolios that the specified product is associated with.
ListPrincipalsForPortfolioResult	listPrincipalsForPortfolio(ListPrincipalsForPortfolioRequest listPrincipalsForPortfolioRequest) Lists all principal ARNs associated with the specified portfolio.
ListProvisioningArtifactsResult	listProvisioningArtifacts(ListProvisioningArtifactsRequest listProvisioningArtifactsRequest) Lists all provisioning artifacts associated with the specified product.
ListRecordHistoryResult	listRecordHistory(ListRecordHistoryRequest listRecordHistoryRequest) Returns a paginated list of all performed requests, in the form of RecordDetails objects that are filtered as specified.
ProvisionProductResult	provisionProduct(ProvisionProductRequest provisionProductRequest) Requests a Provision of a specified product.
RejectPortfolioShareResult	rejectPortfolioShare(RejectPortfolioShareRequest rejectPortfolioShareRequest) Rejects an offer to share a portfolio.
ScanProvisionedProductsResult	scanProvisionedProducts(ScanProvisionedProductsRequest scanProvisionedProductsRequest) Returns a paginated list of all the ProvisionedProduct objects that are currently available (not terminated).
SearchProductsResult	searchProducts(SearchProductsRequest searchProductsRequest) Returns a paginated list all of the Products objects to which the caller has access.
SearchProductsAsAdminResult	searchProductsAsAdmin(SearchProductsAsAdminRequest searchProductsAsAdminRequest) Retrieves summary and status information about all products created within the caller's account.
TerminateProvisionedProductResult	terminateProvisionedProduct(TerminateProvisionedProductRequest terminateProvisionedProductRequest) Requests termination of an existing ProvisionedProduct object.
UpdateConstraintResult	updateConstraint(UpdateConstraintRequest updateConstraintRequest) Updates an existing constraint.
UpdatePortfolioResult	updatePortfolio(UpdatePortfolioRequest updatePortfolioRequest) Updates the specified portfolio's details.
UpdateProductResult	updateProduct(UpdateProductRequest updateProductRequest) Updates an existing product.
UpdateProvisionedProductResult	updateProvisionedProduct(UpdateProvisionedProductRequest updateProvisionedProductRequest) Requests updates to the configuration of an existing ProvisionedProduct object.
UpdateProvisioningArtifactResult	updateProvisioningArtifact(UpdateProvisioningArtifactRequest updateProvisioningArtifactRequest) Updates an existing provisioning artifact's information.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getEndpointPrefix, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerProvider, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.servicecatalog.AWSServiceCatalog

setEndpoint, setRegion, shutdown

Field Detail

configFactory

protected static final ClientConfigurationFactory configFactory

Client configuration factory providing ClientConfigurations tailored to this client

Constructor Detail

AWSServiceCatalogClient

public AWSServiceCatalogClient()

Constructs a new client to invoke service methods on AWS Service Catalog. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

See Also:

DefaultAWSCredentialsProviderChain

AWSServiceCatalogClient

public AWSServiceCatalogClient(ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AWS Service Catalog. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to AWS Service Catalog (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AWSServiceCatalogClient

public AWSServiceCatalogClient(AWSCredentials awsCredentials)

Constructs a new client to invoke service methods on AWS Service Catalog using the specified AWS account credentials.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

AWSServiceCatalogClient

public AWSServiceCatalogClient(AWSCredentials awsCredentials,
                               ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AWS Service Catalog using the specified AWS account credentials and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AWS Service Catalog (ex: proxy settings, retry counts, etc.).

AWSServiceCatalogClient

public AWSServiceCatalogClient(AWSCredentialsProvider awsCredentialsProvider)

Constructs a new client to invoke service methods on AWS Service Catalog using the specified AWS account credentials provider.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

AWSServiceCatalogClient

public AWSServiceCatalogClient(AWSCredentialsProvider awsCredentialsProvider,
                               ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AWS Service Catalog using the specified AWS account credentials provider and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AWS Service Catalog (ex: proxy settings, retry counts, etc.).

AWSServiceCatalogClient

public AWSServiceCatalogClient(AWSCredentialsProvider awsCredentialsProvider,
                               ClientConfiguration clientConfiguration,
                               RequestMetricCollector requestMetricCollector)

Constructs a new client to invoke service methods on AWS Service Catalog using the specified AWS account credentials provider, client configuration options, and request metric collector.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AWS Service Catalog (ex: proxy settings, retry counts, etc.).

requestMetricCollector - optional request metric collector

Method Detail

acceptPortfolioShare

public AcceptPortfolioShareResult acceptPortfolioShare(AcceptPortfolioShareRequest acceptPortfolioShareRequest)

Accepts an offer to share a portfolio.

Specified by:

acceptPortfolioShare in interface AWSServiceCatalog

Parameters:

acceptPortfolioShareRequest -

Returns:

Result of the AcceptPortfolioShare operation returned by the service.

Throws:

InvalidParametersException - One or more parameters provided to the operation are invalid.

ResourceNotFoundException - The specified resource was not found.

LimitExceededException - The current limits of the service would have been exceeded by this operation. Reduce the resource use or increase the service limits and retry the operation.

See Also:

AWS API Documentation

associatePrincipalWithPortfolio

public AssociatePrincipalWithPortfolioResult associatePrincipalWithPortfolio(AssociatePrincipalWithPortfolioRequest associatePrincipalWithPortfolioRequest)

Associates the specified principal ARN with the specified portfolio.

Specified by:

associatePrincipalWithPortfolio in interface AWSServiceCatalog

Parameters:

associatePrincipalWithPortfolioRequest -

Returns:

Result of the AssociatePrincipalWithPortfolio operation returned by the service.

Throws:

InvalidParametersException - One or more parameters provided to the operation are invalid.

ResourceNotFoundException - The specified resource was not found.

LimitExceededException - The current limits of the service would have been exceeded by this operation. Reduce the resource use or increase the service limits and retry the operation.

See Also:

AWS API Documentation

associateProductWithPortfolio

public AssociateProductWithPortfolioResult associateProductWithPortfolio(AssociateProductWithPortfolioRequest associateProductWithPortfolioRequest)

Associates a product with a portfolio.

Specified by:

associateProductWithPortfolio in interface AWSServiceCatalog

Parameters:

associateProductWithPortfolioRequest -

Returns:

Result of the AssociateProductWithPortfolio operation returned by the service.

Throws:

InvalidParametersException - One or more parameters provided to the operation are invalid.

ResourceNotFoundException - The specified resource was not found.

LimitExceededException - The current limits of the service would have been exceeded by this operation. Reduce the resource use or increase the service limits and retry the operation.

See Also:

AWS API Documentation

createConstraint

public CreateConstraintResult createConstraint(CreateConstraintRequest createConstraintRequest)

Creates a new constraint.

Specified by:

createConstraint in interface AWSServiceCatalog

Parameters:

createConstraintRequest -

Returns:

Result of the CreateConstraint operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InvalidParametersException - One or more parameters provided to the operation are invalid.

LimitExceededException - The current limits of the service would have been exceeded by this operation. Reduce the resource use or increase the service limits and retry the operation.

DuplicateResourceException - The specified resource is a duplicate.

See Also:

AWS API Documentation

createPortfolio

public CreatePortfolioResult createPortfolio(CreatePortfolioRequest createPortfolioRequest)

Creates a new portfolio.

Specified by:

createPortfolio in interface AWSServiceCatalog

Parameters:

createPortfolioRequest -

Returns:

Result of the CreatePortfolio operation returned by the service.

Throws:

InvalidParametersException - One or more parameters provided to the operation are invalid.

LimitExceededException - The current limits of the service would have been exceeded by this operation. Reduce the resource use or increase the service limits and retry the operation.

See Also:

AWS API Documentation

createPortfolioShare

public CreatePortfolioShareResult createPortfolioShare(CreatePortfolioShareRequest createPortfolioShareRequest)

Creates a new portfolio share.

Specified by:

createPortfolioShare in interface AWSServiceCatalog

Parameters:

createPortfolioShareRequest -

Returns:

Result of the CreatePortfolioShare operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

LimitExceededException - The current limits of the service would have been exceeded by this operation. Reduce the resource use or increase the service limits and retry the operation.

InvalidParametersException - One or more parameters provided to the operation are invalid.

See Also:

AWS API Documentation

createProduct

public CreateProductResult createProduct(CreateProductRequest createProductRequest)

Creates a new product.

Specified by:

createProduct in interface AWSServiceCatalog

Parameters:

createProductRequest -

Returns:

Result of the CreateProduct operation returned by the service.

Throws:

InvalidParametersException - One or more parameters provided to the operation are invalid.

LimitExceededException - The current limits of the service would have been exceeded by this operation. Reduce the resource use or increase the service limits and retry the operation.

See Also:

AWS API Documentation

createProvisioningArtifact

public CreateProvisioningArtifactResult createProvisioningArtifact(CreateProvisioningArtifactRequest createProvisioningArtifactRequest)

Create a new provisioning artifact for the specified product. This operation will not work with a product that has been shared with you.

Specified by:

createProvisioningArtifact in interface AWSServiceCatalog

Parameters:

createProvisioningArtifactRequest -

Returns:

Result of the CreateProvisioningArtifact operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InvalidParametersException - One or more parameters provided to the operation are invalid.

LimitExceededException - The current limits of the service would have been exceeded by this operation. Reduce the resource use or increase the service limits and retry the operation.

See Also:

AWS API Documentation

deleteConstraint

public DeleteConstraintResult deleteConstraint(DeleteConstraintRequest deleteConstraintRequest)

Deletes the specified constraint.

Specified by:

deleteConstraint in interface AWSServiceCatalog

Parameters:

deleteConstraintRequest -

Returns:

Result of the DeleteConstraint operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InvalidParametersException - One or more parameters provided to the operation are invalid.

See Also:

AWS API Documentation

deletePortfolio

public DeletePortfolioResult deletePortfolio(DeletePortfolioRequest deletePortfolioRequest)

Deletes the specified portfolio. This operation will not work with a portfolio that has been shared with you or if it has products, users, constraints, or shared accounts associated with it.

Specified by:

deletePortfolio in interface AWSServiceCatalog

Parameters:

deletePortfolioRequest -

Returns:

Result of the DeletePortfolio operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InvalidParametersException - One or more parameters provided to the operation are invalid.

ResourceInUseException - The operation was requested against a resource that is currently in use. Free the resource from use and retry the operation.

See Also:

AWS API Documentation

deletePortfolioShare

public DeletePortfolioShareResult deletePortfolioShare(DeletePortfolioShareRequest deletePortfolioShareRequest)

Deletes the specified portfolio share.

Specified by:

deletePortfolioShare in interface AWSServiceCatalog

Parameters:

deletePortfolioShareRequest -

Returns:

Result of the DeletePortfolioShare operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

See Also:

AWS API Documentation

deleteProduct

public DeleteProductResult deleteProduct(DeleteProductRequest deleteProductRequest)

Deletes the specified product. This operation will not work with a product that has been shared with you or is associated with a portfolio.

Specified by:

deleteProduct in interface AWSServiceCatalog

Parameters:

deleteProductRequest -

Returns:

Result of the DeleteProduct operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

ResourceInUseException - The operation was requested against a resource that is currently in use. Free the resource from use and retry the operation.

InvalidParametersException - One or more parameters provided to the operation are invalid.

See Also:

AWS API Documentation

deleteProvisioningArtifact

public DeleteProvisioningArtifactResult deleteProvisioningArtifact(DeleteProvisioningArtifactRequest deleteProvisioningArtifactRequest)

Deletes the specified provisioning artifact. This operation will 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).

Specified by:

deleteProvisioningArtifact in interface AWSServiceCatalog

Parameters:

deleteProvisioningArtifactRequest -

Returns:

Result of the DeleteProvisioningArtifact operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

ResourceInUseException - The operation was requested against a resource that is currently in use. Free the resource from use and retry the operation.

InvalidParametersException - One or more parameters provided to the operation are invalid.

See Also:

AWS API Documentation

describeConstraint

public DescribeConstraintResult describeConstraint(DescribeConstraintRequest describeConstraintRequest)

Retrieves detailed information for a specified constraint.

Specified by:

describeConstraint in interface AWSServiceCatalog

Parameters:

describeConstraintRequest -

Returns:

Result of the DescribeConstraint operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

See Also:

AWS API Documentation

describePortfolio

public DescribePortfolioResult describePortfolio(DescribePortfolioRequest describePortfolioRequest)

Retrieves detailed information and any tags associated with the specified portfolio.

Specified by:

describePortfolio in interface AWSServiceCatalog

Parameters:

describePortfolioRequest -

Returns:

Result of the DescribePortfolio operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

See Also:

AWS API Documentation

describeProduct

public DescribeProductResult describeProduct(DescribeProductRequest describeProductRequest)

Retrieves information about a specified product.

This operation is functionally identical to DescribeProductView except that it takes as input ProductId instead of ProductViewId.

Specified by:

describeProduct in interface AWSServiceCatalog

Parameters:

describeProductRequest -

Returns:

Result of the DescribeProduct operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InvalidParametersException - One or more parameters provided to the operation are invalid.

See Also:

AWS API Documentation

describeProductAsAdmin

public DescribeProductAsAdminResult describeProductAsAdmin(DescribeProductAsAdminRequest describeProductAsAdminRequest)

Retrieves information about a specified product, run with administrator access.

Specified by:

describeProductAsAdmin in interface AWSServiceCatalog

Parameters:

describeProductAsAdminRequest -

Returns:

Result of the DescribeProductAsAdmin operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

See Also:

AWS API Documentation

describeProductView

public DescribeProductViewResult describeProductView(DescribeProductViewRequest describeProductViewRequest)

Retrieves information about a specified product.

This operation is functionally identical to DescribeProduct except that it takes as input ProductViewId instead of ProductId.

Specified by:

describeProductView in interface AWSServiceCatalog

Parameters:

describeProductViewRequest -

Returns:

Result of the DescribeProductView operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InvalidParametersException - One or more parameters provided to the operation are invalid.

See Also:

AWS API Documentation

describeProvisioningArtifact

public DescribeProvisioningArtifactResult describeProvisioningArtifact(DescribeProvisioningArtifactRequest describeProvisioningArtifactRequest)

Retrieves detailed information about the specified provisioning artifact.

Specified by:

describeProvisioningArtifact in interface AWSServiceCatalog

Parameters:

describeProvisioningArtifactRequest -

Returns:

Result of the DescribeProvisioningArtifact operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

See Also:

AWS API Documentation

describeProvisioningParameters

public DescribeProvisioningParametersResult describeProvisioningParameters(DescribeProvisioningParametersRequest describeProvisioningParametersRequest)

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.

Specified by:

describeProvisioningParameters in interface AWSServiceCatalog

Parameters:

describeProvisioningParametersRequest -

Returns:

Result of the DescribeProvisioningParameters operation returned by the service.

Throws:

InvalidParametersException - One or more parameters provided to the operation are invalid.

ResourceNotFoundException - The specified resource was not found.

See Also:

AWS API Documentation

describeRecord

public DescribeRecordResult describeRecord(DescribeRecordRequest describeRecordRequest)

Retrieves a paginated list of the full details of a specific request. Use this operation after calling a request operation (ProvisionProduct, TerminateProvisionedProduct, or UpdateProvisionedProduct).

Specified by:

describeRecord in interface AWSServiceCatalog

Parameters:

describeRecordRequest -

Returns:

Result of the DescribeRecord operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

See Also:

AWS API Documentation

disassociatePrincipalFromPortfolio

public DisassociatePrincipalFromPortfolioResult disassociatePrincipalFromPortfolio(DisassociatePrincipalFromPortfolioRequest disassociatePrincipalFromPortfolioRequest)

Disassociates a previously associated principal ARN from a specified portfolio.

Specified by:

disassociatePrincipalFromPortfolio in interface AWSServiceCatalog

Parameters:

disassociatePrincipalFromPortfolioRequest -

Returns:

Result of the DisassociatePrincipalFromPortfolio operation returned by the service.

Throws:

InvalidParametersException - One or more parameters provided to the operation are invalid.

ResourceNotFoundException - The specified resource was not found.

See Also:

AWS API Documentation

disassociateProductFromPortfolio

public DisassociateProductFromPortfolioResult disassociateProductFromPortfolio(DisassociateProductFromPortfolioRequest disassociateProductFromPortfolioRequest)

Disassociates the specified product from the specified portfolio.

Specified by:

disassociateProductFromPortfolio in interface AWSServiceCatalog

Parameters:

disassociateProductFromPortfolioRequest -

Returns:

Result of the DisassociateProductFromPortfolio operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InvalidParametersException - One or more parameters provided to the operation are invalid.

See Also:

AWS API Documentation

listAcceptedPortfolioShares

public ListAcceptedPortfolioSharesResult listAcceptedPortfolioShares(ListAcceptedPortfolioSharesRequest listAcceptedPortfolioSharesRequest)

Lists details of all portfolios for which sharing was accepted by this account.

Specified by:

listAcceptedPortfolioShares in interface AWSServiceCatalog

Parameters:

listAcceptedPortfolioSharesRequest -

Returns:

Result of the ListAcceptedPortfolioShares operation returned by the service.

Throws:

InvalidParametersException - One or more parameters provided to the operation are invalid.

See Also:

AWS API Documentation

listConstraintsForPortfolio

public ListConstraintsForPortfolioResult listConstraintsForPortfolio(ListConstraintsForPortfolioRequest listConstraintsForPortfolioRequest)

Retrieves detailed constraint information for the specified portfolio and product.

Specified by:

listConstraintsForPortfolio in interface AWSServiceCatalog

Parameters:

listConstraintsForPortfolioRequest -

Returns:

Result of the ListConstraintsForPortfolio operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InvalidParametersException - One or more parameters provided to the operation are invalid.

See Also:

AWS API Documentation

listLaunchPaths

public ListLaunchPathsResult listLaunchPaths(ListLaunchPathsRequest listLaunchPathsRequest)

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.

Specified by:

listLaunchPaths in interface AWSServiceCatalog

Parameters:

listLaunchPathsRequest -

Returns:

Result of the ListLaunchPaths operation returned by the service.

Throws:

InvalidParametersException - One or more parameters provided to the operation are invalid.

ResourceNotFoundException - The specified resource was not found.

See Also:

AWS API Documentation

listPortfolioAccess

public ListPortfolioAccessResult listPortfolioAccess(ListPortfolioAccessRequest listPortfolioAccessRequest)

Lists the account IDs that have been authorized sharing of the specified portfolio.

Specified by:

listPortfolioAccess in interface AWSServiceCatalog

Parameters:

listPortfolioAccessRequest -

Returns:

Result of the ListPortfolioAccess operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

See Also:

AWS API Documentation

listPortfolios

public ListPortfoliosResult listPortfolios(ListPortfoliosRequest listPortfoliosRequest)

Lists all portfolios in the catalog.

Specified by:

listPortfolios in interface AWSServiceCatalog

Parameters:

listPortfoliosRequest -

Returns:

Result of the ListPortfolios operation returned by the service.

Throws:

InvalidParametersException - One or more parameters provided to the operation are invalid.

See Also:

AWS API Documentation

listPortfoliosForProduct

public ListPortfoliosForProductResult listPortfoliosForProduct(ListPortfoliosForProductRequest listPortfoliosForProductRequest)

Lists all portfolios that the specified product is associated with.

Specified by:

listPortfoliosForProduct in interface AWSServiceCatalog

Parameters:

listPortfoliosForProductRequest -

Returns:

Result of the ListPortfoliosForProduct operation returned by the service.

Throws:

InvalidParametersException - One or more parameters provided to the operation are invalid.

ResourceNotFoundException - The specified resource was not found.

See Also:

AWS API Documentation

listPrincipalsForPortfolio

public ListPrincipalsForPortfolioResult listPrincipalsForPortfolio(ListPrincipalsForPortfolioRequest listPrincipalsForPortfolioRequest)

Lists all principal ARNs associated with the specified portfolio.

Specified by:

listPrincipalsForPortfolio in interface AWSServiceCatalog

Parameters:

listPrincipalsForPortfolioRequest -

Returns:

Result of the ListPrincipalsForPortfolio operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InvalidParametersException - One or more parameters provided to the operation are invalid.

See Also:

AWS API Documentation

listProvisioningArtifacts

public ListProvisioningArtifactsResult listProvisioningArtifacts(ListProvisioningArtifactsRequest listProvisioningArtifactsRequest)

Lists all provisioning artifacts associated with the specified product.

Specified by:

listProvisioningArtifacts in interface AWSServiceCatalog

Parameters:

listProvisioningArtifactsRequest -

Returns:

Result of the ListProvisioningArtifacts operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InvalidParametersException - One or more parameters provided to the operation are invalid.

See Also:

AWS API Documentation

listRecordHistory

public ListRecordHistoryResult listRecordHistory(ListRecordHistoryRequest listRecordHistoryRequest)

Returns a paginated list of all performed requests, in the form of RecordDetails objects that are filtered as specified.

Specified by:

listRecordHistory in interface AWSServiceCatalog

Parameters:

listRecordHistoryRequest -

Returns:

Result of the ListRecordHistory operation returned by the service.

Throws:

InvalidParametersException - One or more parameters provided to the operation are invalid.

See Also:

AWS API Documentation

provisionProduct

public ProvisionProductResult provisionProduct(ProvisionProductRequest provisionProductRequest)

Requests a Provision of a specified product. A ProvisionedProduct 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.

Specified by:

provisionProduct in interface AWSServiceCatalog

Parameters:

provisionProductRequest -

Returns:

Result of the ProvisionProduct operation returned by the service.

Throws:

InvalidParametersException - One or more parameters provided to the operation are invalid.

ResourceNotFoundException - The specified resource was not found.

DuplicateResourceException - The specified resource is a duplicate.

See Also:

AWS API Documentation

rejectPortfolioShare

public RejectPortfolioShareResult rejectPortfolioShare(RejectPortfolioShareRequest rejectPortfolioShareRequest)

Rejects an offer to share a portfolio.

Specified by:

rejectPortfolioShare in interface AWSServiceCatalog

Parameters:

rejectPortfolioShareRequest -

Returns:

Result of the RejectPortfolioShare operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

See Also:

AWS API Documentation

scanProvisionedProducts

public ScanProvisionedProductsResult scanProvisionedProducts(ScanProvisionedProductsRequest scanProvisionedProductsRequest)

Returns a paginated list of all the ProvisionedProduct objects that are currently available (not terminated).

Specified by:

scanProvisionedProducts in interface AWSServiceCatalog

Parameters:

scanProvisionedProductsRequest -

Returns:

Result of the ScanProvisionedProducts operation returned by the service.

Throws:

InvalidParametersException - One or more parameters provided to the operation are invalid.

See Also:

AWS API Documentation

searchProducts

public SearchProductsResult searchProducts(SearchProductsRequest searchProductsRequest)

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.

Specified by:

searchProducts in interface AWSServiceCatalog

Parameters:

searchProductsRequest -

Returns:

Result of the SearchProducts operation returned by the service.

Throws:

InvalidParametersException - One or more parameters provided to the operation are invalid.

See Also:

AWS API Documentation

searchProductsAsAdmin

public SearchProductsAsAdminResult searchProductsAsAdmin(SearchProductsAsAdminRequest searchProductsAsAdminRequest)

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.

Specified by:

searchProductsAsAdmin in interface AWSServiceCatalog

Parameters:

searchProductsAsAdminRequest -

Returns:

Result of the SearchProductsAsAdmin operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InvalidParametersException - One or more parameters provided to the operation are invalid.

See Also:

AWS API Documentation

terminateProvisionedProduct

public TerminateProvisionedProductResult terminateProvisionedProduct(TerminateProvisionedProductRequest terminateProvisionedProductRequest)

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.

Specified by:

terminateProvisionedProduct in interface AWSServiceCatalog

Parameters:

terminateProvisionedProductRequest -

Returns:

Result of the TerminateProvisionedProduct operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

See Also:

AWS API Documentation

updateConstraint

public UpdateConstraintResult updateConstraint(UpdateConstraintRequest updateConstraintRequest)

Updates an existing constraint.

Specified by:

updateConstraint in interface AWSServiceCatalog

Parameters:

updateConstraintRequest -

Returns:

Result of the UpdateConstraint operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InvalidParametersException - One or more parameters provided to the operation are invalid.

See Also:

AWS API Documentation

updatePortfolio

public UpdatePortfolioResult updatePortfolio(UpdatePortfolioRequest updatePortfolioRequest)

Updates the specified portfolio's details. This operation will not work with a product that has been shared with you.

Specified by:

updatePortfolio in interface AWSServiceCatalog

Parameters:

updatePortfolioRequest -

Returns:

Result of the UpdatePortfolio operation returned by the service.

Throws:

InvalidParametersException - One or more parameters provided to the operation are invalid.

ResourceNotFoundException - The specified resource was not found.

LimitExceededException - The current limits of the service would have been exceeded by this operation. Reduce the resource use or increase the service limits and retry the operation.

See Also:

AWS API Documentation

updateProduct

public UpdateProductResult updateProduct(UpdateProductRequest updateProductRequest)

Updates an existing product.

Specified by:

updateProduct in interface AWSServiceCatalog

Parameters:

updateProductRequest -

Returns:

Result of the UpdateProduct operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InvalidParametersException - One or more parameters provided to the operation are invalid.

See Also:

AWS API Documentation

updateProvisionedProduct

public UpdateProvisionedProductResult updateProvisionedProduct(UpdateProvisionedProductRequest updateProvisionedProductRequest)

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.

Specified by:

updateProvisionedProduct in interface AWSServiceCatalog

Parameters:

updateProvisionedProductRequest -

Returns:

Result of the UpdateProvisionedProduct operation returned by the service.

Throws:

InvalidParametersException - One or more parameters provided to the operation are invalid.

ResourceNotFoundException - The specified resource was not found.

See Also:

AWS API Documentation

updateProvisioningArtifact

public UpdateProvisioningArtifactResult updateProvisioningArtifact(UpdateProvisioningArtifactRequest updateProvisioningArtifactRequest)

Updates an existing provisioning artifact's information. This operation will not work on a provisioning artifact associated with a product that has been shared with you.

Specified by:

updateProvisioningArtifact in interface AWSServiceCatalog

Parameters:

updateProvisioningArtifactRequest -

Returns:

Result of the UpdateProvisioningArtifact operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource was not found.

InvalidParametersException - One or more parameters provided to the operation are invalid.

See Also:

AWS API Documentation

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

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 the request.

Specified by:

getCachedResponseMetadata in interface AWSServiceCatalog

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.