Expand description
AWS Service Catalog enables organizations to create and manage catalogs of IT services that are approved for use on AWS. To get the most out of this documentation, you should be familiar with the terminology discussed in AWS Service Catalog Concepts.
If you’re using the service, you’re probably looking for ServiceCatalogClient and ServiceCatalog.
Structs§
- Accept
Portfolio Share Input - Accept
Portfolio Share Output - Access
Level Filter The access level to use to filter results.
- Associate
Budget With Resource Input - Associate
Budget With Resource Output - Associate
Principal With Portfolio Input - Associate
Principal With Portfolio Output - Associate
Product With Portfolio Input - Associate
Product With Portfolio Output - Associate
Service Action With Provisioning Artifact Input - Associate
Service Action With Provisioning Artifact Output - Associate
TagOption With Resource Input - Associate
TagOption With Resource Output - Batch
Associate Service Action With Provisioning Artifact Input - Batch
Associate Service Action With Provisioning Artifact Output - Batch
Disassociate Service Action From Provisioning Artifact Input - Batch
Disassociate Service Action From Provisioning Artifact Output - Budget
Detail Information about a budget.
- Cloud
Watch Dashboard Information about a CloudWatch dashboard.
- Constraint
Detail Information about a constraint.
- Constraint
Summary Summary information about a constraint.
- Copy
Product Input - Copy
Product Output - Create
Constraint Input - Create
Constraint Output - Create
Portfolio Input - Create
Portfolio Output - Create
Portfolio Share Input - Create
Portfolio Share Output - Create
Product Input - Create
Product Output - Create
Provisioned Product Plan Input - Create
Provisioned Product Plan Output - Create
Provisioning Artifact Input - Create
Provisioning Artifact Output - Create
Service Action Input - Create
Service Action Output - Create
TagOption Input - Create
TagOption Output - Delete
Constraint Input - Delete
Constraint Output - Delete
Portfolio Input - Delete
Portfolio Output - Delete
Portfolio Share Input - Delete
Portfolio Share Output - Delete
Product Input - Delete
Product Output - Delete
Provisioned Product Plan Input - Delete
Provisioned Product Plan Output - Delete
Provisioning Artifact Input - Delete
Provisioning Artifact Output - Delete
Service Action Input - Delete
Service Action Output - Delete
TagOption Input - Delete
TagOption Output - Describe
Constraint Input - Describe
Constraint Output - Describe
Copy Product Status Input - Describe
Copy Product Status Output - Describe
Portfolio Input - Describe
Portfolio Output - Describe
Portfolio Share Status Input - Describe
Portfolio Share Status Output - Describe
Product AsAdmin Input - Describe
Product AsAdmin Output - Describe
Product Input - Describe
Product Output - Describe
Product View Input - Describe
Product View Output - Describe
Provisioned Product Input - Describe
Provisioned Product Output - Describe
Provisioned Product Plan Input - Describe
Provisioned Product Plan Output - Describe
Provisioning Artifact Input - Describe
Provisioning Artifact Output - Describe
Provisioning Parameters Input - Describe
Provisioning Parameters Output - Describe
Record Input - Describe
Record Output - Describe
Service Action Execution Parameters Input - Describe
Service Action Execution Parameters Output - Describe
Service Action Input - Describe
Service Action Output - Describe
TagOption Input - Describe
TagOption Output - DisableAWS
Organizations Access Input - DisableAWS
Organizations Access Output - Disassociate
Budget From Resource Input - Disassociate
Budget From Resource Output - Disassociate
Principal From Portfolio Input - Disassociate
Principal From Portfolio Output - Disassociate
Product From Portfolio Input - Disassociate
Product From Portfolio Output - Disassociate
Service Action From Provisioning Artifact Input - Disassociate
Service Action From Provisioning Artifact Output - Disassociate
TagOption From Resource Input - Disassociate
TagOption From Resource Output - EnableAWS
Organizations Access Input - EnableAWS
Organizations Access Output - Execute
Provisioned Product Plan Input - Execute
Provisioned Product Plan Output - Execute
Provisioned Product Service Action Input - Execute
Provisioned Product Service Action Output - Execution
Parameter Details of an execution parameter value that is passed to a self-service action when executed on a provisioned product.
- Failed
Service Action Association An object containing information about the error, along with identifying information about the self-service action and its associations.
- GetAWS
Organizations Access Status Input - GetAWS
Organizations Access Status Output - Launch
Path A launch path object.
- Launch
Path Summary Summary information about a product path for a user.
- List
Accepted Portfolio Shares Input - List
Accepted Portfolio Shares Output - List
Budgets ForResource Input - List
Budgets ForResource Output - List
Constraints ForPortfolio Input - List
Constraints ForPortfolio Output - List
Launch Paths Input - List
Launch Paths Output - List
Organization Portfolio Access Input - List
Organization Portfolio Access Output - List
Portfolio Access Input - List
Portfolio Access Output - List
Portfolios ForProduct Input - List
Portfolios ForProduct Output - List
Portfolios Input - List
Portfolios Output - List
Principals ForPortfolio Input - List
Principals ForPortfolio Output - List
Provisioned Product Plans Input - List
Provisioned Product Plans Output - List
Provisioning Artifacts ForService Action Input - List
Provisioning Artifacts ForService Action Output - List
Provisioning Artifacts Input - List
Provisioning Artifacts Output - List
Record History Input - List
Record History Output - List
Record History Search Filter The search filter to use when listing history records.
- List
Resources ForTag Option Input - List
Resources ForTag Option Output - List
Service Actions ForProvisioning Artifact Input - List
Service Actions ForProvisioning Artifact Output - List
Service Actions Input - List
Service Actions Output - List
Stack Instances ForProvisioned Product Input - List
Stack Instances ForProvisioned Product Output - List
TagOptions Filters Filters to use when listing TagOptions.
- List
TagOptions Input - List
TagOptions Output - Organization
Node Information about the organization node.
- Parameter
Constraints The constraints that the administrator has put on the parameter.
- Portfolio
Detail Information about a portfolio.
- Principal
Information about a principal.
- Product
View Aggregation Value A single product view aggregation value/count pair, containing metadata about each product to which the calling user has access.
- Product
View Detail Information about a product view.
- Product
View Summary Summary information about a product view.
- Provision
Product Input - Provision
Product Output - Provisioned
Product Attribute Information about a provisioned product.
- Provisioned
Product Detail Information about a provisioned product.
- Provisioned
Product Plan Details Information about a plan.
- Provisioned
Product Plan Summary Summary information about a plan.
- Provisioning
Artifact Information about a provisioning artifact. A provisioning artifact is also known as a product version.
- Provisioning
Artifact Detail Information about a provisioning artifact (also known as a version) for a product.
- Provisioning
Artifact Parameter Information about a parameter used to provision a product.
- Provisioning
Artifact Preferences The user-defined preferences that will be applied during product provisioning, unless overridden by
ProvisioningPreferencesorUpdateProvisioningPreferences.For more information on maximum concurrent accounts and failure tolerance, see Stack set operation options in the AWS CloudFormation User Guide.
- Provisioning
Artifact Properties Information about a provisioning artifact (also known as a version) for a product.
- Provisioning
Artifact Summary Summary information about a provisioning artifact (also known as a version) for a product.
- Provisioning
Artifact View An object that contains summary information about a product view and a provisioning artifact.
- Provisioning
Parameter Information about a parameter used to provision a product.
- Provisioning
Preferences The user-defined preferences that will be applied when updating a provisioned product. Not all preferences are applicable to all provisioned product types.
- Record
Detail Information about a request operation.
- Record
Error The error code and description resulting from an operation.
- Record
Output The output for the product created as the result of a request. For example, the output for a CloudFormation-backed product that creates an S3 bucket would include the S3 bucket URL.
- Record
Tag Information about a tag, which is a key-value pair.
- Reject
Portfolio Share Input - Reject
Portfolio Share Output - Resource
Change Information about a resource change that will occur when a plan is executed.
- Resource
Change Detail Information about a change to a resource attribute.
- Resource
Detail Information about a resource.
- Resource
Target Definition Information about a change to a resource attribute.
- Scan
Provisioned Products Input - Scan
Provisioned Products Output - Search
Products AsAdmin Input - Search
Products AsAdmin Output - Search
Products Input - Search
Products Output - Search
Provisioned Products Input - Search
Provisioned Products Output - Service
Action Association A self-service action association consisting of the Action ID, the Product ID, and the Provisioning Artifact ID.
- Service
Action Detail An object containing detailed information about the self-service action.
- Service
Action Summary Detailed information about the self-service action.
- Service
Catalog Client - A client for the AWS Service Catalog API.
- Share
Details Information about the portfolio share operation.
- Share
Error Errors that occurred during the portfolio share operation.
- Stack
Instance An AWS CloudFormation stack, in a specific account and region, that's part of a stack set operation. A stack instance is a reference to an attempted or actual stack in a given account within a given region. A stack instance can exist without a stack—for example, if the stack couldn't be created for some reason. A stack instance is associated with only one stack set. Each stack instance contains the ID of its associated stack set, as well as the ID of the actual stack and the stack status.
- Tag
Information about a tag. A tag is a key-value pair. Tags are propagated to the resources created when provisioning a product.
- TagOption
Detail Information about a TagOption.
- TagOption
Summary Summary information about a TagOption.
- Terminate
Provisioned Product Input - Terminate
Provisioned Product Output - Update
Constraint Input - Update
Constraint Output - Update
Portfolio Input - Update
Portfolio Output - Update
Product Input - Update
Product Output - Update
Provisioned Product Input - Update
Provisioned Product Output - Update
Provisioned Product Properties Input - Update
Provisioned Product Properties Output - Update
Provisioning Artifact Input - Update
Provisioning Artifact Output - Update
Provisioning Parameter The parameter key-value pair used to update a provisioned product.
- Update
Provisioning Preferences The user-defined preferences that will be applied when updating a provisioned product. Not all preferences are applicable to all provisioned product types.
- Update
Service Action Input - Update
Service Action Output - Update
TagOption Input - Update
TagOption Output - Usage
Instruction Additional information provided by the administrator.
Enums§
- Accept
Portfolio Share Error - Errors returned by AcceptPortfolioShare
- Associate
Budget With Resource Error - Errors returned by AssociateBudgetWithResource
- Associate
Principal With Portfolio Error - Errors returned by AssociatePrincipalWithPortfolio
- Associate
Product With Portfolio Error - Errors returned by AssociateProductWithPortfolio
- Associate
Service Action With Provisioning Artifact Error - Errors returned by AssociateServiceActionWithProvisioningArtifact
- Associate
TagOption With Resource Error - Errors returned by AssociateTagOptionWithResource
- Batch
Associate Service Action With Provisioning Artifact Error - Errors returned by BatchAssociateServiceActionWithProvisioningArtifact
- Batch
Disassociate Service Action From Provisioning Artifact Error - Errors returned by BatchDisassociateServiceActionFromProvisioningArtifact
- Copy
Product Error - Errors returned by CopyProduct
- Create
Constraint Error - Errors returned by CreateConstraint
- Create
Portfolio Error - Errors returned by CreatePortfolio
- Create
Portfolio Share Error - Errors returned by CreatePortfolioShare
- Create
Product Error - Errors returned by CreateProduct
- Create
Provisioned Product Plan Error - Errors returned by CreateProvisionedProductPlan
- Create
Provisioning Artifact Error - Errors returned by CreateProvisioningArtifact
- Create
Service Action Error - Errors returned by CreateServiceAction
- Create
TagOption Error - Errors returned by CreateTagOption
- Delete
Constraint Error - Errors returned by DeleteConstraint
- Delete
Portfolio Error - Errors returned by DeletePortfolio
- Delete
Portfolio Share Error - Errors returned by DeletePortfolioShare
- Delete
Product Error - Errors returned by DeleteProduct
- Delete
Provisioned Product Plan Error - Errors returned by DeleteProvisionedProductPlan
- Delete
Provisioning Artifact Error - Errors returned by DeleteProvisioningArtifact
- Delete
Service Action Error - Errors returned by DeleteServiceAction
- Delete
TagOption Error - Errors returned by DeleteTagOption
- Describe
Constraint Error - Errors returned by DescribeConstraint
- Describe
Copy Product Status Error - Errors returned by DescribeCopyProductStatus
- Describe
Portfolio Error - Errors returned by DescribePortfolio
- Describe
Portfolio Share Status Error - Errors returned by DescribePortfolioShareStatus
- Describe
Product AsAdmin Error - Errors returned by DescribeProductAsAdmin
- Describe
Product Error - Errors returned by DescribeProduct
- Describe
Product View Error - Errors returned by DescribeProductView
- Describe
Provisioned Product Error - Errors returned by DescribeProvisionedProduct
- Describe
Provisioned Product Plan Error - Errors returned by DescribeProvisionedProductPlan
- Describe
Provisioning Artifact Error - Errors returned by DescribeProvisioningArtifact
- Describe
Provisioning Parameters Error - Errors returned by DescribeProvisioningParameters
- Describe
Record Error - Errors returned by DescribeRecord
- Describe
Service Action Error - Errors returned by DescribeServiceAction
- Describe
Service Action Execution Parameters Error - Errors returned by DescribeServiceActionExecutionParameters
- Describe
TagOption Error - Errors returned by DescribeTagOption
- DisableAWS
Organizations Access Error - Errors returned by DisableAWSOrganizationsAccess
- Disassociate
Budget From Resource Error - Errors returned by DisassociateBudgetFromResource
- Disassociate
Principal From Portfolio Error - Errors returned by DisassociatePrincipalFromPortfolio
- Disassociate
Product From Portfolio Error - Errors returned by DisassociateProductFromPortfolio
- Disassociate
Service Action From Provisioning Artifact Error - Errors returned by DisassociateServiceActionFromProvisioningArtifact
- Disassociate
TagOption From Resource Error - Errors returned by DisassociateTagOptionFromResource
- EnableAWS
Organizations Access Error - Errors returned by EnableAWSOrganizationsAccess
- Execute
Provisioned Product Plan Error - Errors returned by ExecuteProvisionedProductPlan
- Execute
Provisioned Product Service Action Error - Errors returned by ExecuteProvisionedProductServiceAction
- GetAWS
Organizations Access Status Error - Errors returned by GetAWSOrganizationsAccessStatus
- List
Accepted Portfolio Shares Error - Errors returned by ListAcceptedPortfolioShares
- List
Budgets ForResource Error - Errors returned by ListBudgetsForResource
- List
Constraints ForPortfolio Error - Errors returned by ListConstraintsForPortfolio
- List
Launch Paths Error - Errors returned by ListLaunchPaths
- List
Organization Portfolio Access Error - Errors returned by ListOrganizationPortfolioAccess
- List
Portfolio Access Error - Errors returned by ListPortfolioAccess
- List
Portfolios Error - Errors returned by ListPortfolios
- List
Portfolios ForProduct Error - Errors returned by ListPortfoliosForProduct
- List
Principals ForPortfolio Error - Errors returned by ListPrincipalsForPortfolio
- List
Provisioned Product Plans Error - Errors returned by ListProvisionedProductPlans
- List
Provisioning Artifacts Error - Errors returned by ListProvisioningArtifacts
- List
Provisioning Artifacts ForService Action Error - Errors returned by ListProvisioningArtifactsForServiceAction
- List
Record History Error - Errors returned by ListRecordHistory
- List
Resources ForTag Option Error - Errors returned by ListResourcesForTagOption
- List
Service Actions Error - Errors returned by ListServiceActions
- List
Service Actions ForProvisioning Artifact Error - Errors returned by ListServiceActionsForProvisioningArtifact
- List
Stack Instances ForProvisioned Product Error - Errors returned by ListStackInstancesForProvisionedProduct
- List
TagOptions Error - Errors returned by ListTagOptions
- Provision
Product Error - Errors returned by ProvisionProduct
- Reject
Portfolio Share Error - Errors returned by RejectPortfolioShare
- Scan
Provisioned Products Error - Errors returned by ScanProvisionedProducts
- Search
Products AsAdmin Error - Errors returned by SearchProductsAsAdmin
- Search
Products Error - Errors returned by SearchProducts
- Search
Provisioned Products Error - Errors returned by SearchProvisionedProducts
- Terminate
Provisioned Product Error - Errors returned by TerminateProvisionedProduct
- Update
Constraint Error - Errors returned by UpdateConstraint
- Update
Portfolio Error - Errors returned by UpdatePortfolio
- Update
Product Error - Errors returned by UpdateProduct
- Update
Provisioned Product Error - Errors returned by UpdateProvisionedProduct
- Update
Provisioned Product Properties Error - Errors returned by UpdateProvisionedProductProperties
- Update
Provisioning Artifact Error - Errors returned by UpdateProvisioningArtifact
- Update
Service Action Error - Errors returned by UpdateServiceAction
- Update
TagOption Error - Errors returned by UpdateTagOption
Traits§
- Service
Catalog - Trait representing the capabilities of the AWS Service Catalog API. AWS Service Catalog clients implement this trait.