aws-sdk-supplychain 1.18.0 → 1.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb68a4cb61d420ddbeeb264e94b8320f8c2f37dfbfee270a21c00f63662d9108
-  data.tar.gz: 1b5175372151c5e77333be14172ea1a61451b69ca97ecbe40e5e19d76926f80a
+  metadata.gz: 6de64e3122dd8aa459e01a0ab6fd727d40bf51caeca5aa0d4d273ef24eccbfac
+  data.tar.gz: 916e60ec8e31688fadbe4b759d6c9fbd37419bee3679df701e70bcf292f0f73e
 SHA512:
-  metadata.gz: aad1d422536ceb00f7699571caf552dc2789773f44ed1d4221f30857bbdc0d3ccff0d305e70cb208e36bd592ab54e66051b27a066f84485f3c398fab562f9110
-  data.tar.gz: f6bab4c7dca163a632d017b2df3c3c2c0f61eb4adb3cb81f789954b79eebd317ecd6e46ebeaecdb5ff3a75f4a79a28ed463daf0db19671a5af7c3615709ee318
+  metadata.gz: 22608c92f02fa4baeae0ad8583ab67f6868650c4d652de74a9b6d62e36d0f54b1ce6ceee8331f06bf5c7a4640f06c1ca2c64b9c509cf571ccdc34b3d8940bfb8
+  data.tar.gz: a27537297a59c5c6ff0133ddd379c6b970af59ace0732856770b0ebf0e69b612e29b9e01f3350f4d880b230603e210f355f3d721ad163ac66ec13cc1c79148cf

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.19.0 (2024-10-25)
+------------------
+
+* Feature - API doc updates, and also support showing error message on a failed instance
+
 1.18.0 (2024-10-18)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.18.0
+1.19.0

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

@@ -515,8 +515,11 @@ module Aws::SupplyChain
       req.send_request(options)
     end
 
-    # Create DataIntegrationFlow to map one or more different sources to one
-    # target using the SQL transformation query.
+    # Enables you to programmatically create a data pipeline to ingest data
+    # from source systems such as Amazon S3 buckets, to a predefined Amazon
+    # Web Services Supply Chain dataset (product, inbound\_order) or a
+    # temporary dataset along with the data transformation query provided
+    # with the API.
     #
     # @option params [required, String] :instance_id
     #   The Amazon Web Services Supply Chain instance identifier.
@@ -691,7 +694,10 @@ module Aws::SupplyChain
       req.send_request(options)
     end
 
-    # Create a data lake dataset.
+    # Enables you to programmatically create an Amazon Web Services Supply
+    # Chain data lake dataset. Developers can create the datasets using
+    # their pre-defined or custom schema for a given instance ID, namespace,
+    # and dataset name.
     #
     # @option params [required, String] :instance_id
     #   The Amazon Web Services Supply Chain instance identifier.
@@ -1036,12 +1042,18 @@ module Aws::SupplyChain
       req.send_request(options)
     end
 
-    # Create a new instance for AWS Supply Chain. This is an asynchronous
-    # operation. Upon receiving a CreateInstance request, AWS Supply Chain
-    # immediately returns the instance resource, with instance ID, and the
-    # initializing state while simultaneously creating all required Amazon
-    # Web Services resources for an instance creation. You can use
-    # GetInstance to check the status of the instance.
+    # Enables you to programmatically create an Amazon Web Services Supply
+    # Chain instance by applying KMS keys and relevant information
+    # associated with the API without using the Amazon Web Services console.
+    #
+    # This is an asynchronous operation. Upon receiving a CreateInstance
+    # request, Amazon Web Services Supply Chain immediately returns the
+    # instance resource, instance ID, and the initializing state while
+    # simultaneously creating all required Amazon Web Services resources for
+    # an instance creation. You can use GetInstance to check the status of
+    # the instance. If the instance results in an unhealthy state, you need
+    # to check the error message, delete the current instance, and recreate
+    # a new one based on the mitigation from the error message.
     #
     # @option params [String] :instance_name
     #   The AWS Supply Chain instance name.
@@ -1131,6 +1143,7 @@ module Aws::SupplyChain
     #   resp.instance.instance_id #=> String
     #   resp.instance.aws_account_id #=> String
     #   resp.instance.state #=> String, one of "Initializing", "Active", "CreateFailed", "DeleteFailed", "Deleting", "Deleted"
+    #   resp.instance.error_message #=> String
     #   resp.instance.web_app_dns_domain #=> String
     #   resp.instance.created_time #=> Time
     #   resp.instance.last_modified_time #=> Time
@@ -1148,7 +1161,9 @@ module Aws::SupplyChain
       req.send_request(options)
     end
 
-    # Delete the DataIntegrationFlow.
+    # Enable you to programmatically delete an existing data pipeline for
+    # the provided Amazon Web Services Supply Chain instance and
+    # DataIntegrationFlow name.
     #
     # @option params [required, String] :instance_id
     #   The Amazon Web Services Supply Chain instance identifier.
@@ -1196,7 +1211,9 @@ module Aws::SupplyChain
       req.send_request(options)
     end
 
-    # Delete a data lake dataset.
+    # Enables you to programmatically delete an Amazon Web Services Supply
+    # Chain data lake dataset. Developers can delete the existing datasets
+    # for a given instance ID, namespace, and instance name.
     #
     # @option params [required, String] :instance_id
     #   The AWS Supply Chain instance identifier.
@@ -1280,8 +1297,12 @@ module Aws::SupplyChain
       req.send_request(options)
     end
 
-    # Delete the instance. This is an asynchronous operation. Upon receiving
-    # a DeleteInstance request, AWS Supply Chain immediately returns a
+    # Enables you to programmatically delete an Amazon Web Services Supply
+    # Chain instance by deleting the KMS keys and relevant information
+    # associated with the API without using the Amazon Web Services console.
+    #
+    # This is an asynchronous operation. Upon receiving a DeleteInstance
+    # request, Amazon Web Services Supply Chain immediately returns a
     # response with the instance resource, delete state while cleaning up
     # all Amazon Web Services resources created during the instance creation
     # process. You can use the GetInstance action to check the instance
@@ -1327,6 +1348,7 @@ module Aws::SupplyChain
     #   resp.instance.instance_id #=> String
     #   resp.instance.aws_account_id #=> String
     #   resp.instance.state #=> String, one of "Initializing", "Active", "CreateFailed", "DeleteFailed", "Deleting", "Deleted"
+    #   resp.instance.error_message #=> String
     #   resp.instance.web_app_dns_domain #=> String
     #   resp.instance.created_time #=> Time
     #   resp.instance.last_modified_time #=> Time
@@ -1416,7 +1438,9 @@ module Aws::SupplyChain
       req.send_request(options)
     end
 
-    # View the DataIntegrationFlow details.
+    # Enables you to programmatically view a specific data pipeline for the
+    # provided Amazon Web Services Supply Chain instance and
+    # DataIntegrationFlow name.
     #
     # @option params [required, String] :instance_id
     #   The Amazon Web Services Supply Chain instance identifier.
@@ -1509,7 +1533,10 @@ module Aws::SupplyChain
       req.send_request(options)
     end
 
-    # Get a data lake dataset.
+    # Enables you to programmatically view an Amazon Web Services Supply
+    # Chain data lake dataset. Developers can view the data lake dataset
+    # information such as namespace, schema, and so on for a given instance
+    # ID, namespace, and dataset name.
     #
     # @option params [required, String] :instance_id
     #   The Amazon Web Services Supply Chain instance identifier.
@@ -1795,7 +1822,8 @@ module Aws::SupplyChain
       req.send_request(options)
     end
 
-    # Get the AWS Supply Chain instance details.
+    # Enables you to programmatically retrieve the information related to an
+    # Amazon Web Services Supply Chain instance ID.
     #
     # @option params [required, String] :instance_id
     #   The AWS Supply Chain instance identifier
@@ -1826,6 +1854,28 @@ module Aws::SupplyChain
     #     }, 
     #   }
     #
+    # @example Example: Successful GetInstance request with error message
+    #
+    #   resp = client.get_instance({
+    #     instance_id: "9e193580-7cc5-45f7-9609-c43ba0ada793", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     instance: {
+    #       aws_account_id: "123456789012", 
+    #       created_time: Time.parse(172615383136), 
+    #       error_message: "Access denied when attempting to create an S3 bucket. Please correct your IAM policy and try again.", 
+    #       instance_description: "example instance description", 
+    #       instance_id: "9e193580-7cc5-45f7-9609-c43ba0ada793", 
+    #       instance_name: "example instance name", 
+    #       kms_key_arn: "arn:aws:kms:us-west-2:123456789012:key/b14ffc39-b7d4-45ab-991a-6257a7f0d24d", 
+    #       last_modified_time: Time.parse(172615383136), 
+    #       state: "CreateFailed", 
+    #       version_number: 2.0, 
+    #     }, 
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.get_instance({
@@ -1837,6 +1887,7 @@ module Aws::SupplyChain
     #   resp.instance.instance_id #=> String
     #   resp.instance.aws_account_id #=> String
     #   resp.instance.state #=> String, one of "Initializing", "Active", "CreateFailed", "DeleteFailed", "Deleting", "Deleted"
+    #   resp.instance.error_message #=> String
     #   resp.instance.web_app_dns_domain #=> String
     #   resp.instance.created_time #=> Time
     #   resp.instance.last_modified_time #=> Time
@@ -1854,7 +1905,8 @@ module Aws::SupplyChain
       req.send_request(options)
     end
 
-    # Lists all the DataIntegrationFlows in a paginated way.
+    # Enables you to programmatically list all data pipelines for the
+    # provided Amazon Web Services Supply Chain instance.
     #
     # @option params [required, String] :instance_id
     #   The Amazon Web Services Supply Chain instance identifier.
@@ -1993,7 +2045,10 @@ module Aws::SupplyChain
       req.send_request(options)
     end
 
-    # List the data lake datasets for a specific instance and name space.
+    # Enables you to programmatically view the list of Amazon Web Services
+    # Supply Chain data lake datasets. Developers can view the datasets and
+    # the corresponding information such as namespace, schema, and so on for
+    # a given instance ID and namespace.
     #
     # @option params [required, String] :instance_id
     #   The Amazon Web Services Supply Chain instance identifier.
@@ -2309,7 +2364,10 @@ module Aws::SupplyChain
       req.send_request(options)
     end
 
-    # List all the AWS Supply Chain instances in a paginated way.
+    # List all Amazon Web Services Supply Chain instances for a specific
+    # account. Enables you to programmatically list all Amazon Web Services
+    # Supply Chain instances based on their account ID, instance name, and
+    # state of the instance (active or delete).
     #
     # @option params [String] :next_token
     #   The pagination token to fetch the next page of instances.
@@ -2454,6 +2512,7 @@ module Aws::SupplyChain
     #   resp.instances[0].instance_id #=> String
     #   resp.instances[0].aws_account_id #=> String
     #   resp.instances[0].state #=> String, one of "Initializing", "Active", "CreateFailed", "DeleteFailed", "Deleting", "Deleted"
+    #   resp.instances[0].error_message #=> String
     #   resp.instances[0].web_app_dns_domain #=> String
     #   resp.instances[0].created_time #=> Time
     #   resp.instances[0].last_modified_time #=> Time
@@ -2472,7 +2531,11 @@ module Aws::SupplyChain
       req.send_request(options)
     end
 
-    # List all the tags for an Amazon Web ServicesSupply Chain resource.
+    # List all the tags for an Amazon Web ServicesSupply Chain resource. You
+    # can list all the tags added to a resource. By listing the tags,
+    # developers can view the tag level information on a resource and
+    # perform actions such as, deleting a resource associated with a
+    # particular tag.
     #
     # @option params [required, String] :resource_arn
     #   The Amazon Web Services Supply chain resource ARN that needs tags to
@@ -2804,7 +2867,12 @@ module Aws::SupplyChain
       req.send_request(options)
     end
 
-    # Create tags for an Amazon Web Services Supply chain resource.
+    # You can create tags during or after creating a resource such as
+    # instance, data flow, or dataset in AWS Supply chain. During the data
+    # ingestion process, you can add tags such as dev, test, or prod to data
+    # flows created during the data ingestion process in the AWS Supply
+    # Chain datasets. You can use these tags to identify a group of
+    # resources or a single resource used by the developer.
     #
     # @option params [required, String] :resource_arn
     #   The Amazon Web Services Supply chain resource ARN that needs to be
@@ -2848,7 +2916,11 @@ module Aws::SupplyChain
       req.send_request(options)
     end
 
-    # Delete tags for an Amazon Web Services Supply chain resource.
+    # You can delete tags for an Amazon Web Services Supply chain resource
+    # such as instance, data flow, or dataset in AWS Supply Chain. During
+    # the data ingestion process, you can delete tags such as dev, test, or
+    # prod to data flows created during the data ingestion process in the
+    # AWS Supply Chain datasets.
     #
     # @option params [required, String] :resource_arn
     #   The Amazon Web Services Supply chain resource ARN that needs to be
@@ -2890,7 +2962,11 @@ module Aws::SupplyChain
       req.send_request(options)
     end
 
-    # Update the DataIntegrationFlow.
+    # Enables you to programmatically update an existing data pipeline to
+    # ingest data from the source systems such as, Amazon S3 buckets, to a
+    # predefined Amazon Web Services Supply Chain dataset (product,
+    # inbound\_order) or a temporary dataset along with the data
+    # transformation query provided with the API.
     #
     # @option params [required, String] :instance_id
     #   The Amazon Web Services Supply Chain instance identifier.
@@ -3130,7 +3206,10 @@ module Aws::SupplyChain
       req.send_request(options)
     end
 
-    # Update a data lake dataset.
+    # Enables you to programmatically update an Amazon Web Services Supply
+    # Chain data lake dataset. Developers can update the description of a
+    # data lake dataset for a given instance ID, namespace, and dataset
+    # name.
     #
     # @option params [required, String] :instance_id
     #   The Amazon Web Services Chain instance identifier.
@@ -3422,7 +3501,10 @@ module Aws::SupplyChain
       req.send_request(options)
     end
 
-    # Update the instance.
+    # Enables you to programmatically update an Amazon Web Services Supply
+    # Chain instance description by providing all the relevant information
+    # such as account ID, instance ID and so on without using the AWS
+    # console.
     #
     # @option params [required, String] :instance_id
     #   The AWS Supply Chain instance identifier.
@@ -3474,6 +3556,7 @@ module Aws::SupplyChain
     #   resp.instance.instance_id #=> String
     #   resp.instance.aws_account_id #=> String
     #   resp.instance.state #=> String, one of "Initializing", "Active", "CreateFailed", "DeleteFailed", "Deleting", "Deleted"
+    #   resp.instance.error_message #=> String
     #   resp.instance.web_app_dns_domain #=> String
     #   resp.instance.created_time #=> Time
     #   resp.instance.last_modified_time #=> Time
@@ -3509,7 +3592,7 @@ module Aws::SupplyChain
         tracer: tracer
       )
       context[:gem_name] = 'aws-sdk-supplychain'
-      context[:gem_version] = '1.18.0'
+      context[:gem_version] = '1.19.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -321,6 +321,7 @@ module Aws::SupplyChain
     Instance.add_member(:instance_id, Shapes::ShapeRef.new(shape: UUID, required: true, location_name: "instanceId"))
     Instance.add_member(:aws_account_id, Shapes::ShapeRef.new(shape: AwsAccountId, required: true, location_name: "awsAccountId"))
     Instance.add_member(:state, Shapes::ShapeRef.new(shape: InstanceState, required: true, location_name: "state"))
+    Instance.add_member(:error_message, Shapes::ShapeRef.new(shape: String, location_name: "errorMessage"))
     Instance.add_member(:web_app_dns_domain, Shapes::ShapeRef.new(shape: InstanceWebAppDnsDomain, location_name: "webAppDnsDomain"))
     Instance.add_member(:created_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "createdTime"))
     Instance.add_member(:last_modified_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "lastModifiedTime"))

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

@@ -951,6 +951,13 @@ module Aws::SupplyChain
     #   The state of the instance.
     #   @return [String]
     #
+    # @!attribute [rw] error_message
+    #   The Amazon Web Services Supply Chain instance error message. If the
+    #   instance results in an unhealthy state, customers need to check the
+    #   error message, delete the current instance, and recreate a new one
+    #   based on the mitigation from the error message.
+    #   @return [String]
+    #
     # @!attribute [rw] web_app_dns_domain
     #   The WebApp DNS domain name of the instance.
     #   @return [String]
@@ -988,6 +995,7 @@ module Aws::SupplyChain
       :instance_id,
       :aws_account_id,
       :state,
+      :error_message,
       :web_app_dns_domain,
       :created_time,
       :last_modified_time,

data/lib/aws-sdk-supplychain.rb

@@ -54,7 +54,7 @@ module Aws::SupplyChain
   autoload :EndpointProvider, 'aws-sdk-supplychain/endpoint_provider'
   autoload :Endpoints, 'aws-sdk-supplychain/endpoints'
 
-  GEM_VERSION = '1.18.0'
+  GEM_VERSION = '1.19.0'
 
 end
 

data/sig/types.rbs

@@ -267,6 +267,7 @@ module Aws::SupplyChain
       attr_accessor instance_id: ::String
       attr_accessor aws_account_id: ::String
       attr_accessor state: ("Initializing" | "Active" | "CreateFailed" | "DeleteFailed" | "Deleting" | "Deleted")
+      attr_accessor error_message: ::String
       attr_accessor web_app_dns_domain: ::String
       attr_accessor created_time: ::Time
       attr_accessor last_modified_time: ::Time

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-supplychain
 version: !ruby/object:Gem::Version
-  version: 1.18.0
+  version: 1.19.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-18 00:00:00.000000000 Z
+date: 2024-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core