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.
447 448 449 |
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/client.rb', line 447 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.
628 629 630 631 |
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/client.rb', line 628 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.
746 747 748 749 |
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/client.rb', line 746 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.
857 858 859 860 |
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/client.rb', line 857 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.
990 991 992 993 |
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/client.rb', line 990 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.
1021 1022 1023 1024 |
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/client.rb', line 1021 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.
1052 1053 1054 1055 |
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/client.rb', line 1052 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.
1082 1083 1084 1085 |
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/client.rb', line 1082 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.
1113 1114 1115 1116 |
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/client.rb', line 1113 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.
1207 1208 1209 1210 |
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/client.rb', line 1207 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.
1280 1281 1282 1283 |
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/client.rb', line 1280 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.
1348 1349 1350 1351 |
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/client.rb', line 1348 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.
1423 1424 1425 1426 |
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/client.rb', line 1423 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.
1483 1484 1485 1486 |
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/client.rb', line 1483 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.
1552 1553 1554 1555 |
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/client.rb', line 1552 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.
1634 1635 1636 1637 |
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/client.rb', line 1634 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.
1705 1706 1707 1708 |
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/client.rb', line 1705 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.
1756 1757 1758 1759 |
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/client.rb', line 1756 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.
1838 1839 1840 1841 |
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/client.rb', line 1838 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.
1917 1918 1919 1920 |
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/client.rb', line 1917 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.
1969 1970 1971 1972 |
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/client.rb', line 1969 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.
2025 2026 2027 2028 |
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/client.rb', line 2025 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.
2097 2098 2099 2100 |
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/client.rb', line 2097 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.
2139 2140 2141 2142 |
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/client.rb', line 2139 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.
2296 2297 2298 2299 |
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/client.rb', line 2296 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.
2381 2382 2383 2384 |
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/client.rb', line 2381 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.
2469 2470 2471 2472 |
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/client.rb', line 2469 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.
2591 2592 2593 2594 |
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/client.rb', line 2591 def update_transformer(params = {}, = {}) req = build_request(:update_transformer, params) req.send_request() end |