aws-sdk-servicecatalog 1.52.0 → 1.57.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3746171ad09274f81345ab8816d3188411b0c37977524385e9fe3eaf98998819
-  data.tar.gz: 8b2cb2f5f378104704aa46e880b61791970e8a97653223b27c991ae14e1facc5
+  metadata.gz: 89c76b090c5d96c95d08740041870da4cb9406ed01ec1dd129f0accad4e2abe1
+  data.tar.gz: 1040cf39dab777931bfd515ac9929db2e66831c297db6a56160513a9761d2148
 SHA512:
-  metadata.gz: af95e9f10914cb1fe58d87adf8a4ade4c6c590c5f29a8b964884741e2a50e83e7564a27b6452b6f9f0c59c9734edcf99e835782587507e4232db53a4feca0646
-  data.tar.gz: 80df418e1da304a7437ae5860e686231abd4eb770d0e6b236e80b1600f0f5572365af702ffc07c76139ee669b115a51a6cf656f9c5dc0664e525b59fa1d773a6
+  metadata.gz: 8c789ba53be16110c7b45706900a018d112d1722d5492a397e764f0185177626259d4844b183d647bd3900315387db19b83e81e50359443f713d2a0cfc5680ef
+  data.tar.gz: b21966203967757282df595b0c121efe3b009a26f43b76e16e8f5808f1ba581b829c8edd2b38736ee781f8a663983a49712f73140f3cd6e01b9aed3c38a49b6c

data/lib/aws-sdk-servicecatalog.rb

@@ -48,6 +48,6 @@ require_relative 'aws-sdk-servicecatalog/customizations'
 # @!group service
 module Aws::ServiceCatalog
 
-  GEM_VERSION = '1.52.0'
+  GEM_VERSION = '1.57.0'
 
 end

data/lib/aws-sdk-servicecatalog/client.rb

@@ -984,8 +984,13 @@ module Aws::ServiceCatalog
     # `AWSOrganizationsAccess` must be enabled in order to create a
     # portfolio share to an organization node.
     #
-    # You can't share a shared resource. This includes portfolios that
-    # contain a shared product.
+    # 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.
     #
     # @option params [String] :accept_language
     #   The language code.
@@ -1010,6 +1015,10 @@ module Aws::ServiceCatalog
     #   in order for the administrator to monitor the status of the
     #   `PortfolioShare` creation process.
     #
+    # @option params [Boolean] :share_tag_options
+    #   Enables or disables `TagOptions ` sharing when creating the portfolio
+    #   share. If this flag is not provided, TagOptions sharing is disabled.
+    #
     # @return [Types::CreatePortfolioShareOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::CreatePortfolioShareOutput#portfolio_share_token #portfolio_share_token} => String
@@ -1024,6 +1033,7 @@ module Aws::ServiceCatalog
     #       type: "ORGANIZATION", # accepts ORGANIZATION, ORGANIZATIONAL_UNIT, ACCOUNT
     #       value: "OrganizationNodeValue",
     #     },
+    #     share_tag_options: false,
     #   })
     #
     # @example Response structure
@@ -1043,6 +1053,11 @@ module Aws::ServiceCatalog
     #
     # 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.
+    #
     # @option params [String] :accept_language
     #   The language code.
     #
@@ -1073,6 +1088,8 @@ module Aws::ServiceCatalog
     # @option params [String] :support_url
     #   The contact URL for product support.
     #
+    #   `^https?:\/\// `/ is the pattern used to validate SupportUrl.
+    #
     # @option params [required, String] :product_type
     #   The type of product.
     #
@@ -1287,6 +1304,11 @@ module Aws::ServiceCatalog
     # 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.
+    #
     # @option params [String] :accept_language
     #   The language code.
     #
@@ -1475,6 +1497,7 @@ module Aws::ServiceCatalog
     #   resp.tag_option_detail.value #=> String
     #   resp.tag_option_detail.active #=> Boolean
     #   resp.tag_option_detail.id #=> String
+    #   resp.tag_option_detail.owner #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/servicecatalog-2015-12-10/CreateTagOption AWS API Documentation
     #
@@ -1920,6 +1943,7 @@ module Aws::ServiceCatalog
     #   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
     #
@@ -1977,6 +2001,76 @@ module Aws::ServiceCatalog
       req.send_request(options)
     end
 
+    # 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.
+    #
+    # @option params [required, String] :portfolio_id
+    #   The unique identifier of the portfolio for which shares will be
+    #   retrieved.
+    #
+    # @option params [required, String] :type
+    #   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.
+    #
+    # @option params [String] :page_token
+    #   The page token for the next set of results. To retrieve the first set
+    #   of results, use null.
+    #
+    # @option params [Integer] :page_size
+    #   The maximum number of items to return with this call.
+    #
+    # @return [Types::DescribePortfolioSharesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::DescribePortfolioSharesOutput#next_page_token #next_page_token} => String
+    #   * {Types::DescribePortfolioSharesOutput#portfolio_share_details #portfolio_share_details} => Array<Types::PortfolioShareDetail>
+    #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
+    # @example 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,
+    #   })
+    #
+    # @example 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
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/servicecatalog-2015-12-10/DescribePortfolioShares AWS API Documentation
+    #
+    # @overload describe_portfolio_shares(params = {})
+    # @param [Hash] params ({})
+    def describe_portfolio_shares(params = {}, options = {})
+      req = build_request(:describe_portfolio_shares, params)
+      req.send_request(options)
+    end
+
     # Gets information about the specified product.
     #
     # @option params [String] :accept_language
@@ -2061,6 +2155,16 @@ module Aws::ServiceCatalog
     # @option params [String] :name
     #   The product name.
     #
+    # @option params [String] :source_portfolio_id
+    #   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.
+    #
     # @return [Types::DescribeProductAsAdminOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::DescribeProductAsAdminOutput#product_view_detail #product_view_detail} => Types::ProductViewDetail
@@ -2075,6 +2179,7 @@ module Aws::ServiceCatalog
     #     accept_language: "AcceptLanguage",
     #     id: "Id",
     #     name: "ProductViewName",
+    #     source_portfolio_id: "Id",
     #   })
     #
     # @example Response structure
@@ -2108,6 +2213,7 @@ module Aws::ServiceCatalog
     #   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
     #
@@ -2467,6 +2573,12 @@ module Aws::ServiceCatalog
     #   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
@@ -2691,6 +2803,7 @@ module Aws::ServiceCatalog
     #   resp.tag_option_detail.value #=> String
     #   resp.tag_option_detail.active #=> Boolean
     #   resp.tag_option_detail.id #=> String
+    #   resp.tag_option_detail.owner #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/servicecatalog-2015-12-10/DescribeTagOption AWS API Documentation
     #
@@ -3149,6 +3262,103 @@ module Aws::ServiceCatalog
       req.send_request(options)
     end
 
+    # Requests the import of a resource as a Service Catalog provisioned
+    # product that is associated to a Service Catalog product and
+    # provisioning artifact. Once imported, all supported Service Catalog
+    # 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`,
+    # `IMPORT_ROLLBACK_COMPLETE`.
+    #
+    # Import of the resource requires that the CloudFormation stack template
+    # matches the associated Service Catalog product provisioning artifact.
+    #
+    # The user or role that performs this operation must have the
+    # `cloudformation:GetTemplate` and `cloudformation:DescribeStacks` IAM
+    # policy permissions.
+    #
+    # @option params [String] :accept_language
+    #   The language code.
+    #
+    #   * `en` - English (default)
+    #
+    #   * `jp` - Japanese
+    #
+    #   * `zh` - Chinese
+    #
+    # @option params [required, String] :product_id
+    #   The product identifier.
+    #
+    # @option params [required, String] :provisioning_artifact_id
+    #   The identifier of the provisioning artifact.
+    #
+    # @option params [required, String] :provisioned_product_name
+    #   The user-friendly name of the provisioned product. The value must be
+    #   unique for the AWS account. The name cannot be updated after the
+    #   product is provisioned.
+    #
+    # @option params [required, String] :physical_id
+    #   The unique identifier of the resource to be imported. It only
+    #   currently supports CloudFormation stack IDs.
+    #
+    # @option params [required, String] :idempotency_token
+    #   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.**
+    #
+    # @return [Types::ImportAsProvisionedProductOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ImportAsProvisionedProductOutput#record_detail #record_detail} => Types::RecordDetail
+    #
+    # @example 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
+    #   })
+    #
+    # @example 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
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/servicecatalog-2015-12-10/ImportAsProvisionedProduct AWS API Documentation
+    #
+    # @overload import_as_provisioned_product(params = {})
+    # @param [Hash] params ({})
+    def import_as_provisioned_product(params = {}, options = {})
+      req = build_request(:import_as_provisioned_product, params)
+      req.send_request(options)
+    end
+
     # Lists all portfolios for which sharing was accepted by this account.
     #
     # @option params [String] :accept_language
@@ -4199,6 +4409,7 @@ module Aws::ServiceCatalog
     #   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
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/servicecatalog-2015-12-10/ListTagOptions AWS API Documentation
@@ -4769,6 +4980,13 @@ module Aws::ServiceCatalog
     #
     #   * `zh` - Chinese
     #
+    # @option params [Boolean] :retain_physical_resources
+    #   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.
+    #
     # @return [Types::TerminateProvisionedProductOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::TerminateProvisionedProductOutput#record_detail #record_detail} => Types::RecordDetail
@@ -4781,6 +4999,7 @@ module Aws::ServiceCatalog
     #     terminate_token: "IdempotencyToken", # required
     #     ignore_errors: false,
     #     accept_language: "AcceptLanguage",
+    #     retain_physical_resources: false,
     #   })
     #
     # @example Response structure
@@ -5014,6 +5233,81 @@ module Aws::ServiceCatalog
       req.send_request(options)
     end
 
+    # Updates the specified portfolio share. You can use this API to enable
+    # or disable TagOptions 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.
+    #
+    # @option params [String] :accept_language
+    #   The language code.
+    #
+    #   * `en` - English (default)
+    #
+    #   * `jp` - Japanese
+    #
+    #   * `zh` - Chinese
+    #
+    # @option params [required, String] :portfolio_id
+    #   The unique identifier of the portfolio for which the share will be
+    #   updated.
+    #
+    # @option params [String] :account_id
+    #   The AWS Account Id of the recipient account. This field is required
+    #   when updating an external account to account type share.
+    #
+    # @option params [Types::OrganizationNode] :organization_node
+    #   Information about the organization node.
+    #
+    # @option params [Boolean] :share_tag_options
+    #   A flag to enable or disable 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.
+    #
+    # @return [Types::UpdatePortfolioShareOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::UpdatePortfolioShareOutput#portfolio_share_token #portfolio_share_token} => String
+    #   * {Types::UpdatePortfolioShareOutput#status #status} => String
+    #
+    # @example 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,
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.portfolio_share_token #=> String
+    #   resp.status #=> String, one of "NOT_STARTED", "IN_PROGRESS", "COMPLETED", "COMPLETED_WITH_ERRORS", "ERROR"
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/servicecatalog-2015-12-10/UpdatePortfolioShare AWS API Documentation
+    #
+    # @overload update_portfolio_share(params = {})
+    # @param [Hash] params ({})
+    def update_portfolio_share(params = {}, options = {})
+      req = build_request(:update_portfolio_share, params)
+      req.send_request(options)
+    end
+
     # Updates the specified product.
     #
     # @option params [String] :accept_language
@@ -5268,12 +5562,12 @@ module Aws::ServiceCatalog
     # @option params [required, Hash<String,String>] :provisioned_product_properties
     #   A map that contains the provisioned product properties to be updated.
     #
-    #   The `LAUNCH_ROLE` key accepts user ARNs and role ARNs. This key allows
-    #   an administrator to call `UpdateProvisionedProductProperties` to
-    #   update the launch role that is associated with a provisioned product.
-    #   This role is used when an end-user calls a provisioning operation such
-    #   as `UpdateProvisionedProduct`, `TerminateProvisionedProduct`, or
-    #   `ExecuteProvisionedProductServiceAction`. Only an ARN role is valid. A
+    #   The `LAUNCH_ROLE` key accepts role ARNs. This key allows an
+    #   administrator to call `UpdateProvisionedProductProperties` to update
+    #   the launch role that is associated with a provisioned product. This
+    #   role is used when an end user calls a provisioning operation such as
+    #   `UpdateProvisionedProduct`, `TerminateProvisionedProduct`, or
+    #   `ExecuteProvisionedProductServiceAction`. Only a role ARN is valid. A
     #   user ARN is invalid.
     #
     #   The `OWNER` key accepts user ARNs and role ARNs. The owner is the user
@@ -5510,6 +5804,7 @@ module Aws::ServiceCatalog
     #   resp.tag_option_detail.value #=> String
     #   resp.tag_option_detail.active #=> Boolean
     #   resp.tag_option_detail.id #=> String
+    #   resp.tag_option_detail.owner #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/servicecatalog-2015-12-10/UpdateTagOption AWS API Documentation
     #
@@ -5533,7 +5828,7 @@ module Aws::ServiceCatalog
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-servicecatalog'
-      context[:gem_version] = '1.52.0'
+      context[:gem_version] = '1.57.0'
       Seahorse::Client::Request.new(handlers, context)
     end