aws-sdk-marketplacecatalog 1.37.0 → 1.38.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3dab9ec081f9b37daf0e38a8ca3ac7145510a77f141beea52364dc630fcc264f
-  data.tar.gz: f52767c90a9b913488329d59b281cccf365f4ff100ddc0d5c478edebeeb28ee9
+  metadata.gz: 51884d1443c764ad52bd321c404603208c854d739376c01e44ccdc55eba11800
+  data.tar.gz: 30a1aa3c44b627ddcc80fef9719cf891c54cf365ea1670f62e9275d06f17a8d1
 SHA512:
-  metadata.gz: 4ebed5d9f71e74942917bebc7b8294cfc2d76c552171e25f29cc982bbeb0ea18e2450c4c81459f47c160d81ec2e6e3c77077ae0468c77207c40692ff6a364e7a
-  data.tar.gz: ae8c76c4e98ece2df7f6c884afbc791df006c1c375ee81cc670809c323177f105ad1eaf64f0e04d36839c785f7648b1a10cc0df47b28db41df77f81c7c30ee56
+  metadata.gz: 15354c806c8b83e035944429dc0837ed3c4b7df0e0c3bcd5b31df248dcaa1a56ad680c156c99771054a0f6f4541ff9c40d30e7e4683a29e77d087f3f16f10771
+  data.tar.gz: e999189a3757bb4eaf8835e4430ad1c80e9858e3d29da3a9db68e951536c013bc54d6d66acc75eb943786057524c0e4dccacb8ef7eb9e3972d468815287277fc

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.38.0 (2023-12-19)
+------------------
+
+* Feature - AWS Marketplace now supports a new API, BatchDescribeEntities, which returns metadata and content for multiple entities.
+
 1.37.0 (2023-11-30)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.37.0
+1.38.0

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

@@ -388,6 +388,47 @@ module Aws::MarketplaceCatalog
 
     # @!group API Operations
 
+    # Returns metadata and content for multiple entities.
+    #
+    # @option params [required, Array<Types::EntityRequest>] :entity_request_list
+    #   List of entity IDs and the catalogs the entities are present in.
+    #
+    # @return [Types::BatchDescribeEntitiesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::BatchDescribeEntitiesResponse#entity_details #entity_details} => Hash&lt;String,Types::EntityDetail&gt;
+    #   * {Types::BatchDescribeEntitiesResponse#errors #errors} => Hash&lt;String,Types::BatchDescribeErrorDetail&gt;
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.batch_describe_entities({
+    #     entity_request_list: [ # required
+    #       {
+    #         catalog: "Catalog", # required
+    #         entity_id: "EntityId", # required
+    #       },
+    #     ],
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.entity_details #=> Hash
+    #   resp.entity_details["EntityId"].entity_type #=> String
+    #   resp.entity_details["EntityId"].entity_arn #=> String
+    #   resp.entity_details["EntityId"].entity_identifier #=> String
+    #   resp.entity_details["EntityId"].last_modified_date #=> String
+    #   resp.errors #=> Hash
+    #   resp.errors["EntityId"].error_code #=> String
+    #   resp.errors["EntityId"].error_message #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/marketplace-catalog-2018-09-17/BatchDescribeEntities AWS API Documentation
+    #
+    # @overload batch_describe_entities(params = {})
+    # @param [Hash] params ({})
+    def batch_describe_entities(params = {}, options = {})
+      req = build_request(:batch_describe_entities, params)
+      req.send_request(options)
+    end
+
     # Used to cancel an open change request. Must be sent before the status
     # of the request changes to `APPLYING`, the final stage of completing
     # your change request. You can describe a change during the 60-day
@@ -662,10 +703,10 @@ module Aws::MarketplaceCatalog
     #   The catalog related to the request. Fixed value: `AWSMarketplace`
     #
     # @option params [required, String] :entity_type
-    #   The type of entities to retrieve. Valid values are: `ServerProduct`,
-    #   `AmiProduct`, `ContainerProduct`, `DataProduct`, `SaaSProduct`,
-    #   `ProcurementPolicy`, `Experience`, `Audience`, `BrandingSettings`,
-    #   `Offer`, `Seller`, `ResaleAuthorization`.
+    #   The type of entities to retrieve. Valid values are: `AmiProduct`,
+    #   `ContainerProduct`, `DataProduct`, `SaaSProduct`, `ProcurementPolicy`,
+    #   `Experience`, `Audience`, `BrandingSettings`, `Offer`, `Seller`,
+    #   `ResaleAuthorization`.
     #
     # @option params [Array<Types::Filter>] :filter_list
     #   An array of filter objects. Each filter object contains two
@@ -1224,7 +1265,7 @@ module Aws::MarketplaceCatalog
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-marketplacecatalog'
-      context[:gem_version] = '1.37.0'
+      context[:gem_version] = '1.38.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-marketplacecatalog/client_api.rb

@@ -30,6 +30,11 @@ module Aws::MarketplaceCatalog
     AmiProductVisibilityFilter = Shapes::StructureShape.new(name: 'AmiProductVisibilityFilter')
     AmiProductVisibilityFilterValueList = Shapes::ListShape.new(name: 'AmiProductVisibilityFilterValueList')
     AmiProductVisibilityString = Shapes::StringShape.new(name: 'AmiProductVisibilityString')
+    BatchDescribeEntitiesRequest = Shapes::StructureShape.new(name: 'BatchDescribeEntitiesRequest')
+    BatchDescribeEntitiesResponse = Shapes::StructureShape.new(name: 'BatchDescribeEntitiesResponse')
+    BatchDescribeErrorCodeString = Shapes::StringShape.new(name: 'BatchDescribeErrorCodeString')
+    BatchDescribeErrorDetail = Shapes::StructureShape.new(name: 'BatchDescribeErrorDetail')
+    BatchDescribeErrorMessageContent = Shapes::StringShape.new(name: 'BatchDescribeErrorMessageContent')
     CancelChangeSetRequest = Shapes::StructureShape.new(name: 'CancelChangeSetRequest')
     CancelChangeSetResponse = Shapes::StructureShape.new(name: 'CancelChangeSetResponse')
     Catalog = Shapes::StringShape.new(name: 'Catalog')
@@ -81,7 +86,12 @@ module Aws::MarketplaceCatalog
     DescribeEntityRequest = Shapes::StructureShape.new(name: 'DescribeEntityRequest')
     DescribeEntityResponse = Shapes::StructureShape.new(name: 'DescribeEntityResponse')
     Entity = Shapes::StructureShape.new(name: 'Entity')
+    EntityDetail = Shapes::StructureShape.new(name: 'EntityDetail')
+    EntityDetails = Shapes::MapShape.new(name: 'EntityDetails')
+    EntityId = Shapes::StringShape.new(name: 'EntityId')
     EntityNameString = Shapes::StringShape.new(name: 'EntityNameString')
+    EntityRequest = Shapes::StructureShape.new(name: 'EntityRequest')
+    EntityRequestList = Shapes::ListShape.new(name: 'EntityRequestList')
     EntitySummary = Shapes::StructureShape.new(name: 'EntitySummary')
     EntitySummaryList = Shapes::ListShape.new(name: 'EntitySummaryList')
     EntityType = Shapes::StringShape.new(name: 'EntityType')
@@ -90,6 +100,7 @@ module Aws::MarketplaceCatalog
     ErrorCodeString = Shapes::StringShape.new(name: 'ErrorCodeString')
     ErrorDetail = Shapes::StructureShape.new(name: 'ErrorDetail')
     ErrorDetailList = Shapes::ListShape.new(name: 'ErrorDetailList')
+    Errors = Shapes::MapShape.new(name: 'Errors')
     ExceptionMessageContent = Shapes::StringShape.new(name: 'ExceptionMessageContent')
     FailureCode = Shapes::StringShape.new(name: 'FailureCode')
     Filter = Shapes::StructureShape.new(name: 'Filter')
@@ -276,6 +287,17 @@ module Aws::MarketplaceCatalog
 
     AmiProductVisibilityFilterValueList.member = Shapes::ShapeRef.new(shape: AmiProductVisibilityString)
 
+    BatchDescribeEntitiesRequest.add_member(:entity_request_list, Shapes::ShapeRef.new(shape: EntityRequestList, required: true, location_name: "EntityRequestList"))
+    BatchDescribeEntitiesRequest.struct_class = Types::BatchDescribeEntitiesRequest
+
+    BatchDescribeEntitiesResponse.add_member(:entity_details, Shapes::ShapeRef.new(shape: EntityDetails, location_name: "EntityDetails"))
+    BatchDescribeEntitiesResponse.add_member(:errors, Shapes::ShapeRef.new(shape: Errors, location_name: "Errors"))
+    BatchDescribeEntitiesResponse.struct_class = Types::BatchDescribeEntitiesResponse
+
+    BatchDescribeErrorDetail.add_member(:error_code, Shapes::ShapeRef.new(shape: BatchDescribeErrorCodeString, location_name: "ErrorCode"))
+    BatchDescribeErrorDetail.add_member(:error_message, Shapes::ShapeRef.new(shape: BatchDescribeErrorMessageContent, location_name: "ErrorMessage"))
+    BatchDescribeErrorDetail.struct_class = Types::BatchDescribeErrorDetail
+
     CancelChangeSetRequest.add_member(:catalog, Shapes::ShapeRef.new(shape: Catalog, required: true, location: "querystring", location_name: "catalog"))
     CancelChangeSetRequest.add_member(:change_set_id, Shapes::ShapeRef.new(shape: ResourceId, required: true, location: "querystring", location_name: "changeSetId"))
     CancelChangeSetRequest.struct_class = Types::CancelChangeSetRequest
@@ -424,6 +446,22 @@ module Aws::MarketplaceCatalog
     Entity.add_member(:identifier, Shapes::ShapeRef.new(shape: Identifier, location_name: "Identifier"))
     Entity.struct_class = Types::Entity
 
+    EntityDetail.add_member(:entity_type, Shapes::ShapeRef.new(shape: EntityType, location_name: "EntityType"))
+    EntityDetail.add_member(:entity_arn, Shapes::ShapeRef.new(shape: ARN, location_name: "EntityArn"))
+    EntityDetail.add_member(:entity_identifier, Shapes::ShapeRef.new(shape: Identifier, location_name: "EntityIdentifier"))
+    EntityDetail.add_member(:last_modified_date, Shapes::ShapeRef.new(shape: DateTimeISO8601, location_name: "LastModifiedDate"))
+    EntityDetail.add_member(:details_document, Shapes::ShapeRef.new(shape: JsonDocumentType, location_name: "DetailsDocument"))
+    EntityDetail.struct_class = Types::EntityDetail
+
+    EntityDetails.key = Shapes::ShapeRef.new(shape: EntityId)
+    EntityDetails.value = Shapes::ShapeRef.new(shape: EntityDetail)
+
+    EntityRequest.add_member(:catalog, Shapes::ShapeRef.new(shape: Catalog, required: true, location_name: "Catalog"))
+    EntityRequest.add_member(:entity_id, Shapes::ShapeRef.new(shape: EntityId, required: true, location_name: "EntityId"))
+    EntityRequest.struct_class = Types::EntityRequest
+
+    EntityRequestList.member = Shapes::ShapeRef.new(shape: EntityRequest)
+
     EntitySummary.add_member(:name, Shapes::ShapeRef.new(shape: EntityNameString, location_name: "Name"))
     EntitySummary.add_member(:entity_type, Shapes::ShapeRef.new(shape: EntityType, location_name: "EntityType"))
     EntitySummary.add_member(:entity_id, Shapes::ShapeRef.new(shape: ResourceId, location_name: "EntityId"))
@@ -478,6 +516,9 @@ module Aws::MarketplaceCatalog
 
     ErrorDetailList.member = Shapes::ShapeRef.new(shape: ErrorDetail)
 
+    Errors.key = Shapes::ShapeRef.new(shape: EntityId)
+    Errors.value = Shapes::ShapeRef.new(shape: BatchDescribeErrorDetail)
+
     Filter.add_member(:name, Shapes::ShapeRef.new(shape: FilterName, location_name: "Name"))
     Filter.add_member(:value_list, Shapes::ShapeRef.new(shape: ValueList, location_name: "ValueList"))
     Filter.struct_class = Types::Filter
@@ -841,6 +882,18 @@ module Aws::MarketplaceCatalog
         "uid" => "marketplace-catalog-2018-09-17",
       }
 
+      api.add_operation(:batch_describe_entities, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "BatchDescribeEntities"
+        o.http_method = "POST"
+        o.http_request_uri = "/BatchDescribeEntities"
+        o.input = Shapes::ShapeRef.new(shape: BatchDescribeEntitiesRequest)
+        o.output = Shapes::ShapeRef.new(shape: BatchDescribeEntitiesResponse)
+        o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
+        o.errors << Shapes::ShapeRef.new(shape: InternalServiceException)
+        o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
+        o.errors << Shapes::ShapeRef.new(shape: ValidationException)
+      end)
+
       api.add_operation(:cancel_change_set, Seahorse::Model::Operation.new.tap do |o|
         o.name = "CancelChangeSet"
         o.http_method = "PATCH"

data/lib/aws-sdk-marketplacecatalog/endpoints.rb

@@ -12,6 +12,20 @@ module Aws::MarketplaceCatalog
   # @api private
   module Endpoints
 
+    class BatchDescribeEntities
+      def self.build(context)
+        unless context.config.regional_endpoint
+          endpoint = context.config.endpoint.to_s
+        end
+        Aws::MarketplaceCatalog::EndpointParameters.new(
+          region: context.config.region,
+          use_dual_stack: context.config.use_dualstack_endpoint,
+          use_fips: context.config.use_fips_endpoint,
+          endpoint: endpoint,
+        )
+      end
+    end
+
     class CancelChangeSet
       def self.build(context)
         unless context.config.regional_endpoint

data/lib/aws-sdk-marketplacecatalog/plugins/endpoints.rb

@@ -57,6 +57,8 @@ module Aws::MarketplaceCatalog
 
         def parameters_for_operation(context)
           case context.operation_name
+          when :batch_describe_entities
+            Aws::MarketplaceCatalog::Endpoints::BatchDescribeEntities.build(context)
           when :cancel_change_set
             Aws::MarketplaceCatalog::Endpoints::CancelChangeSet.build(context)
           when :delete_resource_policy

data/lib/aws-sdk-marketplacecatalog/types.rb

@@ -180,6 +180,55 @@ module Aws::MarketplaceCatalog
       include Aws::Structure
     end
 
+    # @!attribute [rw] entity_request_list
+    #   List of entity IDs and the catalogs the entities are present in.
+    #   @return [Array<Types::EntityRequest>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/marketplace-catalog-2018-09-17/BatchDescribeEntitiesRequest AWS API Documentation
+    #
+    class BatchDescribeEntitiesRequest < Struct.new(
+      :entity_request_list)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] entity_details
+    #   Details about each entity.
+    #   @return [Hash<String,Types::EntityDetail>]
+    #
+    # @!attribute [rw] errors
+    #   A map of errors returned, with `EntityId` as the key and
+    #   `errorDetail` as the value.
+    #   @return [Hash<String,Types::BatchDescribeErrorDetail>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/marketplace-catalog-2018-09-17/BatchDescribeEntitiesResponse AWS API Documentation
+    #
+    class BatchDescribeEntitiesResponse < Struct.new(
+      :entity_details,
+      :errors)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # An object that contains an error code and error message.
+    #
+    # @!attribute [rw] error_code
+    #   The error code returned.
+    #   @return [String]
+    #
+    # @!attribute [rw] error_message
+    #   The error message returned.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/marketplace-catalog-2018-09-17/BatchDescribeErrorDetail AWS API Documentation
+    #
+    class BatchDescribeErrorDetail < Struct.new(
+      :error_code,
+      :error_message)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @!attribute [rw] catalog
     #   Required. The catalog related to the request. Fixed value:
     #   `AWSMarketplace`.
@@ -221,7 +270,7 @@ module Aws::MarketplaceCatalog
     # @!attribute [rw] change_type
     #   Change types are single string values that describe your intention
     #   for the change. Each change type is unique for each `EntityType`
-    #   provided in the change's scope. For more information on change
+    #   provided in the change's scope. For more information about change
     #   types available for single-AMI products, see [Working with
     #   single-AMI products][1]. Also, for more information about change
     #   types available for container-based products, see [Working with
@@ -865,6 +914,62 @@ module Aws::MarketplaceCatalog
       include Aws::Structure
     end
 
+    # An object that contains metadata and details about the entity.
+    #
+    # @!attribute [rw] entity_type
+    #   The entity type of the entity, in the format of
+    #   `EntityType@Version`.
+    #   @return [String]
+    #
+    # @!attribute [rw] entity_arn
+    #   The Amazon Resource Name (ARN) of the entity.
+    #   @return [String]
+    #
+    # @!attribute [rw] entity_identifier
+    #   The ID of the entity, in the format of `EntityId@RevisionId`.
+    #   @return [String]
+    #
+    # @!attribute [rw] last_modified_date
+    #   The last time the entity was modified.
+    #   @return [String]
+    #
+    # @!attribute [rw] details_document
+    #   An object that contains all the details of the entity.
+    #   @return [Hash,Array,String,Numeric,Boolean]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/marketplace-catalog-2018-09-17/EntityDetail AWS API Documentation
+    #
+    class EntityDetail < Struct.new(
+      :entity_type,
+      :entity_arn,
+      :entity_identifier,
+      :last_modified_date,
+      :details_document)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # An object that contains entity ID and the catalog in which the entity
+    # is present.
+    #
+    # @!attribute [rw] catalog
+    #   The name of the catalog the entity is present in. The only value at
+    #   this time is `AWSMarketplace`.
+    #   @return [String]
+    #
+    # @!attribute [rw] entity_id
+    #   The ID of the entity.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/marketplace-catalog-2018-09-17/EntityRequest AWS API Documentation
+    #
+    class EntityRequest < Struct.new(
+      :catalog,
+      :entity_id)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # This object is a container for common summary information about the
     # entity. The summary doesn't contain the whole entity structure, but
     # it does contain information common across all entities.
@@ -1210,8 +1315,8 @@ module Aws::MarketplaceCatalog
     #   @return [String]
     #
     # @!attribute [rw] entity_type
-    #   The type of entities to retrieve. Valid values are: `ServerProduct`,
-    #   `AmiProduct`, `ContainerProduct`, `DataProduct`, `SaaSProduct`,
+    #   The type of entities to retrieve. Valid values are: `AmiProduct`,
+    #   `ContainerProduct`, `DataProduct`, `SaaSProduct`,
     #   `ProcurementPolicy`, `Experience`, `Audience`, `BrandingSettings`,
     #   `Offer`, `Seller`, `ResaleAuthorization`.
     #   @return [String]

data/lib/aws-sdk-marketplacecatalog.rb

@@ -32,7 +32,7 @@ require_relative 'aws-sdk-marketplacecatalog/customizations'
 # structure.
 #
 #     marketplace_catalog = Aws::MarketplaceCatalog::Client.new
-#     resp = marketplace_catalog.cancel_change_set(params)
+#     resp = marketplace_catalog.batch_describe_entities(params)
 #
 # See {Client} for more information.
 #
@@ -52,6 +52,6 @@ require_relative 'aws-sdk-marketplacecatalog/customizations'
 # @!group service
 module Aws::MarketplaceCatalog
 
-  GEM_VERSION = '1.37.0'
+  GEM_VERSION = '1.38.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-marketplacecatalog
 version: !ruby/object:Gem::Version
-  version: 1.37.0
+  version: 1.38.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-30 00:00:00.000000000 Z
+date: 2023-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core