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 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

Instance Method Summary collapse

Methods included from ClientStubs

#stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(*args) ⇒ Client

Returns a new instance of Client

Parameters:

  • options (Hash)

    a customizable set of options



152
153
154
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 152

def initialize(*args)
  super
end

Instance Method Details

#accept_portfolio_share(params = {}) ⇒ Struct

Accepts an offer to share a 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 to use for this operation. Supported language codes are as follows:

    "en" (English)

    "jp" (Japanese)

    "zh" (Chinese)

    If no code is specified, "en" is used as the default.

  • :portfolio_id (required, String)

    The portfolio identifier.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



188
189
190
191
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 188

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 to use for this operation. Supported language codes are as follows:

    "en" (English)

    "jp" (Japanese)

    "zh" (Chinese)

    If no code is specified, "en" is used as the default.

  • :portfolio_id (required, String)

    The portfolio identifier.

  • :principal_arn (required, String)

    The ARN representing the principal (IAM user, role, or group).

  • :principal_type (required, String)

    The principal type. Must be IAM

Returns:

  • (Struct)

    Returns an empty response.

See Also:



231
232
233
234
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 231

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 a product with a 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 to use for this operation. Supported language codes are as follows:

    "en" (English)

    "jp" (Japanese)

    "zh" (Chinese)

    If no code is specified, "en" is used as the default.

  • :product_id (required, String)

    The product identifier.

  • :portfolio_id (required, String)

    The portfolio identifier.

  • :source_portfolio_id (String)

    The identifier of the source portfolio to use with this association.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



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

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 a TagOption identifier with a resource identifier.

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:



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

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

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

Creates a new constraint. For more information, see Using Constraints.

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 to use for this operation. Supported language codes are as follows:

    "en" (English)

    "jp" (Japanese)

    "zh" (Chinese)

    If no code is specified, "en" is used as the default.

  • :portfolio_id (required, String)

    The portfolio identifier.

  • :product_id (required, String)

    The product identifier.

  • :parameters (required, String)

    The constraint parameters. Expected values vary depending on which Type is specified. For examples, see the bottom of this topic.

    For Type LAUNCH, the RoleArn property is required.

    For Type NOTIFICATION, the NotificationArns property is required.

    For Type TEMPLATE, the Rules property is required.

  • :type (required, String)

    The type of the constraint. Case-sensitive valid values are: LAUNCH, NOTIFICATION, or TEMPLATE.

  • :description (String)

    The text description of the constraint.

  • :idempotency_token (required, String)

    A token to disambiguate duplicate requests. You can create multiple resources using the same input in multiple requests, provided that you also specify a different idempotency token for each request.

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

Returns:

See Also:



386
387
388
389
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 386

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

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

Creates a new 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 to use for this operation. Supported language codes are as follows:

    "en" (English)

    "jp" (Japanese)

    "zh" (Chinese)

    If no code is specified, "en" is used as the default.

  • :display_name (required, String)

    The name to use for display purposes.

  • :description (String)

    The text description of the portfolio.

  • :provider_name (required, String)

    The name of the portfolio provider.

  • :tags (Array<Types::Tag>)

    Tags to associate with the new portfolio.

  • :idempotency_token (required, String)

    A token to disambiguate duplicate requests. You can create multiple resources using the same input in multiple requests, provided that you also specify a different idempotency token for each request.

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

Returns:

See Also:



462
463
464
465
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 462

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

#create_portfolio_share(params = {}) ⇒ Struct

Creates a new portfolio share.

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 to use for this operation. Supported language codes are as follows:

    "en" (English)

    "jp" (Japanese)

    "zh" (Chinese)

    If no code is specified, "en" is used as the default.

  • :portfolio_id (required, String)

    The portfolio identifier.

  • :account_id (required, String)

    The account ID with which to share the portfolio.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



501
502
503
504
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 501

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 new 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.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 to use for this operation. Supported language codes are as follows:

    "en" (English)

    "jp" (Japanese)

    "zh" (Chinese)

    If no code is specified, "en" is used as the default.

  • :name (required, String)

    The name of the product.

  • :owner (required, String)

    The owner of the product.

  • :description (String)

    The text description of the product.

  • :distributor (String)

    The distributor of the product.

  • :support_description (String)

    Support information about the product.

  • :support_email (String)

    Contact email for product support.

  • :support_url (String)

    Contact URL for product support.

  • :product_type (required, String)

    The type of the product to create.

  • :tags (Array<Types::Tag>)

    Tags to associate with the new product.

  • :provisioning_artifact_parameters (required, Types::ProvisioningArtifactProperties)

    Parameters for the provisioning artifact.

  • :idempotency_token (required, String)

    A token to disambiguate duplicate requests. You can create multiple resources using the same input in multiple requests, provided that you also specify a different idempotency token for each request.

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

Returns:

See Also:



622
623
624
625
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 622

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

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

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

See the bottom of this topic for an example JSON request.

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.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 to use for this operation. Supported language codes are as follows:

    "en" (English)

    "jp" (Japanese)

    "zh" (Chinese)

    If no code is specified, "en" is used as the default.

  • :product_id (required, String)

    The product identifier.

  • :parameters (required, Types::ProvisioningArtifactProperties)

    The parameters to use when creating the new provisioning artifact.

  • :idempotency_token (required, String)

    A token to disambiguate duplicate requests. You can create multiple resources using the same input in multiple requests, provided that you also specify a different idempotency token for each request.

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

Returns:

See Also:



695
696
697
698
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 695

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

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

Create a new 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:

See Also:



730
731
732
733
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 730

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 to use for this operation. Supported language codes are as follows:

    "en" (English)

    "jp" (Japanese)

    "zh" (Chinese)

    If no code is specified, "en" is used as the default.

  • :id (required, String)

    The identifier of the constraint to delete.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



765
766
767
768
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 765

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

#delete_portfolio(params = {}) ⇒ Struct

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

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 to use for this operation. Supported language codes are as follows:

    "en" (English)

    "jp" (Japanese)

    "zh" (Chinese)

    If no code is specified, "en" is used as the default.

  • :id (required, String)

    The identifier of the portfolio for the delete request.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



802
803
804
805
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 802

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

#delete_portfolio_share(params = {}) ⇒ Struct

Deletes the specified portfolio share.

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 to use for this operation. Supported language codes are as follows:

    "en" (English)

    "jp" (Japanese)

    "zh" (Chinese)

    If no code is specified, "en" is used as the default.

  • :portfolio_id (required, String)

    The portfolio identifier.

  • :account_id (required, String)

    The account ID associated with the share to delete.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



841
842
843
844
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 841

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. This operation does not work with a product that has been 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 to use for this operation. Supported language codes are as follows:

    "en" (English)

    "jp" (Japanese)

    "zh" (Chinese)

    If no code is specified, "en" is used as the default.

  • :id (required, String)

    The identifier of the product for the delete request.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



878
879
880
881
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 878

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

#delete_provisioning_artifact(params = {}) ⇒ Struct

Deletes the specified provisioning artifact. This operation does not work on a provisioning artifact associated with a product that has been shared with you, or on the last provisioning artifact associated with a product (a product must have at least one provisioning artifact).

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 to use for this operation. Supported language codes are as follows:

    "en" (English)

    "jp" (Japanese)

    "zh" (Chinese)

    If no code is specified, "en" is used as the default.

  • :product_id (required, String)

    The product identifier.

  • :provisioning_artifact_id (required, String)

    The identifier of the provisioning artifact for the delete request. This is sometimes referred to as the product version.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



922
923
924
925
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 922

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

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

Retrieves detailed information for a 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 to use for this operation. Supported language codes are as follows:

    "en" (English)

    "jp" (Japanese)

    "zh" (Chinese)

    If no code is specified, "en" is used as the default.

  • :id (required, String)

    The identifier of the constraint.

Returns:

See Also:



970
971
972
973
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 970

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

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

Retrieves detailed information and any tags associated with 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 to use for this operation. Supported language codes are as follows:

    "en" (English)

    "jp" (Japanese)

    "zh" (Chinese)

    If no code is specified, "en" is used as the default.

  • :id (required, String)

    The identifier of the portfolio for which to retrieve information.

Returns:

See Also:



1027
1028
1029
1030
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 1027

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

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

Retrieves information about a specified product.

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

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 to use for this operation. Supported language codes are as follows:

    "en" (English)

    "jp" (Japanese)

    "zh" (Chinese)

    If no code is specified, "en" is used as the default.

  • :id (required, String)

    The ProductId of the product to describe.

Returns:

See Also:



1087
1088
1089
1090
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 1087

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

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

Retrieves information about a specified product, 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]. #=> Hash
resp.provisioning_artifact_summaries[0].["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 to use for this operation. Supported language codes are as follows:

    "en" (English)

    "jp" (Japanese)

    "zh" (Chinese)

    If no code is specified, "en" is used as the default.

  • :id (required, String)

    The identifier of the product for which to retrieve information.

Returns:

See Also:



1160
1161
1162
1163
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 1160

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

Retrieves information about a specified product.

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

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 to use for this operation. Supported language codes are as follows:

    "en" (English)

    "jp" (Japanese)

    "zh" (Chinese)

    If no code is specified, "en" is used as the default.

  • :id (required, String)

    The ProductViewId of the product to describe.

Returns:

See Also:



1220
1221
1222
1223
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 1220

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

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

Retrieve detailed information about the 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"
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

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code to use for this operation. Supported language codes are as follows:

    "en" (English)

    "jp" (Japanese)

    "zh" (Chinese)

    If no code is specified, "en" is used as the default.

  • :id (required, String)

    The provisioned product identifier.

Returns:

See Also:



1269
1270
1271
1272
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 1269

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

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

Retrieves detailed information about the specified provisioning artifact.

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.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 to use for this operation. Supported language codes are as follows:

    "en" (English)

    "jp" (Japanese)

    "zh" (Chinese)

    If no code is specified, "en" is used as the default.

  • :provisioning_artifact_id (required, String)

    The identifier of the provisioning artifact. This is sometimes referred to as the product version.

  • :product_id (required, String)

    The product identifier.

  • :verbose (Boolean)

    Enable a verbose level of details for the provisioning artifact.

Returns:

See Also:



1329
1330
1331
1332
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 1329

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

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

Provides information about parameters required to provision a specified product in a specified manner. Use this operation to obtain the list of ProvisioningArtifactParameters parameters available to call the ProvisionProduct operation for the specified product.

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

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 to use for this operation. Supported language codes are as follows:

    "en" (English)

    "jp" (Japanese)

    "zh" (Chinese)

    If no code is specified, "en" is used as the default.

  • :product_id (required, String)

    The product identifier.

  • :provisioning_artifact_id (required, String)

    The provisioning artifact identifier for this product. This is sometimes referred to as the product version.

  • :path_id (String)

    The identifier of the path for this product's provisioning. This value is optional if the product has a default path, and is required if there is more than one path for the specified product.

Returns:

See Also:



1415
1416
1417
1418
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 1415

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

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

Retrieves a paginated list of the full details of a specific request. Use this operation after calling a request operation (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 to use for this operation. Supported language codes are as follows:

    "en" (English)

    "jp" (Japanese)

    "zh" (Chinese)

    If no code is specified, "en" is used as the default.

  • :id (required, String)

    The record identifier of the ProvisionedProduct object for which to retrieve output information. This is the RecordDetail.RecordId obtained from the request operation's response.

  • :page_token (String)

    The page token of the first page retrieved. If null, this retrieves the first page of size PageSize.

  • :page_size (Integer)

    The maximum number of items to return in the results. If more results exist than fit in the specified PageSize, the value of NextPageToken in the response is non-null.

Returns:

See Also:



1495
1496
1497
1498
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 1495

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

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

Describes a 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 identifier of the TagOption.

Returns:

See Also:



1526
1527
1528
1529
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 1526

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 to use for this operation. Supported language codes are as follows:

    "en" (English)

    "jp" (Japanese)

    "zh" (Chinese)

    If no code is specified, "en" is used as the default.

  • :portfolio_id (required, String)

    The portfolio identifier.

  • :principal_arn (required, String)

    The ARN representing the principal (IAM user, role, or group).

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1566
1567
1568
1569
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 1566

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 to use for this operation. Supported language codes are as follows:

    "en" (English)

    "jp" (Japanese)

    "zh" (Chinese)

    If no code is specified, "en" is used as the default.

  • :product_id (required, String)

    The product identifier.

  • :portfolio_id (required, String)

    The portfolio identifier.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1605
1606
1607
1608
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 1605

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 a TagOption from a 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)

    Identifier of the resource from which to disassociate the TagOption.

  • :tag_option_id (required, String)

    Identifier of the TagOption to disassociate from the resource.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1631
1632
1633
1634
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 1631

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

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

Lists details of 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,
})

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 to use for this operation. Supported language codes are as follows:

    "en" (English)

    "jp" (Japanese)

    "zh" (Chinese)

    If no code is specified, "en" is used as the default.

  • :page_token (String)

    The page token of the first page retrieved. If null, this retrieves the first page of size PageSize.

  • :page_size (Integer)

    The maximum number of items to return in the results. If more results exist than fit in the specified PageSize, the value of NextPageToken in the response is non-null.

Returns:

See Also:



1688
1689
1690
1691
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 1688

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

Retrieves detailed constraint information 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 to use for this operation. Supported language codes are as follows:

    "en" (English)

    "jp" (Japanese)

    "zh" (Chinese)

    If no code is specified, "en" is used as the default.

  • :portfolio_id (required, String)

    The portfolio identifier.

  • :product_id (String)

    The product identifier.

  • :page_size (Integer)

    The maximum number of items to return in the results. If more results exist than fit in the specified PageSize, the value of NextPageToken in the response is non-null.

  • :page_token (String)

    The page token of the first page retrieved. If null, this retrieves the first page of size PageSize.

Returns:

See Also:



1751
1752
1753
1754
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 1751

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

Returns a paginated list of all paths to a specified product. A path is how the user has access to a specified product, and is necessary when provisioning a product. A path also determines the constraints put on the product.

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 to use for this operation. Supported language codes are as follows:

    "en" (English)

    "jp" (Japanese)

    "zh" (Chinese)

    If no code is specified, "en" is used as the default.

  • :product_id (required, String)

    The product identifier. Identifies the product for which to retrieve LaunchPathSummaries information.

  • :page_size (Integer)

    The maximum number of items to return in the results. If more results exist than fit in the specified PageSize, the value of NextPageToken in the response is non-null.

  • :page_token (String)

    The page token of the first page retrieved. If null, this retrieves the first page of size PageSize.

Returns:

See Also:



1817
1818
1819
1820
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 1817

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 been authorized sharing of the specified portfolio.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code to use for this operation. Supported language codes are as follows:

    "en" (English)

    "jp" (Japanese)

    "zh" (Chinese)

    If no code is specified, "en" is used as the default.

  • :portfolio_id (required, String)

    The portfolio identifier.

Returns:

See Also:



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

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 to use for this operation. Supported language codes are as follows:

    "en" (English)

    "jp" (Japanese)

    "zh" (Chinese)

    If no code is specified, "en" is used as the default.

  • :page_token (String)

    The page token of the first page retrieved. If null, this retrieves the first page of size PageSize.

  • :page_size (Integer)

    The maximum number of items to return in the results. If more results exist than fit in the specified PageSize, the value of NextPageToken in the response is non-null.

Returns:

See Also:



1918
1919
1920
1921
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 1918

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 to use for this operation. Supported language codes are as follows:

    "en" (English)

    "jp" (Japanese)

    "zh" (Chinese)

    If no code is specified, "en" is used as the default.

  • :product_id (required, String)

    The product identifier.

  • :page_token (String)

    The page token of the first page retrieved. If null, this retrieves the first page of size PageSize.

  • :page_size (Integer)

    The maximum number of items to return in the results. If more results exist than fit in the specified PageSize, the value of NextPageToken in the response is non-null.

Returns:

See Also:



1978
1979
1980
1981
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 1978

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 to use for this operation. Supported language codes are as follows:

    "en" (English)

    "jp" (Japanese)

    "zh" (Chinese)

    If no code is specified, "en" is used as the default.

  • :portfolio_id (required, String)

    The portfolio identifier.

  • :page_size (Integer)

    The maximum number of items to return in the results. If more results exist than fit in the specified PageSize, the value of NextPageToken in the response is non-null.

  • :page_token (String)

    The page token of the first page retrieved. If null, this retrieves the first page of size PageSize.

Returns:

See Also:



2034
2035
2036
2037
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2034

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

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

Lists all provisioning artifacts associated with 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.next_page_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code to use for this operation. Supported language codes are as follows:

    "en" (English)

    "jp" (Japanese)

    "zh" (Chinese)

    If no code is specified, "en" is used as the default.

  • :product_id (required, String)

    The product identifier.

Returns:

See Also:



2083
2084
2085
2086
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2083

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

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

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

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 to use for this operation. Supported language codes are as follows:

    "en" (English)

    "jp" (Japanese)

    "zh" (Chinese)

    If no code is specified, "en" is used as the default.

  • :access_level_filter (Types::AccessLevelFilter)

    The access level for obtaining results. If left unspecified, User level access is used.

  • :search_filter (Types::ListRecordHistorySearchFilter)

    The filter to limit search results.

  • :page_size (Integer)

    The maximum number of items to return in the results. If more results exist than fit in the specified PageSize, the value of NextPageToken in the response is non-null.

  • :page_token (String)

    The page token of the first page retrieved. If null, this retrieves the first page of size PageSize.

Returns:

See Also:



2166
2167
2168
2169
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2166

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 resources associated with a 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)

    Identifier of the TagOption.

  • :resource_type (String)

    Resource type.

  • :page_size (Integer)

    The maximum number of items to return in the results. If more results exist than fit in the specified PageSize, the value of NextPageToken in the response is non-null.

  • :page_token (String)

    The page token of the first page retrieved. If null, this retrieves the first page of size PageSize.

Returns:

See Also:



2216
2217
2218
2219
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2216

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 detailed TagOptions information.

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 list of filters with which to limit search results. If no search filters are specified, the output is all TagOptions.

  • :page_size (Integer)

    The maximum number of items to return in the results. If more results exist than fit in the specified PageSize, the value of NextPageToken in the response is non-null.

  • :page_token (String)

    The page token of the first page retrieved. If null, this retrieves the first page of size PageSize.

Returns:

See Also:



2266
2267
2268
2269
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2266

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

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

Requests a provision of a specified product. A provisioned product is a resourced instance for a product. For example, provisioning a CloudFormation-template-backed product results in launching a CloudFormation stack and all the underlying resources that come with it.

You can check the status of this request using the DescribeRecord operation. The error "Parameter validation failed: Missing required parameter in Tags[N]:Value" indicates that your request contains a tag which has a tag key but no corresponding tag value (value is empty or null). Your call may have included values returned from a DescribeProvisioningParameters call that resulted in a TagOption key with an empty list. This happens when TagOption keys are in conflict. For more information, see DescribeProvisioningParameters.

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 to use for this operation. Supported language codes are as follows:

    "en" (English)

    "jp" (Japanese)

    "zh" (Chinese)

    If no code is specified, "en" is used as the default.

  • :product_id (required, String)

    The product identifier.

  • :provisioning_artifact_id (required, String)

    The provisioning artifact identifier for this product. This is sometimes referred to as the product version.

  • :path_id (String)

    The identifier of the path for this product's provisioning. This value is optional if the product has a default path, and is required if there is more than one path for the specified product.

  • :provisioned_product_name (required, String)

    A user-friendly name to identify the ProvisionedProduct object. 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>)

    A list of tags to use as provisioning options.

  • :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:

See Also:



2385
2386
2387
2388
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2385

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 a 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 to use for this operation. Supported language codes are as follows:

    "en" (English)

    "jp" (Japanese)

    "zh" (Chinese)

    If no code is specified, "en" is used as the default.

  • :portfolio_id (required, String)

    The portfolio identifier.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



2420
2421
2422
2423
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2420

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

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

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

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"
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 to use for this operation. Supported language codes are as follows:

    "en" (English)

    "jp" (Japanese)

    "zh" (Chinese)

    If no code is specified, "en" is used as the default.

  • :access_level_filter (Types::AccessLevelFilter)

    The access level for obtaining results. If left unspecified, User level access is used.

  • :page_size (Integer)

    The maximum number of items to return in the results. If more results exist than fit in the specified PageSize, the value of NextPageToken in the response is non-null.

  • :page_token (String)

    The page token of the first page retrieved. If null, this retrieves the first page of size PageSize.

Returns:

See Also:



2488
2489
2490
2491
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2488

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

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

Returns a paginated list all of the Products objects to which the caller has access.

The output of this operation can be used as input for other operations, such as DescribeProductView.

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 to use for this operation. Supported language codes are as follows:

    "en" (English)

    "jp" (Japanese)

    "zh" (Chinese)

    If no code is specified, "en" is used as the default.

  • :filters (Hash<String,Array>)

    The list of filters with which to limit search results. If no search filters are specified, the output is all the products to which the calling user has access.

  • :page_size (Integer)

    The maximum number of items to return in the results. If more results exist than fit in the specified PageSize, the value of NextPageToken in the response is non-null.

  • :sort_by (String)

    The sort field specifier. If no value is specified, results are not sorted.

  • :sort_order (String)

    The sort order specifier. If no value is specified, results are not sorted.

  • :page_token (String)

    The page token of the first page retrieved. If null, this retrieves the first page of size PageSize.

Returns:

See Also:



2576
2577
2578
2579
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2576

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

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

Retrieves summary and status information about all products created within the caller's account. If a portfolio ID is provided, this operation retrieves information for only those products that are associated with the specified portfolio.

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 to use for this operation. Supported language codes are as follows:

    "en" (English)

    "jp" (Japanese)

    "zh" (Chinese)

    If no code is specified, "en" is used as the default.

  • :portfolio_id (String)

    The portfolio identifier.

  • :filters (Hash<String,Array>)

    The list of filters with which to limit search results. If no search filters are specified, the output is all the products to which the administrator has access.

  • :sort_by (String)

    The sort field specifier. If no value is specified, results are not sorted.

  • :sort_order (String)

    The sort order specifier. If no value is specified, results are not sorted.

  • :page_token (String)

    The page token of the first page retrieved. If null, this retrieves the first page of size PageSize.

  • :page_size (Integer)

    The maximum number of items to return in the results. If more results exist than fit in the specified PageSize, the value of NextPageToken in the response is non-null.

  • :product_source (String)

    Access level of the source of the product.

Returns:

See Also:



2669
2670
2671
2672
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2669

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

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

Requests termination of an existing ProvisionedProduct object. If there are Tags associated with the object, they are terminated when the ProvisionedProduct object is terminated.

This operation does not delete any records associated with the ProvisionedProduct object.

You can check the status of this request using the DescribeRecord operation.

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 ProvisionedProduct object to terminate. Specify either ProvisionedProductName or ProvisionedProductId, but not both.

  • :provisioned_product_id (String)

    The identifier of the ProvisionedProduct object to terminate. Specify either ProvisionedProductName or ProvisionedProductId, but not both.

  • :terminate_token (required, String)

    An idempotency token that uniquely identifies the termination request. This token is only valid during the termination process. After the ProvisionedProduct object is terminated, further requests to terminate the same ProvisionedProduct object always return ResourceNotFound regardless of the value of TerminateToken.

    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 ProvisionedProduct object even if it cannot delete the underlying resources.

  • :accept_language (String)

    The language code to use for this operation. Supported language codes are as follows:

    "en" (English)

    "jp" (Japanese)

    "zh" (Chinese)

    If no code is specified, "en" is used as the default.

Returns:

See Also:



2758
2759
2760
2761
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2758

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

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

Updates an existing 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 to use for this operation. Supported language codes are as follows:

    "en" (English)

    "jp" (Japanese)

    "zh" (Chinese)

    If no code is specified, "en" is used as the default.

  • :id (required, String)

    The identifier of the constraint to update.

  • :description (String)

    The updated text description of the constraint.

Returns:

See Also:



2810
2811
2812
2813
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2810

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's details. This operation does not work with a product that has been 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 to use for this operation. Supported language codes are as follows:

    "en" (English)

    "jp" (Japanese)

    "zh" (Chinese)

    If no code is specified, "en" is used as the default.

  • :id (required, String)

    The identifier of the portfolio for the update request.

  • :display_name (String)

    The name to use for display purposes.

  • :description (String)

    The updated text description of the portfolio.

  • :provider_name (String)

    The updated name of the portfolio provider.

  • :add_tags (Array<Types::Tag>)

    Tags to add to the existing list of tags associated with the portfolio.

  • :remove_tags (Array<String>)

    Tags to remove from the existing list of tags associated with the portfolio.

Returns:

See Also:



2888
2889
2890
2891
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2888

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

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

Updates an existing 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 to use for this operation. Supported language codes are as follows:

    "en" (English)

    "jp" (Japanese)

    "zh" (Chinese)

    If no code is specified, "en" is used as the default.

  • :id (required, String)

    The identifier of the product for the update request.

  • :name (String)

    The updated product name.

  • :owner (String)

    The updated owner of the product.

  • :description (String)

    The updated text 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>)

    Tags to add to the existing list of tags associated with the product.

  • :remove_tags (Array<String>)

    Tags to remove from the existing list of tags associated with the product.

Returns:

See Also:



2988
2989
2990
2991
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2988

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 an existing ProvisionedProduct object. If there are tags associated with the object, they cannot be updated or added with this operation. Depending on the specific updates requested, this operation may update with no interruption, with some interruption, or replace the ProvisionedProduct object entirely.

You can check the status of this request using the DescribeRecord operation.

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 to use for this operation. Supported language codes are as follows:

    "en" (English)

    "jp" (Japanese)

    "zh" (Chinese)

    If no code is specified, "en" is used as the default.

  • :provisioned_product_name (String)

    The updated name of the ProvisionedProduct object. Specify either ProvisionedProductName or ProvisionedProductId, but not both.

  • :provisioned_product_id (String)

    The identifier of the ProvisionedProduct object to update. Specify either ProvisionedProductName or ProvisionedProductId, but not both.

  • :product_id (String)

    The identifier of the ProvisionedProduct object.

  • :provisioning_artifact_id (String)

    The provisioning artifact identifier for this product. This is sometimes referred to as the product version.

  • :path_id (String)

    The identifier of the path to use in the updated ProvisionedProduct object. This value is optional if the product has a default path, and is required if there is more than one path for the specified product.

  • :provisioning_parameters (Array<Types::UpdateProvisioningParameter>)

    A list of ProvisioningParameter objects used to update the ProvisionedProduct object.

  • :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:

See Also:



3094
3095
3096
3097
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 3094

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 an existing provisioning artifact's information. This operation does not work on a provisioning artifact associated with a product that has been shared with you.

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",
})

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.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 to use for this operation. Supported language codes are as follows:

    "en" (English)

    "jp" (Japanese)

    "zh" (Chinese)

    If no code is specified, "en" is used as the default.

  • :product_id (required, String)

    The product identifier.

  • :provisioning_artifact_id (required, String)

    The identifier of the provisioning artifact for the update request. This is sometimes referred to as the product version.

  • :name (String)

    The updated name of the provisioning artifact.

  • :description (String)

    The updated text description of the provisioning artifact.

Returns:

See Also:



3159
3160
3161
3162
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 3159

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 an existing 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 identifier of the constraint to update.

  • :value (String)

    The updated value.

  • :active (Boolean)

    The updated active state.

Returns:

See Also:



3198
3199
3200
3201
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 3198

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