Class: Aws::ServiceCatalog::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb

Overview

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

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

For details on configuring region and credentials see the developer guide.

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

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::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

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

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

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

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    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/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.
  • :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 searched 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.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

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

  • :correct_clock_skew (Boolean) — default: true

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy"

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false

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

  • :disable_request_compression (Boolean) — default: false

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP)

    Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
    'https://example.com'
    'http://example.com:123'
    
  • :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.

  • :ignore_configured_endpoint_urls (Boolean)

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

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

  • :max_attempts (Integer) — default: 3

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

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

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

  • :request_min_compression_size_bytes (Integer) — default: 10240

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :retry_backoff (Proc)

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :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. This option is only used in the legacy retry mode.

    @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, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :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. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy"

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String)

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

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

  • :token_provider (Aws::TokenProvider)

    A Bearer Token Provider. This can be an instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean)

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean)

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true

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

  • :endpoint_provider (Aws::ServiceCatalog::EndpointProvider)

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::ServiceCatalog::EndpointParameters

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

  • :http_idle_timeout (Float) — default: 5

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

  • :http_open_timeout (Float) — default: 15

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

  • :http_proxy (URI::HTTP, String)

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

  • :http_read_timeout (Float) — default: 60

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

  • :http_wire_trace (Boolean) — default: false

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

  • :on_chunk_received (Proc)

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).

  • :on_chunk_sent (Proc)

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true

    When true, response errors are raised.

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

  • :ssl_ca_store (String)

    Sets the X509::Store to verify peer certificate.

  • :ssl_timeout (Float)

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true

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



420
421
422
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 420

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.

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



467
468
469
470
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 467

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:



493
494
495
496
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 493

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.

If you share the portfolio with principal name sharing enabled, the PrincipalARN association is included in the share.

The PortfolioID, PrincipalARN, and PrincipalType parameters are required.

You can associate a maximum of 10 Principals with a portfolio using PrincipalType as IAM_PATTERN.

When you associate a principal with portfolio, a potential privilege escalation path may occur when that portfolio is then shared with other accounts. For a user in a recipient account who is not an Service Catalog Admin, but still has the ability to create Principals (Users/Groups/Roles), that user could create a role that matches a principal name association for the portfolio. Although this user may not know which principal names are associated through Service Catalog, they may be able to guess the user. If this potential escalation path is a concern, then Service Catalog recommends using PrincipalType as IAM. With this configuration, the PrincipalARN must already exist in the recipient account before it can be associated.

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

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

    • jp - Japanese

    • zh - Chinese

  • :portfolio_id (required, String)

    The portfolio identifier.

  • :principal_arn (required, String)

    The ARN of the principal (user, role, or group). If the PrincipalType is IAM, the supported value is a fully defined IAM Amazon Resource Name (ARN). If the PrincipalType is IAM_PATTERN, the supported value is an IAM ARN without an AccountID in the following format:

    arn:partition:iam:::resource-type/resource-id

    The ARN resource-id can be either:

    • A fully formed resource-id. For example, arn:aws:iam:::role/resource-name or arn:aws:iam:::role/resource-path/resource-name

    • A wildcard ARN. The wildcard ARN accepts IAM_PATTERN values with a "" or "?" in the resource-id segment of the ARN. For example arn:partition:service:::resource-type/resource-path/resource-name*. The new symbols are exclusive to the resource-path and resource-name and cannot replace the resource-type or other ARN values.

      The ARN path and principal name allow unlimited wildcard characters.

    Examples of an acceptable wildcard ARN:

    • arn:aws:iam:::role/ResourceName_*

    • arn:aws:iam:::role/*/ResourceName_?

    Examples of an unacceptable wildcard ARN:

    • arn:aws:iam:::*/ResourceName

    ^

    You can associate multiple IAM_PATTERNs even if the account has no principal with that name.

    The "?" wildcard character matches zero or one of any character. This is similar to ".?" in regular regex context. The "" wildcard character matches any number of any characters. This is similar to "." in regular regex context.

    In the IAM Principal ARN format (arn:partition:iam:::resource-type/resource-path/resource-name), valid resource-type values include user/, group/, or role/. The "?" and "*" characters are allowed only after the resource-type in the resource-id segment. You can use special characters anywhere within the resource-id.

    The "" character also matches the "/" character, allowing paths to be formed within the resource-id. For example, arn:aws:iam:::role//ResourceName_? matches both arn:aws:iam:::role/pathA/pathB/ResourceName_1 and arn:aws:iam:::role/pathA/ResourceName_1.

  • :principal_type (required, String)

    The principal type. The supported value is IAM if you use a fully defined Amazon Resource Name (ARN), or IAM_PATTERN if you use an ARN with no accountID, with or without wildcard characters.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



614
615
616
617
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 614

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.

A delegated admin is authorized to invoke this command.

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.

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



654
655
656
657
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 654

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

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.

    • jp - Japanese

    • zh - Chinese

  • :idempotency_token (String)

    A unique identifier that you provide to ensure idempotency. If multiple requests from the same Amazon Web Services account use the same 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:

  • (Struct)

    Returns an empty response.

See Also:



703
704
705
706
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 703

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:



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

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", "INVALID_PARAMETER"
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.

    • jp - Japanese

    • zh - Chinese

Returns:

See Also:



778
779
780
781
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 778

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", "INVALID_PARAMETER"
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.

    • jp - Japanese

    • zh - Chinese

Returns:

See Also:



827
828
829
830
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 827

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. If you copy a product to another account, you must first share the product in a portfolio using CreatePortfolioShare.

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.

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



906
907
908
909
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 906

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

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

Creates a constraint.

A delegated admin is authorized to invoke this command.

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_detail.product_id #=> String
resp.constraint_detail.portfolio_id #=> 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.

    • 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

    You are required to specify either the RoleArn or the LocalRoleName but can't use both.

    Specify the RoleArn property as follows:

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

    Specify the LocalRoleName property as follows:

    \{"LocalRoleName": "SCBasicLaunchRole"\}

    If you specify the LocalRoleName property, when an account uses the launch constraint, the IAM role with that name in the account will be used. This allows launch-role constraints to be account-agnostic so the administrator can create fewer resources per shared account.

    The given role name must exist in the account used to create the launch constraint and the account of the user who launches a product with this launch constraint.

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



1060
1061
1062
1063
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 1060

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

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

Creates a portfolio.

A delegated admin is authorized to invoke this command.

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.

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



1133
1134
1135
1136
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 1133

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 management account of an organization or by a delegated administrator. You can share portfolios to an organization, an organizational unit, or a specific account.

Note that if a delegated admin is de-registered, they can no longer create portfolio shares.

AWSOrganizationsAccess must be enabled in order to create a portfolio share to an organization node.

You can't share a shared resource, including portfolios that contain a shared product.

If the portfolio share with the specified account or organization node already exists, this action will have no effect and will not return an error. To update an existing share, you must use the UpdatePortfolioShare API instead.

When you associate a principal with portfolio, a potential privilege escalation path may occur when that portfolio is then shared with other accounts. For a user in a recipient account who is not an Service Catalog Admin, but still has the ability to create Principals (Users/Groups/Roles), that user could create a role that matches a principal name association for the portfolio. Although this user may not know which principal names are associated through Service Catalog, they may be able to guess the user. If this potential escalation path is a concern, then Service Catalog recommends using PrincipalType as IAM. With this configuration, the PrincipalARN must already exist in the recipient account before it can be associated.

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",
  },
  share_tag_options: false,
  share_principals: false,
})

Response structure


resp.portfolio_share_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

    • jp - Japanese

    • zh - Chinese

  • :portfolio_id (required, String)

    The portfolio identifier.

  • :account_id (String)

    The Amazon Web Services account ID. For example, 123456789012.

  • :organization_node (Types::OrganizationNode)

    The organization node to whom you are going to share. When you pass OrganizationNode, it creates PortfolioShare for all of the Amazon Web Services accounts that are associated to the OrganizationNode. The output returns a PortfolioShareToken, which enables the administrator to monitor the status of the PortfolioShare creation process.

  • :share_tag_options (Boolean)

    Enables or disables TagOptions sharing when creating the portfolio share. If this flag is not provided, TagOptions sharing is disabled.

  • :share_principals (Boolean)

    This parameter is only supported for portfolios with an OrganizationalNode Type of ORGANIZATION or ORGANIZATIONAL_UNIT.

    Enables or disables Principal sharing when creating the portfolio share. If you do not provide this flag, principal sharing is disabled.

    When you enable Principal Name Sharing for a portfolio share, the share recipient account end users with a principal that matches any of the associated IAM patterns can provision products from the portfolio. Once shared, the share recipient can view associations of PrincipalType: IAM_PATTERN on their portfolio. You can create the principals in the recipient account before or after creating the share.

Returns:

See Also:



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

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.

A delegated admin is authorized to invoke this command.

The user or role that performs this operation must have the cloudformation:GetTemplate IAM policy permission. This policy permission is required when using the ImportFromPhysicalId template source in the information data section.

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, TERRAFORM_OPEN_SOURCE, TERRAFORM_CLOUD, EXTERNAL
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  provisioning_artifact_parameters: {
    name: "ProvisioningArtifactName",
    description: "ProvisioningArtifactDescription",
    info: {
      "ProvisioningArtifactInfoKey" => "ProvisioningArtifactInfoValue",
    },
    type: "CLOUD_FORMATION_TEMPLATE", # accepts CLOUD_FORMATION_TEMPLATE, MARKETPLACE_AMI, MARKETPLACE_CAR, TERRAFORM_OPEN_SOURCE, TERRAFORM_CLOUD, EXTERNAL
    disable_template_validation: false,
  },
  idempotency_token: "IdempotencyToken", # required
  source_connection: {
    type: "CODESTAR", # accepts CODESTAR
    connection_parameters: { # required
      code_star: {
        connection_arn: "CodeStarConnectionArn", # required
        repository: "Repository", # required
        branch: "RepositoryBranch", # required
        artifact_path: "RepositoryArtifactPath", # 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", "TERRAFORM_OPEN_SOURCE", "TERRAFORM_CLOUD", "EXTERNAL"
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.product_view_detail.source_connection.type #=> String, one of "CODESTAR"
resp.product_view_detail.source_connection.connection_parameters.code_star.connection_arn #=> String
resp.product_view_detail.source_connection.connection_parameters.code_star.repository #=> String
resp.product_view_detail.source_connection.connection_parameters.code_star.branch #=> String
resp.product_view_detail.source_connection.connection_parameters.code_star.artifact_path #=> String
resp.product_view_detail.source_connection.last_sync.last_sync_time #=> Time
resp.product_view_detail.source_connection.last_sync.last_sync_status #=> String, one of "SUCCEEDED", "FAILED"
resp.product_view_detail.source_connection.last_sync.last_sync_status_message #=> String
resp.product_view_detail.source_connection.last_sync.last_successful_sync_time #=> Time
resp.product_view_detail.source_connection.last_sync.last_successful_sync_provisioning_artifact_id #=> String
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", "TERRAFORM_OPEN_SOURCE", "TERRAFORM_CLOUD", "EXTERNAL"
resp.provisioning_artifact_detail.created_time #=> Time
resp.provisioning_artifact_detail.active #=> Boolean
resp.provisioning_artifact_detail.guidance #=> String, one of "DEFAULT", "DEPRECATED"
resp.provisioning_artifact_detail.source_revision #=> 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.

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

    ^https?:\/\/// is the pattern used to validate SupportUrl.

  • :product_type (required, String)

    The type of product.

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

    One or more tags.

  • :provisioning_artifact_parameters (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.**

  • :source_connection (Types::SourceConnection)

    Specifies connection details for the created product and syncs the product to the connection source artifact. This automatically manages the product's artifacts based on changes to the source. The SourceConnection parameter consists of the following sub-fields.

    • Type

    • ConnectionParamters

Returns:

See Also:



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

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 for each provisioned product. To create a plan for an existing provisioned product, the product status must be AVAILABLE 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.

    • 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 Amazon Web Services 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:



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

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.

The user or role that performs this operation must have the cloudformation:GetTemplate IAM policy permission. This policy permission is required when using the ImportFromPhysicalId template source in the information data section.

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: {
      "ProvisioningArtifactInfoKey" => "ProvisioningArtifactInfoValue",
    },
    type: "CLOUD_FORMATION_TEMPLATE", # accepts CLOUD_FORMATION_TEMPLATE, MARKETPLACE_AMI, MARKETPLACE_CAR, TERRAFORM_OPEN_SOURCE, TERRAFORM_CLOUD, EXTERNAL
    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", "TERRAFORM_OPEN_SOURCE", "TERRAFORM_CLOUD", "EXTERNAL"
resp.provisioning_artifact_detail.created_time #=> Time
resp.provisioning_artifact_detail.active #=> Boolean
resp.provisioning_artifact_detail.guidance #=> String, one of "DEFAULT", "DEPRECATED"
resp.provisioning_artifact_detail.source_revision #=> String
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.

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



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

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 Amazon Web Services Systems Manager document (SSM document). For example, AWS-RestartEC2Instance.

    If you are using a shared SSM document, you must provide the ARN instead of the name.

    Version

    The Amazon Web Services 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"\}] or [\{"Name":"InstanceId","Type":"TEXT_VALUE"\}].

  • :description (String)

    The self-service action description.

  • :accept_language (String)

    The language code.

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



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

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
resp.tag_option_detail.owner #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :key (required, String)

    The TagOption key.

  • :value (required, String)

    The TagOption value.

Returns:

See Also:



1726
1727
1728
1729
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 1726

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.

A delegated admin is authorized to invoke this command.

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.

    • jp - Japanese

    • zh - Chinese

  • :id (required, String)

    The identifier of the constraint.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



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

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.

A delegated admin is authorized to invoke this command.

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.

    • jp - Japanese

    • zh - Chinese

  • :id (required, String)

    The portfolio identifier.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1793
1794
1795
1796
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 1793

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 management account of an organization or by a delegated administrator.

Note that if a delegated admin is de-registered, portfolio shares created from that account are removed.

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.

    • jp - Japanese

    • zh - Chinese

  • :portfolio_id (required, String)

    The portfolio identifier.

  • :account_id (String)

    The Amazon Web Services account ID.

  • :organization_node (Types::OrganizationNode)

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

Returns:

See Also:



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

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.

A delegated admin is authorized to invoke this command.

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.

    • jp - Japanese

    • zh - Chinese

  • :id (required, String)

    The product identifier.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1881
1882
1883
1884
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 1881

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.

    • jp - Japanese

    • zh - Chinese

  • :plan_id (required, String)

    The plan identifier.

  • :ignore_errors (Boolean)

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

Returns:

  • (Struct)

    Returns an empty response.

See Also:



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

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.

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



1956
1957
1958
1959
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 1956

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

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.

    • jp - Japanese

    • zh - Chinese

  • :idempotency_token (String)

    A unique identifier that you provide to ensure idempotency. If multiple requests from the same Amazon Web Services account use the same 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:

  • (Struct)

    Returns an empty response.

See Also:



1996
1997
1998
1999
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 1996

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:



2021
2022
2023
2024
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2021

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_detail.product_id #=> String
resp.constraint_detail.portfolio_id #=> 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.

    • jp - Japanese

    • zh - Chinese

  • :id (required, String)

    The identifier of the constraint.

Returns:

See Also:



2066
2067
2068
2069
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2066

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.

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



2107
2108
2109
2110
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2107

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.

A delegated admin is authorized to invoke this command.

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.tag_options[0].owner #=> String
resp.budgets #=> Array
resp.budgets[0].budget_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

    • jp - Japanese

    • zh - Chinese

  • :id (required, String)

    The portfolio identifier.

Returns:

See Also:



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

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 management account in the organization or by a delegated admin.

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:



2209
2210
2211
2212
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2209

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

#describe_portfolio_shares(params = {}) ⇒ Types::DescribePortfolioSharesOutput

Returns a summary of each of the portfolio shares that were created for the specified portfolio.

You can use this API to determine which accounts or organizational nodes this portfolio have been shared, whether the recipient entity has imported the share, and whether TagOptions are included with the share.

The PortfolioId and Type parameters are both required.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_portfolio_shares({
  portfolio_id: "Id", # required
  type: "ACCOUNT", # required, accepts ACCOUNT, ORGANIZATION, ORGANIZATIONAL_UNIT, ORGANIZATION_MEMBER_ACCOUNT
  page_token: "PageToken",
  page_size: 1,
})

Response structure


resp.next_page_token #=> String
resp.portfolio_share_details #=> Array
resp.portfolio_share_details[0].principal_id #=> String
resp.portfolio_share_details[0].type #=> String, one of "ACCOUNT", "ORGANIZATION", "ORGANIZATIONAL_UNIT", "ORGANIZATION_MEMBER_ACCOUNT"
resp.portfolio_share_details[0].accepted #=> Boolean
resp.portfolio_share_details[0].share_tag_options #=> Boolean
resp.portfolio_share_details[0].share_principals #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :portfolio_id (required, String)

    The unique identifier of the portfolio for which shares will be retrieved.

  • :type (required, String)

    The type of portfolio share to summarize. This field acts as a filter on the type of portfolio share, which can be one of the following:

    1. ACCOUNT - Represents an external account to account share.

    2. ORGANIZATION - Represents a share to an organization. This share is available to every account in the organization.

    3. ORGANIZATIONAL_UNIT - Represents a share to an organizational unit.

    4. ORGANIZATION_MEMBER_ACCOUNT - Represents a share to an account in the 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:



2280
2281
2282
2283
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2280

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

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

Gets information about the specified product.

Running this operation with administrator access results in a failure. DescribeProductAsAdmin should be used instead.

Examples:

Request syntax with placeholder values


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

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", "TERRAFORM_OPEN_SOURCE", "TERRAFORM_CLOUD", "EXTERNAL"
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
resp.launch_paths #=> Array
resp.launch_paths[0].id #=> String
resp.launch_paths[0].name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

    • jp - Japanese

    • zh - Chinese

  • :id (String)

    The product identifier.

  • :name (String)

    The product name.

Returns:

See Also:



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

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",
  name: "ProductViewName",
  source_portfolio_id: "Id",
})

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", "TERRAFORM_OPEN_SOURCE", "TERRAFORM_CLOUD", "EXTERNAL"
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.product_view_detail.source_connection.type #=> String, one of "CODESTAR"
resp.product_view_detail.source_connection.connection_parameters.code_star.connection_arn #=> String
resp.product_view_detail.source_connection.connection_parameters.code_star.repository #=> String
resp.product_view_detail.source_connection.connection_parameters.code_star.branch #=> String
resp.product_view_detail.source_connection.connection_parameters.code_star.artifact_path #=> String
resp.product_view_detail.source_connection.last_sync.last_sync_time #=> Time
resp.product_view_detail.source_connection.last_sync.last_sync_status #=> String, one of "SUCCEEDED", "FAILED"
resp.product_view_detail.source_connection.last_sync.last_sync_status_message #=> String
resp.product_view_detail.source_connection.last_sync.last_successful_sync_time #=> Time
resp.product_view_detail.source_connection.last_sync.last_successful_sync_provisioning_artifact_id #=> String
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.tag_options[0].owner #=> String
resp.budgets #=> Array
resp.budgets[0].budget_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

    • jp - Japanese

    • zh - Chinese

  • :id (String)

    The product identifier.

  • :name (String)

    The product name.

  • :source_portfolio_id (String)

    The unique identifier of the shared portfolio that the specified product is associated with.

    You can provide this parameter to retrieve the shared TagOptions associated with the product. If this parameter is provided and if TagOptions sharing is enabled in the portfolio share, the API returns both local and shared TagOptions associated with the product. Otherwise only local TagOptions will be returned.

Returns:

See Also:



2446
2447
2448
2449
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2446

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", "TERRAFORM_OPEN_SOURCE", "TERRAFORM_CLOUD", "EXTERNAL"
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.

    • jp - Japanese

    • zh - Chinese

  • :id (required, String)

    The product view identifier.

Returns:

See Also:



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

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

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.last_provisioning_record_id #=> String
resp.provisioned_product_detail.last_successful_provisioning_record_id #=> String
resp.provisioned_product_detail.product_id #=> String
resp.provisioned_product_detail.provisioning_artifact_id #=> String
resp.provisioned_product_detail.launch_role_arn #=> 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.

    • jp - Japanese

    • zh - Chinese

  • :id (String)

    The provisioned product identifier. You must provide the name or ID, but not both.

    If you do not provide a name or ID, or you provide both name and ID, an InvalidParametersException will occur.

  • :name (String)

    The name of the provisioned product. You must provide the name or ID, but not both.

    If you do not provide a name or ID, or you provide both name and ID, an InvalidParametersException will occur.

Returns:

See Also:



2563
2564
2565
2566
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2563

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.

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



2645
2646
2647
2648
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2645

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",
  product_id: "Id",
  provisioning_artifact_name: "ProvisioningArtifactName",
  product_name: "ProductViewName",
  verbose: false,
  include_provisioning_artifact_parameters: 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", "TERRAFORM_OPEN_SOURCE", "TERRAFORM_CLOUD", "EXTERNAL"
resp.provisioning_artifact_detail.created_time #=> Time
resp.provisioning_artifact_detail.active #=> Boolean
resp.provisioning_artifact_detail.guidance #=> String, one of "DEFAULT", "DEPRECATED"
resp.provisioning_artifact_detail.source_revision #=> String
resp.info #=> Hash
resp.info["ProvisioningArtifactInfoKey"] #=> String
resp.status #=> String, one of "AVAILABLE", "CREATING", "FAILED"
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.provisioning_artifact_parameters[0].parameter_constraints.allowed_pattern #=> String
resp.provisioning_artifact_parameters[0].parameter_constraints.constraint_description #=> String
resp.provisioning_artifact_parameters[0].parameter_constraints.max_length #=> String
resp.provisioning_artifact_parameters[0].parameter_constraints.min_length #=> String
resp.provisioning_artifact_parameters[0].parameter_constraints.max_value #=> String
resp.provisioning_artifact_parameters[0].parameter_constraints.min_value #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

    • jp - Japanese

    • zh - Chinese

  • :provisioning_artifact_id (String)

    The identifier of the provisioning artifact.

  • :product_id (String)

    The product identifier.

  • :provisioning_artifact_name (String)

    The provisioning artifact name.

  • :product_name (String)

    The product name.

  • :verbose (Boolean)

    Indicates whether a verbose level of detail is enabled.

  • :include_provisioning_artifact_parameters (Boolean)

    Indicates if the API call response does or does not include additional details about the provisioning parameters.

Returns:

See Also:



2730
2731
2732
2733
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2730

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",
  product_name: "ProductViewName",
  provisioning_artifact_id: "Id",
  provisioning_artifact_name: "ProvisioningArtifactName",
  path_id: "Id",
  path_name: "PortfolioDisplayName",
})

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.provisioning_artifact_parameters[0].parameter_constraints.allowed_pattern #=> String
resp.provisioning_artifact_parameters[0].parameter_constraints.constraint_description #=> String
resp.provisioning_artifact_parameters[0].parameter_constraints.max_length #=> String
resp.provisioning_artifact_parameters[0].parameter_constraints.min_length #=> String
resp.provisioning_artifact_parameters[0].parameter_constraints.max_value #=> String
resp.provisioning_artifact_parameters[0].parameter_constraints.min_value #=> 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
resp.provisioning_artifact_outputs #=> Array
resp.provisioning_artifact_outputs[0].key #=> String
resp.provisioning_artifact_outputs[0].description #=> String
resp.provisioning_artifact_output_keys #=> Array
resp.provisioning_artifact_output_keys[0].key #=> String
resp.provisioning_artifact_output_keys[0].description #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

    • jp - Japanese

    • zh - Chinese

  • :product_id (String)

    The product identifier. You must provide the product name or ID, but not both.

  • :product_name (String)

    The name of the product. You must provide the name or ID, but not both.

  • :provisioning_artifact_id (String)

    The identifier of the provisioning artifact. You must provide the name or ID, but not both.

  • :provisioning_artifact_name (String)

    The name of the provisioning artifact. You must provide the name or ID, but not both.

  • :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. You must provide the name or ID, but not both.

  • :path_name (String)

    The name of the path. You must provide the name or ID, but not both.

Returns:

See Also:



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

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_detail.launch_role_arn #=> 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.

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



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

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.

    • jp - Japanese

    • zh - Chinese

Returns:

See Also:



2965
2966
2967
2968
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 2965

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

Finds the default parameters for a specific self-service action on a specific provisioned product and returns a map of the results to the user.

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)

    The identifier of the provisioned product.

  • :service_action_id (required, String)

    The self-service action identifier.

  • :accept_language (String)

    The language code.

    • jp - Japanese

    • zh - Chinese

Returns:

See Also:



3011
3012
3013
3014
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 3011

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
resp.tag_option_detail.owner #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String)

    The TagOption identifier.

Returns:

See Also:



3043
3044
3045
3046
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 3043

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 the Organizations service. This command will not delete your current shares, but prevents you from creating new shares throughout your organization. Current shares are not kept in sync with your organization structure if the structure changes after calling this API. Only the management account in the organization can call this API.

You cannot call this API if there are active delegated administrators in the organization.

Note that a delegated administrator is not authorized to invoke DisableAWSOrganizationsAccess.

If you share an Service Catalog portfolio in an organization within Organizations, and then disable Organizations access for Service Catalog, the portfolio access permissions will not sync with the latest changes to the organization structure. Specifically, accounts that you removed from the organization after disabling Service Catalog access will retain access to the previously shared portfolio.

Parameters:

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

    ({})

Returns:

  • (Struct)

    Returns an empty response.

See Also:



3074
3075
3076
3077
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 3074

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:



3101
3102
3103
3104
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 3101

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.

The PrincipalType and PrincipalARN must match the AssociatePrincipalWithPortfolio call request details. For example, to disassociate an association created with a PrincipalARN of PrincipalType IAM you must use the PrincipalType IAM when calling DisassociatePrincipalFromPortfolio.

For portfolios that have been shared with principal name sharing enabled: after disassociating a principal, share recipient accounts will no longer be able to provision products in this portfolio using a role matching the name of the associated principal.

For more information, review associate-principal-with-portfolio in the Amazon Web Services CLI Command Reference.

If you disassociate a principal from a portfolio, with PrincipalType as IAM, the same principal will still have access to the portfolio if it matches one of the associated principals of type IAM_PATTERN. To fully remove access for a principal, verify all the associated Principals of type IAM_PATTERN, and then ensure you disassociate any IAM_PATTERN principals that match the principal whose access you are removing.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

    • jp - Japanese

    • zh - Chinese

  • :portfolio_id (required, String)

    The portfolio identifier.

  • :principal_arn (required, String)

    The ARN of the principal (user, role, or group). This field allows an ARN with no accountID with or without wildcard characters if PrincipalType is IAM_PATTERN.

  • :principal_type (String)

    The supported value is IAM if you use a fully defined ARN, or IAM_PATTERN if you specify an IAM ARN with no AccountId, with or without wildcard characters.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



3172
3173
3174
3175
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 3172

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.

A delegated admin is authorized to invoke this command.

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.

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



3208
3209
3210
3211
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 3208

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

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.

    • jp - Japanese

    • zh - Chinese

  • :idempotency_token (String)

    A unique identifier that you provide to ensure idempotency. If multiple requests from the same Amazon Web Services account use the same 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:

  • (Struct)

    Returns an empty response.

See Also:



3258
3259
3260
3261
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 3258

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:



3284
3285
3286
3287
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 3284

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 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 management account in the organization.

When you call this API, Service Catalog calls organizations:EnableAWSServiceAccess on your behalf so that your shares stay in sync with any changes in your Organizations structure.

Note that a delegated administrator is not authorized to invoke EnableAWSOrganizationsAccess.

If you have previously disabled Organizations access for Service Catalog, and then enable access again, the portfolio access permissions might not sync with the latest changes to the organization structure. Specifically, accounts that you removed from the organization after disabling Service Catalog access, and before you enabled access again, can retain access to the previously shared portfolio. As a result, an account that has been removed from the organization might still be able to create or manage Amazon Web Services resources when it is no longer authorized to do so. Amazon Web Services is working to resolve this issue.

Parameters:

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

    ({})

Returns:

  • (Struct)

    Returns an empty response.

See Also:



3318
3319
3320
3321
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 3318

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
resp.record_detail.launch_role_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

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



3381
3382
3383
3384
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 3381

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
resp.record_detail.launch_role_arn #=> 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.

    • jp - Japanese

    • zh - Chinese

  • :parameters (Hash<String,Array>)

    A map of all self-service action parameters and their values. If a provided parameter is of a special type, such as TARGET, the provided value will override the default value generated by Service Catalog. If the parameters field is not provided, no additional parameters are passed and default values will be used for any special parameters such as TARGET.

Returns:

See Also:



3456
3457
3458
3459
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 3456

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 Organizations portfolio share feature. This API can only be called by the management account in the organization or by a delegated admin.

Examples:

Response structure


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

Parameters:

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

    ({})

Returns:

See Also:



3477
3478
3479
3480
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 3477

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

#get_provisioned_product_outputs(params = {}) ⇒ Types::GetProvisionedProductOutputsOutput

This API takes either a ProvisonedProductId or a ProvisionedProductName, along with a list of one or more output keys, and responds with the key/value pairs of those outputs.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_provisioned_product_outputs({
  accept_language: "AcceptLanguage",
  provisioned_product_id: "Id",
  provisioned_product_name: "ProvisionedProductName",
  output_keys: ["OutputKey"],
  page_size: 1,
  page_token: "PageToken",
})

Response structure


resp.outputs #=> Array
resp.outputs[0].output_key #=> String
resp.outputs[0].output_value #=> String
resp.outputs[0].description #=> String
resp.next_page_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

    • jp - Japanese

    • zh - Chinese

  • :provisioned_product_id (String)

    The identifier of the provisioned product that you want the outputs from.

  • :provisioned_product_name (String)

    The name of the provisioned product that you want the outputs from.

  • :output_keys (Array<String>)

    The list of keys that the API should return with their values. If none are provided, the API will return all outputs of the provisioned 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:



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

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

#import_as_provisioned_product(params = {}) ⇒ Types::ImportAsProvisionedProductOutput

Requests the import of a resource as an Service Catalog provisioned product that is associated to an Service Catalog product and provisioning artifact. Once imported, all supported governance actions are supported on the provisioned product.

Resource import only supports CloudFormation stack ARNs. CloudFormation StackSets, and non-root nested stacks, are not supported.

The CloudFormation stack must have one of the following statuses to be imported: CREATE_COMPLETE, UPDATE_COMPLETE, UPDATE_ROLLBACK_COMPLETE, IMPORT_COMPLETE, and IMPORT_ROLLBACK_COMPLETE.

Import of the resource requires that the CloudFormation stack template matches the associated Service Catalog product provisioning artifact.

When you import an existing CloudFormation stack into a portfolio, Service Catalog does not apply the product's associated constraints during the import process. Service Catalog applies the constraints after you call UpdateProvisionedProduct for the provisioned product.

The user or role that performs this operation must have the cloudformation:GetTemplate and cloudformation:DescribeStacks IAM policy permissions.

You can only import one provisioned product at a time. The product's CloudFormation stack must have the IMPORT_COMPLETE status before you import another.

Examples:

Request syntax with placeholder values


resp = client.import_as_provisioned_product({
  accept_language: "AcceptLanguage",
  product_id: "Id", # required
  provisioning_artifact_id: "Id", # required
  provisioned_product_name: "ProvisionedProductName", # required
  physical_id: "PhysicalId", # 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
resp.record_detail.launch_role_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

    • jp - Japanese

    • zh - Chinese

  • :product_id (required, String)

    The product identifier.

  • :provisioning_artifact_id (required, String)

    The identifier of the provisioning artifact.

  • :provisioned_product_name (required, String)

    The user-friendly name of the provisioned product. The value must be unique for the Amazon Web Services account. The name cannot be updated after the product is provisioned.

  • :physical_id (required, String)

    The unique identifier of the resource to be imported. It only currently supports CloudFormation stack IDs.

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



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

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

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

Lists all imported portfolios for which account-to-account shares were accepted by this account. By specifying the PortfolioShareType, you can list portfolios for which organizational shares were accepted by this account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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.

    • 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 accepted and shared via organizational sharing by the management account or delegated administrator of your organization.

    • AWS_SERVICECATALOG - Deprecated type.

    • IMPORTED - List imported portfolios that have been accepted and shared through account-to-account sharing.

Returns:

See Also:



3717
3718
3719
3720
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 3717

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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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.

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



3767
3768
3769
3770
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 3767

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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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.constraint_details[0].product_id #=> String
resp.constraint_details[0].portfolio_id #=> String
resp.next_page_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

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



3826
3827
3828
3829
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 3826

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 describes how the user gets access to a specified product and is necessary when provisioning a product. A path also determines the constraints that are put on a product. A path is dependent on a specific product, porfolio, and principal.

When provisioning a product that's been added to a portfolio, you must grant your user, group, or role access to the portfolio. For more information, see Granting users access in the Service Catalog User Guide.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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.

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



3898
3899
3900
3901
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 3898

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 management account in the organization or by a delegated admin.

If a delegated admin is de-registered, they can no longer perform this operation.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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.

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



3966
3967
3968
3969
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 3966

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.

A delegated admin can list the accounts that have access to the shared portfolio. Note that if a delegated admin is de-registered, they can no longer perform this operation.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


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

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.

    • jp - Japanese

    • zh - Chinese

  • :portfolio_id (required, String)

    The portfolio identifier.

  • :organization_parent_id (String)

    The ID of an organization node the portfolio is shared with. All children of this node with an inherited portfolio share will be returned.

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



4026
4027
4028
4029
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 4026

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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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.

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



4077
4078
4079
4080
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 4077

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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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.

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



4132
4133
4134
4135
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 4132

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 PrincipalARNs and corresponding PrincipalTypes associated with the specified portfolio.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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", "IAM_PATTERN"
resp.next_page_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

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



4184
4185
4186
4187
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 4184

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.

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



4245
4246
4247
4248
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 4245

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", "TERRAFORM_OPEN_SOURCE", "TERRAFORM_CLOUD", "EXTERNAL"
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.provisioning_artifact_details[0].source_revision #=> String
resp.next_page_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

    • jp - Japanese

    • zh - Chinese

  • :product_id (required, String)

    The product identifier.

Returns:

See Also:



4292
4293
4294
4295
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 4292

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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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", "TERRAFORM_OPEN_SOURCE", "TERRAFORM_CLOUD", "EXTERNAL"
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.

    • jp - Japanese

    • zh - Chinese

Returns:

See Also:



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

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.record_details[0].launch_role_arn #=> String
resp.next_page_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

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



4433
4434
4435
4436
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 4433

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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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:



4487
4488
4489
4490
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 4487

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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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.

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



4536
4537
4538
4539
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 4536

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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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.

    • jp - Japanese

    • zh - Chinese

Returns:

See Also:



4595
4596
4597
4598
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 4595

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 Amazon Web Services 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.

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



4648
4649
4650
4651
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 4648

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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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.tag_option_details[0].owner #=> 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:



4699
4700
4701
4702
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 4699

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

#notify_provision_product_engine_workflow_result(params = {}) ⇒ Struct

Notifies the result of the provisioning engine execution.

Examples:

Request syntax with placeholder values


resp = client.notify_provision_product_engine_workflow_result({
  workflow_token: "EngineWorkflowToken", # required
  record_id: "Id", # required
  status: "SUCCEEDED", # required, accepts SUCCEEDED, FAILED
  failure_reason: "EngineWorkflowFailureReason",
  resource_identifier: {
    unique_tag: {
      key: "UniqueTagKey",
      value: "UniqueTagValue",
    },
  },
  outputs: [
    {
      output_key: "OutputKey",
      output_value: "OutputValue",
      description: "Description",
    },
  ],
  idempotency_token: "IdempotencyToken", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :workflow_token (required, String)

    The encrypted contents of the provisioning engine execution payload that Service Catalog sends after the Terraform product provisioning workflow starts.

  • :record_id (required, String)

    The identifier of the record.

  • :status (required, String)

    The status of the provisioning engine execution.

  • :failure_reason (String)

    The reason why the provisioning engine execution failed.

  • :resource_identifier (Types::EngineWorkflowResourceIdentifier)

    The ID for the provisioned product resources that are part of a resource group.

  • :outputs (Array<Types::RecordOutput>)

    The output of the provisioning engine execution.

  • :idempotency_token (required, String)

    The idempotency token that identifies the provisioning engine execution.

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

Returns:

  • (Struct)

    Returns an empty response.

See Also:



4763
4764
4765
4766
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 4763

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

#notify_terminate_provisioned_product_engine_workflow_result(params = {}) ⇒ Struct

Notifies the result of the terminate engine execution.

Examples:

Request syntax with placeholder values


resp = client.notify_terminate_provisioned_product_engine_workflow_result({
  workflow_token: "EngineWorkflowToken", # required
  record_id: "Id", # required
  status: "SUCCEEDED", # required, accepts SUCCEEDED, FAILED
  failure_reason: "EngineWorkflowFailureReason",
  idempotency_token: "IdempotencyToken", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :workflow_token (required, String)

    The encrypted contents of the terminate engine execution payload that Service Catalog sends after the Terraform product terminate workflow starts.

  • :record_id (required, String)

    The identifier of the record.

  • :status (required, String)

    The status of the terminate engine execution.

  • :failure_reason (String)

    The reason why the terminate engine execution failed.

  • :idempotency_token (required, String)

    The idempotency token that identifies the terminate engine execution.

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

Returns:

  • (Struct)

    Returns an empty response.

See Also:



4806
4807
4808
4809
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 4806

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

#notify_update_provisioned_product_engine_workflow_result(params = {}) ⇒ Struct

Notifies the result of the update engine execution.

Examples:

Request syntax with placeholder values


resp = client.notify_update_provisioned_product_engine_workflow_result({
  workflow_token: "EngineWorkflowToken", # required
  record_id: "Id", # required
  status: "SUCCEEDED", # required, accepts SUCCEEDED, FAILED
  failure_reason: "EngineWorkflowFailureReason",
  outputs: [
    {
      output_key: "OutputKey",
      output_value: "OutputValue",
      description: "Description",
    },
  ],
  idempotency_token: "IdempotencyToken", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :workflow_token (required, String)

    The encrypted contents of the update engine execution payload that Service Catalog sends after the Terraform product update workflow starts.

  • :record_id (required, String)

    The identifier of the record.

  • :status (required, String)

    The status of the update engine execution.

  • :failure_reason (String)

    The reason why the update engine execution failed.

  • :outputs (Array<Types::RecordOutput>)

    The output of the update engine execution.

  • :idempotency_token (required, String)

    The idempotency token that identifies the update engine execution.

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

Returns:

  • (Struct)

    Returns an empty response.

See Also:



4859
4860
4861
4862
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 4859

def notify_update_provisioned_product_engine_workflow_result(params = {}, options = {})
  req = build_request(:notify_update_provisioned_product_engine_workflow_result, 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 that's based on an CloudFormation template launches an 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's a tag conflict for that key. Don't include conflicted keys as tags, or this will cause the error "Parameter validation failed: Missing required parameter in Tags[N]:Value".

When provisioning a product that's been added to a portfolio, you must grant your user, group, or role access to the portfolio. For more information, see Granting users access in the Service Catalog User Guide.

Examples:

Request syntax with placeholder values


resp = client.provision_product({
  accept_language: "AcceptLanguage",
  product_id: "Id",
  product_name: "ProductViewName",
  provisioning_artifact_id: "Id",
  provisioning_artifact_name: "ProvisioningArtifactName",
  path_id: "Id",
  path_name: "PortfolioDisplayName",
  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
resp.record_detail.launch_role_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

    • jp - Japanese

    • zh - Chinese

  • :product_id (String)

    The product identifier. You must provide the name or ID, but not both.

  • :product_name (String)

    The name of the product. You must provide the name or ID, but not both.

  • :provisioning_artifact_id (String)

    The identifier of the provisioning artifact. You must provide the name or ID, but not both.

  • :provisioning_artifact_name (String)

    The name of the provisioning artifact. You must provide the name or ID, but not both.

  • :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. You must provide the name or ID, but not both.

  • :path_name (String)

    The name of the path. You must provide the name or ID, but not both.

  • :provisioned_product_name (required, String)

    A user-friendly name for the provisioned product. This value must be unique for the Amazon Web Services 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:



5010
5011
5012
5013
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 5010

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.

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



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

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].last_provisioning_record_id #=> String
resp.provisioned_products[0].last_successful_provisioning_record_id #=> String
resp.provisioned_products[0].product_id #=> String
resp.provisioned_products[0].provisioning_artifact_id #=> String
resp.provisioned_products[0].launch_role_arn #=> String
resp.next_page_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

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



5122
5123
5124
5125
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 5122

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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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", "TERRAFORM_OPEN_SOURCE", "TERRAFORM_CLOUD", "EXTERNAL"
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.

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



5198
5199
5200
5201
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 5198

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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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", "TERRAFORM_OPEN_SOURCE", "TERRAFORM_CLOUD", "EXTERNAL"
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.product_view_details[0].source_connection.type #=> String, one of "CODESTAR"
resp.product_view_details[0].source_connection.connection_parameters.code_star.connection_arn #=> String
resp.product_view_details[0].source_connection.connection_parameters.code_star.repository #=> String
resp.product_view_details[0].source_connection.connection_parameters.code_star.branch #=> String
resp.product_view_details[0].source_connection.connection_parameters.code_star.artifact_path #=> String
resp.product_view_details[0].source_connection.last_sync.last_sync_time #=> Time
resp.product_view_details[0].source_connection.last_sync.last_sync_status #=> String, one of "SUCCEEDED", "FAILED"
resp.product_view_details[0].source_connection.last_sync.last_sync_status_message #=> String
resp.product_view_details[0].source_connection.last_sync.last_successful_sync_time #=> Time
resp.product_view_details[0].source_connection.last_sync.last_successful_sync_provisioning_artifact_id #=> String
resp.next_page_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

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



5291
5292
5293
5294
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 5291

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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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].last_provisioning_record_id #=> String
resp.provisioned_products[0].last_successful_provisioning_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].product_name #=> String
resp.provisioned_products[0].provisioning_artifact_id #=> String
resp.provisioned_products[0].provisioning_artifact_name #=> 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.

    • 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, provisioningArtifactId, type, status, tags, userArn, userArnSession, lastProvisioningRecordId, lastSuccessfulProvisioningRecordId, productName, and provisioningArtifactName.

    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:



5391
5392
5393
5394
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 5391

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

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_detail.launch_role_arn #=> 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, Service Catalog stops managing the specified provisioned product even if it cannot delete the underlying resources.

  • :accept_language (String)

    The language code.

    • jp - Japanese

    • zh - Chinese

  • :retain_physical_resources (Boolean)

    When this boolean parameter is set to true, the TerminateProvisionedProduct API deletes the Service Catalog provisioned product. However, it does not remove the CloudFormation stack, stack set, or the underlying resources of the deleted provisioned product. The default value is false.

Returns:

See Also:



5478
5479
5480
5481
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 5478

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_detail.product_id #=> String
resp.constraint_detail.portfolio_id #=> 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.

    • 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

    You are required to specify either the RoleArn or the LocalRoleName but can't use both.

    Specify the RoleArn property as follows:

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

    Specify the LocalRoleName property as follows:

    \{"LocalRoleName": "SCBasicLaunchRole"\}

    If you specify the LocalRoleName property, when an account uses the launch constraint, the IAM role with that name in the account will be used. This allows launch-role constraints to be account-agnostic so the administrator can create fewer resources per shared account.

    The given role name must exist in the account used to create the launch constraint and the account of the user who launches a product with this launch constraint.

    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 CloudFormation stack set.

    TEMPLATE

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

Returns:

See Also:



5603
5604
5605
5606
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 5603

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.

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



5675
5676
5677
5678
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 5675

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

#update_portfolio_share(params = {}) ⇒ Types::UpdatePortfolioShareOutput

Updates the specified portfolio share. You can use this API to enable or disable TagOptions sharing or Principal sharing for an existing portfolio share.

The portfolio share cannot be updated if the CreatePortfolioShare operation is IN_PROGRESS, as the share is not available to recipient entities. In this case, you must wait for the portfolio share to be completed.

You must provide the accountId or organization node in the input, but not both.

If the portfolio is shared to both an external account and an organization node, and both shares need to be updated, you must invoke UpdatePortfolioShare separately for each share type.

This API cannot be used for removing the portfolio share. You must use DeletePortfolioShare API for that action.

When you associate a principal with portfolio, a potential privilege escalation path may occur when that portfolio is then shared with other accounts. For a user in a recipient account who is not an Service Catalog Admin, but still has the ability to create Principals (Users/Groups/Roles), that user could create a role that matches a principal name association for the portfolio. Although this user may not know which principal names are associated through Service Catalog, they may be able to guess the user. If this potential escalation path is a concern, then Service Catalog recommends using PrincipalType as IAM. With this configuration, the PrincipalARN must already exist in the recipient account before it can be associated.

Examples:

Request syntax with placeholder values


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

Response structure


resp.portfolio_share_token #=> String
resp.status #=> String, one of "NOT_STARTED", "IN_PROGRESS", "COMPLETED", "COMPLETED_WITH_ERRORS", "ERROR"

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

    • jp - Japanese

    • zh - Chinese

  • :portfolio_id (required, String)

    The unique identifier of the portfolio for which the share will be updated.

  • :account_id (String)

    The Amazon Web Services account Id of the recipient account. This field is required when updating an external account to account type share.

  • :organization_node (Types::OrganizationNode)

    Information about the organization node.

  • :share_tag_options (Boolean)

    Enables or disables TagOptions sharing for the portfolio share. If this field is not provided, the current state of TagOptions sharing on the portfolio share will not be modified.

  • :share_principals (Boolean)

    A flag to enables or disables Principals sharing in the portfolio. If this field is not provided, the current state of the Principals sharing on the portfolio share will not be modified.

Returns:

See Also:



5770
5771
5772
5773
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 5770

def update_portfolio_share(params = {}, options = {})
  req = build_request(:update_portfolio_share, 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"],
  source_connection: {
    type: "CODESTAR", # accepts CODESTAR
    connection_parameters: { # required
      code_star: {
        connection_arn: "CodeStarConnectionArn", # required
        repository: "Repository", # required
        branch: "RepositoryBranch", # required
        artifact_path: "RepositoryArtifactPath", # 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", "TERRAFORM_OPEN_SOURCE", "TERRAFORM_CLOUD", "EXTERNAL"
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.product_view_detail.source_connection.type #=> String, one of "CODESTAR"
resp.product_view_detail.source_connection.connection_parameters.code_star.connection_arn #=> String
resp.product_view_detail.source_connection.connection_parameters.code_star.repository #=> String
resp.product_view_detail.source_connection.connection_parameters.code_star.branch #=> String
resp.product_view_detail.source_connection.connection_parameters.code_star.artifact_path #=> String
resp.product_view_detail.source_connection.last_sync.last_sync_time #=> Time
resp.product_view_detail.source_connection.last_sync.last_sync_status #=> String, one of "SUCCEEDED", "FAILED"
resp.product_view_detail.source_connection.last_sync.last_sync_status_message #=> String
resp.product_view_detail.source_connection.last_sync.last_successful_sync_time #=> Time
resp.product_view_detail.source_connection.last_sync.last_successful_sync_provisioning_artifact_id #=> 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.

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

  • :source_connection (Types::SourceConnection)

    Specifies connection details for the updated product and syncs the product to the connection source artifact. This automatically manages the product's artifacts based on changes to the source. The SourceConnection parameter consists of the following sub-fields.

    • Type

    • ConnectionParamters

Returns:

See Also:



5895
5896
5897
5898
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 5895

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",
  product_name: "ProductViewName",
  provisioning_artifact_id: "Id",
  provisioning_artifact_name: "ProvisioningArtifactName",
  path_id: "Id",
  path_name: "PortfolioDisplayName",
  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
resp.record_detail.launch_role_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :accept_language (String)

    The language code.

    • 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 must provide the name or ID, but not both.

  • :product_id (String)

    The identifier of the product. You must provide the name or ID, but not both.

  • :product_name (String)

    The name of the product. You must provide the name or ID, but not both.

  • :provisioning_artifact_id (String)

    The identifier of the provisioning artifact.

  • :provisioning_artifact_name (String)

    The name of the provisioning artifact. You must provide the name or ID, but not both.

  • :path_id (String)

    The path identifier. This value is optional if the product has a default path, and required if the product has more than one path. You must provide the name or ID, but not both.

  • :path_name (String)

    The name of the path. You must provide the name or ID, but not both.

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



6033
6034
6035
6036
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/client.rb', line 6033

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.

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