aws-sdk-servicecatalog 1.55.0 → 1.60.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -2,7 +2,7 @@
2
2
  # WARNING ABOUT GENERATED CODE
3
3
  #
4
4
  # This file is generated. See the contributing for info on making contributions:
5
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
6
6
  #
7
7
  # WARNING ABOUT GENERATED CODE
8
8
 
@@ -3,7 +3,7 @@
3
3
  # WARNING ABOUT GENERATED CODE
4
4
  #
5
5
  # This file is generated. See the contributing guide for more information:
6
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
@@ -3,7 +3,7 @@
3
3
  # WARNING ABOUT GENERATED CODE
4
4
  #
5
5
  # This file is generated. See the contributing guide for more information:
6
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
@@ -3,7 +3,7 @@
3
3
  # WARNING ABOUT GENERATED CODE
4
4
  #
5
5
  # This file is generated. See the contributing guide for more information:
6
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
@@ -858,6 +858,7 @@ module Aws::ServiceCatalog
858
858
  # type: "ORGANIZATION", # accepts ORGANIZATION, ORGANIZATIONAL_UNIT, ACCOUNT
859
859
  # value: "OrganizationNodeValue",
860
860
  # },
861
+ # share_tag_options: false,
861
862
  # }
862
863
  #
863
864
  # @!attribute [rw] accept_language
@@ -887,13 +888,20 @@ module Aws::ServiceCatalog
887
888
  # `PortfolioShare` creation process.
888
889
  # @return [Types::OrganizationNode]
889
890
  #
891
+ # @!attribute [rw] share_tag_options
892
+ # Enables or disables `TagOptions ` sharing when creating the
893
+ # portfolio share. If this flag is not provided, TagOptions sharing is
894
+ # disabled.
895
+ # @return [Boolean]
896
+ #
890
897
  # @see http://docs.aws.amazon.com/goto/WebAPI/servicecatalog-2015-12-10/CreatePortfolioShareInput AWS API Documentation
891
898
  #
892
899
  class CreatePortfolioShareInput < Struct.new(
893
900
  :accept_language,
894
901
  :portfolio_id,
895
902
  :account_id,
896
- :organization_node)
903
+ :organization_node,
904
+ :share_tag_options)
897
905
  SENSITIVE = []
898
906
  include Aws::Structure
899
907
  end
@@ -978,6 +986,8 @@ module Aws::ServiceCatalog
978
986
  #
979
987
  # @!attribute [rw] support_url
980
988
  # The contact URL for product support.
989
+ #
990
+ # `^https?:\/\// `/ is the pattern used to validate SupportUrl.
981
991
  # @return [String]
982
992
  #
983
993
  # @!attribute [rw] product_type
@@ -989,8 +999,7 @@ module Aws::ServiceCatalog
989
999
  # @return [Array<Types::Tag>]
990
1000
  #
991
1001
  # @!attribute [rw] provisioning_artifact_parameters
992
- # The configuration of the provisioning artifact. The `info` field
993
- # accepts `ImportFromPhysicalID`.
1002
+ # The configuration of the provisioning artifact.
994
1003
  # @return [Types::ProvisioningArtifactProperties]
995
1004
  #
996
1005
  # @!attribute [rw] idempotency_token
@@ -1220,8 +1229,7 @@ module Aws::ServiceCatalog
1220
1229
  # @return [String]
1221
1230
  #
1222
1231
  # @!attribute [rw] parameters
1223
- # The configuration for the provisioning artifact. The `info` field
1224
- # accepts `ImportFromPhysicalID`.
1232
+ # The configuration for the provisioning artifact.
1225
1233
  # @return [Types::ProvisioningArtifactProperties]
1226
1234
  #
1227
1235
  # @!attribute [rw] idempotency_token
@@ -1249,7 +1257,21 @@ module Aws::ServiceCatalog
1249
1257
  # @return [Types::ProvisioningArtifactDetail]
1250
1258
  #
1251
1259
  # @!attribute [rw] info
1260
+ # Specify the template source with one of the following options, but
1261
+ # not both. Keys accepted: \[ `LoadTemplateFromURL`,
1262
+ # `ImportFromPhysicalId` \].
1263
+ #
1252
1264
  # The URL of the CloudFormation template in Amazon S3, in JSON format.
1265
+ #
1266
+ # `LoadTemplateFromURL`
1267
+ #
1268
+ # Use the URL of the CloudFormation template in Amazon S3 in JSON
1269
+ # format.
1270
+ #
1271
+ # `ImportFromPhysicalId`
1272
+ #
1273
+ # Use the physical id of the resource that contains the template;
1274
+ # currently supports CloudFormation stack ARN.
1253
1275
  # @return [Hash<String,String>]
1254
1276
  #
1255
1277
  # @!attribute [rw] status
@@ -1932,6 +1954,76 @@ module Aws::ServiceCatalog
1932
1954
  include Aws::Structure
1933
1955
  end
1934
1956
 
1957
+ # @note When making an API call, you may pass DescribePortfolioSharesInput
1958
+ # data as a hash:
1959
+ #
1960
+ # {
1961
+ # portfolio_id: "Id", # required
1962
+ # type: "ACCOUNT", # required, accepts ACCOUNT, ORGANIZATION, ORGANIZATIONAL_UNIT, ORGANIZATION_MEMBER_ACCOUNT
1963
+ # page_token: "PageToken",
1964
+ # page_size: 1,
1965
+ # }
1966
+ #
1967
+ # @!attribute [rw] portfolio_id
1968
+ # The unique identifier of the portfolio for which shares will be
1969
+ # retrieved.
1970
+ # @return [String]
1971
+ #
1972
+ # @!attribute [rw] type
1973
+ # The type of portfolio share to summarize. This field acts as a
1974
+ # filter on the type of portfolio share, which can be one of the
1975
+ # following:
1976
+ #
1977
+ # 1\. `ACCOUNT` - Represents an external account to account share.
1978
+ #
1979
+ # 2\. `ORGANIZATION` - Represents a share to an organization. This
1980
+ # share is available to every account in the organization.
1981
+ #
1982
+ # 3\. `ORGANIZATIONAL_UNIT` - Represents a share to an organizational
1983
+ # unit.
1984
+ #
1985
+ # 4\. `ORGANIZATION_MEMBER_ACCOUNT` - Represents a share to an account
1986
+ # in the organization.
1987
+ # @return [String]
1988
+ #
1989
+ # @!attribute [rw] page_token
1990
+ # The page token for the next set of results. To retrieve the first
1991
+ # set of results, use null.
1992
+ # @return [String]
1993
+ #
1994
+ # @!attribute [rw] page_size
1995
+ # The maximum number of items to return with this call.
1996
+ # @return [Integer]
1997
+ #
1998
+ # @see http://docs.aws.amazon.com/goto/WebAPI/servicecatalog-2015-12-10/DescribePortfolioSharesInput AWS API Documentation
1999
+ #
2000
+ class DescribePortfolioSharesInput < Struct.new(
2001
+ :portfolio_id,
2002
+ :type,
2003
+ :page_token,
2004
+ :page_size)
2005
+ SENSITIVE = []
2006
+ include Aws::Structure
2007
+ end
2008
+
2009
+ # @!attribute [rw] next_page_token
2010
+ # The page token to use to retrieve the next set of results. If there
2011
+ # are no additional results, this value is null.
2012
+ # @return [String]
2013
+ #
2014
+ # @!attribute [rw] portfolio_share_details
2015
+ # Summaries about each of the portfolio shares.
2016
+ # @return [Array<Types::PortfolioShareDetail>]
2017
+ #
2018
+ # @see http://docs.aws.amazon.com/goto/WebAPI/servicecatalog-2015-12-10/DescribePortfolioSharesOutput AWS API Documentation
2019
+ #
2020
+ class DescribePortfolioSharesOutput < Struct.new(
2021
+ :next_page_token,
2022
+ :portfolio_share_details)
2023
+ SENSITIVE = []
2024
+ include Aws::Structure
2025
+ end
2026
+
1935
2027
  # @note When making an API call, you may pass DescribeProductAsAdminInput
1936
2028
  # data as a hash:
1937
2029
  #
@@ -1939,6 +2031,7 @@ module Aws::ServiceCatalog
1939
2031
  # accept_language: "AcceptLanguage",
1940
2032
  # id: "Id",
1941
2033
  # name: "ProductViewName",
2034
+ # source_portfolio_id: "Id",
1942
2035
  # }
1943
2036
  #
1944
2037
  # @!attribute [rw] accept_language
@@ -1959,12 +2052,24 @@ module Aws::ServiceCatalog
1959
2052
  # The product name.
1960
2053
  # @return [String]
1961
2054
  #
2055
+ # @!attribute [rw] source_portfolio_id
2056
+ # The unique identifier of the shared portfolio that the specified
2057
+ # product is associated with.
2058
+ #
2059
+ # You can provide this parameter to retrieve the shared TagOptions
2060
+ # associated with the product. If this parameter is provided and if
2061
+ # TagOptions sharing is enabled in the portfolio share, the API
2062
+ # returns both local and shared TagOptions associated with the
2063
+ # product. Otherwise only local TagOptions will be returned.
2064
+ # @return [String]
2065
+ #
1962
2066
  # @see http://docs.aws.amazon.com/goto/WebAPI/servicecatalog-2015-12-10/DescribeProductAsAdminInput AWS API Documentation
1963
2067
  #
1964
2068
  class DescribeProductAsAdminInput < Struct.new(
1965
2069
  :accept_language,
1966
2070
  :id,
1967
- :name)
2071
+ :name,
2072
+ :source_portfolio_id)
1968
2073
  SENSITIVE = []
1969
2074
  include Aws::Structure
1970
2075
  end
@@ -4533,10 +4638,59 @@ module Aws::ServiceCatalog
4533
4638
  # The values that the administrator has allowed for the parameter.
4534
4639
  # @return [Array<String>]
4535
4640
  #
4641
+ # @!attribute [rw] allowed_pattern
4642
+ # A regular expression that represents the patterns that allow for
4643
+ # `String` types. The pattern must match the entire parameter value
4644
+ # provided.
4645
+ # @return [String]
4646
+ #
4647
+ # @!attribute [rw] constraint_description
4648
+ # A string that explains a constraint when the constraint is violated.
4649
+ # For example, without a constraint description, a parameter that has
4650
+ # an allowed pattern of `[A-Za-z0-9]+` displays the following error
4651
+ # message when the user specifies an invalid value:
4652
+ #
4653
+ # `Malformed input-Parameter MyParameter must match pattern
4654
+ # [A-Za-z0-9]+`
4655
+ #
4656
+ # By adding a constraint description, such as must only contain
4657
+ # letters (uppercase and lowercase) and numbers, you can display the
4658
+ # following customized error message:
4659
+ #
4660
+ # `Malformed input-Parameter MyParameter must only contain uppercase
4661
+ # and lowercase letters and numbers.`
4662
+ # @return [String]
4663
+ #
4664
+ # @!attribute [rw] max_length
4665
+ # An integer value that determines the largest number of characters
4666
+ # you want to allow for `String` types.
4667
+ # @return [String]
4668
+ #
4669
+ # @!attribute [rw] min_length
4670
+ # An integer value that determines the smallest number of characters
4671
+ # you want to allow for `String` types.
4672
+ # @return [String]
4673
+ #
4674
+ # @!attribute [rw] max_value
4675
+ # A numeric value that determines the largest numeric value you want
4676
+ # to allow for `Number` types.
4677
+ # @return [String]
4678
+ #
4679
+ # @!attribute [rw] min_value
4680
+ # A numeric value that determines the smallest numeric value you want
4681
+ # to allow for `Number` types.
4682
+ # @return [String]
4683
+ #
4536
4684
  # @see http://docs.aws.amazon.com/goto/WebAPI/servicecatalog-2015-12-10/ParameterConstraints AWS API Documentation
4537
4685
  #
4538
4686
  class ParameterConstraints < Struct.new(
4539
- :allowed_values)
4687
+ :allowed_values,
4688
+ :allowed_pattern,
4689
+ :constraint_description,
4690
+ :max_length,
4691
+ :min_length,
4692
+ :max_value,
4693
+ :min_value)
4540
4694
  SENSITIVE = []
4541
4695
  include Aws::Structure
4542
4696
  end
@@ -4580,6 +4734,48 @@ module Aws::ServiceCatalog
4580
4734
  include Aws::Structure
4581
4735
  end
4582
4736
 
4737
+ # Information about the portfolio share.
4738
+ #
4739
+ # @!attribute [rw] principal_id
4740
+ # The identifier of the recipient entity that received the portfolio
4741
+ # share. The recipient entities can be one of the following:
4742
+ #
4743
+ # 1\. An external account.
4744
+ #
4745
+ # 2\. An organziation member account.
4746
+ #
4747
+ # 3\. An organzational unit (OU).
4748
+ #
4749
+ # 4\. The organization itself. (This shares with every account in the
4750
+ # organization).
4751
+ # @return [String]
4752
+ #
4753
+ # @!attribute [rw] type
4754
+ # The type of the portfolio share.
4755
+ # @return [String]
4756
+ #
4757
+ # @!attribute [rw] accepted
4758
+ # Indicates whether the shared portfolio is imported by the recipient
4759
+ # account. If the recipient is in an organization node, the share is
4760
+ # automatically imported, and the field is always set to true.
4761
+ # @return [Boolean]
4762
+ #
4763
+ # @!attribute [rw] share_tag_options
4764
+ # Indicates whether TagOptions sharing is enabled or disabled for the
4765
+ # portfolio share.
4766
+ # @return [Boolean]
4767
+ #
4768
+ # @see http://docs.aws.amazon.com/goto/WebAPI/servicecatalog-2015-12-10/PortfolioShareDetail AWS API Documentation
4769
+ #
4770
+ class PortfolioShareDetail < Struct.new(
4771
+ :principal_id,
4772
+ :type,
4773
+ :accepted,
4774
+ :share_tag_options)
4775
+ SENSITIVE = []
4776
+ include Aws::Structure
4777
+ end
4778
+
4583
4779
  # Information about a principal.
4584
4780
  #
4585
4781
  # @!attribute [rw] principal_arn
@@ -5486,11 +5682,21 @@ module Aws::ServiceCatalog
5486
5682
  # @return [String]
5487
5683
  #
5488
5684
  # @!attribute [rw] info
5685
+ # Specify the template source with one of the following options, but
5686
+ # not both. Keys accepted: \[ `LoadTemplateFromURL`,
5687
+ # `ImportFromPhysicalId` \]
5688
+ #
5489
5689
  # The URL of the CloudFormation template in Amazon S3. Specify the URL
5490
5690
  # in JSON format as follows:
5491
5691
  #
5492
5692
  # `"LoadTemplateFromURL":
5493
5693
  # "https://s3.amazonaws.com/cf-templates-ozkq9d3hgiq2-us-east-1/..."`
5694
+ #
5695
+ # `ImportFromPhysicalId`\: The physical id of the resource that
5696
+ # contains the template. Currently only supports CloudFormation stack
5697
+ # arn. Specify the physical id in JSON format as follows:
5698
+ # `ImportFromPhysicalId:
5699
+ # “arn:aws:cloudformation:[us-east-1]:[accountId]:stack/[StackName]/[resourceId]`
5494
5700
  # @return [Hash<String,String>]
5495
5701
  #
5496
5702
  # @!attribute [rw] type
@@ -5606,7 +5812,20 @@ module Aws::ServiceCatalog
5606
5812
 
5607
5813
  # The user-defined preferences that will be applied when updating a
5608
5814
  # provisioned product. Not all preferences are applicable to all
5609
- # provisioned product types.
5815
+ # provisioned product type
5816
+ #
5817
+ # One or more AWS accounts that will have access to the provisioned
5818
+ # product.
5819
+ #
5820
+ # Applicable only to a `CFN_STACKSET` provisioned product type.
5821
+ #
5822
+ # The AWS accounts specified should be within the list of accounts in
5823
+ # the `STACKSET` constraint. To get the list of accounts in the
5824
+ # `STACKSET` constraint, use the `DescribeProvisioningParameters`
5825
+ # operation.
5826
+ #
5827
+ # If no values are specified, the default value is all accounts from the
5828
+ # `STACKSET` constraint.
5610
5829
  #
5611
5830
  # @note When making an API call, you may pass ProvisioningPreferences
5612
5831
  # data as a hash:
@@ -5621,17 +5840,17 @@ module Aws::ServiceCatalog
5621
5840
  # }
5622
5841
  #
5623
5842
  # @!attribute [rw] stack_set_accounts
5624
- # One or more AWS accounts that will have access to the provisioned
5625
- # product.
5843
+ # One or more AWS accounts where the provisioned product will be
5844
+ # available.
5626
5845
  #
5627
5846
  # Applicable only to a `CFN_STACKSET` provisioned product type.
5628
5847
  #
5629
- # The AWS accounts specified should be within the list of accounts in
5848
+ # The specified accounts should be within the list of accounts from
5630
5849
  # the `STACKSET` constraint. To get the list of accounts in the
5631
5850
  # `STACKSET` constraint, use the `DescribeProvisioningParameters`
5632
5851
  # operation.
5633
5852
  #
5634
- # If no values are specified, the default value is all accounts from
5853
+ # If no values are specified, the default value is all acounts from
5635
5854
  # the `STACKSET` constraint.
5636
5855
  # @return [Array<String>]
5637
5856
  #
@@ -6660,13 +6879,18 @@ module Aws::ServiceCatalog
6660
6879
  # The TagOption identifier.
6661
6880
  # @return [String]
6662
6881
  #
6882
+ # @!attribute [rw] owner
6883
+ # The AWS account Id of the owner account that created the TagOption.
6884
+ # @return [String]
6885
+ #
6663
6886
  # @see http://docs.aws.amazon.com/goto/WebAPI/servicecatalog-2015-12-10/TagOptionDetail AWS API Documentation
6664
6887
  #
6665
6888
  class TagOptionDetail < Struct.new(
6666
6889
  :key,
6667
6890
  :value,
6668
6891
  :active,
6669
- :id)
6892
+ :id,
6893
+ :owner)
6670
6894
  SENSITIVE = []
6671
6895
  include Aws::Structure
6672
6896
  end
@@ -6750,7 +6974,7 @@ module Aws::ServiceCatalog
6750
6974
  #
6751
6975
  # @!attribute [rw] retain_physical_resources
6752
6976
  # When this boolean parameter is set to true, the
6753
- # TerminateProvisionedProduct API deletes the Service Catalog
6977
+ # `TerminateProvisionedProduct` API deletes the Service Catalog
6754
6978
  # provisioned product. However, it does not remove the CloudFormation
6755
6979
  # stack, stack set, or the underlying resources of the deleted
6756
6980
  # provisioned product. The default value is false.
@@ -7001,6 +7225,82 @@ module Aws::ServiceCatalog
7001
7225
  include Aws::Structure
7002
7226
  end
7003
7227
 
7228
+ # @note When making an API call, you may pass UpdatePortfolioShareInput
7229
+ # data as a hash:
7230
+ #
7231
+ # {
7232
+ # accept_language: "AcceptLanguage",
7233
+ # portfolio_id: "Id", # required
7234
+ # account_id: "AccountId",
7235
+ # organization_node: {
7236
+ # type: "ORGANIZATION", # accepts ORGANIZATION, ORGANIZATIONAL_UNIT, ACCOUNT
7237
+ # value: "OrganizationNodeValue",
7238
+ # },
7239
+ # share_tag_options: false,
7240
+ # }
7241
+ #
7242
+ # @!attribute [rw] accept_language
7243
+ # The language code.
7244
+ #
7245
+ # * `en` - English (default)
7246
+ #
7247
+ # * `jp` - Japanese
7248
+ #
7249
+ # * `zh` - Chinese
7250
+ # @return [String]
7251
+ #
7252
+ # @!attribute [rw] portfolio_id
7253
+ # The unique identifier of the portfolio for which the share will be
7254
+ # updated.
7255
+ # @return [String]
7256
+ #
7257
+ # @!attribute [rw] account_id
7258
+ # The AWS Account Id of the recipient account. This field is required
7259
+ # when updating an external account to account type share.
7260
+ # @return [String]
7261
+ #
7262
+ # @!attribute [rw] organization_node
7263
+ # Information about the organization node.
7264
+ # @return [Types::OrganizationNode]
7265
+ #
7266
+ # @!attribute [rw] share_tag_options
7267
+ # A flag to enable or disable TagOptions sharing for the portfolio
7268
+ # share. If this field is not provided, the current state of
7269
+ # TagOptions sharing on the portfolio share will not be modified.
7270
+ # @return [Boolean]
7271
+ #
7272
+ # @see http://docs.aws.amazon.com/goto/WebAPI/servicecatalog-2015-12-10/UpdatePortfolioShareInput AWS API Documentation
7273
+ #
7274
+ class UpdatePortfolioShareInput < Struct.new(
7275
+ :accept_language,
7276
+ :portfolio_id,
7277
+ :account_id,
7278
+ :organization_node,
7279
+ :share_tag_options)
7280
+ SENSITIVE = []
7281
+ include Aws::Structure
7282
+ end
7283
+
7284
+ # @!attribute [rw] portfolio_share_token
7285
+ # The token that tracks the status of the `UpdatePortfolioShare`
7286
+ # operation for external account to account or organizational type
7287
+ # sharing.
7288
+ # @return [String]
7289
+ #
7290
+ # @!attribute [rw] status
7291
+ # The status of `UpdatePortfolioShare` operation. You can also obtain
7292
+ # the operation status using `DescribePortfolioShareStatus` API.
7293
+ # @return [String]
7294
+ #
7295
+ # @see http://docs.aws.amazon.com/goto/WebAPI/servicecatalog-2015-12-10/UpdatePortfolioShareOutput AWS API Documentation
7296
+ #
7297
+ class UpdatePortfolioShareOutput < Struct.new(
7298
+ :portfolio_share_token,
7299
+ :status)
7300
+ SENSITIVE = []
7301
+ include Aws::Structure
7302
+ end
7303
+
7004
7304
  # @note When making an API call, you may pass UpdateProductInput
7005
7305
  # data as a hash:
7006
7306
  #