Class: Aws::B2bi::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::B2bi::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/client.rb
Overview
An API client for B2bi. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::B2bi::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#create_capability(params = {}) ⇒ Types::CreateCapabilityResponse
Instantiates a capability based on the specified parameters.
-
#create_partnership(params = {}) ⇒ Types::CreatePartnershipResponse
Creates a partnership between a customer and a trading partner, based on the supplied parameters.
-
#create_profile(params = {}) ⇒ Types::CreateProfileResponse
Creates a customer profile.
-
#create_transformer(params = {}) ⇒ Types::CreateTransformerResponse
Creates a transformer.
-
#delete_capability(params = {}) ⇒ Struct
Deletes the specified capability.
-
#delete_partnership(params = {}) ⇒ Struct
Deletes the specified partnership.
-
#delete_profile(params = {}) ⇒ Struct
Deletes the specified profile.
-
#delete_transformer(params = {}) ⇒ Struct
Deletes the specified transformer.
-
#get_capability(params = {}) ⇒ Types::GetCapabilityResponse
Retrieves the details for the specified capability.
-
#get_partnership(params = {}) ⇒ Types::GetPartnershipResponse
Retrieves the details for a partnership, based on the partner and profile IDs specified.
-
#get_profile(params = {}) ⇒ Types::GetProfileResponse
Retrieves the details for the profile specified by the profile ID.
-
#get_transformer(params = {}) ⇒ Types::GetTransformerResponse
Retrieves the details for the transformer specified by the transformer ID.
-
#get_transformer_job(params = {}) ⇒ Types::GetTransformerJobResponse
Returns the details of the transformer run, based on the Transformer job ID.
-
#list_capabilities(params = {}) ⇒ Types::ListCapabilitiesResponse
Lists the capabilities associated with your Amazon Web Services account for your current or specified region.
-
#list_partnerships(params = {}) ⇒ Types::ListPartnershipsResponse
Lists the partnerships associated with your Amazon Web Services account for your current or specified region.
-
#list_profiles(params = {}) ⇒ Types::ListProfilesResponse
Lists the profiles associated with your Amazon Web Services account for your current or specified region.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify.
-
#list_transformers(params = {}) ⇒ Types::ListTransformersResponse
Lists the available transformers.
-
#start_transformer_job(params = {}) ⇒ Types::StartTransformerJobResponse
Runs a job, using a transformer, to parse input EDI (electronic data interchange) file into the output structures used by Amazon Web Services B2BI Data Interchange.
-
#tag_resource(params = {}) ⇒ Struct
Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN).
-
#test_mapping(params = {}) ⇒ Types::TestMappingResponse
Maps the input file according to the provided template file.
-
#test_parsing(params = {}) ⇒ Types::TestParsingResponse
Parses the input EDI (electronic data interchange) file.
-
#untag_resource(params = {}) ⇒ Struct
Detaches a key-value pair from the specified resource, as identified by its Amazon Resource Name (ARN).
-
#update_capability(params = {}) ⇒ Types::UpdateCapabilityResponse
Updates some of the parameters for a capability, based on the specified parameters.
-
#update_partnership(params = {}) ⇒ Types::UpdatePartnershipResponse
Updates some of the parameters for a partnership between a customer and trading partner.
-
#update_profile(params = {}) ⇒ Types::UpdateProfileResponse
Updates the specified parameters for a profile.
-
#update_transformer(params = {}) ⇒ Types::UpdateTransformerResponse
Updates the specified parameters for a transformer.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
420 421 422 |
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/client.rb', line 420 def initialize(*args) super end |
Instance Method Details
#create_capability(params = {}) ⇒ Types::CreateCapabilityResponse
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.
601 602 603 604 |
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/client.rb', line 601 def create_capability(params = {}, = {}) req = build_request(:create_capability, params) req.send_request() end |
#create_partnership(params = {}) ⇒ Types::CreatePartnershipResponse
Creates a partnership between a customer and a trading partner, based 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.
719 720 721 722 |
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/client.rb', line 719 def create_partnership(params = {}, = {}) req = build_request(:create_partnership, params) req.send_request() end |
#create_profile(params = {}) ⇒ Types::CreateProfileResponse
Creates a customer profile. You can have up to five customer profiles, each representing a distinct private network. A profile is the mechanism used to create the concept of a private network.
830 831 832 833 |
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/client.rb', line 830 def create_profile(params = {}, = {}) req = build_request(:create_profile, params) req.send_request() end |
#create_transformer(params = {}) ⇒ Types::CreateTransformerResponse
Creates a transformer. A transformer describes how to process the incoming EDI documents and extract the necessary information to the output file.
963 964 965 966 |
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/client.rb', line 963 def create_transformer(params = {}, = {}) req = build_request(:create_transformer, params) req.send_request() end |
#delete_capability(params = {}) ⇒ Struct
Deletes the specified capability. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.
994 995 996 997 |
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/client.rb', line 994 def delete_capability(params = {}, = {}) req = build_request(:delete_capability, params) req.send_request() end |
#delete_partnership(params = {}) ⇒ Struct
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.
1025 1026 1027 1028 |
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/client.rb', line 1025 def delete_partnership(params = {}, = {}) req = build_request(:delete_partnership, params) req.send_request() end |
#delete_profile(params = {}) ⇒ Struct
Deletes the specified profile. A profile is the mechanism used to create the concept of a private network.
1055 1056 1057 1058 |
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/client.rb', line 1055 def delete_profile(params = {}, = {}) req = build_request(:delete_profile, params) req.send_request() end |
#delete_transformer(params = {}) ⇒ Struct
Deletes the specified transformer. A transformer describes how to process the incoming EDI documents and extract the necessary information to the output file.
1086 1087 1088 1089 |
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/client.rb', line 1086 def delete_transformer(params = {}, = {}) req = build_request(:delete_transformer, params) req.send_request() end |
#get_capability(params = {}) ⇒ Types::GetCapabilityResponse
Retrieves the details for the specified capability. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.
1180 1181 1182 1183 |
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/client.rb', line 1180 def get_capability(params = {}, = {}) req = build_request(:get_capability, params) req.send_request() end |
#get_partnership(params = {}) ⇒ Types::GetPartnershipResponse
Retrieves the details for a partnership, based on the partner and 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.
1253 1254 1255 1256 |
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/client.rb', line 1253 def get_partnership(params = {}, = {}) req = build_request(:get_partnership, params) req.send_request() end |
#get_profile(params = {}) ⇒ Types::GetProfileResponse
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.
1321 1322 1323 1324 |
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/client.rb', line 1321 def get_profile(params = {}, = {}) req = build_request(:get_profile, params) req.send_request() end |
#get_transformer(params = {}) ⇒ Types::GetTransformerResponse
Retrieves the details for the transformer specified by the transformer ID. A transformer describes how to process the incoming EDI documents and extract the necessary information to the output file.
1396 1397 1398 1399 |
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/client.rb', line 1396 def get_transformer(params = {}, = {}) req = build_request(:get_transformer, params) req.send_request() end |
#get_transformer_job(params = {}) ⇒ Types::GetTransformerJobResponse
Returns the details of the transformer run, based on the Transformer job ID.
1456 1457 1458 1459 |
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/client.rb', line 1456 def get_transformer_job(params = {}, = {}) req = build_request(:get_transformer_job, params) req.send_request() end |
#list_capabilities(params = {}) ⇒ Types::ListCapabilitiesResponse
Lists the capabilities associated with your Amazon Web Services account for your current or specified region. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1525 1526 1527 1528 |
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/client.rb', line 1525 def list_capabilities(params = {}, = {}) req = build_request(:list_capabilities, params) req.send_request() end |
#list_partnerships(params = {}) ⇒ Types::ListPartnershipsResponse
Lists the partnerships associated with your Amazon Web Services 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1607 1608 1609 1610 |
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/client.rb', line 1607 def list_partnerships(params = {}, = {}) req = build_request(:list_partnerships, params) req.send_request() end |
#list_profiles(params = {}) ⇒ Types::ListProfilesResponse
Lists the profiles associated with your Amazon Web Services account for your current or specified region. A profile is the mechanism used to create the concept of a private network.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1678 1679 1680 1681 |
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/client.rb', line 1678 def list_profiles(params = {}, = {}) req = build_request(:list_profiles, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify. The resource can be a capability, partnership, profile, or transformer.
1729 1730 1731 1732 |
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/client.rb', line 1729 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#list_transformers(params = {}) ⇒ Types::ListTransformersResponse
Lists the available transformers. A transformer describes how to process the incoming EDI documents and extract the necessary information to the output file.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1811 1812 1813 1814 |
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/client.rb', line 1811 def list_transformers(params = {}, = {}) req = build_request(:list_transformers, params) req.send_request() end |
#start_transformer_job(params = {}) ⇒ Types::StartTransformerJobResponse
Runs a job, using a transformer, to parse input EDI (electronic data 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.
1890 1891 1892 1893 |
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/client.rb', line 1890 def start_transformer_job(params = {}, = {}) req = build_request(:start_transformer_job, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Resources are capability, partnership, profile, transformers and other entities.
There is no response returned from this call.
1942 1943 1944 1945 |
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/client.rb', line 1942 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#test_mapping(params = {}) ⇒ Types::TestMappingResponse
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.
1998 1999 2000 2001 |
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/client.rb', line 1998 def test_mapping(params = {}, = {}) req = build_request(:test_mapping, params) req.send_request() end |
#test_parsing(params = {}) ⇒ Types::TestParsingResponse
Parses the input EDI (electronic data interchange) file. The input file has a file size limit of 250 KB.
2070 2071 2072 2073 |
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/client.rb', line 2070 def test_parsing(params = {}, = {}) req = build_request(:test_parsing, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Detaches a key-value pair from the specified resource, as identified by its Amazon Resource Name (ARN). Resources are capability, partnership, profile, transformers and other entities.
2112 2113 2114 2115 |
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/client.rb', line 2112 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_capability(params = {}) ⇒ Types::UpdateCapabilityResponse
Updates some of the parameters for a capability, based on the specified parameters. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.
2269 2270 2271 2272 |
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/client.rb', line 2269 def update_capability(params = {}, = {}) req = build_request(:update_capability, params) req.send_request() end |
#update_partnership(params = {}) ⇒ Types::UpdatePartnershipResponse
Updates some of the parameters for a partnership between a customer 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.
2354 2355 2356 2357 |
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/client.rb', line 2354 def update_partnership(params = {}, = {}) req = build_request(:update_partnership, params) req.send_request() end |
#update_profile(params = {}) ⇒ Types::UpdateProfileResponse
Updates the specified parameters for a profile. A profile is the mechanism used to create the concept of a private network.
2442 2443 2444 2445 |
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/client.rb', line 2442 def update_profile(params = {}, = {}) req = build_request(:update_profile, params) req.send_request() end |
#update_transformer(params = {}) ⇒ Types::UpdateTransformerResponse
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.
2564 2565 2566 2567 |
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/client.rb', line 2564 def update_transformer(params = {}, = {}) req = build_request(:update_transformer, params) req.send_request() end |