@aws-sdk/client-service-catalog

Description

AWS SDK for JavaScript ServiceCatalog Client for Node.js, Browser and React Native.

Service Catalog

Service Catalog enables
organizations to create and manage catalogs of IT services that are approved for Amazon Web Services. To
get the most out of this documentation, you should be familiar with the terminology
discussed in Service Catalog
Concepts.

Installing

To install this package, simply type add or install @aws-sdk/client-service-catalog
using your favorite package manager:
- npm install @aws-sdk/client-service-catalog
- yarn add @aws-sdk/client-service-catalog
- pnpm add @aws-sdk/client-service-catalog

Getting Started

$3

The AWS SDK is modulized by clients and commands.
To send a request, you only need to import the ServiceCatalogClient and
the commands you need, for example ListPortfoliosCommand:

``js
// ES5 example
const { ServiceCatalogClient, ListPortfoliosCommand } = require("@aws-sdk/client-service-catalog");
`

`ts
// ES6+ example
import { ServiceCatalogClient, ListPortfoliosCommand } from "@aws-sdk/client-service-catalog";
`

$3

To send a request, you:

- Initiate client with configuration (e.g. credentials, region).
- Initiate command with input parameters.
- Call send operation on client with command object as input.
- If you are using a custom http handler, you may call destroy() to close open connections.

`js
// a client can be shared by different commands.
const client = new ServiceCatalogClient({ region: "REGION" });

const params = { /* input parameters / };
const command = new ListPortfoliosCommand(params);
`

#### Async/await

We recommend using await
operator to wait for the promise returned by send operation as follows:

`js
// async/await.
try {
const data = await client.send(command);
// process data.
} catch (error) {
// error handling.
} finally {
// finally.
}
`

Async-await is clean, concise, intuitive, easy to debug and has better error handling
as compared to using Promise chains or callbacks.

#### Promises

You can also use Promise chaining
to execute send operation.

`js
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
`

Promises can also be called using .catch() and .finally() as follows:

`js
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
`

#### Callbacks

We do not recommend using callbacks because of callback hell,
but they are supported by the send operation.

`js
// callbacks.
client.send(command, (err, data) => {
// process err and data.
});
`

#### v2 compatible style

The client can also send requests using v2 compatible style.
However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
on modular packages in AWS SDK for JavaScript

`ts
import * as AWS from "@aws-sdk/client-service-catalog";
const client = new AWS.ServiceCatalog({ region: "REGION" });

// async/await.
try {
const data = await client.listPortfolios(params);
// process data.
} catch (error) {
// error handling.
}

// Promises.
client
.listPortfolios(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});

// callbacks.
client.listPortfolios(params, (err, data) => {
// process err and data.
});
`

$3

When the service returns an exception, the error will include the exception information,
as well as response metadata (e.g. request id).

`js
try {
const data = await client.send(command);
// process data.
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
/**
* The keys within exceptions are also parsed.
* You can access them by specifying exception names:
* if (error.name === 'SomeServiceException') {
* const value = error.specialKeyInException;
* }
*/
}
`

Getting Help

Please use these community resources for getting help.
We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.

- Visit Developer Guide
or API Reference.
- Check out the blog posts tagged with aws-sdk-js
on AWS Developer Blog.
- Ask a question on StackOverflow and tag it with aws-sdk-js.
- Join the AWS JavaScript community on gitter.
- If it turns out that you may have found a bug, please open an issue.

To test your universal JavaScript code in Node.js, browser and react-native environments,
visit our code samples repo.

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-service-catalog` package is updated.
To contribute to client you can check our generate clients scripts.

License

This SDK is distributed under the
Apache License, Version 2.0,
see LICENSE for more information.

Client Commands (Operations List)

AcceptPortfolioShare

Command API Reference / Input / Output

AssociateBudgetWithResource

Command API Reference / Input / Output

AssociatePrincipalWithPortfolio

Command API Reference / Input / Output

AssociateProductWithPortfolio

Command API Reference / Input / Output

AssociateServiceActionWithProvisioningArtifact

Command API Reference / Input / Output

AssociateTagOptionWithResource

Command API Reference / Input / Output

BatchAssociateServiceActionWithProvisioningArtifact

Command API Reference / Input / Output

BatchDisassociateServiceActionFromProvisioningArtifact

Command API Reference / Input / Output

CopyProduct

Command API Reference / Input / Output

CreateConstraint

Command API Reference / Input / Output

CreatePortfolio

Command API Reference / Input / Output

CreatePortfolioShare

Command API Reference / Input / Output

CreateProduct

Command API Reference / Input / Output

CreateProvisionedProductPlan

Command API Reference / Input / Output

CreateProvisioningArtifact

Command API Reference / Input / Output

CreateServiceAction

Command API Reference / Input / Output

CreateTagOption

Command API Reference / Input / Output

DeleteConstraint

Command API Reference / Input / Output

DeletePortfolio

Command API Reference / Input / Output

DeletePortfolioShare

Command API Reference / Input / Output

DeleteProduct

Command API Reference / Input / Output

DeleteProvisionedProductPlan

Command API Reference / Input / Output

DeleteProvisioningArtifact

Command API Reference / Input / Output

DeleteServiceAction

Command API Reference / Input / Output

DeleteTagOption

Command API Reference / Input / Output

DescribeConstraint

Command API Reference / Input / Output

DescribeCopyProductStatus

Command API Reference / Input / Output

DescribePortfolio

Command API Reference / Input / Output

DescribePortfolioShares

Command API Reference / Input / Output

DescribePortfolioShareStatus

Command API Reference / Input / Output

DescribeProduct

Command API Reference / Input / Output

DescribeProductAsAdmin

Command API Reference / Input / Output

DescribeProductView

Command API Reference / Input / Output

DescribeProvisionedProduct

Command API Reference / Input / Output

DescribeProvisionedProductPlan

Command API Reference / Input / Output

DescribeProvisioningArtifact

Command API Reference / Input / Output

DescribeProvisioningParameters

Command API Reference / Input / Output

DescribeRecord

Command API Reference / Input / Output

DescribeServiceAction

Command API Reference / Input / Output

DescribeServiceActionExecutionParameters

Command API Reference / Input / Output

DescribeTagOption

Command API Reference / Input / Output

DisableAWSOrganizationsAccess

Command API Reference / Input / Output

DisassociateBudgetFromResource

Command API Reference / Input / Output

DisassociatePrincipalFromPortfolio

Command API Reference / Input / Output

DisassociateProductFromPortfolio

Command API Reference / Input / Output

DisassociateServiceActionFromProvisioningArtifact

Command API Reference / Input / Output

DisassociateTagOptionFromResource

Command API Reference / Input / Output

EnableAWSOrganizationsAccess

Command API Reference / Input / Output

ExecuteProvisionedProductPlan

Command API Reference / Input / Output

ExecuteProvisionedProductServiceAction

Command API Reference / Input / Output

GetAWSOrganizationsAccessStatus

Command API Reference / Input / Output

GetProvisionedProductOutputs

Command API Reference / Input / Output

ImportAsProvisionedProduct

Command API Reference / Input / Output

ListAcceptedPortfolioShares

Command API Reference / Input / Output

ListBudgetsForResource

Command API Reference / Input / Output

ListConstraintsForPortfolio

Command API Reference / Input / Output

ListLaunchPaths

Command API Reference / Input / Output

ListOrganizationPortfolioAccess

Command API Reference / Input / Output

ListPortfolioAccess

Command API Reference / Input / Output

ListPortfolios

Command API Reference / Input / Output

ListPortfoliosForProduct

Command API Reference / Input / Output

ListPrincipalsForPortfolio

Command API Reference / Input / Output

ListProvisionedProductPlans

Command API Reference / Input / Output

ListProvisioningArtifacts

Command API Reference / Input / Output

ListProvisioningArtifactsForServiceAction

Command API Reference / Input / Output

ListRecordHistory

Command API Reference / Input / Output

ListResourcesForTagOption

Command API Reference / Input / Output

ListServiceActions

Command API Reference / Input / Output

ListServiceActionsForProvisioningArtifact

Command API Reference / Input / Output

ListStackInstancesForProvisionedProduct

Command API Reference / Input / Output

ListTagOptions

Command API Reference / Input / Output

NotifyProvisionProductEngineWorkflowResult

Command API Reference / Input / Output

NotifyTerminateProvisionedProductEngineWorkflowResult

Command API Reference / Input / Output

NotifyUpdateProvisionedProductEngineWorkflowResult

Command API Reference / Input / Output

ProvisionProduct

Command API Reference / Input / Output

RejectPortfolioShare

Command API Reference / Input / Output

ScanProvisionedProducts

Command API Reference / Input / Output

SearchProducts

Command API Reference / Input / Output

SearchProductsAsAdmin

Command API Reference / Input / Output

SearchProvisionedProducts

Command API Reference / Input / Output

TerminateProvisionedProduct

Command API Reference / Input / Output

UpdateConstraint

Command API Reference / Input / Output

UpdatePortfolio

Command API Reference / Input / Output

UpdatePortfolioShare

Command API Reference / Input / Output

UpdateProduct

Command API Reference / Input / Output

UpdateProvisionedProduct

Command API Reference / Input / Output

UpdateProvisionedProductProperties

Command API Reference / Input / Output

UpdateProvisioningArtifact

Command API Reference / Input / Output

UpdateServiceAction

Command API Reference / Input / Output

UpdateTagOption

Command API Reference / Input / Output