aws-sdk-b2bi 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13b22cfa7e14182e7476aa483940c9f9869c735d940facd73a5ef15afc433c35
-  data.tar.gz: d0238bb388fd1230af494a3f4898051ae96ddc1011eefe4d392c09746f35015c
+  metadata.gz: 5a83c50c08435033fa539268b9978cf604567bc915ed9776065caf028e5d5b67
+  data.tar.gz: 436a23c7679dcde90db5a3e13d227916e054179c743e3eb0506042c13a9ec5d4
 SHA512:
-  metadata.gz: 1c94edbd4722648402b87f96945b57731f429b68770d078ed7c570715a0201e57ba36016c0bde49b81c4e2bb54381369b3b3edda95fd8fbc1a05724381944d8c
-  data.tar.gz: d52739c99ce0e7d71d53f4b9f628977a29d08d950a1ea1ae6c4140f6fac613993497e47a0fc583c24c94f6d5b3ac9185a98c8ac679fd8a0204ef3d29f2f848a6
+  metadata.gz: b707bdd1804f1fb19a36fde509e23425ba3cbb69d022c3bfce0eedb685b0e7469c2c9a44039693695071c63c1d7ccb2d46164dce93c7f8c2b66299ab7ffae6f5
+  data.tar.gz: 94f7f30f8013e1e9f12ef177d2b166bac72e4aeb4af43997a04105751d5e0a1d4fb1c688f071a86038d37011d9b95d910f0e4e6684ead129607efe5cca4b9ea8

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.2.0 (2023-12-14)
+------------------
+
+* Feature - Documentation updates for AWS B2B Data Interchange
+
 1.1.0 (2023-11-28)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.1.0
+1.2.0

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

@@ -398,9 +398,9 @@ module Aws::B2bi
 
     # @!group API Operations
 
-    # Instantiates a capability based on the specified parameters.
-    # Capabilities contain the information necessary to process incoming EDI
-    # (electronic data interchange) documents.
+    # Instantiates a capability based on the specified parameters. A trading
+    # capability contains the information required to transform incoming EDI
+    # documents into JSON or XML outputs.
     #
     # @option params [required, String] :name
     #   Specifies the name of the capability, used to identify it.
@@ -438,80 +438,6 @@ module Aws::B2bi
     #   * {Types::CreateCapabilityResponse#instructions_documents #instructions_documents} => Array<Types::S3Location>
     #   * {Types::CreateCapabilityResponse#created_at #created_at} => Time
     #
-    #
-    # @example Example: Sample CreateCapability call
-    #
-    #   resp = client.create_capability({
-    #     name: "b2biexample", 
-    #     type: "edi", 
-    #     client_token: "foo", 
-    #     configuration: {
-    #       edi: {
-    #         type: {
-    #           x12_details: {
-    #             version: "VERSION_4010", 
-    #             transaction_set: "X12_110", 
-    #           }, 
-    #         }, 
-    #         input_location: {
-    #           key: "input/", 
-    #           bucket_name: "test-bucket", 
-    #         }, 
-    #         output_location: {
-    #           key: "output/", 
-    #           bucket_name: "test-bucket", 
-    #         }, 
-    #         transformer_id: "tr-9a893cf536df4658b", 
-    #       }, 
-    #     }, 
-    #     instructions_documents: [
-    #       {
-    #         key: "instructiondoc.txt", 
-    #         bucket_name: "test-bucket", 
-    #       }, 
-    #     ], 
-    #     tags: [
-    #       {
-    #         key: "capabilityKey1", 
-    #         value: "capabilityValue1", 
-    #       }, 
-    #     ], 
-    #   })
-    #
-    #   resp.to_h outputs the following:
-    #   {
-    #     name: "b2biexample", 
-    #     type: "edi", 
-    #     capability_arn: "arn:aws:b2bi:us-west-2:123456789012:capability/ca-963a8121e4fc4e348", 
-    #     capability_id: "ca-963a8121e4fc4e348", 
-    #     configuration: {
-    #       edi: {
-    #         type: {
-    #           x12_details: {
-    #             version: "VERSION_4010", 
-    #             transaction_set: "X12_110", 
-    #           }, 
-    #         }, 
-    #         input_location: {
-    #           key: "input/", 
-    #           bucket_name: "test-bucket", 
-    #         }, 
-    #         output_location: {
-    #           key: "output/", 
-    #           bucket_name: "test-bucket", 
-    #         }, 
-    #         transformer_id: "tr-9a893cf536df4658b", 
-    #       }, 
-    #     }, 
-    #     created_at: Time.parse("2023-11-01T21:51:05.504Z"), 
-    #     instructions_documents: [
-    #       {
-    #         key: "instructiondoc.txt", 
-    #         bucket_name: "test-bucket", 
-    #       }, 
-    #     ], 
-    #   }
-    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.create_capability({
@@ -579,10 +505,9 @@ module Aws::B2bi
     end
 
     # Creates a partnership between a customer and a trading partner, based
-    # on the supplied parameters. Partnerships link trading partners with
-    # your profile and a specific transformer, so that the EDI (electronic
-    # data interchange) documents that they upload to Amazon S3 can be
-    # processed according to their specifications.
+    # on the supplied parameters. A partnership represents the connection
+    # between you and your trading partner. It ties together a profile and
+    # one or more trading capabilities.
     #
     # @option params [required, String] :profile_id
     #   Specifies the unique, system-generated identifier for the profile
@@ -623,41 +548,6 @@ module Aws::B2bi
     #   * {Types::CreatePartnershipResponse#trading_partner_id #trading_partner_id} => String
     #   * {Types::CreatePartnershipResponse#created_at #created_at} => Time
     #
-    #
-    # @example Example: Sample CreatePartnership call
-    #
-    #   resp = client.create_partnership({
-    #     name: "b2bipartner", 
-    #     capabilities: [
-    #       "ca-963a8121e4fc4e348", 
-    #     ], 
-    #     client_token: "foo", 
-    #     email: "john@example.com", 
-    #     phone: "5555555555", 
-    #     profile_id: "p-60fbc37c87f04fce9", 
-    #     tags: [
-    #       {
-    #         key: "sampleKey1", 
-    #         value: "sampleValue1", 
-    #       }, 
-    #     ], 
-    #   })
-    #
-    #   resp.to_h outputs the following:
-    #   {
-    #     name: "b2bipartner", 
-    #     capabilities: [
-    #       "ca-963a8121e4fc4e348", 
-    #     ], 
-    #     created_at: Time.parse("2023-11-01T21:51:05.504Z"), 
-    #     email: "john@example.com", 
-    #     partnership_arn: "arn:aws:b2bi:us-west-2:123456789012:partnership/ps-60fbc37c87f04fce9", 
-    #     partnership_id: "ps-219fa02f5b4242af8", 
-    #     phone: "5555555555", 
-    #     profile_id: "p-60fbc37c87f04fce9", 
-    #     trading_partner_id: "tp-2a17ca447f6f4a8a8", 
-    #   }
-    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.create_partnership({
@@ -698,8 +588,8 @@ module Aws::B2bi
     end
 
     # Creates a customer profile. You can have up to five customer profiles,
-    # each representing a distinct private network. Profiles contain basic
-    # information about you and your business.
+    # each representing a distinct private network. A profile is the
+    # mechanism used to create the concept of a private network.
     #
     # @option params [required, String] :name
     #   Specifies the name of the profile.
@@ -739,37 +629,6 @@ module Aws::B2bi
     #   * {Types::CreateProfileResponse#log_group_name #log_group_name} => String
     #   * {Types::CreateProfileResponse#created_at #created_at} => Time
     #
-    #
-    # @example Example: Sample CreateProfile call
-    #
-    #   resp = client.create_profile({
-    #     name: "Shipping Profile", 
-    #     business_name: "John's Shipping", 
-    #     client_token: "foo", 
-    #     email: "john@example.com", 
-    #     logging: "ENABLED", 
-    #     phone: "5555555555", 
-    #     tags: [
-    #       {
-    #         key: "sampleKey", 
-    #         value: "sampleValue", 
-    #       }, 
-    #     ], 
-    #   })
-    #
-    #   resp.to_h outputs the following:
-    #   {
-    #     name: "Shipping Profile", 
-    #     business_name: "John's Trucking", 
-    #     created_at: Time.parse("2023-11-01T21:51:05.504Z"), 
-    #     email: "john@example.com", 
-    #     log_group_name: "b2bi/p-60fbc37c87f04fce9-Logs", 
-    #     logging: "ENABLED", 
-    #     phone: "5555555555", 
-    #     profile_arn: "arn:aws:b2bi:us-west-2:123456789012:profile/p-60fbc37c87f04fce9", 
-    #     profile_id: "p-60fbc37c87f04fce9", 
-    #   }
-    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.create_profile({
@@ -808,9 +667,9 @@ module Aws::B2bi
       req.send_request(options)
     end
 
-    # Creates a transformer. Transformers describe how to process the
-    # incoming EDI (electronic data interchange) documents, and extract the
-    # necessary information.
+    # Creates a transformer. A transformer describes how to process the
+    # incoming EDI documents and extract the necessary information to the
+    # output file.
     #
     # @option params [required, String] :name
     #   Specifies the name of the transformer, used to identify it.
@@ -857,47 +716,6 @@ module Aws::B2bi
     #   * {Types::CreateTransformerResponse#sample_document #sample_document} => String
     #   * {Types::CreateTransformerResponse#created_at #created_at} => Time
     #
-    #
-    # @example Example: Sample CreateTransformer call
-    #
-    #   resp = client.create_transformer({
-    #     name: "transformJSON", 
-    #     client_token: "foo", 
-    #     edi_type: {
-    #       x12_details: {
-    #         version: "VERSION_4010", 
-    #         transaction_set: "X12_110", 
-    #       }, 
-    #     }, 
-    #     file_format: "JSON", 
-    #     mapping_template: "{}", 
-    #     sample_document: "s3://test-bucket/sampleDoc.txt", 
-    #     tags: [
-    #       {
-    #         key: "sampleKey", 
-    #         value: "sampleValue", 
-    #       }, 
-    #     ], 
-    #   })
-    #
-    #   resp.to_h outputs the following:
-    #   {
-    #     name: "transformJSON", 
-    #     created_at: Time.parse("2023-11-01T21:51:05.504Z"), 
-    #     edi_type: {
-    #       x12_details: {
-    #         version: "VERSION_4010", 
-    #         transaction_set: "X12_110", 
-    #       }, 
-    #     }, 
-    #     file_format: "JSON", 
-    #     mapping_template: "$", 
-    #     sample_document: "s3://test-bucket/sampleDoc.txt", 
-    #     status: "inactive", 
-    #     transformer_arn: "arn:aws:b2bi:us-west-2:123456789012:transformer/tr-974c129999f84d8c9", 
-    #     transformer_id: "tr-974c129999f84d8c9", 
-    #   }
-    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.create_transformer({
@@ -942,22 +760,15 @@ module Aws::B2bi
       req.send_request(options)
     end
 
-    # Deletes the specified capability. Capabilities contain the information
-    # necessary to process incoming EDI (electronic data interchange)
-    # documents.
+    # Deletes the specified capability. A trading capability contains the
+    # information required to transform incoming EDI documents into JSON or
+    # XML outputs.
     #
     # @option params [required, String] :capability_id
     #   Specifies a system-assigned unique identifier for the capability.
     #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
-    #
-    # @example Example: Sample DeleteCapabilty call
-    #
-    #   resp = client.delete_capability({
-    #     capability_id: "ca-963a8121e4fc4e348", 
-    #   })
-    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.delete_capability({
@@ -973,23 +784,15 @@ module Aws::B2bi
       req.send_request(options)
     end
 
-    # Deletes the specified partnership. Partnerships link trading partners
-    # with your profile and a specific transformer, so that the EDI
-    # (electronic data interchange) documents that they upload to Amazon S3
-    # can be processed according to their specifications.
+    # Deletes the specified partnership. A partnership represents the
+    # connection between you and your trading partner. It ties together a
+    # profile and one or more trading capabilities.
     #
     # @option params [required, String] :partnership_id
     #   Specifies the unique, system-generated identifier for a partnership.
     #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
-    #
-    # @example Example: Sample DeletePartnership call
-    #
-    #   resp = client.delete_partnership({
-    #     partnership_id: "ps-219fa02f5b4242af8", 
-    #   })
-    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.delete_partnership({
@@ -1005,21 +808,14 @@ module Aws::B2bi
       req.send_request(options)
     end
 
-    # Deletes the specified profile. Profiles contain basic information
-    # about you and your business.
+    # Deletes the specified profile. A profile is the mechanism used to
+    # create the concept of a private network.
     #
     # @option params [required, String] :profile_id
     #   Specifies the unique, system-generated identifier for the profile.
     #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
-    #
-    # @example Example: Sample DeleteProfile call
-    #
-    #   resp = client.delete_profile({
-    #     profile_id: "p-60fbc37c87f04fce9", 
-    #   })
-    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.delete_profile({
@@ -1035,22 +831,15 @@ module Aws::B2bi
       req.send_request(options)
     end
 
-    # Deletes the specified transformer. Transformers describe how to
-    # process the incoming EDI (electronic data interchange) documents, and
-    # extract the necessary information.
+    # Deletes the specified transformer. A transformer describes how to
+    # process the incoming EDI documents and extract the necessary
+    # information to the output file.
     #
     # @option params [required, String] :transformer_id
     #   Specifies the system-assigned unique identifier for the transformer.
     #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
-    #
-    # @example Example: Sample DeleteTransformer call
-    #
-    #   resp = client.delete_transformer({
-    #     transformer_id: "tr-974c129999f84d8c9", 
-    #   })
-    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.delete_transformer({
@@ -1066,9 +855,9 @@ module Aws::B2bi
       req.send_request(options)
     end
 
-    # Retrieves the details for the specified capability. Capabilities
-    # contain the information necessary to process incoming EDI (electronic
-    # data interchange) documents.
+    # Retrieves the details for the specified capability. A trading
+    # capability contains the information required to transform incoming EDI
+    # documents into JSON or XML outputs.
     #
     # @option params [required, String] :capability_id
     #   Specifies a system-assigned unique identifier for the capability.
@@ -1084,48 +873,6 @@ module Aws::B2bi
     #   * {Types::GetCapabilityResponse#created_at #created_at} => Time
     #   * {Types::GetCapabilityResponse#modified_at #modified_at} => Time
     #
-    #
-    # @example Example: Sample GetCapabilty call
-    #
-    #   resp = client.get_capability({
-    #     capability_id: "ca-963a8121e4fc4e348", 
-    #   })
-    #
-    #   resp.to_h outputs the following:
-    #   {
-    #     name: "b2biexample", 
-    #     type: "edi", 
-    #     capability_arn: "arn:aws:b2bi:us-west-2:123456789012:capability/ca-963a8121e4fc4e348", 
-    #     capability_id: "ca-963a8121e4fc4e348", 
-    #     configuration: {
-    #       edi: {
-    #         type: {
-    #           x12_details: {
-    #             version: "VERSION_4010", 
-    #             transaction_set: "X12_110", 
-    #           }, 
-    #         }, 
-    #         input_location: {
-    #           key: "input/", 
-    #           bucket_name: "test-bucket", 
-    #         }, 
-    #         output_location: {
-    #           key: "output/", 
-    #           bucket_name: "test-bucket", 
-    #         }, 
-    #         transformer_id: "tr-9a893cf536df4658b", 
-    #       }, 
-    #     }, 
-    #     created_at: Time.parse("2023-11-01T21:51:05.504Z"), 
-    #     instructions_documents: [
-    #       {
-    #         key: "instructiondoc.txt", 
-    #         bucket_name: "test-bucket", 
-    #       }, 
-    #     ], 
-    #     modified_at: Time.parse("2023-11-02T21:51:05.504Z"), 
-    #   }
-    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.get_capability({
@@ -1161,10 +908,9 @@ module Aws::B2bi
     end
 
     # Retrieves the details for a partnership, based on the partner and
-    # profile IDs specified. Partnerships link trading partners with your
-    # profile and a specific transformer, so that the EDI (electronic data
-    # interchange) documents that they upload to Amazon S3 can be processed
-    # according to their specifications.
+    # profile IDs specified. A partnership represents the connection between
+    # you and your trading partner. It ties together a profile and one or
+    # more trading capabilities.
     #
     # @option params [required, String] :partnership_id
     #   Specifies the unique, system-generated identifier for a partnership.
@@ -1182,29 +928,6 @@ module Aws::B2bi
     #   * {Types::GetPartnershipResponse#created_at #created_at} => Time
     #   * {Types::GetPartnershipResponse#modified_at #modified_at} => Time
     #
-    #
-    # @example Example: Sample GetPartnership call
-    #
-    #   resp = client.get_partnership({
-    #     partnership_id: "ps-219fa02f5b4242af8", 
-    #   })
-    #
-    #   resp.to_h outputs the following:
-    #   {
-    #     name: "b2bipartner", 
-    #     capabilities: [
-    #       "ca-963a8121e4fc4e348", 
-    #     ], 
-    #     created_at: Time.parse("2023-11-01T21:51:05.504Z"), 
-    #     email: "john@example.com", 
-    #     modified_at: Time.parse("2023-11-01T21:51:05.504Z"), 
-    #     partnership_arn: "arn:aws:b2bi:us-west-2:123456789012:partnership/ps-219fa02f5b4242af8", 
-    #     partnership_id: "ps-219fa02f5b4242af8", 
-    #     phone: "5555555555", 
-    #     profile_id: "p-60fbc37c87f04fce9", 
-    #     trading_partner_id: "tp-2a17ca447f6f4a8a8", 
-    #   }
-    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.get_partnership({
@@ -1234,8 +957,9 @@ module Aws::B2bi
       req.send_request(options)
     end
 
-    # Retrieves the details for the profile specified by the profile ID.
-    # Profiles contain basic information about you and your business.
+    # Retrieves the details for the profile specified by the profile ID. A
+    # profile is the mechanism used to create the concept of a private
+    # network.
     #
     # @option params [required, String] :profile_id
     #   Specifies the unique, system-generated identifier for the profile.
@@ -1253,26 +977,6 @@ module Aws::B2bi
     #   * {Types::GetProfileResponse#created_at #created_at} => Time
     #   * {Types::GetProfileResponse#modified_at #modified_at} => Time
     #
-    #
-    # @example Example: Sample GetProfile call
-    #
-    #   resp = client.get_profile({
-    #     profile_id: "p-60fbc37c87f04fce9", 
-    #   })
-    #
-    #   resp.to_h outputs the following:
-    #   {
-    #     name: "Shipping Profile", 
-    #     business_name: "John's Trucking", 
-    #     created_at: Time.parse("2023-11-01T21:51:05.504Z"), 
-    #     email: "john@example.com", 
-    #     log_group_name: "b2bi/p-60fbc37c87f04fce9-Logs", 
-    #     logging: "ENABLED", 
-    #     phone: "5555555555", 
-    #     profile_arn: "arn:aws:b2bi:us-west-2:123456789012:profile/p-60fbc37c87f04fce9", 
-    #     profile_id: "p-60fbc37c87f04fce9", 
-    #   }
-    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.get_profile({
@@ -1302,8 +1006,8 @@ module Aws::B2bi
     end
 
     # Retrieves the details for the transformer specified by the transformer
-    # ID. Transformers describe how to process the incoming EDI (electronic
-    # data interchange) documents, and extract the necessary information.
+    # ID. A transformer describes how to process the incoming EDI documents
+    # and extract the necessary information to the output file.
     #
     # @option params [required, String] :transformer_id
     #   Specifies the system-assigned unique identifier for the transformer.
@@ -1321,32 +1025,6 @@ module Aws::B2bi
     #   * {Types::GetTransformerResponse#created_at #created_at} => Time
     #   * {Types::GetTransformerResponse#modified_at #modified_at} => Time
     #
-    #
-    # @example Example: Sample GetTransformer call
-    #
-    #   resp = client.get_transformer({
-    #     transformer_id: "tr-974c129999f84d8c9", 
-    #   })
-    #
-    #   resp.to_h outputs the following:
-    #   {
-    #     name: "transformJSON", 
-    #     created_at: Time.parse("2023-11-01T21:51:05.504Z"), 
-    #     edi_type: {
-    #       x12_details: {
-    #         version: "VERSION_4010", 
-    #         transaction_set: "X12_110", 
-    #       }, 
-    #     }, 
-    #     file_format: "JSON", 
-    #     mapping_template: "$", 
-    #     modified_at: Time.parse("2023-11-01T21:51:05.504Z"), 
-    #     sample_document: "s3://test-bucket/sampleDoc.txt", 
-    #     status: "inactive", 
-    #     transformer_arn: "arn:aws:b2bi:us-west-2:123456789012:transformer/tr-974c129999f84d8c9", 
-    #     transformer_id: "tr-974c129999f84d8c9", 
-    #   }
-    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.get_transformer({
@@ -1392,26 +1070,6 @@ module Aws::B2bi
     #   * {Types::GetTransformerJobResponse#output_files #output_files} => Array<Types::S3Location>
     #   * {Types::GetTransformerJobResponse#message #message} => String
     #
-    #
-    # @example Example: Sample GetTransformerJob call
-    #
-    #   resp = client.get_transformer_job({
-    #     transformer_id: "tr-974c129999f84d8c9", 
-    #     transformer_job_id: "tj-vpYxfV7yQOqjMSYllEslLw", 
-    #   })
-    #
-    #   resp.to_h outputs the following:
-    #   {
-    #     message: "Transformed, writing output", 
-    #     output_files: [
-    #       {
-    #         key: "output/sample-214.edi.2023-11-01T10:44:03.353Z.json", 
-    #         bucket_name: "gt-edi-test", 
-    #       }, 
-    #     ], 
-    #     status: "succeeded", 
-    #   }
-    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.get_transformer_job({
@@ -1437,9 +1095,9 @@ module Aws::B2bi
     end
 
     # Lists the capabilities associated with your Amazon Web Services
-    # account for your current or specified region. Capabilities contain the
-    # information necessary to process incoming EDI (electronic data
-    # interchange) documents.
+    # account for your current or specified region. A trading capability
+    # contains the information required to transform incoming EDI documents
+    # into JSON or XML outputs.
     #
     # @option params [String] :next_token
     #   When additional results are obtained from the command, a `NextToken`
@@ -1457,28 +1115,6 @@ module Aws::B2bi
     #
     # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
     #
-    #
-    # @example Example: Sample ListCapabilities call
-    #
-    #   resp = client.list_capabilities({
-    #     max_results: 50, 
-    #     next_token: "foo", 
-    #   })
-    #
-    #   resp.to_h outputs the following:
-    #   {
-    #     capabilities: [
-    #       {
-    #         name: "b2biexample", 
-    #         type: "edi", 
-    #         capability_id: "ca-963a8121e4fc4e348", 
-    #         created_at: Time.parse("2023-11-01T21:51:05.504Z"), 
-    #         modified_at: Time.parse("2023-11-01T21:51:05.504Z"), 
-    #       }, 
-    #     ], 
-    #     next_token: "foo", 
-    #   }
-    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.list_capabilities({
@@ -1506,10 +1142,9 @@ module Aws::B2bi
     end
 
     # Lists the partnerships associated with your Amazon Web Services
-    # account for your current or specified region. Partnerships link
-    # trading partners with your profile and a specific transformer, so that
-    # the EDI (electronic data interchange) documents that they upload to
-    # Amazon S3 can be processed according to their specifications.
+    # account for your current or specified region. A partnership represents
+    # the connection between you and your trading partner. It ties together
+    # a profile and one or more trading capabilities.
     #
     # @option params [String] :profile_id
     #   Specifies the unique, system-generated identifier for the profile
@@ -1531,33 +1166,6 @@ module Aws::B2bi
     #
     # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
     #
-    #
-    # @example Example: Sample ListPartnerships call
-    #
-    #   resp = client.list_partnerships({
-    #     max_results: 50, 
-    #     next_token: "foo", 
-    #     profile_id: "p-60fbc37c87f04fce9", 
-    #   })
-    #
-    #   resp.to_h outputs the following:
-    #   {
-    #     next_token: "string", 
-    #     partnerships: [
-    #       {
-    #         name: "b2bipartner", 
-    #         capabilities: [
-    #           "ca-963a8121e4fc4e348", 
-    #         ], 
-    #         created_at: Time.parse("2023-11-01T21:51:05.504Z"), 
-    #         modified_at: Time.parse("2023-11-01T21:51:05.504Z"), 
-    #         partnership_id: "ps-219fa02f5b4242af8", 
-    #         profile_id: "p-60fbc37c87f04fce9", 
-    #         trading_partner_id: "tp-2a17ca447f6f4a8a8", 
-    #       }, 
-    #     ], 
-    #   }
-    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.list_partnerships({
@@ -1589,8 +1197,8 @@ module Aws::B2bi
     end
 
     # Lists the profiles associated with your Amazon Web Services account
-    # for your current or specified region. Profiles contain basic
-    # information about you and your business.
+    # for your current or specified region. A profile is the mechanism used
+    # to create the concept of a private network.
     #
     # @option params [String] :next_token
     #   When additional results are obtained from the command, a `NextToken`
@@ -1608,29 +1216,6 @@ module Aws::B2bi
     #
     # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
     #
-    #
-    # @example Example: Sample ListProfiles call
-    #
-    #   resp = client.list_profiles({
-    #     max_results: 50, 
-    #     next_token: "foo", 
-    #   })
-    #
-    #   resp.to_h outputs the following:
-    #   {
-    #     next_token: "foo", 
-    #     profiles: [
-    #       {
-    #         name: "Shipping Profile", 
-    #         business_name: "John's Trucking", 
-    #         created_at: Time.parse("2023-11-01T21:51:05.504Z"), 
-    #         log_group_name: "b2bi/p-60fbc37c87f04fce9-Logs", 
-    #         logging: "ENABLED", 
-    #         profile_id: "p-60fbc37c87f04fce9", 
-    #       }, 
-    #     ], 
-    #   }
-    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.list_profiles({
@@ -1672,23 +1257,6 @@ module Aws::B2bi
     #
     #   * {Types::ListTagsForResourceResponse#tags #tags} => Array<Types::Tag>
     #
-    #
-    # @example Example: Sample ListTagsForResources call
-    #
-    #   resp = client.list_tags_for_resource({
-    #     resource_arn: "arn:aws:b2bi:us-west-2:123456789012:profile/p-60fbc37c87f04fce9", 
-    #   })
-    #
-    #   resp.to_h outputs the following:
-    #   {
-    #     tags: [
-    #       {
-    #         key: "sampleKey", 
-    #         value: "SampleValue", 
-    #       }, 
-    #     ], 
-    #   }
-    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.list_tags_for_resource({
@@ -1710,9 +1278,9 @@ module Aws::B2bi
       req.send_request(options)
     end
 
-    # Lists the available transformers. Transformers describe how to process
-    # the incoming EDI (electronic data interchange) documents, and extract
-    # the necessary information.
+    # Lists the available transformers. A transformer describes how to
+    # process the incoming EDI documents and extract the necessary
+    # information to the output file.
     #
     # @option params [String] :next_token
     #   When additional results are obtained from the command, a `NextToken`
@@ -1730,37 +1298,6 @@ module Aws::B2bi
     #
     # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
     #
-    #
-    # @example Example: Sample ListTransformers call
-    #
-    #   resp = client.list_transformers({
-    #     max_results: 50, 
-    #     next_token: "foo", 
-    #   })
-    #
-    #   resp.to_h outputs the following:
-    #   {
-    #     next_token: "foo", 
-    #     transformers: [
-    #       {
-    #         name: "transformJSON", 
-    #         created_at: Time.parse("2023-11-01T21:51:05.504Z"), 
-    #         edi_type: {
-    #           x12_details: {
-    #             version: "VERSION_4010", 
-    #             transaction_set: "X12_110", 
-    #           }, 
-    #         }, 
-    #         file_format: "JSON", 
-    #         mapping_template: "$", 
-    #         modified_at: Time.parse("2023-11-01T21:51:05.504Z"), 
-    #         sample_document: "s3://test-bucket/sampleDoc.txt", 
-    #         status: "inactive", 
-    #         transformer_id: "tr-974c129999f84d8c9", 
-    #       }, 
-    #     ], 
-    #   }
-    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.list_transformers({
@@ -1796,6 +1333,11 @@ module Aws::B2bi
     # interchange) file into the output structures used by Amazon Web
     # Services B2BI Data Interchange.
     #
+    # If you only want to transform EDI (electronic data interchange)
+    # documents, you don't need to create profiles, partnerships or
+    # capabilities. Just create and configure a transformer, and then run
+    # the `StartTransformerJob` API to process your files.
+    #
     # @option params [required, Types::S3Location] :input_file
     #   Specifies the location of the input file for the transformation. The
     #   location consists of an Amazon S3 bucket and prefix.
@@ -1817,27 +1359,6 @@ module Aws::B2bi
     #
     #   * {Types::StartTransformerJobResponse#transformer_job_id #transformer_job_id} => String
     #
-    #
-    # @example Example: Sample StartTransformerJob call
-    #
-    #   resp = client.start_transformer_job({
-    #     client_token: "foo", 
-    #     input_file: {
-    #       key: "input/inputFile.txt", 
-    #       bucket_name: "test-bucket", 
-    #     }, 
-    #     output_location: {
-    #       key: "output/", 
-    #       bucket_name: "test-bucket", 
-    #     }, 
-    #     transformer_id: "tr-974c129999f84d8c9", 
-    #   })
-    #
-    #   resp.to_h outputs the following:
-    #   {
-    #     transformer_job_id: "tj-vpYxfV7yQOqjMSYllEslLw", 
-    #   }
-    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.start_transformer_job({
@@ -1884,19 +1405,6 @@ module Aws::B2bi
     #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
-    #
-    # @example Example: Sample TagResource call
-    #
-    #   resp = client.tag_resource({
-    #     resource_arn: "arn:aws:b2bi:us-west-2:123456789012:profile/p-60fbc37c87f04fce9", 
-    #     tags: [
-    #       {
-    #         key: "sampleKey", 
-    #         value: "SampleValue", 
-    #       }, 
-    #     ], 
-    #   })
-    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.tag_resource({
@@ -1918,11 +1426,14 @@ module Aws::B2bi
       req.send_request(options)
     end
 
-    # Maps the input file according to the provided template file.
+    # Maps the input file according to the provided template file. The API
+    # call downloads the file contents from the Amazon S3 location, and
+    # passes the contents in as a string, to the `inputFileContent`
+    # parameter.
     #
     # @option params [required, String] :input_file_content
-    #   Specify the EDI (electronic data interchange) file that is used as
-    #   input for the transform.
+    #   Specify the contents of the EDI (electronic data interchange) XML or
+    #   JSON file that is used as input for the transform.
     #
     # @option params [required, String] :mapping_template
     #   Specifies the name of the mapping template for the transformer. This
@@ -1937,20 +1448,6 @@ module Aws::B2bi
     #
     #   * {Types::TestMappingResponse#mapped_file_content #mapped_file_content} => String
     #
-    #
-    # @example Example: Sample TestMapping call
-    #
-    #   resp = client.test_mapping({
-    #     file_format: "JSON", 
-    #     input_file_content: "Sample file content", 
-    #     mapping_template: "$", 
-    #   })
-    #
-    #   resp.to_h outputs the following:
-    #   {
-    #     mapped_file_content: "Sample file content", 
-    #   }
-    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.test_mapping({
@@ -1992,28 +1489,6 @@ module Aws::B2bi
     #
     #   * {Types::TestParsingResponse#parsed_file_content #parsed_file_content} => String
     #
-    #
-    # @example Example: Sample TestParsing call
-    #
-    #   resp = client.test_parsing({
-    #     edi_type: {
-    #       x12_details: {
-    #         version: "VERSION_4010", 
-    #         transaction_set: "X12_110", 
-    #       }, 
-    #     }, 
-    #     file_format: "JSON", 
-    #     input_file: {
-    #       key: "sampleFile.txt", 
-    #       bucket_name: "test-bucket", 
-    #     }, 
-    #   })
-    #
-    #   resp.to_h outputs the following:
-    #   {
-    #     parsed_file_content: "Sample parsed file content", 
-    #   }
-    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.test_parsing({
@@ -2059,16 +1534,6 @@ module Aws::B2bi
     #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
-    #
-    # @example Example: Sample UntagResource call
-    #
-    #   resp = client.untag_resource({
-    #     resource_arn: "arn:aws:b2bi:us-west-2:123456789012:profile/p-60fbc37c87f04fce9", 
-    #     tag_keys: [
-    #       "sampleKey", 
-    #     ], 
-    #   })
-    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.untag_resource({
@@ -2086,8 +1551,8 @@ module Aws::B2bi
     end
 
     # Updates some of the parameters for a capability, based on the
-    # specified parameters. Capabilities contain the information necessary
-    # to process incoming EDI (electronic data interchange) documents.
+    # specified parameters. A trading capability contains the information
+    # required to transform incoming EDI documents into JSON or XML outputs.
     #
     # @option params [required, String] :capability_id
     #   Specifies a system-assigned unique identifier for the capability.
@@ -2114,74 +1579,6 @@ module Aws::B2bi
     #   * {Types::UpdateCapabilityResponse#created_at #created_at} => Time
     #   * {Types::UpdateCapabilityResponse#modified_at #modified_at} => Time
     #
-    #
-    # @example Example: Sample UpdateCapability call
-    #
-    #   resp = client.update_capability({
-    #     name: "b2biexample", 
-    #     capability_id: "ca-963a8121e4fc4e348", 
-    #     configuration: {
-    #       edi: {
-    #         type: {
-    #           x12_details: {
-    #             version: "VERSION_4010", 
-    #             transaction_set: "X12_110", 
-    #           }, 
-    #         }, 
-    #         input_location: {
-    #           key: "input/", 
-    #           bucket_name: "test-bucket", 
-    #         }, 
-    #         output_location: {
-    #           key: "output/", 
-    #           bucket_name: "test-bucket", 
-    #         }, 
-    #         transformer_id: "tr-9a893cf536df4658b", 
-    #       }, 
-    #     }, 
-    #     instructions_documents: [
-    #       {
-    #         key: "instructiondoc.txt", 
-    #         bucket_name: "test-bucket", 
-    #       }, 
-    #     ], 
-    #   })
-    #
-    #   resp.to_h outputs the following:
-    #   {
-    #     name: "b2biexample", 
-    #     type: "edi", 
-    #     capability_arn: "arn:aws:b2bi:us-west-2:123456789012:capability/ca-963a8121e4fc4e348", 
-    #     capability_id: "ca-963a8121e4fc4e348", 
-    #     configuration: {
-    #       edi: {
-    #         type: {
-    #           x12_details: {
-    #             version: "VERSION_4010", 
-    #             transaction_set: "X12_110", 
-    #           }, 
-    #         }, 
-    #         input_location: {
-    #           key: "input/", 
-    #           bucket_name: "test-bucket", 
-    #         }, 
-    #         output_location: {
-    #           key: "output/", 
-    #           bucket_name: "test-bucket", 
-    #         }, 
-    #         transformer_id: "tr-9a893cf536df4658b", 
-    #       }, 
-    #     }, 
-    #     created_at: Time.parse("2023-11-01T21:51:05.504Z"), 
-    #     instructions_documents: [
-    #       {
-    #         key: "instructiondoc.txt", 
-    #         bucket_name: "test-bucket", 
-    #       }, 
-    #     ], 
-    #     modified_at: Time.parse("2023-11-01T21:51:05.504Z"), 
-    #   }
-    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.update_capability({
@@ -2243,10 +1640,9 @@ module Aws::B2bi
     end
 
     # Updates some of the parameters for a partnership between a customer
-    # and trading partner. Partnerships link trading partners with your
-    # profile and a specific transformer, so that the EDI (electronic data
-    # interchange) documents that they upload to Amazon S3 can be processed
-    # according to their specifications.
+    # and trading partner. A partnership represents the connection between
+    # you and your trading partner. It ties together a profile and one or
+    # more trading capabilities.
     #
     # @option params [required, String] :partnership_id
     #   Specifies the unique, system-generated identifier for a partnership.
@@ -2270,33 +1666,6 @@ module Aws::B2bi
     #   * {Types::UpdatePartnershipResponse#created_at #created_at} => Time
     #   * {Types::UpdatePartnershipResponse#modified_at #modified_at} => Time
     #
-    #
-    # @example Example: Sample UpdatePartnership call
-    #
-    #   resp = client.update_partnership({
-    #     name: "b2bipartner", 
-    #     capabilities: [
-    #       "ca-963a8121e4fc4e348", 
-    #     ], 
-    #     partnership_id: "ps-219fa02f5b4242af8", 
-    #   })
-    #
-    #   resp.to_h outputs the following:
-    #   {
-    #     name: "b2bipartner", 
-    #     capabilities: [
-    #       "ca-963a8121e4fc4e348", 
-    #     ], 
-    #     created_at: Time.parse("2023-11-01T21:51:05.504Z"), 
-    #     email: "john@example.com", 
-    #     modified_at: Time.parse("2023-11-01T21:51:05.504Z"), 
-    #     partnership_arn: "arn:aws:b2bi:us-west-2:123456789012:partnership/ps-60fbc37c87f04fce9", 
-    #     partnership_id: "ps-219fa02f5b4242af8", 
-    #     phone: "5555555555", 
-    #     profile_id: "p-60fbc37c87f04fce9", 
-    #     trading_partner_id: "tp-2a17ca447f6f4a8a8", 
-    #   }
-    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.update_partnership({
@@ -2328,8 +1697,8 @@ module Aws::B2bi
       req.send_request(options)
     end
 
-    # Updates the specified parameters for a profile. Profiles contain basic
-    # information about you and your business.
+    # Updates the specified parameters for a profile. A profile is the
+    # mechanism used to create the concept of a private network.
     #
     # @option params [required, String] :profile_id
     #   Specifies the unique, system-generated identifier for the profile.
@@ -2359,31 +1728,6 @@ module Aws::B2bi
     #   * {Types::UpdateProfileResponse#created_at #created_at} => Time
     #   * {Types::UpdateProfileResponse#modified_at #modified_at} => Time
     #
-    #
-    # @example Example: Sample UpdateProfile call
-    #
-    #   resp = client.update_profile({
-    #     name: "Shipping Profile", 
-    #     business_name: "John's Shipping", 
-    #     email: "john@example.com", 
-    #     phone: "5555555555", 
-    #     profile_id: "p-60fbc37c87f04fce9", 
-    #   })
-    #
-    #   resp.to_h outputs the following:
-    #   {
-    #     name: "Shipping Profile", 
-    #     business_name: "John's Trucking", 
-    #     created_at: Time.parse("2023-11-01T21:51:05.504Z"), 
-    #     email: "john@example.com", 
-    #     log_group_name: "b2bi/p-60fbc37c87f04fce9-Logs", 
-    #     logging: "ENABLED", 
-    #     modified_at: Time.parse("2023-11-02T21:51:05.504Z"), 
-    #     phone: "5555555555", 
-    #     profile_arn: "arn:aws:b2bi:us-west-2:123456789012:profile/p-60fbc37c87f04fce9", 
-    #     profile_id: "p-60fbc37c87f04fce9", 
-    #   }
-    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.update_profile({
@@ -2416,9 +1760,9 @@ module Aws::B2bi
       req.send_request(options)
     end
 
-    # Updates the specified parameters for a transformer. Transformers
-    # describe how to process the incoming EDI (electronic data interchange)
-    # documents, and extract the necessary information.
+    # Updates the specified parameters for a transformer. A transformer
+    # describes how to process the incoming EDI documents and extract the
+    # necessary information to the output file.
     #
     # @option params [required, String] :transformer_id
     #   Specifies the system-assigned unique identifier for the transformer.
@@ -2462,43 +1806,6 @@ module Aws::B2bi
     #   * {Types::UpdateTransformerResponse#created_at #created_at} => Time
     #   * {Types::UpdateTransformerResponse#modified_at #modified_at} => Time
     #
-    #
-    # @example Example: Sample UpdateTransformer call
-    #
-    #   resp = client.update_transformer({
-    #     name: "transformJSON", 
-    #     edi_type: {
-    #       x12_details: {
-    #         version: "VERSION_4010", 
-    #         transaction_set: "X12_110", 
-    #       }, 
-    #     }, 
-    #     file_format: "JSON", 
-    #     mapping_template: "{}", 
-    #     sample_document: "s3://test-bucket/sampleDoc.txt", 
-    #     status: "inactive", 
-    #     transformer_id: "tr-974c129999f84d8c9", 
-    #   })
-    #
-    #   resp.to_h outputs the following:
-    #   {
-    #     name: "transformJSON", 
-    #     created_at: Time.parse("2023-11-01T21:51:05.504Z"), 
-    #     edi_type: {
-    #       x12_details: {
-    #         version: "VERSION_4010", 
-    #         transaction_set: "X12_110", 
-    #       }, 
-    #     }, 
-    #     file_format: "JSON", 
-    #     mapping_template: "$", 
-    #     modified_at: Time.parse("2023-11-01T21:51:05.504Z"), 
-    #     sample_document: "s3://test-bucket/sampleDoc.txt", 
-    #     status: "inactive", 
-    #     transformer_arn: "arn:aws:b2bi:us-west-2:607686414464:transformer/tr-974c129999f84d8c9", 
-    #     transformer_id: "tr-974c129999f84d8c9", 
-    #   }
-    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.update_transformer({
@@ -2552,7 +1859,7 @@ module Aws::B2bi
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-b2bi'
-      context[:gem_version] = '1.1.0'
+      context[:gem_version] = '1.2.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -24,9 +24,9 @@ module Aws::B2bi
     end
 
     # A capability object. Currently, only EDI (electronic data interchange)
-    # capabilities are supported. Capabilities contain the information
-    # necessary to process incoming EDI (electronic data interchange)
-    # documents.
+    # capabilities are supported. A trading capability contains the
+    # information required to transform incoming EDI documents into JSON or
+    # XML outputs.
     #
     # @note CapabilityConfiguration is a union - when making an API calls you must set exactly one of the members.
     #
@@ -49,9 +49,9 @@ module Aws::B2bi
       class Unknown < CapabilityConfiguration; end
     end
 
-    # Returns the capability summary details. Capabilities contain the
-    # information necessary to process incoming EDI (electronic data
-    # interchange) documents.
+    # Returns the capability summary details. A trading capability contains
+    # the information required to transform incoming EDI documents into JSON
+    # or XML outputs.
     #
     # @!attribute [rw] capability_id
     #   Returns a system-assigned unique identifier for the capability.
@@ -1183,10 +1183,9 @@ module Aws::B2bi
       include Aws::Structure
     end
 
-    # A structure that contains the details for a partnership. Partnerships
-    # link trading partners with your profile and a specific transformer, so
-    # that the EDI (electronic data interchange) documents that they upload
-    # to Amazon S3 can be processed according to their specifications.
+    # A structure that contains the details for a partnership. A partnership
+    # represents the connection between you and your trading partner. It
+    # ties together a profile and one or more trading capabilities.
     #
     # @!attribute [rw] profile_id
     #   Returns the unique, system-generated identifier for the profile
@@ -1233,8 +1232,8 @@ module Aws::B2bi
       include Aws::Structure
     end
 
-    # Contains the details for a profile. Profiles contain basic information
-    # about you and your business.
+    # Contains the details for a profile. A profile is the mechanism used to
+    # create the concept of a private network.
     #
     # @!attribute [rw] profile_id
     #   Returns the unique, system-generated identifier for the profile.
@@ -1447,8 +1446,8 @@ module Aws::B2bi
     end
 
     # @!attribute [rw] input_file_content
-    #   Specify the EDI (electronic data interchange) file that is used as
-    #   input for the transform.
+    #   Specify the contents of the EDI (electronic data interchange) XML or
+    #   JSON file that is used as input for the transform.
     #   @return [String]
     #
     # @!attribute [rw] mapping_template
@@ -1544,9 +1543,9 @@ module Aws::B2bi
       include Aws::Structure
     end
 
-    # Contains the details for a transformer object. Transformers describe
-    # how to process the incoming EDI (electronic data interchange)
-    # documents, and extract the necessary information.
+    # Contains the details for a transformer object. A transformer describes
+    # how to process the incoming EDI documents and extract the necessary
+    # information to the output file.
     #
     # @!attribute [rw] transformer_id
     #   Returns the system-assigned unique identifier for the transformer.
@@ -2027,6 +2026,12 @@ module Aws::B2bi
     # structure is used when the system transforms an EDI (electronic data
     # interchange) file.
     #
+    # <note markdown="1"> If an EDI input file contains more than one transaction, each
+    # transaction must have the same transaction set and version, for
+    # example 214/4010. If not, the transformer cannot parse the file.
+    #
+    #  </note>
+    #
     # @!attribute [rw] transaction_set
     #   Returns an enumerated type where each value identifies an X12
     #   transaction set. Transaction sets are maintained by the X12

data/lib/aws-sdk-b2bi.rb

@@ -52,6 +52,6 @@ require_relative 'aws-sdk-b2bi/customizations'
 # @!group service
 module Aws::B2bi
 
-  GEM_VERSION = '1.1.0'
+  GEM_VERSION = '1.2.0'
 
 end

metadata

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