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

#api_requests, #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(options) ⇒ Client

Returns a new instance of Client

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider)

    Your AWS credentials. This can be an instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::SharedCredentials - Used for loading credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2 IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails to enable retries and extended timeouts.
  • :region (required, String)

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is search for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :client_side_monitoring (Boolean) — default: false

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: ""

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1"

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true

    When true, an attempt is made to coerce request parameters into the required types.

  • :disable_host_prefix_injection (Boolean) — default: false

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :endpoint (String)

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test endpoints. This should be avalid HTTP(S) URI.

  • :endpoint_cache_max_entries (Integer) — default: 1000

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false

    When set to true, endpoint discovery will be enabled for operations when available. Defaults to false.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default

    The log formatter.

  • :log_level (Symbol) — default: :info

    The log level to send messages to the :logger at.

  • :logger (Logger)

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :profile (String) — default: "default"

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :retry_base_delay (Float) — default: 0.3

    The base delay in seconds used by the default backoff function.

  • :retry_jitter (Symbol) — default: :none

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

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

  • :retry_max_delay (Integer) — default: 0

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.

  • :secret_access_key (String)
  • :session_token (String)
  • :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.

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

  • :validate_params (Boolean) — default: true

    When true, request parameters are validated before sending the request.

  • :http_proxy (URI::HTTP, String)

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_open_timeout (Float) — default: 15

    The number of seconds to wait when opening a HTTP session before rasing a Timeout::Error.

  • :http_read_timeout (Integer) — default: 60

    The default number of seconds to wait for response data. This value can safely be set per-request on the session yeidled by #session_for.

  • :http_idle_timeout (Float) — default: 5

    The number of seconds a connection is allowed to sit idble before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_continue_timeout (Float) — default: 1

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session yeidled by #session_for.

  • :http_wire_trace (Boolean) — default: false

    When true, HTTP debug output will be sent to the :logger.

  • :ssl_verify_peer (Boolean) — default: true

    When true, SSL peer certificates are verified when establishing a connection.

  • :ssl_ca_bundle (String)

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String)

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.



261
262
263
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 261

def initialize(*args)
  super
end

Instance Method Details

#accept_portfolio_share(params = {}) ⇒ Struct

Accepts an offer to share the specified portfolio.

Examples:

Request syntax with placeholder values


resp = client.accept_portfolio_share({
  accept_language: "AcceptLanguage",
  portfolio_id: "Id", # required
  portfolio_share_type: "IMPORTED", # accepts IMPORTED, AWS_SERVICECATALOG, AWS_ORGANIZATIONS
})

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :portfolio_id (required, String)

    The portfolio identifier.

  • :portfolio_share_type (String)

    The type of shared portfolios to accept. The default is to accept imported portfolios.

    • AWS_ORGANIZATIONS - Accept portfolios shared by the master account of your organization.

    • IMPORTED - Accept imported portfolios.

    • AWS_SERVICECATALOG - Not supported. (Throws ResourceNotFoundException.)

    For example, aws servicecatalog accept-portfolio-share --portfolio-id "port-2qwzkwxt3y5fk" --portfolio-share-type AWS_ORGANIZATIONS

Returns:

  • (Struct)

    Returns an empty response.

See Also:



310
311
312
313
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 310

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

#associate_budget_with_resource(params = {}) ⇒ Struct

Associates the specified budget with the specified resource.

Examples:

Request syntax with placeholder values


resp = client.associate_budget_with_resource({
  budget_name: "BudgetName", # required
  resource_id: "Id", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :budget_name (required, String)

    The name of the budget you want to associate.

  • :resource_id (required, String)

    The resource identifier. Either a portfolio-id or a product-id.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



336
337
338
339
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 336

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

#associate_principal_with_portfolio(params = {}) ⇒ Struct

Associates the specified principal ARN with the specified portfolio.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :portfolio_id (required, String)

    The portfolio identifier.

  • :principal_arn (required, String)

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

  • :principal_type (required, String)

    The principal type. The supported value is IAM.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



376
377
378
379
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 376

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

#associate_product_with_portfolio(params = {}) ⇒ Struct

Associates the specified product with the specified portfolio.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :product_id (required, String)

    The product identifier.

  • :portfolio_id (required, String)

    The portfolio identifier.

  • :source_portfolio_id (String)

    The identifier of the source portfolio.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



416
417
418
419
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 416

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

#associate_service_action_with_provisioning_artifact(params = {}) ⇒ Struct

Associates a self-service action with a provisioning artifact.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :product_id (required, String)

    The product identifier. For example, prod-abcdzk7xy33qa.

  • :provisioning_artifact_id (required, String)

    The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne.

  • :service_action_id (required, String)

    The self-service action identifier. For example, act-fs7abcd89wxyz.

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

Returns:

  • (Struct)

    Returns an empty response.

See Also:



457
458
459
460
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 457

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

#associate_tag_option_with_resource(params = {}) ⇒ Struct

Associate the specified TagOption with the specified portfolio or product.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_id (required, String)

    The resource identifier.

  • :tag_option_id (required, String)

    The TagOption identifier.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



484
485
486
487
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 484

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

#batch_associate_service_action_with_provisioning_artifact(params = {}) ⇒ Types::BatchAssociateServiceActionWithProvisioningArtifactOutput

Associates multiple self-service actions with provisioning artifacts.

Examples:

Request syntax with placeholder values


resp = client.batch_associate_service_action_with_provisioning_artifact({
  service_action_associations: [ # required
    {
      service_action_id: "Id", # required
      product_id: "Id", # required
      provisioning_artifact_id: "Id", # required
    },
  ],
  accept_language: "AcceptLanguage",
})

Response structure


resp.failed_service_action_associations #=> Array
resp.failed_service_action_associations[0].service_action_id #=> String
resp.failed_service_action_associations[0].product_id #=> String
resp.failed_service_action_associations[0].provisioning_artifact_id #=> String
resp.failed_service_action_associations[0].error_code #=> String, one of "DUPLICATE_RESOURCE", "INTERNAL_FAILURE", "LIMIT_EXCEEDED", "RESOURCE_NOT_FOUND", "THROTTLING"
resp.failed_service_action_associations[0].error_message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :service_action_associations (required, Array<Types::ServiceActionAssociation>)

    One or more associations, each consisting of the Action ID, the Product ID, and the Provisioning Artifact ID.

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

Returns:

See Also:



534
535
536
537
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 534

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

#batch_disassociate_service_action_from_provisioning_artifact(params = {}) ⇒ Types::BatchDisassociateServiceActionFromProvisioningArtifactOutput

Disassociates a batch of self-service actions from the specified provisioning artifact.

Examples:

Request syntax with placeholder values


resp = client.batch_disassociate_service_action_from_provisioning_artifact({
  service_action_associations: [ # required
    {
      service_action_id: "Id", # required
      product_id: "Id", # required
      provisioning_artifact_id: "Id", # required
    },
  ],
  accept_language: "AcceptLanguage",
})

Response structure


resp.failed_service_action_associations #=> Array
resp.failed_service_action_associations[0].service_action_id #=> String
resp.failed_service_action_associations[0].product_id #=> String
resp.failed_service_action_associations[0].provisioning_artifact_id #=> String
resp.failed_service_action_associations[0].error_code #=> String, one of "DUPLICATE_RESOURCE", "INTERNAL_FAILURE", "LIMIT_EXCEEDED", "RESOURCE_NOT_FOUND", "THROTTLING"
resp.failed_service_action_associations[0].error_message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :service_action_associations (required, Array<Types::ServiceActionAssociation>)

    One or more associations, each consisting of the Action ID, the Product ID, and the Provisioning Artifact ID.

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

Returns:

See Also:



585
586
587
588
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 585

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

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

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.copy_product_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :source_product_arn (required, String)

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

  • :target_product_id (String)

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

  • :target_product_name (String)

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

  • :source_provisioning_artifact_identifiers (Array<Hash>)

    The identifiers of the provisioning artifacts (also known as versions) of the product to copy. By default, all provisioning artifacts are copied.

  • :copy_options (Array<String>)

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

  • :idempotency_token (required, String)

    A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

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

Returns:

See Also:



664
665
666
667
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 664

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

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

Creates a constraint.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :portfolio_id (required, String)

    The portfolio identifier.

  • :product_id (required, String)

    The product identifier.

  • :parameters (required, String)

    The constraint parameters, in JSON format. The syntax depends on the constraint type as follows:

    LAUNCH

    Specify the RoleArn property as follows:

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

    You cannot have both a LAUNCH and a STACKSET constraint.

    You also cannot have more than one LAUNCH constraint on a product and portfolio.

    NOTIFICATION

    Specify the NotificationArns property as follows:

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

    RESOURCE_UPDATE

    Specify the TagUpdatesOnProvisionedProduct property as follows:

    \{"Version":"2.0","Properties":\{"TagUpdateOnProvisionedProduct":"String"\}\}

    The TagUpdatesOnProvisionedProduct property accepts a string value of ALLOWED or NOT_ALLOWED.

    STACKSET

    Specify the Parameters property as follows:

    \{"Version": "String", "Properties": \{"AccountList": [ "String" ], "RegionList": [ "String" ], "AdminRole": "String", "ExecutionRole": "String"\}\}

    You cannot have both a LAUNCH and a STACKSET constraint.

    You also cannot have more than one STACKSET constraint on a product and portfolio.

    Products with a STACKSET constraint will launch an AWS CloudFormation stack set.

    TEMPLATE

    Specify the Rules property. For more information, see Template Constraint Rules.

  • :type (required, String)

    The type of constraint.

    • LAUNCH

    • NOTIFICATION

    • RESOURCE_UPDATE

    • STACKSET

    • TEMPLATE

  • :description (String)

    The description of the constraint.

  • :idempotency_token (required, String)

    A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

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

Returns:

See Also:



797
798
799
800
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 797

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

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

Creates a portfolio.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :display_name (required, String)

    The name to use for display purposes.

  • :description (String)

    The description of the portfolio.

  • :provider_name (required, String)

    The name of the portfolio provider.

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

    One or more tags.

  • :idempotency_token (required, String)

    A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

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

Returns:

See Also:



870
871
872
873
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 870

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

#create_portfolio_share(params = {}) ⇒ Types::CreatePortfolioShareOutput

Shares the specified portfolio with the specified account or organization node. Shares to an organization node can only be created by the master account of an Organization. AWSOrganizationsAccess must be enabled in order to create a portfolio share to an organization node.

Examples:

Request syntax with placeholder values


resp = client.create_portfolio_share({
  accept_language: "AcceptLanguage",
  portfolio_id: "Id", # required
  account_id: "AccountId",
  organization_node: {
    type: "ORGANIZATION", # accepts ORGANIZATION, ORGANIZATIONAL_UNIT, ACCOUNT
    value: "OrganizationNodeValue",
  },
})

Response structure


resp.portfolio_share_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :portfolio_id (required, String)

    The portfolio identifier.

  • :account_id (String)

    The AWS account ID. For example, 123456789012.

  • :organization_node (Types::OrganizationNode)

    The organization node to whom you are going to share. If OrganizationNode is passed in, PortfolioShare will be created for the node and its children (when applies), and a PortfolioShareToken will be returned in the output in order for the administrator to monitor the status of the PortfolioShare creation process.

Returns:

See Also:



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

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

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

Creates a product.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :name (required, String)

    The name of the product.

  • :owner (required, String)

    The owner of the product.

  • :description (String)

    The description of the product.

  • :distributor (String)

    The distributor of the product.

  • :support_description (String)

    The support information about the product.

  • :support_email (String)

    The contact email for product support.

  • :support_url (String)

    The contact URL for product support.

  • :product_type (required, String)

    The type of product.

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

    One or more tags.

  • :provisioning_artifact_parameters (required, Types::ProvisioningArtifactProperties)

    The configuration of the provisioning artifact.

  • :idempotency_token (required, String)

    A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

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

Returns:

See Also:



1048
1049
1050
1051
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 1048

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

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

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :plan_name (required, String)

    The name of the plan.

  • :plan_type (required, String)

    The plan type.

  • :notification_arns (Array<String>)

    Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events.

  • :path_id (String)

    The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths.

  • :product_id (required, String)

    The product identifier.

  • :provisioned_product_name (required, String)

    A user-friendly name for the provisioned product. This value must be unique for the AWS account and cannot be updated after the product is provisioned.

  • :provisioning_artifact_id (required, String)

    The identifier of the provisioning artifact.

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

    Parameters specified by the administrator that are required for provisioning the product.

  • :idempotency_token (required, String)

    A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

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

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

    One or more tags.

    If the plan is for an existing provisioned product, the product must have a RESOURCE_UPDATE constraint with TagUpdatesOnProvisionedProduct set to ALLOWED to allow tag updates.

Returns:

See Also:



1167
1168
1169
1170
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 1167

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

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :product_id (required, String)

    The product identifier.

  • :parameters (required, Types::ProvisioningArtifactProperties)

    The configuration for the provisioning artifact.

  • :idempotency_token (required, String)

    A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

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

Returns:

See Also:



1241
1242
1243
1244
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 1241

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

#create_service_action(params = {}) ⇒ Types::CreateServiceActionOutput

Creates a self-service action.

Examples:

Request syntax with placeholder values


resp = client.create_service_action({
  name: "ServiceActionName", # required
  definition_type: "SSM_AUTOMATION", # required, accepts SSM_AUTOMATION
  definition: { # required
    "Name" => "ServiceActionDefinitionValue",
  },
  description: "ServiceActionDescription",
  accept_language: "AcceptLanguage",
  idempotency_token: "IdempotencyToken", # required
})

Response structure


resp.service_action_detail.service_action_summary.id #=> String
resp.service_action_detail.service_action_summary.name #=> String
resp.service_action_detail.service_action_summary.description #=> String
resp.service_action_detail.service_action_summary.definition_type #=> String, one of "SSM_AUTOMATION"
resp.service_action_detail.definition #=> Hash
resp.service_action_detail.definition["ServiceActionDefinitionKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String)

    The self-service action name.

  • :definition_type (required, String)

    The service action definition type. For example, SSM_AUTOMATION.

  • :definition (required, Hash<String,String>)

    The self-service action definition. Can be one of the following:

    Name

    The name of the AWS Systems Manager Document. For example, AWS-RestartEC2Instance.

    Version

    The AWS Systems Manager automation document version. For example, "Version": "1"

    AssumeRole

    The Amazon Resource Name (ARN) of the role that performs the self-service actions on your behalf. For example, "AssumeRole": "arn:aws:iam::12345678910:role/ActionRole".

    To reuse the provisioned product launch role, set to "AssumeRole": "LAUNCH_ROLE".

    Parameters

    The list of parameters in JSON format.

    For example: [\{"Name":"InstanceId","Type":"TARGET"\}].

  • :description (String)

    The self-service action description.

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :idempotency_token (required, String)

    A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

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

Returns:

See Also:



1332
1333
1334
1335
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 1332

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

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

Creates a TagOption.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :key (required, String)

    The TagOption key.

  • :value (required, String)

    The TagOption value.

Returns:

See Also:



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

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

#delete_constraint(params = {}) ⇒ Struct

Deletes the specified constraint.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :id (required, String)

    The identifier of the constraint.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1399
1400
1401
1402
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 1399

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

#delete_portfolio(params = {}) ⇒ Struct

Deletes the specified portfolio.

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

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :id (required, String)

    The portfolio identifier.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



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

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

#delete_portfolio_share(params = {}) ⇒ Types::DeletePortfolioShareOutput

Stops sharing the specified portfolio with the specified account or organization node. Shares to an organization node can only be deleted by the master account of an Organization.

Examples:

Request syntax with placeholder values


resp = client.delete_portfolio_share({
  accept_language: "AcceptLanguage",
  portfolio_id: "Id", # required
  account_id: "AccountId",
  organization_node: {
    type: "ORGANIZATION", # accepts ORGANIZATION, ORGANIZATIONAL_UNIT, ACCOUNT
    value: "OrganizationNodeValue",
  },
})

Response structure


resp.portfolio_share_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :portfolio_id (required, String)

    The portfolio identifier.

  • :account_id (String)

    The AWS account ID.

  • :organization_node (Types::OrganizationNode)

    The organization node to whom you are going to stop sharing.

Returns:

See Also:



1485
1486
1487
1488
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 1485

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

#delete_product(params = {}) ⇒ Struct

Deletes the specified product.

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

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :id (required, String)

    The product identifier.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1520
1521
1522
1523
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 1520

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

#delete_provisioned_product_plan(params = {}) ⇒ Struct

Deletes the specified plan.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :plan_id (required, String)

    The plan identifier.

  • :ignore_errors (Boolean)

    If set to true, AWS Service Catalog stops managing the specified provisioned product even if it cannot delete the underlying resources.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1557
1558
1559
1560
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 1557

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

#delete_provisioning_artifact(params = {}) ⇒ Struct

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

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

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :product_id (required, String)

    The product identifier.

  • :provisioning_artifact_id (required, String)

    The identifier of the provisioning artifact.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1599
1600
1601
1602
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 1599

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

#delete_service_action(params = {}) ⇒ Struct

Deletes a self-service action.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String)

    The self-service action identifier. For example, act-fs7abcd89wxyz.

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

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 delete_service_action(params = {}, options = {})
  req = build_request(:delete_service_action, params)
  req.send_request(options)
end

#delete_tag_option(params = {}) ⇒ Struct

Deletes the specified TagOption.

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

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String)

    The TagOption identifier.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1656
1657
1658
1659
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 1656

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

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

Gets information about the specified constraint.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :id (required, String)

    The identifier of the constraint.

Returns:

See Also:



1701
1702
1703
1704
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 1701

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

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

Gets the status of the specified copy product operation.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :copy_product_token (required, String)

    The token for the copy product operation. This token is returned by CopyProduct.

Returns:

See Also:



1744
1745
1746
1747
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 1744

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

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

Gets information about the specified portfolio.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :id (required, String)

    The portfolio identifier.

Returns:

See Also:



1800
1801
1802
1803
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 1800

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

#describe_portfolio_share_status(params = {}) ⇒ Types::DescribePortfolioShareStatusOutput

Gets the status of the specified portfolio share operation. This API can only be called by the master account in the organization.

Examples:

Request syntax with placeholder values


resp = client.describe_portfolio_share_status({
  portfolio_share_token: "Id", # required
})

Response structure


resp.portfolio_share_token #=> String
resp.portfolio_id #=> String
resp.organization_node_value #=> String
resp.status #=> String, one of "NOT_STARTED", "IN_PROGRESS", "COMPLETED", "COMPLETED_WITH_ERRORS", "ERROR"
resp.share_details.successful_shares #=> Array
resp.share_details.successful_shares[0] #=> String
resp.share_details.share_errors #=> Array
resp.share_details.share_errors[0].accounts #=> Array
resp.share_details.share_errors[0].accounts[0] #=> String
resp.share_details.share_errors[0].message #=> String
resp.share_details.share_errors[0].error #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :portfolio_share_token (required, String)

    The token for the portfolio share operation. This token is returned either by CreatePortfolioShare or by DeletePortfolioShare.

Returns:

See Also:



1844
1845
1846
1847
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 1844

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

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

Gets information about the specified product.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :id (required, String)

    The product identifier.

Returns:

See Also:



1902
1903
1904
1905
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 1902

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.product_view_detail.product_view_summary.id #=> String
resp.product_view_detail.product_view_summary.product_id #=> String
resp.product_view_detail.product_view_summary.name #=> String
resp.product_view_detail.product_view_summary.owner #=> String
resp.product_view_detail.product_view_summary.short_description #=> String
resp.product_view_detail.product_view_summary.type #=> String, one of "CLOUD_FORMATION_TEMPLATE", "MARKETPLACE"
resp.product_view_detail.product_view_summary.distributor #=> String
resp.product_view_detail.product_view_summary.has_default_path #=> Boolean
resp.product_view_detail.product_view_summary.support_email #=> String
resp.product_view_detail.product_view_summary.support_description #=> String
resp.product_view_detail.product_view_summary.support_url #=> String
resp.product_view_detail.status #=> String, one of "AVAILABLE", "CREATING", "FAILED"
resp.product_view_detail.product_arn #=> String
resp.product_view_detail.created_time #=> Time
resp.provisioning_artifact_summaries #=> Array
resp.provisioning_artifact_summaries[0].id #=> String
resp.provisioning_artifact_summaries[0].name #=> String
resp.provisioning_artifact_summaries[0].description #=> String
resp.provisioning_artifact_summaries[0].created_time #=> Time
resp.provisioning_artifact_summaries[0]. #=> 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
resp.budgets #=> Array
resp.budgets[0].budget_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :id (required, String)

    The product identifier.

Returns:

See Also:



1975
1976
1977
1978
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 1975

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

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

Gets information about the specified product.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :id (required, String)

    The product view identifier.

Returns:

See Also:



2030
2031
2032
2033
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2030

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

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

Gets information about the specified provisioned product.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :id (required, String)

    The provisioned product identifier.

Returns:

See Also:



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

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

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

Gets information about the resource changes for the specified plan.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :plan_id (required, String)

    The plan identifier.

  • :page_size (Integer)

    The maximum number of items to return with this call.

  • :page_token (String)

    The page token for the next set of results. To retrieve the first set of results, use null.

Returns:

See Also:



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

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :provisioning_artifact_id (required, String)

    The identifier of the provisioning artifact.

  • :product_id (required, String)

    The product identifier.

  • :verbose (Boolean)

    Indicates whether a verbose level of detail is enabled.

Returns:

See Also:



2223
2224
2225
2226
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2223

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

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :product_id (required, String)

    The product identifier.

  • :provisioning_artifact_id (required, String)

    The identifier of the provisioning artifact.

  • :path_id (String)

    The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths.

Returns:

See Also:



2305
2306
2307
2308
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2305

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

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

Gets information about the specified request operation.

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

If a provisioned product was transferred to a new owner using UpdateProvisionedProductProperties, the new owner will be able to describe all past records for that product. The previous owner will no longer be able to describe the records, but will be able to use ListRecordHistory to see the product's history from when he was the owner.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :id (required, String)

    The record identifier of the provisioned product. This identifier is returned by the request operation.

  • :page_token (String)

    The page token for the next set of results. To retrieve the first set of results, use null.

  • :page_size (Integer)

    The maximum number of items to return with this call.

Returns:

See Also:



2389
2390
2391
2392
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2389

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

#describe_service_action(params = {}) ⇒ Types::DescribeServiceActionOutput

Describes a self-service action.

Examples:

Request syntax with placeholder values


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

Response structure


resp.service_action_detail.service_action_summary.id #=> String
resp.service_action_detail.service_action_summary.name #=> String
resp.service_action_detail.service_action_summary.description #=> String
resp.service_action_detail.service_action_summary.definition_type #=> String, one of "SSM_AUTOMATION"
resp.service_action_detail.definition #=> Hash
resp.service_action_detail.definition["ServiceActionDefinitionKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String)

    The self-service action identifier.

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

Returns:

See Also:



2432
2433
2434
2435
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2432

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

#describe_service_action_execution_parameters(params = {}) ⇒ Types::DescribeServiceActionExecutionParametersOutput

Returns a response object which responds to the following methods:

Examples:

Request syntax with placeholder values


resp = client.describe_service_action_execution_parameters({
  provisioned_product_id: "Id", # required
  service_action_id: "Id", # required
  accept_language: "AcceptLanguage",
})

Response structure


resp.service_action_parameters #=> Array
resp.service_action_parameters[0].name #=> String
resp.service_action_parameters[0].type #=> String
resp.service_action_parameters[0].default_values #=> Array
resp.service_action_parameters[0].default_values[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :provisioned_product_id (required, String)
  • :service_action_id (required, String)
  • :accept_language (String)

Returns:

See Also:



2467
2468
2469
2470
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2467

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

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

Gets information about the specified TagOption.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String)

    The TagOption identifier.

Returns:

See Also:



2498
2499
2500
2501
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2498

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

#disable_aws_organizations_access(params = {}) ⇒ Struct

Disable portfolio sharing through AWS Organizations feature. This feature will not delete your current shares but it will prevent you from creating new shares throughout your organization. Current shares will not be in sync with your organization structure if it changes after calling this API. This API can only be called by the master account in the organization.

Parameters:

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

    ({})

Returns:

  • (Struct)

    Returns an empty response.

See Also:



2516
2517
2518
2519
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2516

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

#disassociate_budget_from_resource(params = {}) ⇒ Struct

Disassociates the specified budget from the specified resource.

Examples:

Request syntax with placeholder values


resp = client.disassociate_budget_from_resource({
  budget_name: "BudgetName", # required
  resource_id: "Id", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :budget_name (required, String)

    The name of the budget you want to disassociate.

  • :resource_id (required, String)

    The resource identifier you want to disassociate from. Either a portfolio-id or a product-id.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



2543
2544
2545
2546
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2543

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

#disassociate_principal_from_portfolio(params = {}) ⇒ Struct

Disassociates a previously associated principal ARN from a specified portfolio.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :portfolio_id (required, String)

    The portfolio identifier.

  • :principal_arn (required, String)

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

Returns:

  • (Struct)

    Returns an empty response.

See Also:



2580
2581
2582
2583
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2580

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

#disassociate_product_from_portfolio(params = {}) ⇒ Struct

Disassociates the specified product from the specified portfolio.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :product_id (required, String)

    The product identifier.

  • :portfolio_id (required, String)

    The portfolio identifier.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



2616
2617
2618
2619
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2616

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

#disassociate_service_action_from_provisioning_artifact(params = {}) ⇒ Struct

Disassociates the specified self-service action association from the specified provisioning artifact.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :product_id (required, String)

    The product identifier. For example, prod-abcdzk7xy33qa.

  • :provisioning_artifact_id (required, String)

    The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne.

  • :service_action_id (required, String)

    The self-service action identifier. For example, act-fs7abcd89wxyz.

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

Returns:

  • (Struct)

    Returns an empty response.

See Also:



2658
2659
2660
2661
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2658

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

#disassociate_tag_option_from_resource(params = {}) ⇒ Struct

Disassociates the specified TagOption from the specified resource.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_id (required, String)

    The resource identifier.

  • :tag_option_id (required, String)

    The TagOption identifier.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



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

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

#enable_aws_organizations_access(params = {}) ⇒ Struct

Enable portfolio sharing feature through AWS Organizations. This API will allow Service Catalog to receive updates on your organization in order to sync your shares with the current structure. This API can only be called by the master account in the organization.

By calling this API Service Catalog will make a call to organizations:EnableAWSServiceAccess on your behalf so that your shares can be in sync with any changes in your AWS Organizations structure.

Parameters:

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

    ({})

Returns:

  • (Struct)

    Returns an empty response.

See Also:



2705
2706
2707
2708
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2705

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :plan_id (required, String)

    The plan identifier.

  • :idempotency_token (required, String)

    A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

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

Returns:

See Also:



2769
2770
2771
2772
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2769

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

#execute_provisioned_product_service_action(params = {}) ⇒ Types::ExecuteProvisionedProductServiceActionOutput

Executes a self-service action against a provisioned product.

Examples:

Request syntax with placeholder values


resp = client.execute_provisioned_product_service_action({
  provisioned_product_id: "Id", # required
  service_action_id: "Id", # required
  execute_token: "IdempotencyToken", # required
  accept_language: "AcceptLanguage",
  parameters: {
    "ExecutionParameterKey" => ["ExecutionParameterValue"],
  },
})

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_id (required, String)

    The identifier of the provisioned product.

  • :service_action_id (required, String)

    The self-service action identifier. For example, act-fs7abcd89wxyz.

  • :execute_token (required, String)

    An idempotency token that uniquely identifies the execute request.

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

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :parameters (Hash<String,Array>)

Returns:

See Also:



2839
2840
2841
2842
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2839

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

#get_aws_organizations_access_status(params = {}) ⇒ Types::GetAWSOrganizationsAccessStatusOutput

Get the Access Status for AWS Organization portfolio share feature. This API can only be called by the master account in the organization.

Examples:

Response structure


resp.access_status #=> String, one of "ENABLED", "UNDER_CHANGE", "DISABLED"

Parameters:

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

    ({})

Returns:

See Also:



2859
2860
2861
2862
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2859

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :page_token (String)

    The page token for the next set of results. To retrieve the first set of results, use null.

  • :page_size (Integer)

    The maximum number of items to return with this call.

  • :portfolio_share_type (String)

    The type of shared portfolios to list. The default is to list imported portfolios.

    • AWS_ORGANIZATIONS - List portfolios shared by the master account of your organization

    • AWS_SERVICECATALOG - List default portfolios

    • IMPORTED - List imported portfolios

Returns:

See Also:



2922
2923
2924
2925
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2922

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

#list_budgets_for_resource(params = {}) ⇒ Types::ListBudgetsForResourceOutput

Lists all the budgets associated to the specified resource.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :resource_id (required, String)

    The resource identifier.

  • :page_size (Integer)

    The maximum number of items to return with this call.

  • :page_token (String)

    The page token for the next set of results. To retrieve the first set of results, use null.

Returns:

See Also:



2972
2973
2974
2975
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2972

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

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

Lists the constraints for the specified portfolio and product.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :portfolio_id (required, String)

    The portfolio identifier.

  • :product_id (String)

    The product identifier.

  • :page_size (Integer)

    The maximum number of items to return with this call.

  • :page_token (String)

    The page token for the next set of results. To retrieve the first set of results, use null.

Returns:

See Also:



3029
3030
3031
3032
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 3029

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :product_id (required, String)

    The product identifier.

  • :page_size (Integer)

    The maximum number of items to return with this call.

  • :page_token (String)

    The page token for the next set of results. To retrieve the first set of results, use null.

Returns:

See Also:



3088
3089
3090
3091
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 3088

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

#list_organization_portfolio_access(params = {}) ⇒ Types::ListOrganizationPortfolioAccessOutput

Lists the organization nodes that have access to the specified portfolio. This API can only be called by the master account in the organization.

Examples:

Request syntax with placeholder values


resp = client.list_organization_portfolio_access({
  accept_language: "AcceptLanguage",
  portfolio_id: "Id", # required
  organization_node_type: "ORGANIZATION", # required, accepts ORGANIZATION, ORGANIZATIONAL_UNIT, ACCOUNT
  page_token: "PageToken",
  page_size: 1,
})

Response structure


resp.organization_nodes #=> Array
resp.organization_nodes[0].type #=> String, one of "ORGANIZATION", "ORGANIZATIONAL_UNIT", "ACCOUNT"
resp.organization_nodes[0].value #=> String
resp.next_page_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :portfolio_id (required, String)

    The portfolio identifier. For example, port-2abcdext3y5fk.

  • :organization_node_type (required, String)

    The organization node type that will be returned in the output.

    • ORGANIZATION - Organization that has access to the portfolio.

    • ORGANIZATIONAL_UNIT - Organizational unit that has access to the portfolio within your organization.

    • ACCOUNT - Account that has access to the portfolio within your organization.

  • :page_token (String)

    The page token for the next set of results. To retrieve the first set of results, use null.

  • :page_size (Integer)

    The maximum number of items to return with this call.

Returns:

See Also:



3153
3154
3155
3156
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 3153

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :portfolio_id (required, String)

    The portfolio identifier.

Returns:

See Also:



3194
3195
3196
3197
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 3194

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

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

Lists all portfolios in the catalog.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :page_token (String)

    The page token for the next set of results. To retrieve the first set of results, use null.

  • :page_size (Integer)

    The maximum number of items to return with this call.

Returns:

See Also:



3245
3246
3247
3248
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 3245

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

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

Lists all portfolios that the specified product is associated with.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :product_id (required, String)

    The product identifier.

  • :page_token (String)

    The page token for the next set of results. To retrieve the first set of results, use null.

  • :page_size (Integer)

    The maximum number of items to return with this call.

Returns:

See Also:



3300
3301
3302
3303
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 3300

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

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

Lists all principal ARNs associated with the specified portfolio.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :portfolio_id (required, String)

    The portfolio identifier.

  • :page_size (Integer)

    The maximum number of items to return with this call.

  • :page_token (String)

    The page token for the next set of results. To retrieve the first set of results, use null.

Returns:

See Also:



3351
3352
3353
3354
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 3351

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :provision_product_id (String)

    The product identifier.

  • :page_size (Integer)

    The maximum number of items to return with this call.

  • :page_token (String)

    The page token for the next set of results. To retrieve the first set of results, use null.

  • :access_level_filter (Types::AccessLevelFilter)

    The access level to use to obtain results. The default is User.

Returns:

See Also:



3414
3415
3416
3417
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 3414

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :product_id (required, String)

    The product identifier.

Returns:

See Also:



3462
3463
3464
3465
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 3462

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

#list_provisioning_artifacts_for_service_action(params = {}) ⇒ Types::ListProvisioningArtifactsForServiceActionOutput

Lists all provisioning artifacts (also known as versions) for the specified self-service action.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :service_action_id (required, String)

    The self-service action identifier. For example, act-fs7abcd89wxyz.

  • :page_size (Integer)

    The maximum number of items to return with this call.

  • :page_token (String)

    The page token for the next set of results. To retrieve the first set of results, use null.

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

Returns:

See Also:



3528
3529
3530
3531
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 3528

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

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

Lists the specified requests or all performed requests.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :access_level_filter (Types::AccessLevelFilter)

    The access level to use to obtain results. The default is User.

  • :search_filter (Types::ListRecordHistorySearchFilter)

    The search filter to scope the results.

  • :page_size (Integer)

    The maximum number of items to return with this call.

  • :page_token (String)

    The page token for the next set of results. To retrieve the first set of results, use null.

Returns:

See Also:



3604
3605
3606
3607
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 3604

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

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

Lists the resources associated with the specified TagOption.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :tag_option_id (required, String)

    The TagOption identifier.

  • :resource_type (String)

    The resource type.

    • Portfolio

    • Product

  • :page_size (Integer)

    The maximum number of items to return with this call.

  • :page_token (String)

    The page token for the next set of results. To retrieve the first set of results, use null.

Returns:

See Also:



3656
3657
3658
3659
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 3656

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

#list_service_actions(params = {}) ⇒ Types::ListServiceActionsOutput

Lists all self-service actions.

Examples:

Request syntax with placeholder values


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

Response structure


resp.service_action_summaries #=> Array
resp.service_action_summaries[0].id #=> String
resp.service_action_summaries[0].name #=> String
resp.service_action_summaries[0].description #=> String
resp.service_action_summaries[0].definition_type #=> String, one of "SSM_AUTOMATION"
resp.next_page_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :page_size (Integer)

    The maximum number of items to return with this call.

  • :page_token (String)

    The page token for the next set of results. To retrieve the first set of results, use null.

Returns:

See Also:



3705
3706
3707
3708
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 3705

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

#list_service_actions_for_provisioning_artifact(params = {}) ⇒ Types::ListServiceActionsForProvisioningArtifactOutput

Returns a paginated list of self-service actions associated with the specified Product ID and Provisioning Artifact ID.

Examples:

Request syntax with placeholder values


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

Response structure


resp.service_action_summaries #=> Array
resp.service_action_summaries[0].id #=> String
resp.service_action_summaries[0].name #=> String
resp.service_action_summaries[0].description #=> String
resp.service_action_summaries[0].definition_type #=> String, one of "SSM_AUTOMATION"
resp.next_page_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :product_id (required, String)

    The product identifier. For example, prod-abcdzk7xy33qa.

  • :provisioning_artifact_id (required, String)

    The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne.

  • :page_size (Integer)

    The maximum number of items to return with this call.

  • :page_token (String)

    The page token for the next set of results. To retrieve the first set of results, use null.

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

Returns:

See Also:



3764
3765
3766
3767
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 3764

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

#list_stack_instances_for_provisioned_product(params = {}) ⇒ Types::ListStackInstancesForProvisionedProductOutput

Returns summary information about stack instances that are associated with the specified CFN_STACKSET type provisioned product. You can filter for stack instances that are associated with a specific AWS account name or region.

Examples:

Request syntax with placeholder values


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

Response structure


resp.stack_instances #=> Array
resp.stack_instances[0]. #=> String
resp.stack_instances[0].region #=> String
resp.stack_instances[0].stack_instance_status #=> String, one of "CURRENT", "OUTDATED", "INOPERABLE"
resp.next_page_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :provisioned_product_id (required, String)

    The identifier of the provisioned product.

  • :page_token (String)

    The page token for the next set of results. To retrieve the first set of results, use null.

  • :page_size (Integer)

    The maximum number of items to return with this call.

Returns:

See Also:



3819
3820
3821
3822
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 3819

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

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

Lists the specified TagOptions or all TagOptions.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :filters (Types::ListTagOptionsFilters)

    The search filters. If no search filters are specified, the output includes all TagOptions.

  • :page_size (Integer)

    The maximum number of items to return with this call.

  • :page_token (String)

    The page token for the next set of results. To retrieve the first set of results, use null.

Returns:

See Also:



3867
3868
3869
3870
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 3867

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

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

Provisions the specified product.

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

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

Examples:

Request syntax with placeholder values


resp = client.provision_product({
  accept_language: "AcceptLanguage",
  product_id: "Id", # required
  provisioning_artifact_id: "Id", # required
  path_id: "Id",
  provisioned_product_name: "ProvisionedProductName", # required
  provisioning_parameters: [
    {
      key: "ParameterKey",
      value: "ParameterValue",
    },
  ],
  provisioning_preferences: {
    stack_set_accounts: ["AccountId"],
    stack_set_regions: ["Region"],
    stack_set_failure_tolerance_count: 1,
    stack_set_failure_tolerance_percentage: 1,
    stack_set_max_concurrency_count: 1,
    stack_set_max_concurrency_percentage: 1,
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  notification_arns: ["NotificationArn"],
  provision_token: "IdempotencyToken", # required
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :product_id (required, String)

    The product identifier.

  • :provisioning_artifact_id (required, String)

    The identifier of the provisioning artifact.

  • :path_id (String)

    The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths.

  • :provisioned_product_name (required, String)

    A user-friendly name for the provisioned product. This value must be unique for the AWS account and cannot be updated after the product is provisioned.

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

    Parameters specified by the administrator that are required for provisioning the product.

  • :provisioning_preferences (Types::ProvisioningPreferences)

    An object that contains information about the provisioning preferences for a stack set.

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

    One or more tags.

  • :notification_arns (Array<String>)

    Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events.

  • :provision_token (required, String)

    An idempotency token that uniquely identifies the provisioning request.

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

Returns:

See Also:



3991
3992
3993
3994
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 3991

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

#reject_portfolio_share(params = {}) ⇒ Struct

Rejects an offer to share the specified portfolio.

Examples:

Request syntax with placeholder values


resp = client.reject_portfolio_share({
  accept_language: "AcceptLanguage",
  portfolio_id: "Id", # required
  portfolio_share_type: "IMPORTED", # accepts IMPORTED, AWS_SERVICECATALOG, AWS_ORGANIZATIONS
})

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :portfolio_id (required, String)

    The portfolio identifier.

  • :portfolio_share_type (String)

    The type of shared portfolios to reject. The default is to reject imported portfolios.

    • AWS_ORGANIZATIONS - Reject portfolios shared by the master account of your organization.

    • IMPORTED - Reject imported portfolios.

    • AWS_SERVICECATALOG - Not supported. (Throws ResourceNotFoundException.)

    For example, aws servicecatalog reject-portfolio-share --portfolio-id "port-2qwzkwxt3y5fk" --portfolio-share-type AWS_ORGANIZATIONS

Returns:

  • (Struct)

    Returns an empty response.

See Also:



4039
4040
4041
4042
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 4039

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

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

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

To use additional filtering, see SearchProvisionedProducts.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :access_level_filter (Types::AccessLevelFilter)

    The access level to use to obtain results. The default is User.

  • :page_size (Integer)

    The maximum number of items to return with this call.

  • :page_token (String)

    The page token for the next set of results. To retrieve the first set of results, use null.

Returns:

See Also:



4104
4105
4106
4107
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 4104

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :filters (Hash<String,Array>)

    The search filters. If no search filters are specified, the output includes all products to which the caller has access.

  • :page_size (Integer)

    The maximum number of items to return with this call.

  • :sort_by (String)

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

  • :sort_order (String)

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

  • :page_token (String)

    The page token for the next set of results. To retrieve the first set of results, use null.

Returns:

See Also:



4180
4181
4182
4183
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 4180

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :portfolio_id (String)

    The portfolio identifier.

  • :filters (Hash<String,Array>)

    The search filters. If no search filters are specified, the output includes all products to which the administrator has access.

  • :sort_by (String)

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

  • :sort_order (String)

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

  • :page_token (String)

    The page token for the next set of results. To retrieve the first set of results, use null.

  • :page_size (Integer)

    The maximum number of items to return with this call.

  • :product_source (String)

    Access level of the source of the product.

Returns:

See Also:



4263
4264
4265
4266
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 4263

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :access_level_filter (Types::AccessLevelFilter)

    The access level to use to obtain results. The default is User.

  • :filters (Hash<String,Array>)

    The search filters.

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

    Example: "SearchQuery":["status:AVAILABLE"]

  • :sort_by (String)

    The sort field. If no value is specified, the results are not sorted. The valid values are arn, id, name, and lastRecordId.

  • :sort_order (String)

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

  • :page_size (Integer)

    The maximum number of items to return with this call.

  • :page_token (String)

    The page token for the next set of results. To retrieve the first set of results, use null.

Returns:

See Also:



4357
4358
4359
4360
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 4357

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

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

Terminates the specified provisioned product.

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

You can check the status of this request using DescribeRecord.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :provisioned_product_name (String)

    The name of the provisioned product. You cannot specify both ProvisionedProductName and ProvisionedProductId.

  • :provisioned_product_id (String)

    The identifier of the provisioned product. You cannot specify both ProvisionedProductName and ProvisionedProductId.

  • :terminate_token (required, String)

    An idempotency token that uniquely identifies the termination request. This token is only valid during the termination process. After the provisioned product is terminated, subsequent requests to terminate the same provisioned product always return ResourceNotFound.

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

  • :ignore_errors (Boolean)

    If set to true, AWS Service Catalog stops managing the specified provisioned product even if it cannot delete the underlying resources.

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

Returns:

See Also:



4437
4438
4439
4440
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 4437

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

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

Updates the specified constraint.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :id (required, String)

    The identifier of the constraint.

  • :description (String)

    The updated description of the constraint.

  • :parameters (String)

    The constraint parameters, in JSON format. The syntax depends on the constraint type as follows:

    LAUNCH

    Specify the RoleArn property as follows:

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

    You cannot have both a LAUNCH and a STACKSET constraint.

    You also cannot have more than one LAUNCH constraint on a product and portfolio.

    NOTIFICATION

    Specify the NotificationArns property as follows:

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

    RESOURCE_UPDATE

    Specify the TagUpdatesOnProvisionedProduct property as follows:

    \{"Version":"2.0","Properties":\{"TagUpdateOnProvisionedProduct":"String"\}\}

    The TagUpdatesOnProvisionedProduct property accepts a string value of ALLOWED or NOT_ALLOWED.

    STACKSET

    Specify the Parameters property as follows:

    \{"Version": "String", "Properties": \{"AccountList": [ "String" ], "RegionList": [ "String" ], "AdminRole": "String", "ExecutionRole": "String"\}\}

    You cannot have both a LAUNCH and a STACKSET constraint.

    You also cannot have more than one STACKSET constraint on a product and portfolio.

    Products with a STACKSET constraint will launch an AWS CloudFormation stack set.

    TEMPLATE

    Specify the Rules property. For more information, see Template Constraint Rules.

Returns:

See Also:



4543
4544
4545
4546
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 4543

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

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

Updates the specified portfolio.

You cannot update a product that was shared with you.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :id (required, String)

    The portfolio identifier.

  • :display_name (String)

    The name to use for display purposes.

  • :description (String)

    The updated description of the portfolio.

  • :provider_name (String)

    The updated name of the portfolio provider.

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

    The tags to add.

  • :remove_tags (Array<String>)

    The tags to remove.

Returns:

See Also:



4617
4618
4619
4620
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 4617

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

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

Updates the specified product.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :id (required, String)

    The product identifier.

  • :name (String)

    The updated product name.

  • :owner (String)

    The updated owner of the product.

  • :description (String)

    The updated description of the product.

  • :distributor (String)

    The updated distributor of the product.

  • :support_description (String)

    The updated support description for the product.

  • :support_email (String)

    The updated support email for the product.

  • :support_url (String)

    The updated support URL for the product.

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

    The tags to add to the product.

  • :remove_tags (Array<String>)

    The tags to remove from the product.

Returns:

See Also:



4713
4714
4715
4716
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 4713

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

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

Requests updates to the configuration of the specified provisioned product.

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

You can check the status of this request using DescribeRecord.

Examples:

Request syntax with placeholder values


resp = client.update_provisioned_product({
  accept_language: "AcceptLanguage",
  provisioned_product_name: "ProvisionedProductNameOrArn",
  provisioned_product_id: "Id",
  product_id: "Id",
  provisioning_artifact_id: "Id",
  path_id: "Id",
  provisioning_parameters: [
    {
      key: "ParameterKey",
      value: "ParameterValue",
      use_previous_value: false,
    },
  ],
  provisioning_preferences: {
    stack_set_accounts: ["AccountId"],
    stack_set_regions: ["Region"],
    stack_set_failure_tolerance_count: 1,
    stack_set_failure_tolerance_percentage: 1,
    stack_set_max_concurrency_count: 1,
    stack_set_max_concurrency_percentage: 1,
    stack_set_operation_type: "CREATE", # accepts CREATE, UPDATE, DELETE
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  update_token: "IdempotencyToken", # required
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :provisioned_product_name (String)

    The name of the provisioned product. You cannot specify both ProvisionedProductName and ProvisionedProductId.

  • :provisioned_product_id (String)

    The identifier of the provisioned product. You cannot specify both ProvisionedProductName and ProvisionedProductId.

  • :product_id (String)

    The identifier of the product.

  • :provisioning_artifact_id (String)

    The identifier of the provisioning artifact.

  • :path_id (String)

    The new path identifier. This value is optional if the product has a default path, and required if the product has more than one path.

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

    The new parameters.

  • :provisioning_preferences (Types::UpdateProvisioningPreferences)

    An object that contains information about the provisioning preferences for a stack set.

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

    One or more tags. Requires the product to have RESOURCE_UPDATE constraint with TagUpdatesOnProvisionedProduct set to ALLOWED to allow tag updates.

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



4836
4837
4838
4839
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 4836

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

#update_provisioned_product_properties(params = {}) ⇒ Types::UpdateProvisionedProductPropertiesOutput

Requests updates to the properties of the specified provisioned product.

Examples:

Request syntax with placeholder values


resp = client.update_provisioned_product_properties({
  accept_language: "AcceptLanguage",
  provisioned_product_id: "Id", # required
  provisioned_product_properties: { # required
    "OWNER" => "PropertyValue",
  },
  idempotency_token: "IdempotencyToken", # required
})

Response structure


resp.provisioned_product_id #=> String
resp.provisioned_product_properties #=> Hash
resp.provisioned_product_properties["PropertyKey"] #=> String
resp.record_id #=> String
resp.status #=> String, one of "CREATED", "IN_PROGRESS", "IN_PROGRESS_IN_ERROR", "SUCCEEDED", "FAILED"

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :provisioned_product_id (required, String)

    The identifier of the provisioned product.

  • :provisioned_product_properties (required, Hash<String,String>)

    A map that contains the provisioned product properties to be updated.

    The OWNER key only accepts user ARNs. The owner is the user that is allowed to see, update, terminate, and execute service actions in the provisioned product.

    The administrator can change the owner of a provisioned product to another IAM user within the same account. Both end user owners and administrators can see ownership history of the provisioned product using the ListRecordHistory API. The new owner can describe all past records for the provisioned product using the DescribeRecord API. The previous owner can no longer use DescribeRecord, but can still see the product's history from when he was an owner using ListRecordHistory.

    If a provisioned product ownership is assigned to an end user, they can see and perform any action through the API or Service Catalog console such as update, terminate, and execute service actions. If an end user provisions a product and the owner is updated to someone else, they will no longer be able to see or perform any actions through API or the Service Catalog console on that provisioned product.

  • :idempotency_token (required, String)

    The idempotency token that uniquely identifies the provisioning product update request.

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

Returns:

See Also:



4917
4918
4919
4920
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 4917

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

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • :product_id (required, String)

    The product identifier.

  • :provisioning_artifact_id (required, String)

    The identifier of the provisioning artifact.

  • :name (String)

    The updated name of the provisioning artifact.

  • :description (String)

    The updated description of the provisioning artifact.

  • :active (Boolean)

    Indicates whether the product version is active.

  • :guidance (String)

    Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.

    The DEFAULT value indicates that the product version is active.

    The administrator can set the guidance to DEPRECATED to inform users that the product version is deprecated. Users are able to make updates to a provisioned product of a deprecated version but cannot launch new provisioned products using a deprecated version.

Returns:

See Also:



4998
4999
5000
5001
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 4998

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

#update_service_action(params = {}) ⇒ Types::UpdateServiceActionOutput

Updates a self-service action.

Examples:

Request syntax with placeholder values


resp = client.update_service_action({
  id: "Id", # required
  name: "ServiceActionName",
  definition: {
    "Name" => "ServiceActionDefinitionValue",
  },
  description: "ServiceActionDescription",
  accept_language: "AcceptLanguage",
})

Response structure


resp.service_action_detail.service_action_summary.id #=> String
resp.service_action_detail.service_action_summary.name #=> String
resp.service_action_detail.service_action_summary.description #=> String
resp.service_action_detail.service_action_summary.definition_type #=> String, one of "SSM_AUTOMATION"
resp.service_action_detail.definition #=> Hash
resp.service_action_detail.definition["ServiceActionDefinitionKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String)

    The self-service action identifier.

  • :name (String)

    The self-service action name.

  • :definition (Hash<String,String>)

    A map that defines the self-service action.

  • :description (String)

    The self-service action description.

  • :accept_language (String)

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

Returns:

See Also:



5055
5056
5057
5058
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 5055

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

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

Updates the specified TagOption.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String)

    The TagOption identifier.

  • :value (String)

    The updated value.

  • :active (Boolean)

    The updated active state.

Returns:

See Also:



5094
5095
5096
5097
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 5094

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