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

Class: Aws::ServiceCatalog::Client

Inherits:
Seahorse::Client::Base show all
Defined in:
(unknown)

Overview

An API client for AWS Service Catalog. To construct a client, you need to configure a :region and :credentials.

servicecatalog = Aws::ServiceCatalog::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

See #initialize for a full list of supported configuration options.

Region

You can configure a default region in the following locations:

  • ENV['AWS_REGION']
  • Aws.config[:region]

Go here for a list of supported regions.

Credentials

Default credentials are loaded automatically from the following locations:

  • ENV['AWS_ACCESS_KEY_ID'] and ENV['AWS_SECRET_ACCESS_KEY']
  • Aws.config[:credentials]
  • The shared credentials ini file at ~/.aws/credentials (more information)
  • From an instance profile when running on EC2

You can also construct a credentials object from one of the following classes:

Alternatively, you configure credentials with :access_key_id and :secret_access_key:

# load credentials from disk
creds = YAML.load(File.read('/path/to/secrets'))

Aws::ServiceCatalog::Client.new(
  access_key_id: creds['access_key_id'],
  secret_access_key: creds['secret_access_key']
)

Always load your credentials from outside your application. Avoid configuring credentials statically and never commit them to source control.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

Constructor collapse

API Operations collapse

Instance Method Summary collapse

Methods inherited from Seahorse::Client::Base

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

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options = {}) ⇒ Aws::ServiceCatalog::Client

Constructs an API client.

Options Hash (options):

  • :access_key_id (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :convert_params (Boolean) — default: true

    When true, an attempt is made to coerce request parameters into the required types. See Plugins::ParamConverter for more details.

  • :credentials (required, Credentials)

    Your AWS credentials. The following locations will be searched in order for credentials:

    • :access_key_id, :secret_access_key, and :session_token options
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • HOME/.aws/credentials shared credentials file
    • EC2 instance profile credentials See Plugins::RequestSigner for more details.
  • :endpoint (String)

    A default endpoint is constructed from the :region. See Plugins::RegionalEndpoint for more details.

  • :http_continue_timeout (Float) — default: 1

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_idle_timeout (Integer) — default: 5

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_open_timeout (Integer) — default: 15

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_proxy (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_read_timeout (Integer) — default: 60

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_wire_trace (Boolean) — default: false

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :log_level (Symbol) — default: :info

    The log level to send messages to the logger at. See Plugins::Logging for more details.

  • :log_formatter (Logging::LogFormatter)

    The log formatter. Defaults to Seahorse::Client::Logging::Formatter.default. See Plugins::Logging for more details.

  • :logger (Logger) — default: nil

    The Logger instance to send log messages to. If this option is not set, logging will be disabled. See Plugins::Logging for more details.

  • :profile (String)

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used. See Plugins::RequestSigner for more details.

  • :raise_response_errors (Boolean) — default: true

    When true, response errors are raised. See Seahorse::Client::Plugins::RaiseResponseErrors for more details.

  • :region (required, String)

    The AWS region to connect to. The region is used to construct the client endpoint. Defaults to ENV['AWS_REGION']. Also checks AMAZON_REGION and AWS_DEFAULT_REGION. See Plugins::RegionalEndpoint for more details.

  • :retry_limit (Integer) — default: 3

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors and auth errors from expired credentials. See Plugins::RetryErrors for more details.

  • :secret_access_key (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :session_token (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :simple_json (Boolean) — default: false

    Disables request parameter conversion, validation, and formatting. Also disable response data type conversions. This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

    When :simple_json is enabled, the request parameters hash must be formatted exactly as the DynamoDB API expects. See Plugins::Protocols::JsonRpc for more details.

  • :ssl_ca_bundle (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_directory (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_store (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_verify_peer (Boolean) — default: true

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :stub_responses (Boolean) — default: false

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled. See Plugins::StubResponses for more details.

  • :validate_params (Boolean) — default: true

    When true, request parameters are validated before sending the request. See Plugins::ParamValidator for more details.

Instance Method Details

#accept_portfolio_share(options = {}) ⇒ 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
})

Options Hash (options):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :portfolio_id (required, String)

    The portfolio identifier.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#associate_principal_with_portfolio(options = {}) ⇒ 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
})

Options Hash (options):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :portfolio_id (required, String)

    The portfolio identifier.

  • :principal_arn (required, String)

    The ARN 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:

#associate_product_with_portfolio(options = {}) ⇒ 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",
})

Options Hash (options):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :product_id (required, String)

    The product identifier.

  • :portfolio_id (required, String)

    The portfolio identifier.

  • :source_portfolio_id (String)

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

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#associate_tag_option_with_resource(options = {}) ⇒ 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
})

Options Hash (options):

  • :resource_id (required, String)

    The resource identifier.

  • :tag_option_id (required, String)

    The TagOption identifier.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

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

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.copy_product_token #=> String

Options Hash (options):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :source_product_arn (required, String)

    The Amazon Resource Name (ARN) of the source product.

  • :target_product_id (String)

    The ID of the target product. By default, a new product is created.

  • :target_product_name (String)

    A name for the target product. The default is the name of the source product.

  • :source_provisioning_artifact_identifiers (Array<Hash<String,String>>)

    The IDs of the product versions to copy. By default, all provisioning artifacts are copied.

  • :copy_options (Array<String>)

    The copy options. If the value is CopyTags, the tags from the source product are copied to the target product.

  • :idempotency_token (required, String)

    This parameter will be auto-filled on your behalf with a random UUIDv4 when no value is provided. A token to disambiguate duplicate requests. You can use the same input in multiple requests, provided that you also specify a different idempotency token for each request.

Returns:

See Also:

#create_constraint(options = {}) ⇒ 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"

Options Hash (options):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :portfolio_id (required, String)

    The portfolio identifier.

  • :product_id (required, String)

    The product identifier.

  • :parameters (required, String)

    The constraint parameters. Expected values vary depending on which Type is specified. For more information, see the Examples section.

    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)

    This parameter will be auto-filled on your behalf with a random UUIDv4 when no value is provided. A token to disambiguate duplicate requests. You can use the same input in multiple requests, provided that you also specify a different idempotency token for each request.

Returns:

See Also:

#create_portfolio(options = {}) ⇒ 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

Options Hash (options):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :display_name (required, String)

    The name to use for display purposes.

  • :description (String)

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

    This parameter will be auto-filled on your behalf with a random UUIDv4 when no value is provided. A token to disambiguate duplicate requests. You can use the same input in multiple requests, provided that you also specify a different idempotency token for each request.

Returns:

See Also:

#create_portfolio_share(options = {}) ⇒ 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
})

Options Hash (options):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :portfolio_id (required, String)

    The portfolio identifier.

  • :account_id (required, String)

    The account ID with which to share the portfolio.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#create_product(options = {}) ⇒ 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 #=> true/false
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

Options Hash (options):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :name (required, String)

    The name of the product.

  • :owner (required, String)

    The owner of the product.

  • :description (String)

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

    This parameter will be auto-filled on your behalf with a random UUIDv4 when no value is provided. A token to disambiguate duplicate requests. You can use the same input in multiple requests, provided that you also specify a different idempotency token for each request.

Returns:

See Also:

#create_provisioning_artifact(options = {}) ⇒ 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.

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"

Options Hash (options):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :product_id (required, String)

    The product identifier.

  • :parameters (required, Types::ProvisioningArtifactProperties)

    The parameters to use when creating the new provisioning artifact.

  • :idempotency_token (required, String)

    This parameter will be auto-filled on your behalf with a random UUIDv4 when no value is provided. A token to disambiguate duplicate requests. You can use the same input in multiple requests, provided that you also specify a different idempotency token for each request.

Returns:

See Also:

#create_tag_option(options = {}) ⇒ 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 #=> true/false
resp.tag_option_detail.id #=> String

Options Hash (options):

  • :key (required, String)

    The TagOption key.

  • :value (required, String)

    The TagOption value.

Returns:

See Also:

#delete_constraint(options = {}) ⇒ Struct

Deletes the specified constraint.

Examples:

Request syntax with placeholder values


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

Options Hash (options):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :id (required, String)

    The identifier of the constraint to delete.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#delete_portfolio(options = {}) ⇒ 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
})

Options Hash (options):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :id (required, String)

    The identifier of the portfolio for the delete request.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#delete_portfolio_share(options = {}) ⇒ 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
})

Options Hash (options):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :portfolio_id (required, String)

    The portfolio identifier.

  • :account_id (required, String)

    The account ID associated with the share to delete.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#delete_product(options = {}) ⇒ 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
})

Options Hash (options):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :id (required, String)

    The identifier of the product for the delete request.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#delete_provisioning_artifact(options = {}) ⇒ 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
})

Options Hash (options):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :product_id (required, String)

    The product identifier.

  • :provisioning_artifact_id (required, String)

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

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#describe_constraint(options = {}) ⇒ 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"

Options Hash (options):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :id (required, String)

    The identifier of the constraint.

Returns:

See Also:

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

Describes the status of the specified copy product operation.

Examples:

Request syntax with placeholder values


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

Response structure


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

Options Hash (options):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :copy_product_token (required, String)

    The token returned from the call to CopyProduct that initiated the operation.

Returns:

See Also:

#describe_portfolio(options = {}) ⇒ 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 #=> true/false
resp.tag_options[0].id #=> String

Options Hash (options):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :id (required, String)

    The identifier of the portfolio for which to retrieve information.

Returns:

See Also:

#describe_product(options = {}) ⇒ 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 #=> true/false
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

Options Hash (options):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :id (required, String)

    The ProductId of the product to describe.

Returns:

See Also:

#describe_product_as_admin(options = {}) ⇒ 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 #=> true/false
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 #=> true/false
resp.tag_options[0].id #=> String

Options Hash (options):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :id (required, String)

    The identifier of the product for which to retrieve information.

Returns:

See Also:

#describe_product_view(options = {}) ⇒ 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 #=> true/false
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

Options Hash (options):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :id (required, String)

    The ProductViewId of the product to describe.

Returns:

See Also:

#describe_provisioned_product(options = {}) ⇒ 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

Options Hash (options):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :id (required, String)

    The provisioned product identifier.

Returns:

See Also:

#describe_provisioning_artifact(options = {}) ⇒ 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"

Options Hash (options):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

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

#describe_provisioning_parameters(options = {}) ⇒ 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 #=> true/false
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

Options Hash (options):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :product_id (required, String)

    The product identifier.

  • :provisioning_artifact_id (required, String)

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

#describe_record(options = {}) ⇒ 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

Options Hash (options):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

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

#describe_tag_option(options = {}) ⇒ 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 #=> true/false
resp.tag_option_detail.id #=> String

Options Hash (options):

  • :id (required, String)

    The identifier of the TagOption.

Returns:

See Also:

#disassociate_principal_from_portfolio(options = {}) ⇒ 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
})

Options Hash (options):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :portfolio_id (required, String)

    The portfolio identifier.

  • :principal_arn (required, String)

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

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#disassociate_product_from_portfolio(options = {}) ⇒ 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
})

Options Hash (options):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :product_id (required, String)

    The product identifier.

  • :portfolio_id (required, String)

    The portfolio identifier.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#disassociate_tag_option_from_resource(options = {}) ⇒ 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
})

Options Hash (options):

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

#list_accepted_portfolio_shares(options = {}) ⇒ 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

Options Hash (options):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

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

#list_constraints_for_portfolio(options = {}) ⇒ 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

Options Hash (options):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :portfolio_id (required, String)

    The portfolio identifier.

  • :product_id (String)

    The product identifier.

  • :page_size (Integer)

    The maximum number of items to return 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:

#list_launch_paths(options = {}) ⇒ 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

Options Hash (options):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

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

#list_portfolio_access(options = {}) ⇒ 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

Options Hash (options):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :portfolio_id (required, String)

    The portfolio identifier.

Returns:

See Also:

#list_portfolios(options = {}) ⇒ 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

Options Hash (options):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

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

#list_portfolios_for_product(options = {}) ⇒ 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

Options Hash (options):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :product_id (required, String)

    The product identifier.

  • :page_token (String)

    The page token 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:

#list_principals_for_portfolio(options = {}) ⇒ 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

Options Hash (options):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :portfolio_id (required, String)

    The portfolio identifier.

  • :page_size (Integer)

    The maximum number of items to return 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:

#list_provisioning_artifacts(options = {}) ⇒ 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

Options Hash (options):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :product_id (required, String)

    The product identifier.

Returns:

See Also:

#list_record_history(options = {}) ⇒ 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

Options Hash (options):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

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

#list_resources_for_tag_option(options = {}) ⇒ 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

Options Hash (options):

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

#list_tag_options(options = {}) ⇒ 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 #=> true/false
resp.tag_option_details[0].id #=> String
resp.page_token #=> String

Options Hash (options):

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

#provision_product(options = {}) ⇒ 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

Options Hash (options):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :product_id (required, String)

    The product identifier.

  • :provisioning_artifact_id (required, String)

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

    This parameter will be auto-filled on your behalf with a random UUIDv4 when no value is provided. An idempotency token that uniquely identifies the provisioning request.

Returns:

See Also:

#reject_portfolio_share(options = {}) ⇒ 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
})

Options Hash (options):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :portfolio_id (required, String)

    The portfolio identifier.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#scan_provisioned_products(options = {}) ⇒ 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

Options Hash (options):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

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

#search_products(options = {}) ⇒ 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 #=> true/false
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

Options Hash (options):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :filters (Hash<String,Array<String>>)

    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:

#search_products_as_admin(options = {}) ⇒ 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 #=> true/false
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

Options Hash (options):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :portfolio_id (String)

    The portfolio identifier.

  • :filters (Hash<String,Array<String>>)

    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:

#terminate_provisioned_product(options = {}) ⇒ 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

Options Hash (options):

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

    This parameter will be auto-filled on your behalf with a random UUIDv4 when no value is provided. 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.

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

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

Returns:

See Also:

#update_constraint(options = {}) ⇒ 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"

Options Hash (options):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :id (required, String)

    The identifier of the constraint to update.

  • :description (String)

    The updated text description of the constraint.

Returns:

See Also:

#update_portfolio(options = {}) ⇒ 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

Options Hash (options):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

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

#update_product(options = {}) ⇒ 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 #=> true/false
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

Options Hash (options):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

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

#update_provisioned_product(options = {}) ⇒ 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

Options Hash (options):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

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

    This parameter will be auto-filled on your behalf with a random UUIDv4 when no value is provided. The idempotency token that uniquely identifies the provisioning update request.

Returns:

See Also:

#update_provisioning_artifact(options = {}) ⇒ 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"

Options Hash (options):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :product_id (required, String)

    The product identifier.

  • :provisioning_artifact_id (required, String)

    The identifier of the provisioning artifact 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:

#update_tag_option(options = {}) ⇒ 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 #=> true/false
resp.tag_option_detail.id #=> String

Options Hash (options):

  • :id (required, String)

    The identifier of the constraint to update.

  • :value (String)

    The updated value.

  • :active (Boolean)

    The updated active state.

Returns:

See Also:

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean

Waiters polls an API operation until a resource enters a desired state.

Basic Usage

Waiters will poll until they are succesful, they fail by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop, sleeping between attempts client.waiter_until(waiter_name, params)

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You configure waiters by passing a block to #wait_until:

# poll for ~25 seconds
client.wait_until(...) do |w|
  w.max_attempts = 5
  w.delay = 5
end

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
client.wait_until(...) do |w|

  # disable max attempts
  w.max_attempts = nil

  # poll for 1 hour, instead of a number of attempts
  w.before_wait do |attempts, response|
    throw :failure if Time.now - started_at > 3600
  end

end

Handling Errors

When a waiter is successful, it returns true. When a waiter fails, it raises an error. All errors raised extend from Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

Parameters:

  • waiter_name (Symbol)

    The name of the waiter. See #waiter_names for a full list of supported waiters.

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

    Additional request parameters. See the #waiter_names for a list of supported waiters and what request they call. The called request determines the list of accepted parameters.

Yield Parameters:

Returns:

  • (Boolean)

    Returns true if the waiter was successful.

Raises:

  • (Errors::FailureStateError)

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

  • (Errors::TooManyAttemptsError)

    Raised when the configured maximum number of attempts have been made, and the waiter is not yet successful.

  • (Errors::UnexpectedError)

    Raised when an error is encounted while polling for a resource that is not expected.

  • (Errors::NoSuchWaiterError)

    Raised when you request to wait for an unknown state.

#waiter_namesArray<Symbol>

Returns the list of supported waiters. The following table lists the supported waiters and the client method they call:

Waiter NameClient MethodDefault Delay:Default Max Attempts:

Returns:

  • (Array<Symbol>)

    the list of supported waiters.