You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::ServiceCatalog::Client

Inherits:

Seahorse::Client::Base

Object
Seahorse::Client::Base
Aws::ServiceCatalog::Client

show all

Includes:: ClientStubs

Defined in:: gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

#accept_portfolio_share(params = {}) ⇒ Struct
Accepts an offer to share the specified portfolio.
#associate_principal_with_portfolio(params = {}) ⇒ Struct
Associates the specified principal ARN with the specified portfolio.
#associate_product_with_portfolio(params = {}) ⇒ Struct
Associates the specified product with the specified portfolio.
#associate_tag_option_with_resource(params = {}) ⇒ Struct
Associate the specified TagOption with the specified portfolio or product.
#copy_product(params = {}) ⇒ Types::CopyProductOutput
Copies the specified source product to the specified target product or a new product.
#create_constraint(params = {}) ⇒ Types::CreateConstraintOutput
Creates a constraint.
#create_portfolio(params = {}) ⇒ Types::CreatePortfolioOutput
Creates a portfolio.
#create_portfolio_share(params = {}) ⇒ Struct
Shares the specified portfolio with the specified account.
#create_product(params = {}) ⇒ Types::CreateProductOutput
Creates a product.
#create_provisioned_product_plan(params = {}) ⇒ Types::CreateProvisionedProductPlanOutput
Creates a plan.
#create_provisioning_artifact(params = {}) ⇒ Types::CreateProvisioningArtifactOutput
Creates a provisioning artifact (also known as a version) for the specified product.
#create_tag_option(params = {}) ⇒ Types::CreateTagOptionOutput
Creates a TagOption.
#delete_constraint(params = {}) ⇒ Struct
Deletes the specified constraint.
#delete_portfolio(params = {}) ⇒ Struct
Deletes the specified portfolio.
#delete_portfolio_share(params = {}) ⇒ Struct
Stops sharing the specified portfolio with the specified account.
#delete_product(params = {}) ⇒ Struct
Deletes the specified product.
#delete_provisioned_product_plan(params = {}) ⇒ Struct
Deletes the specified plan.
#delete_provisioning_artifact(params = {}) ⇒ Struct
Deletes the specified provisioning artifact (also known as a version) for the specified product.
#delete_tag_option(params = {}) ⇒ Struct
Deletes the specified TagOption.
#describe_constraint(params = {}) ⇒ Types::DescribeConstraintOutput
Gets information about the specified constraint.
#describe_copy_product_status(params = {}) ⇒ Types::DescribeCopyProductStatusOutput
Gets the status of the specified copy product operation.
#describe_portfolio(params = {}) ⇒ Types::DescribePortfolioOutput
Gets information about the specified portfolio.
#describe_product(params = {}) ⇒ Types::DescribeProductOutput
Gets information about the specified product.
#describe_product_as_admin(params = {}) ⇒ Types::DescribeProductAsAdminOutput
Gets information about the specified product.
#describe_product_view(params = {}) ⇒ Types::DescribeProductViewOutput
Gets information about the specified product.
#describe_provisioned_product(params = {}) ⇒ Types::DescribeProvisionedProductOutput
Gets information about the specified provisioned product.
#describe_provisioned_product_plan(params = {}) ⇒ Types::DescribeProvisionedProductPlanOutput
Gets information about the resource changes for the specified plan.
#describe_provisioning_artifact(params = {}) ⇒ Types::DescribeProvisioningArtifactOutput
Gets information about the specified provisioning artifact (also known as a version) for the specified product.
#describe_provisioning_parameters(params = {}) ⇒ Types::DescribeProvisioningParametersOutput
Gets information about the configuration required to provision the specified product using the specified provisioning artifact.
#describe_record(params = {}) ⇒ Types::DescribeRecordOutput
Gets information about the specified request operation.
#describe_tag_option(params = {}) ⇒ Types::DescribeTagOptionOutput
Gets information about the specified TagOption.
#disassociate_principal_from_portfolio(params = {}) ⇒ Struct
Disassociates a previously associated principal ARN from a specified portfolio.
#disassociate_product_from_portfolio(params = {}) ⇒ Struct
Disassociates the specified product from the specified portfolio.
#disassociate_tag_option_from_resource(params = {}) ⇒ Struct
Disassociates the specified TagOption from the specified resource.
#execute_provisioned_product_plan(params = {}) ⇒ Types::ExecuteProvisionedProductPlanOutput
Provisions or modifies a product based on the resource changes for the specified plan.
#list_accepted_portfolio_shares(params = {}) ⇒ Types::ListAcceptedPortfolioSharesOutput
Lists all portfolios for which sharing was accepted by this account.
#list_constraints_for_portfolio(params = {}) ⇒ Types::ListConstraintsForPortfolioOutput
Lists the constraints for the specified portfolio and product.
#list_launch_paths(params = {}) ⇒ Types::ListLaunchPathsOutput
Lists the paths to the specified product.
#list_portfolio_access(params = {}) ⇒ Types::ListPortfolioAccessOutput
Lists the account IDs that have access to the specified portfolio.
#list_portfolios(params = {}) ⇒ Types::ListPortfoliosOutput
Lists all portfolios in the catalog.
#list_portfolios_for_product(params = {}) ⇒ Types::ListPortfoliosForProductOutput
Lists all portfolios that the specified product is associated with.
#list_principals_for_portfolio(params = {}) ⇒ Types::ListPrincipalsForPortfolioOutput
Lists all principal ARNs associated with the specified portfolio.
#list_provisioned_product_plans(params = {}) ⇒ Types::ListProvisionedProductPlansOutput
Lists the plans for the specified provisioned product or all plans to which the user has access.
#list_provisioning_artifacts(params = {}) ⇒ Types::ListProvisioningArtifactsOutput
Lists all provisioning artifacts (also known as versions) for the specified product.
#list_record_history(params = {}) ⇒ Types::ListRecordHistoryOutput
Lists the specified requests or all performed requests.
#list_resources_for_tag_option(params = {}) ⇒ Types::ListResourcesForTagOptionOutput
Lists the resources associated with the specified TagOption.
#list_tag_options(params = {}) ⇒ Types::ListTagOptionsOutput
Lists the specified TagOptions or all TagOptions.
#provision_product(params = {}) ⇒ Types::ProvisionProductOutput
Provisions the specified product.
#reject_portfolio_share(params = {}) ⇒ Struct
Rejects an offer to share the specified portfolio.
#scan_provisioned_products(params = {}) ⇒ Types::ScanProvisionedProductsOutput
Lists the provisioned products that are available (not terminated).
#search_products(params = {}) ⇒ Types::SearchProductsOutput
Gets information about the products to which the caller has access.
#search_products_as_admin(params = {}) ⇒ Types::SearchProductsAsAdminOutput
Gets information about the products for the specified portfolio or all products.
#search_provisioned_products(params = {}) ⇒ Types::SearchProvisionedProductsOutput
Gets information about the provisioned products that meet the specified criteria.
#terminate_provisioned_product(params = {}) ⇒ Types::TerminateProvisionedProductOutput
Terminates the specified provisioned product.
#update_constraint(params = {}) ⇒ Types::UpdateConstraintOutput
Updates the specified constraint.
#update_portfolio(params = {}) ⇒ Types::UpdatePortfolioOutput
Updates the specified portfolio.
#update_product(params = {}) ⇒ Types::UpdateProductOutput
Updates the specified product.
#update_provisioned_product(params = {}) ⇒ Types::UpdateProvisionedProductOutput
Requests updates to the configuration of the specified provisioned product.
#update_provisioning_artifact(params = {}) ⇒ Types::UpdateProvisioningArtifactOutput
Updates the specified provisioning artifact (also known as a version) for the specified product.
#update_tag_option(params = {}) ⇒ Types::UpdateTagOptionOutput
Updates the specified TagOption.

Instance Method Summary collapse

#initialize(*args) ⇒ Client constructor
A new instance of Client.

Constructor Details

#initialize(*args) ⇒ `Client`

Returns a new instance of Client

Parameters:

options (Hash) —
a customizable set of options



163
164
165

# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 163

def initialize(*args)
  super
end

Instance Method Details

#accept_portfolio_share(params = {}) ⇒ `Struct`

Accepts an offer to share the specified portfolio.

Examples:

Request syntax with placeholder values


resp = client.accept_portfolio_share({
  accept_language: "AcceptLanguage",
  portfolio_id: "Id", # required
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:accept_language (String) —
The language code.
- en - English (default)
- jp - Japanese
- zh - Chinese
:portfolio_id (required, String) —
The portfolio identifier.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 196

def accept_portfolio_share(params = {}, options = {})
  req = build_request(:accept_portfolio_share, params)
  req.send_request(options)
end

#associate_principal_with_portfolio(params = {}) ⇒ `Struct`

Associates the specified principal ARN with the specified portfolio.

Examples:

Request syntax with placeholder values


resp = client.associate_principal_with_portfolio({
  accept_language: "AcceptLanguage",
  portfolio_id: "Id", # required
  principal_arn: "PrincipalARN", # required
  principal_type: "IAM", # required, accepts IAM
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:accept_language (String) —
The language code.
- en - English (default)
- jp - Japanese
- zh - Chinese
:portfolio_id (required, String) —
The portfolio identifier.
:principal_arn (required, String) —
The ARN of the principal (IAM user, role, or group).
:principal_type (required, String) —
The principal type. The supported value is IAM.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 236

def associate_principal_with_portfolio(params = {}, options = {})
  req = build_request(:associate_principal_with_portfolio, params)
  req.send_request(options)
end

#associate_product_with_portfolio(params = {}) ⇒ `Struct`

Associates the specified product with the specified portfolio.

Examples:

Request syntax with placeholder values


resp = client.associate_product_with_portfolio({
  accept_language: "AcceptLanguage",
  product_id: "Id", # required
  portfolio_id: "Id", # required
  source_portfolio_id: "Id",
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:accept_language (String) —
The language code.
- en - English (default)
- jp - Japanese
- zh - Chinese
:product_id (required, String) —
The product identifier.
:portfolio_id (required, String) —
The portfolio identifier.
:source_portfolio_id (String) —
The identifier of the source portfolio.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 276

def associate_product_with_portfolio(params = {}, options = {})
  req = build_request(:associate_product_with_portfolio, params)
  req.send_request(options)
end

#associate_tag_option_with_resource(params = {}) ⇒ `Struct`

Associate the specified TagOption with the specified portfolio or product.

Examples:

Request syntax with placeholder values


resp = client.associate_tag_option_with_resource({
  resource_id: "ResourceId", # required
  tag_option_id: "TagOptionId", # required
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:resource_id (required, String) —
The resource identifier.
:tag_option_id (required, String) —
The TagOption identifier.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 303

def associate_tag_option_with_resource(params = {}, options = {})
  req = build_request(:associate_tag_option_with_resource, params)
  req.send_request(options)
end

#copy_product(params = {}) ⇒ `Types::CopyProductOutput`

Copies the specified source product to the specified target product or a new product.

You can copy a product to the same account or another account. You can copy a product to the same region or another region.

This operation is performed asynchronously. To track the progress of the operation, use DescribeCopyProductStatus.

Examples:

Request syntax with placeholder values


resp = client.copy_product({
  accept_language: "AcceptLanguage",
  source_product_arn: "ProductArn", # required
  target_product_id: "Id",
  target_product_name: "ProductViewName",
  source_provisioning_artifact_identifiers: [
    {
      "Id" => "ProvisioningArtifactPropertyValue",
    },
  ],
  copy_options: ["CopyTags"], # accepts CopyTags
  idempotency_token: "IdempotencyToken", # required
})

Response structure


resp.copy_product_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:accept_language (String) —
The language code.
- en - English (default)
- jp - Japanese
- zh - Chinese
:source_product_arn (required, String) —
The Amazon Resource Name (ARN) of the source product.
:target_product_id (String) —
The identifier of the target product. By default, a new product is created.
:target_product_name (String) —
A name for the target product. The default is the name of the source product.
:source_provisioning_artifact_identifiers (Array<Hash>) —
The identifiers of the provisioning artifacts (also known as versions) of the product to copy. By default, all provisioning artifacts are copied.
:copy_options (Array<String>) —
The copy options. If the value is CopyTags, the tags from the source product are copied to the target product.
:idempotency_token (required, String) —
A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

(Types::CopyProductOutput) —
Returns a response object which responds to the following methods:
- #copy_product_token => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 382

def copy_product(params = {}, options = {})
  req = build_request(:copy_product, params)
  req.send_request(options)
end

#create_constraint(params = {}) ⇒ `Types::CreateConstraintOutput`

Creates a constraint.

Examples:

Request syntax with placeholder values


resp = client.create_constraint({
  accept_language: "AcceptLanguage",
  portfolio_id: "Id", # required
  product_id: "Id", # required
  parameters: "ConstraintParameters", # required
  type: "ConstraintType", # required
  description: "ConstraintDescription",
  idempotency_token: "IdempotencyToken", # required
})

Response structure


resp.constraint_detail.constraint_id #=> String
resp.constraint_detail.type #=> String
resp.constraint_detail.description #=> String
resp.constraint_detail.owner #=> String
resp.constraint_parameters #=> String
resp.status #=> String, one of "AVAILABLE", "CREATING", "FAILED"

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:accept_language (String) —
The language code.
- en - English (default)
- jp - Japanese
- zh - Chinese
:portfolio_id (required, String) —
The portfolio identifier.
:product_id (required, String) —
The product identifier.
:parameters (required, String) —
The constraint parameters, in JSON format. The syntax depends on the constraint type as follows:

LAUNCH

Specify the RoleArn property as follows:

\"RoleArn\" : \"arn:aws:iam::123456789012:role/LaunchRole\"

NOTIFICATION

Specify the NotificationArns property as follows:

\"NotificationArns\" : [\"arn:aws:sns:us-east-1:123456789012:Topic\"]

TEMPLATE

Specify the Rules property. For more information, see Template Constraint Rules.
:type (required, String) —
The type of constraint.
- LAUNCH
- NOTIFICATION
- TEMPLATE
:description (String) —
The description of the constraint.
:idempotency_token (required, String) —
A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

(Types::CreateConstraintOutput) —
Returns a response object which responds to the following methods:
- #constraint_detail => Types::ConstraintDetail
- #constraint_parameters => String
- #status => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 481

def create_constraint(params = {}, options = {})
  req = build_request(:create_constraint, params)
  req.send_request(options)
end

#create_portfolio(params = {}) ⇒ `Types::CreatePortfolioOutput`

Creates a portfolio.

Examples:

Request syntax with placeholder values


resp = client.create_portfolio({
  accept_language: "AcceptLanguage",
  display_name: "PortfolioDisplayName", # required
  description: "PortfolioDescription",
  provider_name: "ProviderName", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  idempotency_token: "IdempotencyToken", # required
})

Response structure


resp.portfolio_detail.id #=> String
resp.portfolio_detail.arn #=> String
resp.portfolio_detail.display_name #=> String
resp.portfolio_detail.description #=> String
resp.portfolio_detail.created_time #=> Time
resp.portfolio_detail.provider_name #=> String
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:accept_language (String) —
The language code.
- en - English (default)
- jp - Japanese
- zh - Chinese
:display_name (required, String) —
The name to use for display purposes.
:description (String) —
The description of the portfolio.
:provider_name (required, String) —
The name of the portfolio provider.
:tags (Array<Types::Tag>) —
One or more tags.
:idempotency_token (required, String) —
A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

(Types::CreatePortfolioOutput) —
Returns a response object which responds to the following methods:
- #portfolio_detail => Types::PortfolioDetail
- #tags => Array<Types::Tag>

See Also:

AWS API Documentation

# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 554

def create_portfolio(params = {}, options = {})
  req = build_request(:create_portfolio, params)
  req.send_request(options)
end

#create_portfolio_share(params = {}) ⇒ `Struct`

Shares the specified portfolio with the specified account.

Examples:

Request syntax with placeholder values


resp = client.create_portfolio_share({
  accept_language: "AcceptLanguage",
  portfolio_id: "Id", # required
  account_id: "AccountId", # required
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:accept_language (String) —
The language code.
- en - English (default)
- jp - Japanese
- zh - Chinese
:portfolio_id (required, String) —
The portfolio identifier.
:account_id (required, String) —
The AWS account ID.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 590

def create_portfolio_share(params = {}, options = {})
  req = build_request(:create_portfolio_share, params)
  req.send_request(options)
end

#create_product(params = {}) ⇒ `Types::CreateProductOutput`

Creates a product.

Examples:

Request syntax with placeholder values


resp = client.create_product({
  accept_language: "AcceptLanguage",
  name: "ProductViewName", # required
  owner: "ProductViewOwner", # required
  description: "ProductViewShortDescription",
  distributor: "ProductViewOwner",
  support_description: "SupportDescription",
  support_email: "SupportEmail",
  support_url: "SupportUrl",
  product_type: "CLOUD_FORMATION_TEMPLATE", # required, accepts CLOUD_FORMATION_TEMPLATE, MARKETPLACE
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  provisioning_artifact_parameters: { # required
    name: "ProvisioningArtifactName",
    description: "ProvisioningArtifactDescription",
    info: { # required
      "ProvisioningArtifactInfoKey" => "ProvisioningArtifactInfoValue",
    },
    type: "CLOUD_FORMATION_TEMPLATE", # accepts CLOUD_FORMATION_TEMPLATE, MARKETPLACE_AMI, MARKETPLACE_CAR
  },
  idempotency_token: "IdempotencyToken", # required
})

Response structure


resp.product_view_detail.product_view_summary.id #=> String
resp.product_view_detail.product_view_summary.product_id #=> String
resp.product_view_detail.product_view_summary.name #=> String
resp.product_view_detail.product_view_summary.owner #=> String
resp.product_view_detail.product_view_summary.short_description #=> String
resp.product_view_detail.product_view_summary.type #=> String, one of "CLOUD_FORMATION_TEMPLATE", "MARKETPLACE"
resp.product_view_detail.product_view_summary.distributor #=> String
resp.product_view_detail.product_view_summary.has_default_path #=> Boolean
resp.product_view_detail.product_view_summary.support_email #=> String
resp.product_view_detail.product_view_summary.support_description #=> String
resp.product_view_detail.product_view_summary.support_url #=> String
resp.product_view_detail.status #=> String, one of "AVAILABLE", "CREATING", "FAILED"
resp.product_view_detail.product_arn #=> String
resp.product_view_detail.created_time #=> Time
resp.provisioning_artifact_detail.id #=> String
resp.provisioning_artifact_detail.name #=> String
resp.provisioning_artifact_detail.description #=> String
resp.provisioning_artifact_detail.type #=> String, one of "CLOUD_FORMATION_TEMPLATE", "MARKETPLACE_AMI", "MARKETPLACE_CAR"
resp.provisioning_artifact_detail.created_time #=> Time
resp.provisioning_artifact_detail.active #=> Boolean
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:accept_language (String) —
The language code.
- en - English (default)
- jp - Japanese
- zh - Chinese
:name (required, String) —
The name of the product.
:owner (required, String) —
The owner of the product.
:description (String) —
The description of the product.
:distributor (String) —
The distributor of the product.
:support_description (String) —
The support information about the product.
:support_email (String) —
The contact email for product support.
:support_url (String) —
The contact URL for product support.
:product_type (required, String) —
The type of product.
:tags (Array<Types::Tag>) —
One or more tags.
:provisioning_artifact_parameters (required, Types::ProvisioningArtifactProperties) —
The configuration of the provisioning artifact.
:idempotency_token (required, String) —
A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

(Types::CreateProductOutput) —
Returns a response object which responds to the following methods:
- #product_view_detail => Types::ProductViewDetail
- #provisioning_artifact_detail => Types::ProvisioningArtifactDetail
- #tags => Array<Types::Tag>

See Also:

AWS API Documentation

# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 709

def create_product(params = {}, options = {})
  req = build_request(:create_product, params)
  req.send_request(options)
end

#create_provisioned_product_plan(params = {}) ⇒ `Types::CreateProvisionedProductPlanOutput`

Creates a plan. A plan includes the list of resources to be created (when provisioning a new product) or modified (when updating a provisioned product) when the plan is executed.

You can create one plan per provisioned product. To create a plan for an existing provisioned product, the product status must be AVAILBLE or TAINTED.

To view the resource changes in the change set, use DescribeProvisionedProductPlan. To create or modify the provisioned product, use ExecuteProvisionedProductPlan.

Examples:

Request syntax with placeholder values


resp = client.create_provisioned_product_plan({
  accept_language: "AcceptLanguage",
  plan_name: "ProvisionedProductPlanName", # required
  plan_type: "CLOUDFORMATION", # required, accepts CLOUDFORMATION
  notification_arns: ["NotificationArn"],
  path_id: "Id",
  product_id: "Id", # required
  provisioned_product_name: "ProvisionedProductName", # required
  provisioning_artifact_id: "Id", # required
  provisioning_parameters: [
    {
      key: "ParameterKey",
      value: "ParameterValue",
      use_previous_value: false,
    },
  ],
  idempotency_token: "IdempotencyToken", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.plan_name #=> String
resp.plan_id #=> String
resp.provision_product_id #=> String
resp.provisioned_product_name #=> String
resp.provisioning_artifact_id #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:accept_language (String) —
The language code.
- en - English (default)
- jp - Japanese
- zh - Chinese
:plan_name (required, String) —
The name of the plan.
:plan_type (required, String) —
The plan type.
:notification_arns (Array<String>) —
Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events.
:path_id (String) —
The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths.
:product_id (required, String) —
The product identifier.
:provisioned_product_name (required, String) —
A user-friendly name for the provisioned product. This value must be unique for the AWS account and cannot be updated after the product is provisioned.
:provisioning_artifact_id (required, String) —
The identifier of the provisioning artifact.
:provisioning_parameters (Array<Types::UpdateProvisioningParameter>) —
Parameters specified by the administrator that are required for provisioning the product.
:idempotency_token (required, String) —
A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

A suitable default value is auto-generated. You should normally not need to pass this option.**
:tags (Array<Types::Tag>) —
One or more tags.

Returns:

(Types::CreateProvisionedProductPlanOutput) —
Returns a response object which responds to the following methods:
- #plan_name => String
- #plan_id => String
- #provision_product_id => String
- #provisioned_product_name => String
- #provisioning_artifact_id => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 823

def create_provisioned_product_plan(params = {}, options = {})
  req = build_request(:create_provisioned_product_plan, params)
  req.send_request(options)
end

#create_provisioning_artifact(params = {}) ⇒ `Types::CreateProvisioningArtifactOutput`

Creates a provisioning artifact (also known as a version) for the specified product.

You cannot create a provisioning artifact for a product that was shared with you.

Examples:

Request syntax with placeholder values


resp = client.create_provisioning_artifact({
  accept_language: "AcceptLanguage",
  product_id: "Id", # required
  parameters: { # required
    name: "ProvisioningArtifactName",
    description: "ProvisioningArtifactDescription",
    info: { # required
      "ProvisioningArtifactInfoKey" => "ProvisioningArtifactInfoValue",
    },
    type: "CLOUD_FORMATION_TEMPLATE", # accepts CLOUD_FORMATION_TEMPLATE, MARKETPLACE_AMI, MARKETPLACE_CAR
  },
  idempotency_token: "IdempotencyToken", # required
})

Response structure


resp.provisioning_artifact_detail.id #=> String
resp.provisioning_artifact_detail.name #=> String
resp.provisioning_artifact_detail.description #=> String
resp.provisioning_artifact_detail.type #=> String, one of "CLOUD_FORMATION_TEMPLATE", "MARKETPLACE_AMI", "MARKETPLACE_CAR"
resp.provisioning_artifact_detail.created_time #=> Time
resp.provisioning_artifact_detail.active #=> Boolean
resp.info #=> Hash
resp.info["ProvisioningArtifactInfoKey"] #=> String
resp.status #=> String, one of "AVAILABLE", "CREATING", "FAILED"

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:accept_language (String) —
The language code.
- en - English (default)
- jp - Japanese
- zh - Chinese
:product_id (required, String) —
The product identifier.
:parameters (required, Types::ProvisioningArtifactProperties) —
The configuration for the provisioning artifact.
:idempotency_token (required, String) —
A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

(Types::CreateProvisioningArtifactOutput) —
Returns a response object which responds to the following methods:
- #provisioning_artifact_detail => Types::ProvisioningArtifactDetail
- #info => Hash<String,String>
- #status => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 895

def create_provisioning_artifact(params = {}, options = {})
  req = build_request(:create_provisioning_artifact, params)
  req.send_request(options)
end

#create_tag_option(params = {}) ⇒ `Types::CreateTagOptionOutput`

Creates a TagOption.

Examples:

Request syntax with placeholder values


resp = client.create_tag_option({
  key: "TagOptionKey", # required
  value: "TagOptionValue", # required
})

Response structure


resp.tag_option_detail.key #=> String
resp.tag_option_detail.value #=> String
resp.tag_option_detail.active #=> Boolean
resp.tag_option_detail.id #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:key (required, String) —
The TagOption key.
:value (required, String) —
The TagOption value.

Returns:

(Types::CreateTagOptionOutput) —
Returns a response object which responds to the following methods:
- #tag_option_detail => Types::TagOptionDetail

See Also:

AWS API Documentation

# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 930

def create_tag_option(params = {}, options = {})
  req = build_request(:create_tag_option, params)
  req.send_request(options)
end

#delete_constraint(params = {}) ⇒ `Struct`

Deletes the specified constraint.

Examples:

Request syntax with placeholder values


resp = client.delete_constraint({
  accept_language: "AcceptLanguage",
  id: "Id", # required
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:accept_language (String) —
The language code.
- en - English (default)
- jp - Japanese
- zh - Chinese
:id (required, String) —
The identifier of the constraint.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 962

def delete_constraint(params = {}, options = {})
  req = build_request(:delete_constraint, params)
  req.send_request(options)
end

#delete_portfolio(params = {}) ⇒ `Struct`

Deletes the specified portfolio.

You cannot delete a portfolio if it was shared with you or if it has associated products, users, constraints, or shared accounts.

Examples:

Request syntax with placeholder values


resp = client.delete_portfolio({
  accept_language: "AcceptLanguage",
  id: "Id", # required
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:accept_language (String) —
The language code.
- en - English (default)
- jp - Japanese
- zh - Chinese
:id (required, String) —
The portfolio identifier.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 997

def delete_portfolio(params = {}, options = {})
  req = build_request(:delete_portfolio, params)
  req.send_request(options)
end

#delete_portfolio_share(params = {}) ⇒ `Struct`

Stops sharing the specified portfolio with the specified account.

Examples:

Request syntax with placeholder values


resp = client.delete_portfolio_share({
  accept_language: "AcceptLanguage",
  portfolio_id: "Id", # required
  account_id: "AccountId", # required
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:accept_language (String) —
The language code.
- en - English (default)
- jp - Japanese
- zh - Chinese
:portfolio_id (required, String) —
The portfolio identifier.
:account_id (required, String) —
The AWS account ID.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 1033

def delete_portfolio_share(params = {}, options = {})
  req = build_request(:delete_portfolio_share, params)
  req.send_request(options)
end

#delete_product(params = {}) ⇒ `Struct`

Deletes the specified product.

You cannot delete a product if it was shared with you or is associated with a portfolio.

Examples:

Request syntax with placeholder values


resp = client.delete_product({
  accept_language: "AcceptLanguage",
  id: "Id", # required
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:accept_language (String) —
The language code.
- en - English (default)
- jp - Japanese
- zh - Chinese
:id (required, String) —
The product identifier.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 1068

def delete_product(params = {}, options = {})
  req = build_request(:delete_product, params)
  req.send_request(options)
end

#delete_provisioned_product_plan(params = {}) ⇒ `Struct`

Deletes the specified plan.

Examples:

Request syntax with placeholder values


resp = client.delete_provisioned_product_plan({
  accept_language: "AcceptLanguage",
  plan_id: "Id", # required
  ignore_errors: false,
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:accept_language (String) —
The language code.
- en - English (default)
- jp - Japanese
- zh - Chinese
:plan_id (required, String) —
The plan identifier.
:ignore_errors (Boolean) —
If set to true, AWS Service Catalog stops managing the specified provisioned product even if it cannot delete the underlying resources.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 1105

def delete_provisioned_product_plan(params = {}, options = {})
  req = build_request(:delete_provisioned_product_plan, params)
  req.send_request(options)
end

#delete_provisioning_artifact(params = {}) ⇒ `Struct`

Deletes the specified provisioning artifact (also known as a version) for the specified product.

You cannot delete a provisioning artifact associated with a product that was shared with you. You cannot delete the last provisioning artifact for a product, because a product must have at least one provisioning artifact.

Examples:

Request syntax with placeholder values


resp = client.delete_provisioning_artifact({
  accept_language: "AcceptLanguage",
  product_id: "Id", # required
  provisioning_artifact_id: "Id", # required
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:accept_language (String) —
The language code.
- en - English (default)
- jp - Japanese
- zh - Chinese
:product_id (required, String) —
The product identifier.
:provisioning_artifact_id (required, String) —
The identifier of the provisioning artifact.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 1147

def delete_provisioning_artifact(params = {}, options = {})
  req = build_request(:delete_provisioning_artifact, params)
  req.send_request(options)
end

#delete_tag_option(params = {}) ⇒ `Struct`

Deletes the specified TagOption.

You cannot delete a TagOption if it is associated with a product or portfolio.

Examples:

Request syntax with placeholder values


resp = client.delete_tag_option({
  id: "TagOptionId", # required
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:id (required, String) —
The TagOption identifier.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 1172

def delete_tag_option(params = {}, options = {})
  req = build_request(:delete_tag_option, params)
  req.send_request(options)
end

#describe_constraint(params = {}) ⇒ `Types::DescribeConstraintOutput`

Gets information about the specified constraint.

Examples:

Request syntax with placeholder values


resp = client.describe_constraint({
  accept_language: "AcceptLanguage",
  id: "Id", # required
})

Response structure


resp.constraint_detail.constraint_id #=> String
resp.constraint_detail.type #=> String
resp.constraint_detail.description #=> String
resp.constraint_detail.owner #=> String
resp.constraint_parameters #=> String
resp.status #=> String, one of "AVAILABLE", "CREATING", "FAILED"

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:accept_language (String) —
The language code.
- en - English (default)
- jp - Japanese
- zh - Chinese
:id (required, String) —
The identifier of the constraint.

Returns:

(Types::DescribeConstraintOutput) —
Returns a response object which responds to the following methods:
- #constraint_detail => Types::ConstraintDetail
- #constraint_parameters => String
- #status => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 1217

def describe_constraint(params = {}, options = {})
  req = build_request(:describe_constraint, params)
  req.send_request(options)
end

#describe_copy_product_status(params = {}) ⇒ `Types::DescribeCopyProductStatusOutput`

Gets the status of the specified copy product operation.

Examples:

Request syntax with placeholder values


resp = client.describe_copy_product_status({
  accept_language: "AcceptLanguage",
  copy_product_token: "Id", # required
})

Response structure


resp.copy_product_status #=> String, one of "SUCCEEDED", "IN_PROGRESS", "FAILED"
resp.target_product_id #=> String
resp.status_detail #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:accept_language (String) —
The language code.
- en - English (default)
- jp - Japanese
- zh - Chinese
:copy_product_token (required, String) —
The token for the copy product operation. This token is returned by CopyProduct.

Returns:

(Types::DescribeCopyProductStatusOutput) —
Returns a response object which responds to the following methods:
- #copy_product_status => String
- #target_product_id => String
- #status_detail => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 1260

def describe_copy_product_status(params = {}, options = {})
  req = build_request(:describe_copy_product_status, params)
  req.send_request(options)
end

#describe_portfolio(params = {}) ⇒ `Types::DescribePortfolioOutput`

Gets information about the specified portfolio.

Examples:

Request syntax with placeholder values


resp = client.describe_portfolio({
  accept_language: "AcceptLanguage",
  id: "Id", # required
})

Response structure


resp.portfolio_detail.id #=> String
resp.portfolio_detail.arn #=> String
resp.portfolio_detail.display_name #=> String
resp.portfolio_detail.description #=> String
resp.portfolio_detail.created_time #=> Time
resp.portfolio_detail.provider_name #=> String
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.tag_options #=> Array
resp.tag_options[0].key #=> String
resp.tag_options[0].value #=> String
resp.tag_options[0].active #=> Boolean
resp.tag_options[0].id #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:accept_language (String) —
The language code.
- en - English (default)
- jp - Japanese
- zh - Chinese
:id (required, String) —
The portfolio identifier.

Returns:

(Types::DescribePortfolioOutput) —
Returns a response object which responds to the following methods:
- #portfolio_detail => Types::PortfolioDetail
- #tags => Array<Types::Tag>
- #tag_options => Array<Types::TagOptionDetail>

See Also:

AWS API Documentation

# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 1313

def describe_portfolio(params = {}, options = {})
  req = build_request(:describe_portfolio, params)
  req.send_request(options)
end

#describe_product(params = {}) ⇒ `Types::DescribeProductOutput`

Gets information about the specified product.

Examples:

Request syntax with placeholder values


resp = client.describe_product({
  accept_language: "AcceptLanguage",
  id: "Id", # required
})

Response structure


resp.product_view_summary.id #=> String
resp.product_view_summary.product_id #=> String
resp.product_view_summary.name #=> String
resp.product_view_summary.owner #=> String
resp.product_view_summary.short_description #=> String
resp.product_view_summary.type #=> String, one of "CLOUD_FORMATION_TEMPLATE", "MARKETPLACE"
resp.product_view_summary.distributor #=> String
resp.product_view_summary.has_default_path #=> Boolean
resp.product_view_summary.support_email #=> String
resp.product_view_summary.support_description #=> String
resp.product_view_summary.support_url #=> String
resp.provisioning_artifacts #=> Array
resp.provisioning_artifacts[0].id #=> String
resp.provisioning_artifacts[0].name #=> String
resp.provisioning_artifacts[0].description #=> String
resp.provisioning_artifacts[0].created_time #=> Time

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:accept_language (String) —
The language code.
- en - English (default)
- jp - Japanese
- zh - Chinese
:id (required, String) —
The product identifier.

Returns:

(Types::DescribeProductOutput) —
Returns a response object which responds to the following methods:
- #product_view_summary => Types::ProductViewSummary
- #provisioning_artifacts => Array<Types::ProvisioningArtifact>

See Also:

AWS API Documentation

# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 1367

def describe_product(params = {}, options = {})
  req = build_request(:describe_product, params)
  req.send_request(options)
end

#describe_product_as_admin(params = {}) ⇒ `Types::DescribeProductAsAdminOutput`

Gets information about the specified product. This operation is run with administrator access.

Examples:

Request syntax with placeholder values


resp = client.describe_product_as_admin({
  accept_language: "AcceptLanguage",
  id: "Id", # required
})

Response structure


resp.product_view_detail.product_view_summary.id #=> String
resp.product_view_detail.product_view_summary.product_id #=> String
resp.product_view_detail.product_view_summary.name #=> String
resp.product_view_detail.product_view_summary.owner #=> String
resp.product_view_detail.product_view_summary.short_description #=> String
resp.product_view_detail.product_view_summary.type #=> String, one of "CLOUD_FORMATION_TEMPLATE", "MARKETPLACE"
resp.product_view_detail.product_view_summary.distributor #=> String
resp.product_view_detail.product_view_summary.has_default_path #=> Boolean
resp.product_view_detail.product_view_summary.support_email #=> String
resp.product_view_detail.product_view_summary.support_description #=> String
resp.product_view_detail.product_view_summary.support_url #=> String
resp.product_view_detail.status #=> String, one of "AVAILABLE", "CREATING", "FAILED"
resp.product_view_detail.product_arn #=> String
resp.product_view_detail.created_time #=> Time
resp.provisioning_artifact_summaries #=> Array
resp.provisioning_artifact_summaries[0].id #=> String
resp.provisioning_artifact_summaries[0].name #=> String
resp.provisioning_artifact_summaries[0].description #=> String
resp.provisioning_artifact_summaries[0].created_time #=> Time
resp.provisioning_artifact_summaries[0].provisioning_artifact_metadata #=> Hash
resp.provisioning_artifact_summaries[0].provisioning_artifact_metadata["ProvisioningArtifactInfoKey"] #=> String
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.tag_options #=> Array
resp.tag_options[0].key #=> String
resp.tag_options[0].value #=> String
resp.tag_options[0].active #=> Boolean
resp.tag_options[0].id #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:accept_language (String) —
The language code.
- en - English (default)
- jp - Japanese
- zh - Chinese
:id (required, String) —
The product identifier.

Returns:

(Types::DescribeProductAsAdminOutput) —
Returns a response object which responds to the following methods:
- #product_view_detail => Types::ProductViewDetail
- #provisioning_artifact_summaries => Array<Types::ProvisioningArtifactSummary>
- #tags => Array<Types::Tag>
- #tag_options => Array<Types::TagOptionDetail>

See Also:

AWS API Documentation

# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 1437

def describe_product_as_admin(params = {}, options = {})
  req = build_request(:describe_product_as_admin, params)
  req.send_request(options)
end

#describe_product_view(params = {}) ⇒ `Types::DescribeProductViewOutput`

Gets information about the specified product.

Examples:

Request syntax with placeholder values


resp = client.describe_product_view({
  accept_language: "AcceptLanguage",
  id: "Id", # required
})

Response structure


resp.product_view_summary.id #=> String
resp.product_view_summary.product_id #=> String
resp.product_view_summary.name #=> String
resp.product_view_summary.owner #=> String
resp.product_view_summary.short_description #=> String
resp.product_view_summary.type #=> String, one of "CLOUD_FORMATION_TEMPLATE", "MARKETPLACE"
resp.product_view_summary.distributor #=> String
resp.product_view_summary.has_default_path #=> Boolean
resp.product_view_summary.support_email #=> String
resp.product_view_summary.support_description #=> String
resp.product_view_summary.support_url #=> String
resp.provisioning_artifacts #=> Array
resp.provisioning_artifacts[0].id #=> String
resp.provisioning_artifacts[0].name #=> String
resp.provisioning_artifacts[0].description #=> String
resp.provisioning_artifacts[0].created_time #=> Time

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:accept_language (String) —
The language code.
- en - English (default)
- jp - Japanese
- zh - Chinese
:id (required, String) —
The product view identifier.

Returns:

(Types::DescribeProductViewOutput) —
Returns a response object which responds to the following methods:
- #product_view_summary => Types::ProductViewSummary
- #provisioning_artifacts => Array<Types::ProvisioningArtifact>

See Also:

AWS API Documentation

# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 1491

def describe_product_view(params = {}, options = {})
  req = build_request(:describe_product_view, params)
  req.send_request(options)
end

#describe_provisioned_product(params = {}) ⇒ `Types::DescribeProvisionedProductOutput`

Gets information about the specified provisioned product.

Examples:

Request syntax with placeholder values


resp = client.describe_provisioned_product({
  accept_language: "AcceptLanguage",
  id: "Id", # required
})

Response structure


resp.provisioned_product_detail.name #=> String
resp.provisioned_product_detail.arn #=> String
resp.provisioned_product_detail.type #=> String
resp.provisioned_product_detail.id #=> String
resp.provisioned_product_detail.status #=> String, one of "AVAILABLE", "UNDER_CHANGE", "TAINTED", "ERROR", "PLAN_IN_PROGRESS"
resp.provisioned_product_detail.status_message #=> String
resp.provisioned_product_detail.created_time #=> Time
resp.provisioned_product_detail.idempotency_token #=> String
resp.provisioned_product_detail.last_record_id #=> String
resp.cloud_watch_dashboards #=> Array
resp.cloud_watch_dashboards[0].name #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:accept_language (String) —
The language code.
- en - English (default)
- jp - Japanese
- zh - Chinese
:id (required, String) —
The provisioned product identifier.

Returns:

(Types::DescribeProvisionedProductOutput) —
Returns a response object which responds to the following methods:
- #provisioned_product_detail => Types::ProvisionedProductDetail
- #cloud_watch_dashboards => Array<Types::CloudWatchDashboard>

See Also:

AWS API Documentation

# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 1540

def describe_provisioned_product(params = {}, options = {})
  req = build_request(:describe_provisioned_product, params)
  req.send_request(options)
end

#describe_provisioned_product_plan(params = {}) ⇒ `Types::DescribeProvisionedProductPlanOutput`

Gets information about the resource changes for the specified plan.

Examples:

Request syntax with placeholder values


resp = client.describe_provisioned_product_plan({
  accept_language: "AcceptLanguage",
  plan_id: "Id", # required
  page_size: 1,
  page_token: "PageToken",
})

Response structure


resp.provisioned_product_plan_details.created_time #=> Time
resp.provisioned_product_plan_details.path_id #=> String
resp.provisioned_product_plan_details.product_id #=> String
resp.provisioned_product_plan_details.plan_name #=> String
resp.provisioned_product_plan_details.plan_id #=> String
resp.provisioned_product_plan_details.provision_product_id #=> String
resp.provisioned_product_plan_details.provision_product_name #=> String
resp.provisioned_product_plan_details.plan_type #=> String, one of "CLOUDFORMATION"
resp.provisioned_product_plan_details.provisioning_artifact_id #=> String
resp.provisioned_product_plan_details.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_SUCCESS", "CREATE_FAILED", "EXECUTE_IN_PROGRESS", "EXECUTE_SUCCESS", "EXECUTE_FAILED"
resp.provisioned_product_plan_details.updated_time #=> Time
resp.provisioned_product_plan_details.notification_arns #=> Array
resp.provisioned_product_plan_details.notification_arns[0] #=> String
resp.provisioned_product_plan_details.provisioning_parameters #=> Array
resp.provisioned_product_plan_details.provisioning_parameters[0].key #=> String
resp.provisioned_product_plan_details.provisioning_parameters[0].value #=> String
resp.provisioned_product_plan_details.provisioning_parameters[0].use_previous_value #=> Boolean
resp.provisioned_product_plan_details.tags #=> Array
resp.provisioned_product_plan_details.tags[0].key #=> String
resp.provisioned_product_plan_details.tags[0].value #=> String
resp.provisioned_product_plan_details.status_message #=> String
resp.resource_changes #=> Array
resp.resource_changes[0].action #=> String, one of "ADD", "MODIFY", "REMOVE"
resp.resource_changes[0].logical_resource_id #=> String
resp.resource_changes[0].physical_resource_id #=> String
resp.resource_changes[0].resource_type #=> String
resp.resource_changes[0].replacement #=> String, one of "TRUE", "FALSE", "CONDITIONAL"
resp.resource_changes[0].scope #=> Array
resp.resource_changes[0].scope[0] #=> String, one of "PROPERTIES", "METADATA", "CREATIONPOLICY", "UPDATEPOLICY", "DELETIONPOLICY", "TAGS"
resp.resource_changes[0].details #=> Array
resp.resource_changes[0].details[0].target.attribute #=> String, one of "PROPERTIES", "METADATA", "CREATIONPOLICY", "UPDATEPOLICY", "DELETIONPOLICY", "TAGS"
resp.resource_changes[0].details[0].target.name #=> String
resp.resource_changes[0].details[0].target.requires_recreation #=> String, one of "NEVER", "CONDITIONALLY", "ALWAYS"
resp.resource_changes[0].details[0].evaluation #=> String, one of "STATIC", "DYNAMIC"
resp.resource_changes[0].details[0].causing_entity #=> String
resp.next_page_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:accept_language (String) —
The language code.
- en - English (default)
- jp - Japanese
- zh - Chinese
:plan_id (required, String) —
The plan identifier.
:page_size (Integer) —
The maximum number of items to return with this call.
:page_token (String) —
The page token for the next set of results. To retrieve the first set of results, use null.

Returns:

(Types::DescribeProvisionedProductPlanOutput) —
Returns a response object which responds to the following methods:
- #provisioned_product_plan_details => Types::ProvisionedProductPlanDetails
- #resource_changes => Array<Types::ResourceChange>
- #next_page_token => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 1624

def describe_provisioned_product_plan(params = {}, options = {})
  req = build_request(:describe_provisioned_product_plan, params)
  req.send_request(options)
end

#describe_provisioning_artifact(params = {}) ⇒ `Types::DescribeProvisioningArtifactOutput`

Gets information about the specified provisioning artifact (also known as a version) for the specified product.

Examples:

Request syntax with placeholder values


resp = client.describe_provisioning_artifact({
  accept_language: "AcceptLanguage",
  provisioning_artifact_id: "Id", # required
  product_id: "Id", # required
  verbose: false,
})

Response structure


resp.provisioning_artifact_detail.id #=> String
resp.provisioning_artifact_detail.name #=> String
resp.provisioning_artifact_detail.description #=> String
resp.provisioning_artifact_detail.type #=> String, one of "CLOUD_FORMATION_TEMPLATE", "MARKETPLACE_AMI", "MARKETPLACE_CAR"
resp.provisioning_artifact_detail.created_time #=> Time
resp.provisioning_artifact_detail.active #=> Boolean
resp.info #=> Hash
resp.info["ProvisioningArtifactInfoKey"] #=> String
resp.status #=> String, one of "AVAILABLE", "CREATING", "FAILED"

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:accept_language (String) —
The language code.
- en - English (default)
- jp - Japanese
- zh - Chinese
:provisioning_artifact_id (required, String) —
The identifier of the provisioning artifact.
:product_id (required, String) —
The product identifier.
:verbose (Boolean) —
Indicates whether a verbose level of detail is enabled.

Returns:

(Types::DescribeProvisioningArtifactOutput) —
Returns a response object which responds to the following methods:
- #provisioning_artifact_detail => Types::ProvisioningArtifactDetail
- #info => Hash<String,String>
- #status => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 1681

def describe_provisioning_artifact(params = {}, options = {})
  req = build_request(:describe_provisioning_artifact, params)
  req.send_request(options)
end

#describe_provisioning_parameters(params = {}) ⇒ `Types::DescribeProvisioningParametersOutput`

Gets information about the configuration required to provision the specified product using the specified provisioning artifact.

If the output contains a TagOption key with an empty list of values, there is a TagOption conflict for that key. The end user cannot take action to fix the conflict, and launch is not blocked. In subsequent calls to ProvisionProduct, do not include conflicted TagOption keys as tags, or this causes the error "Parameter validation failed: Missing required parameter in Tags[N]:Value". Tag the provisioned product with the value sc-tagoption-conflict-portfolioId-productId.

Examples:

Request syntax with placeholder values


resp = client.describe_provisioning_parameters({
  accept_language: "AcceptLanguage",
  product_id: "Id", # required
  provisioning_artifact_id: "Id", # required
  path_id: "Id",
})

Response structure


resp.provisioning_artifact_parameters #=> Array
resp.provisioning_artifact_parameters[0].parameter_key #=> String
resp.provisioning_artifact_parameters[0].default_value #=> String
resp.provisioning_artifact_parameters[0].parameter_type #=> String
resp.provisioning_artifact_parameters[0].is_no_echo #=> Boolean
resp.provisioning_artifact_parameters[0].description #=> String
resp.provisioning_artifact_parameters[0].parameter_constraints.allowed_values #=> Array
resp.provisioning_artifact_parameters[0].parameter_constraints.allowed_values[0] #=> String
resp.constraint_summaries #=> Array
resp.constraint_summaries[0].type #=> String
resp.constraint_summaries[0].description #=> String
resp.usage_instructions #=> Array
resp.usage_instructions[0].type #=> String
resp.usage_instructions[0].value #=> String
resp.tag_options #=> Array
resp.tag_options[0].key #=> String
resp.tag_options[0].values #=> Array
resp.tag_options[0].values[0] #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:accept_language (String) —
The language code.
- en - English (default)
- jp - Japanese
- zh - Chinese
:product_id (required, String) —
The product identifier.
:provisioning_artifact_id (required, String) —
The identifier of the provisioning artifact.
:path_id (String) —
The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths.

Returns:

(Types::DescribeProvisioningParametersOutput) —
Returns a response object which responds to the following methods:
- #provisioning_artifact_parameters => Array<Types::ProvisioningArtifactParameter>
- #constraint_summaries => Array<Types::ConstraintSummary>
- #usage_instructions => Array<Types::UsageInstruction>
- #tag_options => Array<Types::TagOptionSummary>

See Also:

AWS API Documentation

# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 1758

def describe_provisioning_parameters(params = {}, options = {})
  req = build_request(:describe_provisioning_parameters, params)
  req.send_request(options)
end

#describe_record(params = {}) ⇒ `Types::DescribeRecordOutput`

Gets information about the specified request operation.

Use this operation after calling a request operation (for example, ProvisionProduct, TerminateProvisionedProduct, or UpdateProvisionedProduct).

Examples:

Request syntax with placeholder values


resp = client.describe_record({
  accept_language: "AcceptLanguage",
  id: "Id", # required
  page_token: "PageToken",
  page_size: 1,
})

Response structure


resp.record_detail.record_id #=> String
resp.record_detail.provisioned_product_name #=> String
resp.record_detail.status #=> String, one of "CREATED", "IN_PROGRESS", "IN_PROGRESS_IN_ERROR", "SUCCEEDED", "FAILED"
resp.record_detail.created_time #=> Time
resp.record_detail.updated_time #=> Time
resp.record_detail.provisioned_product_type #=> String
resp.record_detail.record_type #=> String
resp.record_detail.provisioned_product_id #=> String
resp.record_detail.product_id #=> String
resp.record_detail.provisioning_artifact_id #=> String
resp.record_detail.path_id #=> String
resp.record_detail.record_errors #=> Array
resp.record_detail.record_errors[0].code #=> String
resp.record_detail.record_errors[0].description #=> String
resp.record_detail.record_tags #=> Array
resp.record_detail.record_tags[0].key #=> String
resp.record_detail.record_tags[0].value #=> String
resp.record_outputs #=> Array
resp.record_outputs[0].output_key #=> String
resp.record_outputs[0].output_value #=> String
resp.record_outputs[0].description #=> String
resp.next_page_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:accept_language (String) —
The language code.
- en - English (default)
- jp - Japanese
- zh - Chinese
:id (required, String) —
The record identifier of the provisioned product. This identifier is returned by the request operation.
:page_token (String) —
The page token for the next set of results. To retrieve the first set of results, use null.
:page_size (Integer) —
The maximum number of items to return with this call.

Returns:

(Types::DescribeRecordOutput) —
Returns a response object which responds to the following methods:
- #record_detail => Types::RecordDetail
- #record_outputs => Array<Types::RecordOutput>
- #next_page_token => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 1833

def describe_record(params = {}, options = {})
  req = build_request(:describe_record, params)
  req.send_request(options)
end

#describe_tag_option(params = {}) ⇒ `Types::DescribeTagOptionOutput`

Gets information about the specified TagOption.

Examples:

Request syntax with placeholder values


resp = client.describe_tag_option({
  id: "TagOptionId", # required
})

Response structure


resp.tag_option_detail.key #=> String
resp.tag_option_detail.value #=> String
resp.tag_option_detail.active #=> Boolean
resp.tag_option_detail.id #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:id (required, String) —
The TagOption identifier.

Returns:

(Types::DescribeTagOptionOutput) —
Returns a response object which responds to the following methods:
- #tag_option_detail => Types::TagOptionDetail

See Also:

AWS API Documentation

# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 1864

def describe_tag_option(params = {}, options = {})
  req = build_request(:describe_tag_option, params)
  req.send_request(options)
end

#disassociate_principal_from_portfolio(params = {}) ⇒ `Struct`

Disassociates a previously associated principal ARN from a specified portfolio.

Examples:

Request syntax with placeholder values


resp = client.disassociate_principal_from_portfolio({
  accept_language: "AcceptLanguage",
  portfolio_id: "Id", # required
  principal_arn: "PrincipalARN", # required
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:accept_language (String) —
The language code.
- en - English (default)
- jp - Japanese
- zh - Chinese
:portfolio_id (required, String) —
The portfolio identifier.
:principal_arn (required, String) —
The ARN of the principal (IAM user, role, or group).

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 1901

def disassociate_principal_from_portfolio(params = {}, options = {})
  req = build_request(:disassociate_principal_from_portfolio, params)
  req.send_request(options)
end

#disassociate_product_from_portfolio(params = {}) ⇒ `Struct`

Disassociates the specified product from the specified portfolio.

Examples:

Request syntax with placeholder values


resp = client.disassociate_product_from_portfolio({
  accept_language: "AcceptLanguage",
  product_id: "Id", # required
  portfolio_id: "Id", # required
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:accept_language (String) —
The language code.
- en - English (default)
- jp - Japanese
- zh - Chinese
:product_id (required, String) —
The product identifier.
:portfolio_id (required, String) —
The portfolio identifier.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 1937

def disassociate_product_from_portfolio(params = {}, options = {})
  req = build_request(:disassociate_product_from_portfolio, params)
  req.send_request(options)
end

#disassociate_tag_option_from_resource(params = {}) ⇒ `Struct`

Disassociates the specified TagOption from the specified resource.

Examples:

Request syntax with placeholder values


resp = client.disassociate_tag_option_from_resource({
  resource_id: "ResourceId", # required
  tag_option_id: "TagOptionId", # required
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:resource_id (required, String) —
The resource identifier.
:tag_option_id (required, String) —
The TagOption identifier.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 1963

def disassociate_tag_option_from_resource(params = {}, options = {})
  req = build_request(:disassociate_tag_option_from_resource, params)
  req.send_request(options)
end

#execute_provisioned_product_plan(params = {}) ⇒ `Types::ExecuteProvisionedProductPlanOutput`

Provisions or modifies a product based on the resource changes for the specified plan.

Examples:

Request syntax with placeholder values


resp = client.execute_provisioned_product_plan({
  accept_language: "AcceptLanguage",
  plan_id: "Id", # required
  idempotency_token: "IdempotencyToken", # required
})

Response structure


resp.record_detail.record_id #=> String
resp.record_detail.provisioned_product_name #=> String
resp.record_detail.status #=> String, one of "CREATED", "IN_PROGRESS", "IN_PROGRESS_IN_ERROR", "SUCCEEDED", "FAILED"
resp.record_detail.created_time #=> Time
resp.record_detail.updated_time #=> Time
resp.record_detail.provisioned_product_type #=> String
resp.record_detail.record_type #=> String
resp.record_detail.provisioned_product_id #=> String
resp.record_detail.product_id #=> String
resp.record_detail.provisioning_artifact_id #=> String
resp.record_detail.path_id #=> String
resp.record_detail.record_errors #=> Array
resp.record_detail.record_errors[0].code #=> String
resp.record_detail.record_errors[0].description #=> String
resp.record_detail.record_tags #=> Array
resp.record_detail.record_tags[0].key #=> String
resp.record_detail.record_tags[0].value #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:accept_language (String) —
The language code.
- en - English (default)
- jp - Japanese
- zh - Chinese
:plan_id (required, String) —
The plan identifier.
:idempotency_token (required, String) —
A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

(Types::ExecuteProvisionedProductPlanOutput) —
Returns a response object which responds to the following methods:
- #record_detail => Types::RecordDetail

See Also:

AWS API Documentation

# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2027

def execute_provisioned_product_plan(params = {}, options = {})
  req = build_request(:execute_provisioned_product_plan, params)
  req.send_request(options)
end

#list_accepted_portfolio_shares(params = {}) ⇒ `Types::ListAcceptedPortfolioSharesOutput`

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

Examples:

Request syntax with placeholder values


resp = client.list_accepted_portfolio_shares({
  accept_language: "AcceptLanguage",
  page_token: "PageToken",
  page_size: 1,
  portfolio_share_type: "IMPORTED", # accepts IMPORTED, AWS_SERVICECATALOG
})

Response structure


resp.portfolio_details #=> Array
resp.portfolio_details[0].id #=> String
resp.portfolio_details[0].arn #=> String
resp.portfolio_details[0].display_name #=> String
resp.portfolio_details[0].description #=> String
resp.portfolio_details[0].created_time #=> Time
resp.portfolio_details[0].provider_name #=> String
resp.next_page_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:accept_language (String) —
The language code.
- en - English (default)
- jp - Japanese
- zh - Chinese
:page_token (String) —
The page token for the next set of results. To retrieve the first set of results, use null.
:page_size (Integer) —
The maximum number of items to return with this call.
:portfolio_share_type (String) —
The type of shared portfolios to list. The default is to list imported portfolios.
- AWS_SERVICECATALOG - List default portfolios
- IMPORTED - List imported portfolios

Returns:

(Types::ListAcceptedPortfolioSharesOutput) —
Returns a response object which responds to the following methods:
- #portfolio_details => Array<Types::PortfolioDetail>
- #next_page_token => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2087

def list_accepted_portfolio_shares(params = {}, options = {})
  req = build_request(:list_accepted_portfolio_shares, params)
  req.send_request(options)
end

#list_constraints_for_portfolio(params = {}) ⇒ `Types::ListConstraintsForPortfolioOutput`

Lists the constraints for the specified portfolio and product.

Examples:

Request syntax with placeholder values


resp = client.list_constraints_for_portfolio({
  accept_language: "AcceptLanguage",
  portfolio_id: "Id", # required
  product_id: "Id",
  page_size: 1,
  page_token: "PageToken",
})

Response structure


resp.constraint_details #=> Array
resp.constraint_details[0].constraint_id #=> String
resp.constraint_details[0].type #=> String
resp.constraint_details[0].description #=> String
resp.constraint_details[0].owner #=> String
resp.next_page_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:accept_language (String) —
The language code.
- en - English (default)
- jp - Japanese
- zh - Chinese
:portfolio_id (required, String) —
The portfolio identifier.
:product_id (String) —
The product identifier.
:page_size (Integer) —
The maximum number of items to return with this call.
:page_token (String) —
The page token for the next set of results. To retrieve the first set of results, use null.

Returns:

(Types::ListConstraintsForPortfolioOutput) —
Returns a response object which responds to the following methods:
- #constraint_details => Array<Types::ConstraintDetail>
- #next_page_token => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2144

def list_constraints_for_portfolio(params = {}, options = {})
  req = build_request(:list_constraints_for_portfolio, params)
  req.send_request(options)
end

#list_launch_paths(params = {}) ⇒ `Types::ListLaunchPathsOutput`

Lists the paths to the 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.

Examples:

Request syntax with placeholder values


resp = client.list_launch_paths({
  accept_language: "AcceptLanguage",
  product_id: "Id", # required
  page_size: 1,
  page_token: "PageToken",
})

Response structure


resp.launch_path_summaries #=> Array
resp.launch_path_summaries[0].id #=> String
resp.launch_path_summaries[0].constraint_summaries #=> Array
resp.launch_path_summaries[0].constraint_summaries[0].type #=> String
resp.launch_path_summaries[0].constraint_summaries[0].description #=> String
resp.launch_path_summaries[0].tags #=> Array
resp.launch_path_summaries[0].tags[0].key #=> String
resp.launch_path_summaries[0].tags[0].value #=> String
resp.launch_path_summaries[0].name #=> String
resp.next_page_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:accept_language (String) —
The language code.
- en - English (default)
- jp - Japanese
- zh - Chinese
:product_id (required, String) —
The product identifier.
:page_size (Integer) —
The maximum number of items to return with this call.
:page_token (String) —
The page token for the next set of results. To retrieve the first set of results, use null.

Returns:

(Types::ListLaunchPathsOutput) —
Returns a response object which responds to the following methods:
- #launch_path_summaries => Array<Types::LaunchPathSummary>
- #next_page_token => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2203

def list_launch_paths(params = {}, options = {})
  req = build_request(:list_launch_paths, params)
  req.send_request(options)
end

#list_portfolio_access(params = {}) ⇒ `Types::ListPortfolioAccessOutput`

Lists the account IDs that have access to the specified portfolio.

Examples:

Request syntax with placeholder values


resp = client.list_portfolio_access({
  accept_language: "AcceptLanguage",
  portfolio_id: "Id", # required
})

Response structure


resp.account_ids #=> Array
resp.account_ids[0] #=> String
resp.next_page_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:accept_language (String) —
The language code.
- en - English (default)
- jp - Japanese
- zh - Chinese
:portfolio_id (required, String) —
The portfolio identifier.

Returns:

(Types::ListPortfolioAccessOutput) —
Returns a response object which responds to the following methods:
- #account_ids => Array<String>
- #next_page_token => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2244

def list_portfolio_access(params = {}, options = {})
  req = build_request(:list_portfolio_access, params)
  req.send_request(options)
end

#list_portfolios(params = {}) ⇒ `Types::ListPortfoliosOutput`

Lists all portfolios in the catalog.

Examples:

Request syntax with placeholder values


resp = client.list_portfolios({
  accept_language: "AcceptLanguage",
  page_token: "PageToken",
  page_size: 1,
})

Response structure


resp.portfolio_details #=> Array
resp.portfolio_details[0].id #=> String
resp.portfolio_details[0].arn #=> String
resp.portfolio_details[0].display_name #=> String
resp.portfolio_details[0].description #=> String
resp.portfolio_details[0].created_time #=> Time
resp.portfolio_details[0].provider_name #=> String
resp.next_page_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:accept_language (String) —
The language code.
- en - English (default)
- jp - Japanese
- zh - Chinese
:page_token (String) —
The page token for the next set of results. To retrieve the first set of results, use null.
:page_size (Integer) —
The maximum number of items to return with this call.

Returns:

(Types::ListPortfoliosOutput) —
Returns a response object which responds to the following methods:
- #portfolio_details => Array<Types::PortfolioDetail>
- #next_page_token => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2295

def list_portfolios(params = {}, options = {})
  req = build_request(:list_portfolios, params)
  req.send_request(options)
end

#list_portfolios_for_product(params = {}) ⇒ `Types::ListPortfoliosForProductOutput`

Lists all portfolios that the specified product is associated with.

Examples:

Request syntax with placeholder values


resp = client.list_portfolios_for_product({
  accept_language: "AcceptLanguage",
  product_id: "Id", # required
  page_token: "PageToken",
  page_size: 1,
})

Response structure


resp.portfolio_details #=> Array
resp.portfolio_details[0].id #=> String
resp.portfolio_details[0].arn #=> String
resp.portfolio_details[0].display_name #=> String
resp.portfolio_details[0].description #=> String
resp.portfolio_details[0].created_time #=> Time
resp.portfolio_details[0].provider_name #=> String
resp.next_page_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:accept_language (String) —
The language code.
- en - English (default)
- jp - Japanese
- zh - Chinese
:product_id (required, String) —
The product identifier.
:page_token (String) —
The page token for the next set of results. To retrieve the first set of results, use null.
:page_size (Integer) —
The maximum number of items to return with this call.

Returns:

(Types::ListPortfoliosForProductOutput) —
Returns a response object which responds to the following methods:
- #portfolio_details => Array<Types::PortfolioDetail>
- #next_page_token => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2350

def list_portfolios_for_product(params = {}, options = {})
  req = build_request(:list_portfolios_for_product, params)
  req.send_request(options)
end

#list_principals_for_portfolio(params = {}) ⇒ `Types::ListPrincipalsForPortfolioOutput`

Lists all principal ARNs associated with the specified portfolio.

Examples:

Request syntax with placeholder values


resp = client.list_principals_for_portfolio({
  accept_language: "AcceptLanguage",
  portfolio_id: "Id", # required
  page_size: 1,
  page_token: "PageToken",
})

Response structure


resp.principals #=> Array
resp.principals[0].principal_arn #=> String
resp.principals[0].principal_type #=> String, one of "IAM"
resp.next_page_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:accept_language (String) —
The language code.
- en - English (default)
- jp - Japanese
- zh - Chinese
:portfolio_id (required, String) —
The portfolio identifier.
:page_size (Integer) —
The maximum number of items to return with this call.
:page_token (String) —
The page token for the next set of results. To retrieve the first set of results, use null.

Returns:

(Types::ListPrincipalsForPortfolioOutput) —
Returns a response object which responds to the following methods:
- #principals => Array<Types::Principal>
- #next_page_token => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2401

def list_principals_for_portfolio(params = {}, options = {})
  req = build_request(:list_principals_for_portfolio, params)
  req.send_request(options)
end

#list_provisioned_product_plans(params = {}) ⇒ `Types::ListProvisionedProductPlansOutput`

Lists the plans for the specified provisioned product or all plans to which the user has access.

Examples:

Request syntax with placeholder values


resp = client.list_provisioned_product_plans({
  accept_language: "AcceptLanguage",
  provision_product_id: "Id",
  page_size: 1,
  page_token: "PageToken",
  access_level_filter: {
    key: "Account", # accepts Account, Role, User
    value: "AccessLevelFilterValue",
  },
})

Response structure


resp.provisioned_product_plans #=> Array
resp.provisioned_product_plans[0].plan_name #=> String
resp.provisioned_product_plans[0].plan_id #=> String
resp.provisioned_product_plans[0].provision_product_id #=> String
resp.provisioned_product_plans[0].provision_product_name #=> String
resp.provisioned_product_plans[0].plan_type #=> String, one of "CLOUDFORMATION"
resp.provisioned_product_plans[0].provisioning_artifact_id #=> String
resp.next_page_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:accept_language (String) —
The language code.
- en - English (default)
- jp - Japanese
- zh - Chinese
:provision_product_id (String) —
The product identifier.
:page_size (Integer) —
The maximum number of items to return with this call.
:page_token (String) —
The page token for the next set of results. To retrieve the first set of results, use null.
:access_level_filter (Types::AccessLevelFilter) —
The access level to use to obtain results. The default is User.

Returns:

(Types::ListProvisionedProductPlansOutput) —
Returns a response object which responds to the following methods:
- #provisioned_product_plans => Array<Types::ProvisionedProductPlanSummary>
- #next_page_token => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2464

def list_provisioned_product_plans(params = {}, options = {})
  req = build_request(:list_provisioned_product_plans, params)
  req.send_request(options)
end

#list_provisioning_artifacts(params = {}) ⇒ `Types::ListProvisioningArtifactsOutput`

Lists all provisioning artifacts (also known as versions) for the specified product.

Examples:

Request syntax with placeholder values


resp = client.list_provisioning_artifacts({
  accept_language: "AcceptLanguage",
  product_id: "Id", # required
})

Response structure


resp.provisioning_artifact_details #=> Array
resp.provisioning_artifact_details[0].id #=> String
resp.provisioning_artifact_details[0].name #=> String
resp.provisioning_artifact_details[0].description #=> String
resp.provisioning_artifact_details[0].type #=> String, one of "CLOUD_FORMATION_TEMPLATE", "MARKETPLACE_AMI", "MARKETPLACE_CAR"
resp.provisioning_artifact_details[0].created_time #=> Time
resp.provisioning_artifact_details[0].active #=> Boolean
resp.next_page_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:accept_language (String) —
The language code.
- en - English (default)
- jp - Japanese
- zh - Chinese
:product_id (required, String) —
The product identifier.

Returns:

(Types::ListProvisioningArtifactsOutput) —
Returns a response object which responds to the following methods:
- #provisioning_artifact_details => Array<Types::ProvisioningArtifactDetail>
- #next_page_token => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2511

def list_provisioning_artifacts(params = {}, options = {})
  req = build_request(:list_provisioning_artifacts, params)
  req.send_request(options)
end

#list_record_history(params = {}) ⇒ `Types::ListRecordHistoryOutput`

Lists the specified requests or all performed requests.

Examples:

Request syntax with placeholder values


resp = client.list_record_history({
  accept_language: "AcceptLanguage",
  access_level_filter: {
    key: "Account", # accepts Account, Role, User
    value: "AccessLevelFilterValue",
  },
  search_filter: {
    key: "SearchFilterKey",
    value: "SearchFilterValue",
  },
  page_size: 1,
  page_token: "PageToken",
})

Response structure


resp.record_details #=> Array
resp.record_details[0].record_id #=> String
resp.record_details[0].provisioned_product_name #=> String
resp.record_details[0].status #=> String, one of "CREATED", "IN_PROGRESS", "IN_PROGRESS_IN_ERROR", "SUCCEEDED", "FAILED"
resp.record_details[0].created_time #=> Time
resp.record_details[0].updated_time #=> Time
resp.record_details[0].provisioned_product_type #=> String
resp.record_details[0].record_type #=> String
resp.record_details[0].provisioned_product_id #=> String
resp.record_details[0].product_id #=> String
resp.record_details[0].provisioning_artifact_id #=> String
resp.record_details[0].path_id #=> String
resp.record_details[0].record_errors #=> Array
resp.record_details[0].record_errors[0].code #=> String
resp.record_details[0].record_errors[0].description #=> String
resp.record_details[0].record_tags #=> Array
resp.record_details[0].record_tags[0].key #=> String
resp.record_details[0].record_tags[0].value #=> String
resp.next_page_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:accept_language (String) —
The language code.
- en - English (default)
- jp - Japanese
- zh - Chinese
:access_level_filter (Types::AccessLevelFilter) —
The access level to use to obtain results. The default is User.
:search_filter (Types::ListRecordHistorySearchFilter) —
The search filter to scope the results.
:page_size (Integer) —
The maximum number of items to return with this call.
:page_token (String) —
The page token for the next set of results. To retrieve the first set of results, use null.

Returns:

(Types::ListRecordHistoryOutput) —
Returns a response object which responds to the following methods:
- #record_details => Array<Types::RecordDetail>
- #next_page_token => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2587

def list_record_history(params = {}, options = {})
  req = build_request(:list_record_history, params)
  req.send_request(options)
end

#list_resources_for_tag_option(params = {}) ⇒ `Types::ListResourcesForTagOptionOutput`

Lists the resources associated with the specified TagOption.

Examples:

Request syntax with placeholder values


resp = client.list_resources_for_tag_option({
  tag_option_id: "TagOptionId", # required
  resource_type: "ResourceType",
  page_size: 1,
  page_token: "PageToken",
})

Response structure


resp.resource_details #=> Array
resp.resource_details[0].id #=> String
resp.resource_details[0].arn #=> String
resp.resource_details[0].name #=> String
resp.resource_details[0].description #=> String
resp.resource_details[0].created_time #=> Time
resp.page_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:tag_option_id (required, String) —
The TagOption identifier.
:resource_type (String) —
The resource type.
- Portfolio
- Product
:page_size (Integer) —
The maximum number of items to return with this call.
:page_token (String) —
The page token for the next set of results. To retrieve the first set of results, use null.

Returns:

(Types::ListResourcesForTagOptionOutput) —
Returns a response object which responds to the following methods:
- #resource_details => Array<Types::ResourceDetail>
- #page_token => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2639

def list_resources_for_tag_option(params = {}, options = {})
  req = build_request(:list_resources_for_tag_option, params)
  req.send_request(options)
end

#list_tag_options(params = {}) ⇒ `Types::ListTagOptionsOutput`

Lists the specified TagOptions or all TagOptions.

Examples:

Request syntax with placeholder values


resp = client.list_tag_options({
  filters: {
    key: "TagOptionKey",
    value: "TagOptionValue",
    active: false,
  },
  page_size: 1,
  page_token: "PageToken",
})

Response structure


resp.tag_option_details #=> Array
resp.tag_option_details[0].key #=> String
resp.tag_option_details[0].value #=> String
resp.tag_option_details[0].active #=> Boolean
resp.tag_option_details[0].id #=> String
resp.page_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:filters (Types::ListTagOptionsFilters) —
The search filters. If no search filters are specified, the output includes all TagOptions.
:page_size (Integer) —
The maximum number of items to return with this call.
:page_token (String) —
The page token for the next set of results. To retrieve the first set of results, use null.

Returns:

(Types::ListTagOptionsOutput) —
Returns a response object which responds to the following methods:
- #tag_option_details => Array<Types::TagOptionDetail>
- #page_token => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2687

def list_tag_options(params = {}, options = {})
  req = build_request(:list_tag_options, params)
  req.send_request(options)
end

#provision_product(params = {}) ⇒ `Types::ProvisionProductOutput`

Provisions the specified product.

A provisioned product is a resourced instance of a product. For example, provisioning a product based on a CloudFormation template launches a CloudFormation stack and its underlying resources. You can check the status of this request using DescribeRecord.

If the request contains a tag key with an empty list of values, there is a tag conflict for that key. Do not include conflicted keys as tags, or this causes the error "Parameter validation failed: Missing required parameter in Tags[N]:Value".

Examples:

Request syntax with placeholder values


resp = client.provision_product({
  accept_language: "AcceptLanguage",
  product_id: "Id", # required
  provisioning_artifact_id: "Id", # required
  path_id: "Id",
  provisioned_product_name: "ProvisionedProductName", # required
  provisioning_parameters: [
    {
      key: "ParameterKey",
      value: "ParameterValue",
    },
  ],
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  notification_arns: ["NotificationArn"],
  provision_token: "IdempotencyToken", # required
})

Response structure


resp.record_detail.record_id #=> String
resp.record_detail.provisioned_product_name #=> String
resp.record_detail.status #=> String, one of "CREATED", "IN_PROGRESS", "IN_PROGRESS_IN_ERROR", "SUCCEEDED", "FAILED"
resp.record_detail.created_time #=> Time
resp.record_detail.updated_time #=> Time
resp.record_detail.provisioned_product_type #=> String
resp.record_detail.record_type #=> String
resp.record_detail.provisioned_product_id #=> String
resp.record_detail.product_id #=> String
resp.record_detail.provisioning_artifact_id #=> String
resp.record_detail.path_id #=> String
resp.record_detail.record_errors #=> Array
resp.record_detail.record_errors[0].code #=> String
resp.record_detail.record_errors[0].description #=> String
resp.record_detail.record_tags #=> Array
resp.record_detail.record_tags[0].key #=> String
resp.record_detail.record_tags[0].value #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:accept_language (String) —
The language code.
- en - English (default)
- jp - Japanese
- zh - Chinese
:product_id (required, String) —
The product identifier.
:provisioning_artifact_id (required, String) —
The identifier of the provisioning artifact.
:path_id (String) —
The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths.
:provisioned_product_name (required, String) —
A user-friendly name for the provisioned product. This value must be unique for the AWS account and cannot be updated after the product is provisioned.
:provisioning_parameters (Array<Types::ProvisioningParameter>) —
Parameters specified by the administrator that are required for provisioning the product.
:tags (Array<Types::Tag>) —
One or more tags.
:notification_arns (Array<String>) —
Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events.
:provision_token (required, String) —
An idempotency token that uniquely identifies the provisioning request.

A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

(Types::ProvisionProductOutput) —
Returns a response object which responds to the following methods:
- #record_detail => Types::RecordDetail

See Also:

AWS API Documentation

# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2799

def provision_product(params = {}, options = {})
  req = build_request(:provision_product, params)
  req.send_request(options)
end

#reject_portfolio_share(params = {}) ⇒ `Struct`

Rejects an offer to share the specified portfolio.

Examples:

Request syntax with placeholder values


resp = client.reject_portfolio_share({
  accept_language: "AcceptLanguage",
  portfolio_id: "Id", # required
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:accept_language (String) —
The language code.
- en - English (default)
- jp - Japanese
- zh - Chinese
:portfolio_id (required, String) —
The portfolio identifier.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2831

def reject_portfolio_share(params = {}, options = {})
  req = build_request(:reject_portfolio_share, params)
  req.send_request(options)
end

#scan_provisioned_products(params = {}) ⇒ `Types::ScanProvisionedProductsOutput`

Lists the provisioned products that are available (not terminated).

To use additional filtering, see SearchProvisionedProducts.

Examples:

Request syntax with placeholder values


resp = client.scan_provisioned_products({
  accept_language: "AcceptLanguage",
  access_level_filter: {
    key: "Account", # accepts Account, Role, User
    value: "AccessLevelFilterValue",
  },
  page_size: 1,
  page_token: "PageToken",
})

Response structure


resp.provisioned_products #=> Array
resp.provisioned_products[0].name #=> String
resp.provisioned_products[0].arn #=> String
resp.provisioned_products[0].type #=> String
resp.provisioned_products[0].id #=> String
resp.provisioned_products[0].status #=> String, one of "AVAILABLE", "UNDER_CHANGE", "TAINTED", "ERROR", "PLAN_IN_PROGRESS"
resp.provisioned_products[0].status_message #=> String
resp.provisioned_products[0].created_time #=> Time
resp.provisioned_products[0].idempotency_token #=> String
resp.provisioned_products[0].last_record_id #=> String
resp.next_page_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:accept_language (String) —
The language code.
- en - English (default)
- jp - Japanese
- zh - Chinese
:access_level_filter (Types::AccessLevelFilter) —
The access level to use to obtain results. The default is User.
:page_size (Integer) —
The maximum number of items to return with this call.
:page_token (String) —
The page token for the next set of results. To retrieve the first set of results, use null.

Returns:

(Types::ScanProvisionedProductsOutput) —
Returns a response object which responds to the following methods:
- #provisioned_products => Array<Types::ProvisionedProductDetail>
- #next_page_token => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2894

def scan_provisioned_products(params = {}, options = {})
  req = build_request(:scan_provisioned_products, params)
  req.send_request(options)
end

#search_products(params = {}) ⇒ `Types::SearchProductsOutput`

Gets information about the products to which the caller has access.

Examples:

Request syntax with placeholder values


resp = client.search_products({
  accept_language: "AcceptLanguage",
  filters: {
    "FullTextSearch" => ["ProductViewFilterValue"],
  },
  page_size: 1,
  sort_by: "Title", # accepts Title, VersionCount, CreationDate
  sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
  page_token: "PageToken",
})

Response structure


resp.product_view_summaries #=> Array
resp.product_view_summaries[0].id #=> String
resp.product_view_summaries[0].product_id #=> String
resp.product_view_summaries[0].name #=> String
resp.product_view_summaries[0].owner #=> String
resp.product_view_summaries[0].short_description #=> String
resp.product_view_summaries[0].type #=> String, one of "CLOUD_FORMATION_TEMPLATE", "MARKETPLACE"
resp.product_view_summaries[0].distributor #=> String
resp.product_view_summaries[0].has_default_path #=> Boolean
resp.product_view_summaries[0].support_email #=> String
resp.product_view_summaries[0].support_description #=> String
resp.product_view_summaries[0].support_url #=> String
resp.product_view_aggregations #=> Hash
resp.product_view_aggregations["ProductViewAggregationType"] #=> Array
resp.product_view_aggregations["ProductViewAggregationType"][0].value #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
resp.product_view_aggregations["ProductViewAggregationType"][0].approximate_count #=> Integer
resp.next_page_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:accept_language (String) —
The language code.
- en - English (default)
- jp - Japanese
- zh - Chinese
:filters (Hash<String,Array>) —
The search filters. If no search filters are specified, the output includes all products to which the caller has access.
:page_size (Integer) —
The maximum number of items to return with this call.
:sort_by (String) —
The sort field. If no value is specified, the results are not sorted.
:sort_order (String) —
The sort order. If no value is specified, the results are not sorted.
:page_token (String) —
The page token for the next set of results. To retrieve the first set of results, use null.

Returns:

(Types::SearchProductsOutput) —
Returns a response object which responds to the following methods:
- #product_view_summaries => Array<Types::ProductViewSummary>
- #product_view_aggregations => Hash<String,Array<Types::ProductViewAggregationValue>>
- #next_page_token => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2970

def search_products(params = {}, options = {})
  req = build_request(:search_products, params)
  req.send_request(options)
end

#search_products_as_admin(params = {}) ⇒ `Types::SearchProductsAsAdminOutput`

Gets information about the products for the specified portfolio or all products.

Examples:

Request syntax with placeholder values


resp = client.search_products_as_admin({
  accept_language: "AcceptLanguage",
  portfolio_id: "Id",
  filters: {
    "FullTextSearch" => ["ProductViewFilterValue"],
  },
  sort_by: "Title", # accepts Title, VersionCount, CreationDate
  sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
  page_token: "PageToken",
  page_size: 1,
  product_source: "ACCOUNT", # accepts ACCOUNT
})

Response structure


resp.product_view_details #=> Array
resp.product_view_details[0].product_view_summary.id #=> String
resp.product_view_details[0].product_view_summary.product_id #=> String
resp.product_view_details[0].product_view_summary.name #=> String
resp.product_view_details[0].product_view_summary.owner #=> String
resp.product_view_details[0].product_view_summary.short_description #=> String
resp.product_view_details[0].product_view_summary.type #=> String, one of "CLOUD_FORMATION_TEMPLATE", "MARKETPLACE"
resp.product_view_details[0].product_view_summary.distributor #=> String
resp.product_view_details[0].product_view_summary.has_default_path #=> Boolean
resp.product_view_details[0].product_view_summary.support_email #=> String
resp.product_view_details[0].product_view_summary.support_description #=> String
resp.product_view_details[0].product_view_summary.support_url #=> String
resp.product_view_details[0].status #=> String, one of "AVAILABLE", "CREATING", "FAILED"
resp.product_view_details[0].product_arn #=> String
resp.product_view_details[0].created_time #=> Time
resp.next_page_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:accept_language (String) —
The language code.
- en - English (default)
- jp - Japanese
- zh - Chinese
:portfolio_id (String) —
The portfolio identifier.
:filters (Hash<String,Array>) —
The search filters. If no search filters are specified, the output includes all products to which the administrator has access.
:sort_by (String) —
The sort field. If no value is specified, the results are not sorted.
:sort_order (String) —
The sort order. If no value is specified, the results are not sorted.
:page_token (String) —
The page token for the next set of results. To retrieve the first set of results, use null.
:page_size (Integer) —
The maximum number of items to return with this call.
:product_source (String) —
Access level of the source of the product.

Returns:

(Types::SearchProductsAsAdminOutput) —
Returns a response object which responds to the following methods:
- #product_view_details => Array<Types::ProductViewDetail>
- #next_page_token => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 3053

def search_products_as_admin(params = {}, options = {})
  req = build_request(:search_products_as_admin, params)
  req.send_request(options)
end

#search_provisioned_products(params = {}) ⇒ `Types::SearchProvisionedProductsOutput`

Gets information about the provisioned products that meet the specified criteria.

Examples:

Request syntax with placeholder values


resp = client.search_provisioned_products({
  accept_language: "AcceptLanguage",
  access_level_filter: {
    key: "Account", # accepts Account, Role, User
    value: "AccessLevelFilterValue",
  },
  filters: {
    "SearchQuery" => ["ProvisionedProductViewFilterValue"],
  },
  sort_by: "SortField",
  sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
  page_size: 1,
  page_token: "PageToken",
})

Response structure


resp.provisioned_products #=> Array
resp.provisioned_products[0].name #=> String
resp.provisioned_products[0].arn #=> String
resp.provisioned_products[0].type #=> String
resp.provisioned_products[0].id #=> String
resp.provisioned_products[0].status #=> String, one of "AVAILABLE", "UNDER_CHANGE", "TAINTED", "ERROR", "PLAN_IN_PROGRESS"
resp.provisioned_products[0].status_message #=> String
resp.provisioned_products[0].created_time #=> Time
resp.provisioned_products[0].idempotency_token #=> String
resp.provisioned_products[0].last_record_id #=> String
resp.provisioned_products[0].tags #=> Array
resp.provisioned_products[0].tags[0].key #=> String
resp.provisioned_products[0].tags[0].value #=> String
resp.provisioned_products[0].physical_id #=> String
resp.provisioned_products[0].product_id #=> String
resp.provisioned_products[0].provisioning_artifact_id #=> String
resp.provisioned_products[0].user_arn #=> String
resp.provisioned_products[0].user_arn_session #=> String
resp.total_results_count #=> Integer
resp.next_page_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:accept_language (String) —
The language code.
- en - English (default)
- jp - Japanese
- zh - Chinese
:access_level_filter (Types::AccessLevelFilter) —
The access level to use to obtain results. The default is User.
:filters (Hash<String,Array>) —
The search filters.

When the key is SearchQuery, the searchable fields are arn, createdTime, id, lastRecordId, idempotencyToken, name, physicalId, productId, provisioningArtifact, type, status, tags, userArn, and userArnSession.

Example: "SearchQuery":["status:AVAILABLE"]
:sort_by (String) —
The sort field. If no value is specified, the results are not sorted. The valid values are arn, id, name, and lastRecordId.
:sort_order (String) —
The sort order. If no value is specified, the results are not sorted.
:page_size (Integer) —
The maximum number of items to return with this call.
:page_token (String) —
The page token for the next set of results. To retrieve the first set of results, use null.

Returns:

(Types::SearchProvisionedProductsOutput) —
Returns a response object which responds to the following methods:
- #provisioned_products => Array<Types::ProvisionedProductAttribute>
- #total_results_count => Integer
- #next_page_token => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 3147

def search_provisioned_products(params = {}, options = {})
  req = build_request(:search_provisioned_products, params)
  req.send_request(options)
end

#terminate_provisioned_product(params = {}) ⇒ `Types::TerminateProvisionedProductOutput`

Terminates the specified provisioned product.

This operation does not delete any records associated with the provisioned product.

You can check the status of this request using DescribeRecord.

Examples:

Request syntax with placeholder values


resp = client.terminate_provisioned_product({
  provisioned_product_name: "ProvisionedProductNameOrArn",
  provisioned_product_id: "Id",
  terminate_token: "IdempotencyToken", # required
  ignore_errors: false,
  accept_language: "AcceptLanguage",
})

Response structure


resp.record_detail.record_id #=> String
resp.record_detail.provisioned_product_name #=> String
resp.record_detail.status #=> String, one of "CREATED", "IN_PROGRESS", "IN_PROGRESS_IN_ERROR", "SUCCEEDED", "FAILED"
resp.record_detail.created_time #=> Time
resp.record_detail.updated_time #=> Time
resp.record_detail.provisioned_product_type #=> String
resp.record_detail.record_type #=> String
resp.record_detail.provisioned_product_id #=> String
resp.record_detail.product_id #=> String
resp.record_detail.provisioning_artifact_id #=> String
resp.record_detail.path_id #=> String
resp.record_detail.record_errors #=> Array
resp.record_detail.record_errors[0].code #=> String
resp.record_detail.record_errors[0].description #=> String
resp.record_detail.record_tags #=> Array
resp.record_detail.record_tags[0].key #=> String
resp.record_detail.record_tags[0].value #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:provisioned_product_name (String) —
The name of the provisioned product. You cannot specify both ProvisionedProductName and ProvisionedProductId.
:provisioned_product_id (String) —
The identifier of the provisioned product. You cannot specify both ProvisionedProductName and ProvisionedProductId.
:terminate_token (required, String) —
An idempotency token that uniquely identifies the termination request. This token is only valid during the termination process. After the provisioned product is terminated, subsequent requests to terminate the same provisioned product always return ResourceNotFound.

A suitable default value is auto-generated. You should normally not need to pass this option.**
:ignore_errors (Boolean) —
If set to true, AWS Service Catalog stops managing the specified provisioned product even if it cannot delete the underlying resources.
:accept_language (String) —
The language code.
- en - English (default)
- jp - Japanese
- zh - Chinese

Returns:

(Types::TerminateProvisionedProductOutput) —
Returns a response object which responds to the following methods:
- #record_detail => Types::RecordDetail

See Also:

AWS API Documentation

# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 3227

def terminate_provisioned_product(params = {}, options = {})
  req = build_request(:terminate_provisioned_product, params)
  req.send_request(options)
end

#update_constraint(params = {}) ⇒ `Types::UpdateConstraintOutput`

Updates the specified constraint.

Examples:

Request syntax with placeholder values


resp = client.update_constraint({
  accept_language: "AcceptLanguage",
  id: "Id", # required
  description: "ConstraintDescription",
})

Response structure


resp.constraint_detail.constraint_id #=> String
resp.constraint_detail.type #=> String
resp.constraint_detail.description #=> String
resp.constraint_detail.owner #=> String
resp.constraint_parameters #=> String
resp.status #=> String, one of "AVAILABLE", "CREATING", "FAILED"

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:accept_language (String) —
The language code.
- en - English (default)
- jp - Japanese
- zh - Chinese
:id (required, String) —
The identifier of the constraint.
:description (String) —
The updated description of the constraint.

Returns:

(Types::UpdateConstraintOutput) —
Returns a response object which responds to the following methods:
- #constraint_detail => Types::ConstraintDetail
- #constraint_parameters => String
- #status => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 3276

def update_constraint(params = {}, options = {})
  req = build_request(:update_constraint, params)
  req.send_request(options)
end

#update_portfolio(params = {}) ⇒ `Types::UpdatePortfolioOutput`

Updates the specified portfolio.

You cannot update a product that was shared with you.

Examples:

Request syntax with placeholder values


resp = client.update_portfolio({
  accept_language: "AcceptLanguage",
  id: "Id", # required
  display_name: "PortfolioDisplayName",
  description: "PortfolioDescription",
  provider_name: "ProviderName",
  add_tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  remove_tags: ["TagKey"],
})

Response structure


resp.portfolio_detail.id #=> String
resp.portfolio_detail.arn #=> String
resp.portfolio_detail.display_name #=> String
resp.portfolio_detail.description #=> String
resp.portfolio_detail.created_time #=> Time
resp.portfolio_detail.provider_name #=> String
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:accept_language (String) —
The language code.
- en - English (default)
- jp - Japanese
- zh - Chinese
:id (required, String) —
The portfolio identifier.
:display_name (String) —
The name to use for display purposes.
:description (String) —
The updated description of the portfolio.
:provider_name (String) —
The updated name of the portfolio provider.
:add_tags (Array<Types::Tag>) —
The tags to add.
:remove_tags (Array<String>) —
The tags to remove.

Returns:

(Types::UpdatePortfolioOutput) —
Returns a response object which responds to the following methods:
- #portfolio_detail => Types::PortfolioDetail
- #tags => Array<Types::Tag>

See Also:

AWS API Documentation

# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 3350

def update_portfolio(params = {}, options = {})
  req = build_request(:update_portfolio, params)
  req.send_request(options)
end

#update_product(params = {}) ⇒ `Types::UpdateProductOutput`

Updates the specified product.

Examples:

Request syntax with placeholder values


resp = client.update_product({
  accept_language: "AcceptLanguage",
  id: "Id", # required
  name: "ProductViewName",
  owner: "ProductViewOwner",
  description: "ProductViewShortDescription",
  distributor: "ProductViewOwner",
  support_description: "SupportDescription",
  support_email: "SupportEmail",
  support_url: "SupportUrl",
  add_tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  remove_tags: ["TagKey"],
})

Response structure


resp.product_view_detail.product_view_summary.id #=> String
resp.product_view_detail.product_view_summary.product_id #=> String
resp.product_view_detail.product_view_summary.name #=> String
resp.product_view_detail.product_view_summary.owner #=> String
resp.product_view_detail.product_view_summary.short_description #=> String
resp.product_view_detail.product_view_summary.type #=> String, one of "CLOUD_FORMATION_TEMPLATE", "MARKETPLACE"
resp.product_view_detail.product_view_summary.distributor #=> String
resp.product_view_detail.product_view_summary.has_default_path #=> Boolean
resp.product_view_detail.product_view_summary.support_email #=> String
resp.product_view_detail.product_view_summary.support_description #=> String
resp.product_view_detail.product_view_summary.support_url #=> String
resp.product_view_detail.status #=> String, one of "AVAILABLE", "CREATING", "FAILED"
resp.product_view_detail.product_arn #=> String
resp.product_view_detail.created_time #=> Time
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:accept_language (String) —
The language code.
- en - English (default)
- jp - Japanese
- zh - Chinese
:id (required, String) —
The product identifier.
:name (String) —
The updated product name.
:owner (String) —
The updated owner of the product.
:description (String) —
The updated description of the product.
:distributor (String) —
The updated distributor of the product.
:support_description (String) —
The updated support description for the product.
:support_email (String) —
The updated support email for the product.
:support_url (String) —
The updated support URL for the product.
:add_tags (Array<Types::Tag>) —
The tags to add to the product.
:remove_tags (Array<String>) —
The tags to remove from the product.

Returns:

(Types::UpdateProductOutput) —
Returns a response object which responds to the following methods:
- #product_view_detail => Types::ProductViewDetail
- #tags => Array<Types::Tag>

See Also:

AWS API Documentation

# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 3446

def update_product(params = {}, options = {})
  req = build_request(:update_product, params)
  req.send_request(options)
end

#update_provisioned_product(params = {}) ⇒ `Types::UpdateProvisionedProductOutput`

Requests updates to the configuration of the specified provisioned product.

If there are tags associated with the object, they cannot be updated or added. Depending on the specific updates requested, this operation can update with no interruption, with some interruption, or replace the provisioned product entirely.

You can check the status of this request using DescribeRecord.

Examples:

Request syntax with placeholder values


resp = client.update_provisioned_product({
  accept_language: "AcceptLanguage",
  provisioned_product_name: "ProvisionedProductNameOrArn",
  provisioned_product_id: "Id",
  product_id: "Id",
  provisioning_artifact_id: "Id",
  path_id: "Id",
  provisioning_parameters: [
    {
      key: "ParameterKey",
      value: "ParameterValue",
      use_previous_value: false,
    },
  ],
  update_token: "IdempotencyToken", # required
})

Response structure


resp.record_detail.record_id #=> String
resp.record_detail.provisioned_product_name #=> String
resp.record_detail.status #=> String, one of "CREATED", "IN_PROGRESS", "IN_PROGRESS_IN_ERROR", "SUCCEEDED", "FAILED"
resp.record_detail.created_time #=> Time
resp.record_detail.updated_time #=> Time
resp.record_detail.provisioned_product_type #=> String
resp.record_detail.record_type #=> String
resp.record_detail.provisioned_product_id #=> String
resp.record_detail.product_id #=> String
resp.record_detail.provisioning_artifact_id #=> String
resp.record_detail.path_id #=> String
resp.record_detail.record_errors #=> Array
resp.record_detail.record_errors[0].code #=> String
resp.record_detail.record_errors[0].description #=> String
resp.record_detail.record_tags #=> Array
resp.record_detail.record_tags[0].key #=> String
resp.record_detail.record_tags[0].value #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:accept_language (String) —
The language code.
- en - English (default)
- jp - Japanese
- zh - Chinese
:provisioned_product_name (String) —
The updated name of the provisioned product. You cannot specify both ProvisionedProductName and ProvisionedProductId.
:provisioned_product_id (String) —
The identifier of the provisioned product. You cannot specify both ProvisionedProductName and ProvisionedProductId.
:product_id (String) —
The identifier of the provisioned product.
:provisioning_artifact_id (String) —
The identifier of the provisioning artifact.
:path_id (String) —
The new path identifier. This value is optional if the product has a default path, and required if the product has more than one path.
:provisioning_parameters (Array<Types::UpdateProvisioningParameter>) —
The new parameters.
:update_token (required, String) —
The idempotency token that uniquely identifies the provisioning update request.

A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

(Types::UpdateProvisionedProductOutput) —
Returns a response object which responds to the following methods:
- #record_detail => Types::RecordDetail

See Also:

AWS API Documentation

# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 3545

def update_provisioned_product(params = {}, options = {})
  req = build_request(:update_provisioned_product, params)
  req.send_request(options)
end

#update_provisioning_artifact(params = {}) ⇒ `Types::UpdateProvisioningArtifactOutput`

Updates the specified provisioning artifact (also known as a version) for the specified product.

You cannot update a provisioning artifact for a product that was shared with you.

Examples:

Request syntax with placeholder values


resp = client.update_provisioning_artifact({
  accept_language: "AcceptLanguage",
  product_id: "Id", # required
  provisioning_artifact_id: "Id", # required
  name: "ProvisioningArtifactName",
  description: "ProvisioningArtifactDescription",
  active: false,
})

Response structure


resp.provisioning_artifact_detail.id #=> String
resp.provisioning_artifact_detail.name #=> String
resp.provisioning_artifact_detail.description #=> String
resp.provisioning_artifact_detail.type #=> String, one of "CLOUD_FORMATION_TEMPLATE", "MARKETPLACE_AMI", "MARKETPLACE_CAR"
resp.provisioning_artifact_detail.created_time #=> Time
resp.provisioning_artifact_detail.active #=> Boolean
resp.info #=> Hash
resp.info["ProvisioningArtifactInfoKey"] #=> String
resp.status #=> String, one of "AVAILABLE", "CREATING", "FAILED"

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:accept_language (String) —
The language code.
- en - English (default)
- jp - Japanese
- zh - Chinese
:product_id (required, String) —
The product identifier.
:provisioning_artifact_id (required, String) —
The identifier of the provisioning artifact.
:name (String) —
The updated name of the provisioning artifact.
:description (String) —
The updated description of the provisioning artifact.
:active (Boolean) —
Indicates whether the product version is active.

Returns:

(Types::UpdateProvisioningArtifactOutput) —
Returns a response object which responds to the following methods:
- #provisioning_artifact_detail => Types::ProvisioningArtifactDetail
- #info => Hash<String,String>
- #status => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 3613

def update_provisioning_artifact(params = {}, options = {})
  req = build_request(:update_provisioning_artifact, params)
  req.send_request(options)
end

#update_tag_option(params = {}) ⇒ `Types::UpdateTagOptionOutput`

Updates the specified TagOption.

Examples:

Request syntax with placeholder values


resp = client.update_tag_option({
  id: "TagOptionId", # required
  value: "TagOptionValue",
  active: false,
})

Response structure


resp.tag_option_detail.key #=> String
resp.tag_option_detail.value #=> String
resp.tag_option_detail.active #=> Boolean
resp.tag_option_detail.id #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:id (required, String) —
The TagOption identifier.
:value (String) —
The updated value.
:active (Boolean) —
The updated active state.

Returns:

(Types::UpdateTagOptionOutput) —
Returns a response object which responds to the following methods:
- #tag_option_detail => Types::TagOptionDetail

See Also:

AWS API Documentation

# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 3652

def update_tag_option(params = {}, options = {})
  req = build_request(:update_tag_option, params)
  req.send_request(options)
end

Class: Aws::ServiceCatalog::Client

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

Methods inherited from Seahorse::Client::Base

Methods included from Seahorse::Client::HandlerBuilder

Constructor Details

#initialize(*args) ⇒ Client

Instance Method Details

#accept_portfolio_share(params = {}) ⇒ Struct

#associate_principal_with_portfolio(params = {}) ⇒ Struct

#associate_product_with_portfolio(params = {}) ⇒ Struct

#associate_tag_option_with_resource(params = {}) ⇒ Struct

#copy_product(params = {}) ⇒ Types::CopyProductOutput

#create_constraint(params = {}) ⇒ Types::CreateConstraintOutput

#create_portfolio(params = {}) ⇒ Types::CreatePortfolioOutput

#create_portfolio_share(params = {}) ⇒ Struct

#create_product(params = {}) ⇒ Types::CreateProductOutput

#create_provisioned_product_plan(params = {}) ⇒ Types::CreateProvisionedProductPlanOutput

#create_provisioning_artifact(params = {}) ⇒ Types::CreateProvisioningArtifactOutput

#create_tag_option(params = {}) ⇒ Types::CreateTagOptionOutput

#delete_constraint(params = {}) ⇒ Struct

#delete_portfolio(params = {}) ⇒ Struct

#delete_portfolio_share(params = {}) ⇒ Struct

#delete_product(params = {}) ⇒ Struct

#delete_provisioned_product_plan(params = {}) ⇒ Struct

#delete_provisioning_artifact(params = {}) ⇒ Struct

#delete_tag_option(params = {}) ⇒ Struct

#describe_constraint(params = {}) ⇒ Types::DescribeConstraintOutput

#describe_copy_product_status(params = {}) ⇒ Types::DescribeCopyProductStatusOutput

#describe_portfolio(params = {}) ⇒ Types::DescribePortfolioOutput

#describe_product(params = {}) ⇒ Types::DescribeProductOutput

#describe_product_as_admin(params = {}) ⇒ Types::DescribeProductAsAdminOutput

#describe_product_view(params = {}) ⇒ Types::DescribeProductViewOutput

#describe_provisioned_product(params = {}) ⇒ Types::DescribeProvisionedProductOutput

#describe_provisioned_product_plan(params = {}) ⇒ Types::DescribeProvisionedProductPlanOutput

#describe_provisioning_artifact(params = {}) ⇒ Types::DescribeProvisioningArtifactOutput

#describe_provisioning_parameters(params = {}) ⇒ Types::DescribeProvisioningParametersOutput

#describe_record(params = {}) ⇒ Types::DescribeRecordOutput

#describe_tag_option(params = {}) ⇒ Types::DescribeTagOptionOutput

#disassociate_principal_from_portfolio(params = {}) ⇒ Struct

#disassociate_product_from_portfolio(params = {}) ⇒ Struct

#disassociate_tag_option_from_resource(params = {}) ⇒ Struct

#execute_provisioned_product_plan(params = {}) ⇒ Types::ExecuteProvisionedProductPlanOutput

#list_accepted_portfolio_shares(params = {}) ⇒ Types::ListAcceptedPortfolioSharesOutput

#list_constraints_for_portfolio(params = {}) ⇒ Types::ListConstraintsForPortfolioOutput

#list_launch_paths(params = {}) ⇒ Types::ListLaunchPathsOutput

#list_portfolio_access(params = {}) ⇒ Types::ListPortfolioAccessOutput

#list_portfolios(params = {}) ⇒ Types::ListPortfoliosOutput

#list_portfolios_for_product(params = {}) ⇒ Types::ListPortfoliosForProductOutput

#list_principals_for_portfolio(params = {}) ⇒ Types::ListPrincipalsForPortfolioOutput

#list_provisioned_product_plans(params = {}) ⇒ Types::ListProvisionedProductPlansOutput

#list_provisioning_artifacts(params = {}) ⇒ Types::ListProvisioningArtifactsOutput

#list_record_history(params = {}) ⇒ Types::ListRecordHistoryOutput

#list_resources_for_tag_option(params = {}) ⇒ Types::ListResourcesForTagOptionOutput

#list_tag_options(params = {}) ⇒ Types::ListTagOptionsOutput

#provision_product(params = {}) ⇒ Types::ProvisionProductOutput

#reject_portfolio_share(params = {}) ⇒ Struct

#scan_provisioned_products(params = {}) ⇒ Types::ScanProvisionedProductsOutput

#search_products(params = {}) ⇒ Types::SearchProductsOutput

#search_products_as_admin(params = {}) ⇒ Types::SearchProductsAsAdminOutput

#search_provisioned_products(params = {}) ⇒ Types::SearchProvisionedProductsOutput

#terminate_provisioned_product(params = {}) ⇒ Types::TerminateProvisionedProductOutput

#update_constraint(params = {}) ⇒ Types::UpdateConstraintOutput

#update_portfolio(params = {}) ⇒ Types::UpdatePortfolioOutput

#update_product(params = {}) ⇒ Types::UpdateProductOutput

#update_provisioned_product(params = {}) ⇒ Types::UpdateProvisionedProductOutput

#update_provisioning_artifact(params = {}) ⇒ Types::UpdateProvisioningArtifactOutput

#update_tag_option(params = {}) ⇒ Types::UpdateTagOptionOutput

#initialize(*args) ⇒ `Client`

#accept_portfolio_share(params = {}) ⇒ `Struct`

#associate_principal_with_portfolio(params = {}) ⇒ `Struct`

#associate_product_with_portfolio(params = {}) ⇒ `Struct`

#associate_tag_option_with_resource(params = {}) ⇒ `Struct`

#copy_product(params = {}) ⇒ `Types::CopyProductOutput`

#create_constraint(params = {}) ⇒ `Types::CreateConstraintOutput`

#create_portfolio(params = {}) ⇒ `Types::CreatePortfolioOutput`

#create_portfolio_share(params = {}) ⇒ `Struct`

#create_product(params = {}) ⇒ `Types::CreateProductOutput`

#create_provisioned_product_plan(params = {}) ⇒ `Types::CreateProvisionedProductPlanOutput`

#create_provisioning_artifact(params = {}) ⇒ `Types::CreateProvisioningArtifactOutput`

#create_tag_option(params = {}) ⇒ `Types::CreateTagOptionOutput`

#delete_constraint(params = {}) ⇒ `Struct`

#delete_portfolio(params = {}) ⇒ `Struct`

#delete_portfolio_share(params = {}) ⇒ `Struct`

#delete_product(params = {}) ⇒ `Struct`

#delete_provisioned_product_plan(params = {}) ⇒ `Struct`

#delete_provisioning_artifact(params = {}) ⇒ `Struct`

#delete_tag_option(params = {}) ⇒ `Struct`

#describe_constraint(params = {}) ⇒ `Types::DescribeConstraintOutput`

#describe_copy_product_status(params = {}) ⇒ `Types::DescribeCopyProductStatusOutput`

#describe_portfolio(params = {}) ⇒ `Types::DescribePortfolioOutput`

#describe_product(params = {}) ⇒ `Types::DescribeProductOutput`

#describe_product_as_admin(params = {}) ⇒ `Types::DescribeProductAsAdminOutput`

#describe_product_view(params = {}) ⇒ `Types::DescribeProductViewOutput`

#describe_provisioned_product(params = {}) ⇒ `Types::DescribeProvisionedProductOutput`

#describe_provisioned_product_plan(params = {}) ⇒ `Types::DescribeProvisionedProductPlanOutput`

#describe_provisioning_artifact(params = {}) ⇒ `Types::DescribeProvisioningArtifactOutput`

#describe_provisioning_parameters(params = {}) ⇒ `Types::DescribeProvisioningParametersOutput`

#describe_record(params = {}) ⇒ `Types::DescribeRecordOutput`

#describe_tag_option(params = {}) ⇒ `Types::DescribeTagOptionOutput`

#disassociate_principal_from_portfolio(params = {}) ⇒ `Struct`

#disassociate_product_from_portfolio(params = {}) ⇒ `Struct`

#disassociate_tag_option_from_resource(params = {}) ⇒ `Struct`

#execute_provisioned_product_plan(params = {}) ⇒ `Types::ExecuteProvisionedProductPlanOutput`

#list_accepted_portfolio_shares(params = {}) ⇒ `Types::ListAcceptedPortfolioSharesOutput`

#list_constraints_for_portfolio(params = {}) ⇒ `Types::ListConstraintsForPortfolioOutput`

#list_launch_paths(params = {}) ⇒ `Types::ListLaunchPathsOutput`

#list_portfolio_access(params = {}) ⇒ `Types::ListPortfolioAccessOutput`

#list_portfolios(params = {}) ⇒ `Types::ListPortfoliosOutput`

#list_portfolios_for_product(params = {}) ⇒ `Types::ListPortfoliosForProductOutput`

#list_principals_for_portfolio(params = {}) ⇒ `Types::ListPrincipalsForPortfolioOutput`

#list_provisioned_product_plans(params = {}) ⇒ `Types::ListProvisionedProductPlansOutput`

#list_provisioning_artifacts(params = {}) ⇒ `Types::ListProvisioningArtifactsOutput`

#list_record_history(params = {}) ⇒ `Types::ListRecordHistoryOutput`

#list_resources_for_tag_option(params = {}) ⇒ `Types::ListResourcesForTagOptionOutput`

#list_tag_options(params = {}) ⇒ `Types::ListTagOptionsOutput`

#provision_product(params = {}) ⇒ `Types::ProvisionProductOutput`

#reject_portfolio_share(params = {}) ⇒ `Struct`

#scan_provisioned_products(params = {}) ⇒ `Types::ScanProvisionedProductsOutput`

#search_products(params = {}) ⇒ `Types::SearchProductsOutput`

#search_products_as_admin(params = {}) ⇒ `Types::SearchProductsAsAdminOutput`

#search_provisioned_products(params = {}) ⇒ `Types::SearchProvisionedProductsOutput`

#terminate_provisioned_product(params = {}) ⇒ `Types::TerminateProvisionedProductOutput`

#update_constraint(params = {}) ⇒ `Types::UpdateConstraintOutput`

#update_portfolio(params = {}) ⇒ `Types::UpdatePortfolioOutput`

#update_product(params = {}) ⇒ `Types::UpdateProductOutput`

#update_provisioned_product(params = {}) ⇒ `Types::UpdateProvisionedProductOutput`

#update_provisioning_artifact(params = {}) ⇒ `Types::UpdateProvisioningArtifactOutput`

#update_tag_option(params = {}) ⇒ `Types::UpdateTagOptionOutput`