Struct aws_sdk_b2bi::Client

pub struct Client { /* private fields */ }

Client for AWS B2B Data Interchange

Client for invoking operations on AWS B2B Data Interchange. Each operation on AWS B2B Data Interchange is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_b2bi::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Config struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_b2bi::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the GetTransformerJob operation has a Client::get_transformer_job, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.get_transformer_job()
    .transformer_job_id("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn create_capability(&self) -> CreateCapabilityFluentBuilder

Constructs a fluent builder for the CreateCapability operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    Specifies the name of the capability, used to identify it.

    
    
  • r#type(CapabilityType) / set_type(Option<CapabilityType>):
    required: true
    

    Specifies the type of the capability. Currently, only edi is supported.

    
    
  • configuration(CapabilityConfiguration) / set_configuration(Option<CapabilityConfiguration>):
    required: true
    

    Specifies a structure that contains the details for a capability.

    
    
  • instructions_documents(S3Location) / set_instructions_documents(Option<Vec::<S3Location>>):
    required: false
    

    Specifies one or more locations in Amazon S3, each specifying an EDI document that can be used with this capability. Each item contains the name of the bucket and the key, to identify the document’s location.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    Reserved for future use.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Specifies the key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to resources (capabilities, partnerships, and so on) for any purpose.

    
    
• On success, responds with CreateCapabilityOutput with field(s):
  • capability_id(String):

    Returns a system-assigned unique identifier for the capability.

  • capability_arn(String):

    Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.

  • name(String):

    Returns the name of the capability used to identify it.

  • r#type(CapabilityType):

    Returns the type of the capability. Currently, only edi is supported.

  • configuration(Option<CapabilityConfiguration>):

    Returns a structure that contains the details for a capability.

  • instructions_documents(Option<Vec::<S3Location>>):

    Returns one or more locations in Amazon S3, each specifying an EDI document that can be used with this capability. Each item contains the name of the bucket and the key, to identify the document’s location.

  • created_at(DateTime):

    Returns a timestamp for creation date and time of the capability.

• On failure, responds with SdkError<CreateCapabilityError>

impl Client

pub fn create_partnership(&self) -> CreatePartnershipFluentBuilder

Constructs a fluent builder for the CreatePartnership operation.

• The fluent builder is configurable:
  • profile_id(impl Into<String>) / set_profile_id(Option<String>):
    required: true
    

    Specifies the unique, system-generated identifier for the profile connected to this partnership.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    Specifies a descriptive name for the partnership.

    
    
  • email(impl Into<String>) / set_email(Option<String>):
    required: true
    

    Specifies the email address associated with this trading partner.

    
    
  • phone(impl Into<String>) / set_phone(Option<String>):
    required: false
    

    Specifies the phone number associated with the partnership.

    
    
  • capabilities(impl Into<String>) / set_capabilities(Option<Vec::<String>>):
    required: false
    

    Specifies a list of the capabilities associated with this partnership.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    Reserved for future use.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Specifies the key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to resources (capabilities, partnerships, and so on) for any purpose.

    
    
• On success, responds with CreatePartnershipOutput with field(s):
  • profile_id(String):

    Returns the unique, system-generated identifier for the profile connected to this partnership.

  • partnership_id(String):

    Returns the unique, system-generated identifier for a partnership.

  • partnership_arn(String):

    Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.

  • name(Option<String>):

    Returns a descriptive name for the partnership.

  • email(Option<String>):

    Returns the email address associated with this trading partner.

  • phone(Option<String>):

    Returns the phone number associated with the partnership.

  • capabilities(Option<Vec::<String>>):

    Returns one or more capabilities associated with this partnership.

  • trading_partner_id(Option<String>):

    Returns the unique, system-generated identifier for a trading partner.

  • created_at(DateTime):

    Returns a timestamp for creation date and time of the partnership.

• On failure, responds with SdkError<CreatePartnershipError>

impl Client

pub fn create_profile(&self) -> CreateProfileFluentBuilder

Constructs a fluent builder for the CreateProfile operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    Specifies the name of the profile.

    
    
  • email(impl Into<String>) / set_email(Option<String>):
    required: false
    

    Specifies the email address associated with this customer profile.

    
    
  • phone(impl Into<String>) / set_phone(Option<String>):
    required: true
    

    Specifies the phone number associated with the profile.

    
    
  • business_name(impl Into<String>) / set_business_name(Option<String>):
    required: true
    

    Specifies the name for the business associated with this profile.

    
    
  • logging(Logging) / set_logging(Option<Logging>):
    required: true
    

    Specifies whether or not logging is enabled for this profile.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    Reserved for future use.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Specifies the key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to resources (capabilities, partnerships, and so on) for any purpose.

    
    
• On success, responds with CreateProfileOutput with field(s):
  • profile_id(String):

    Returns the unique, system-generated identifier for the profile.

  • profile_arn(String):

    Returns an Amazon Resource Name (ARN) for the profile.

  • name(String):

    Returns the name of the profile, used to identify it.

  • business_name(String):

    Returns the name for the business associated with this profile.

  • phone(String):

    Returns the phone number associated with the profile.

  • email(Option<String>):

    Returns the email address associated with this customer profile.

  • logging(Option<Logging>):

    Returns whether or not logging is turned on for this profile.

  • log_group_name(Option<String>):

    Returns the name of the logging group.

  • created_at(DateTime):

    Returns a timestamp representing the time the profile was created.

• On failure, responds with SdkError<CreateProfileError>

impl Client

pub fn create_transformer(&self) -> CreateTransformerFluentBuilder

Constructs a fluent builder for the CreateTransformer operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    Specifies the name of the transformer, used to identify it.

    
    
  • file_format(FileFormat) / set_file_format(Option<FileFormat>):
    required: true
    

    Specifies that the currently supported file formats for EDI transformations are JSON and XML.

    
    
  • mapping_template(impl Into<String>) / set_mapping_template(Option<String>):
    required: true
    

    Specifies the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.

    
    
  • edi_type(EdiType) / set_edi_type(Option<EdiType>):
    required: true
    

    Specifies the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.

    
    
  • sample_document(impl Into<String>) / set_sample_document(Option<String>):
    required: false
    

    Specifies a sample EDI document that is used by a transformer as a guide for processing the EDI data.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    Reserved for future use.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Specifies the key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to resources (capabilities, partnerships, and so on) for any purpose.

    
    
• On success, responds with CreateTransformerOutput with field(s):
  • transformer_id(String):

    Returns the system-assigned unique identifier for the transformer.

  • transformer_arn(String):

    Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.

  • name(String):

    Returns the name of the transformer, used to identify it.

  • file_format(FileFormat):

    Returns that the currently supported file formats for EDI transformations are JSON and XML.

  • mapping_template(String):

    Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.

  • status(TransformerStatus):

    Returns the state of the newly created transformer. The transformer can be either active or inactive. For the transformer to be used in a capability, its status must active.

  • edi_type(Option<EdiType>):

    Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.

  • sample_document(Option<String>):

    Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.

  • created_at(DateTime):

    Returns a timestamp for creation date and time of the transformer.

• On failure, responds with SdkError<CreateTransformerError>

impl Client

pub fn delete_capability(&self) -> DeleteCapabilityFluentBuilder

Constructs a fluent builder for the DeleteCapability operation.

• The fluent builder is configurable:
  • capability_id(impl Into<String>) / set_capability_id(Option<String>):
    required: true
    

    Specifies a system-assigned unique identifier for the capability.

    
    
• On success, responds with DeleteCapabilityOutput
• On failure, responds with SdkError<DeleteCapabilityError>

impl Client

pub fn delete_partnership(&self) -> DeletePartnershipFluentBuilder

Constructs a fluent builder for the DeletePartnership operation.

• The fluent builder is configurable:
  • partnership_id(impl Into<String>) / set_partnership_id(Option<String>):
    required: true
    

    Specifies the unique, system-generated identifier for a partnership.

    
    
• On success, responds with DeletePartnershipOutput
• On failure, responds with SdkError<DeletePartnershipError>

impl Client

pub fn delete_profile(&self) -> DeleteProfileFluentBuilder

Constructs a fluent builder for the DeleteProfile operation.

• The fluent builder is configurable:
  • profile_id(impl Into<String>) / set_profile_id(Option<String>):
    required: true
    

    Specifies the unique, system-generated identifier for the profile.

    
    
• On success, responds with DeleteProfileOutput
• On failure, responds with SdkError<DeleteProfileError>

impl Client

pub fn delete_transformer(&self) -> DeleteTransformerFluentBuilder

Constructs a fluent builder for the DeleteTransformer operation.

• The fluent builder is configurable:
  • transformer_id(impl Into<String>) / set_transformer_id(Option<String>):
    required: true
    

    Specifies the system-assigned unique identifier for the transformer.

    
    
• On success, responds with DeleteTransformerOutput
• On failure, responds with SdkError<DeleteTransformerError>

impl Client

pub fn get_capability(&self) -> GetCapabilityFluentBuilder

Constructs a fluent builder for the GetCapability operation.

• The fluent builder is configurable:
  • capability_id(impl Into<String>) / set_capability_id(Option<String>):
    required: true
    

    Specifies a system-assigned unique identifier for the capability.

    
    
• On success, responds with GetCapabilityOutput with field(s):
  • capability_id(String):

    Returns a system-assigned unique identifier for the capability.

  • capability_arn(String):

    Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.

  • name(String):

    Returns the name of the capability, used to identify it.

  • r#type(CapabilityType):

    Returns the type of the capability. Currently, only edi is supported.

  • configuration(Option<CapabilityConfiguration>):

    Returns a structure that contains the details for a capability.

  • instructions_documents(Option<Vec::<S3Location>>):

    Returns one or more locations in Amazon S3, each specifying an EDI document that can be used with this capability. Each item contains the name of the bucket and the key, to identify the document’s location.

  • created_at(DateTime):

    Returns a timestamp for creation date and time of the capability.

  • modified_at(Option<DateTime>):

    Returns a timestamp for last time the capability was modified.

• On failure, responds with SdkError<GetCapabilityError>

impl Client

pub fn get_partnership(&self) -> GetPartnershipFluentBuilder

Constructs a fluent builder for the GetPartnership operation.

• The fluent builder is configurable:
  • partnership_id(impl Into<String>) / set_partnership_id(Option<String>):
    required: true
    

    Specifies the unique, system-generated identifier for a partnership.

    
    
• On success, responds with GetPartnershipOutput with field(s):
  • profile_id(String):

    Returns the unique, system-generated identifier for the profile connected to this partnership.

  • partnership_id(String):

    Returns the unique, system-generated identifier for a partnership.

  • partnership_arn(String):

    Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.

  • name(Option<String>):

    Returns the display name of the partnership

  • email(Option<String>):

    Returns the email address associated with this trading partner.

  • phone(Option<String>):

    Returns the phone number associated with the partnership.

  • capabilities(Option<Vec::<String>>):

    Returns one or more capabilities associated with this partnership.

  • trading_partner_id(Option<String>):

    Returns the unique identifier for the partner for this partnership.

  • created_at(DateTime):

    Returns a timestamp for creation date and time of the partnership.

  • modified_at(Option<DateTime>):

    Returns a timestamp that identifies the most recent date and time that the partnership was modified.

• On failure, responds with SdkError<GetPartnershipError>

impl Client

pub fn get_profile(&self) -> GetProfileFluentBuilder

Constructs a fluent builder for the GetProfile operation.

• The fluent builder is configurable:
  • profile_id(impl Into<String>) / set_profile_id(Option<String>):
    required: true
    

    Specifies the unique, system-generated identifier for the profile.

    
    
• On success, responds with GetProfileOutput with field(s):
  • profile_id(String):

    Returns the unique, system-generated identifier for the profile.

  • profile_arn(String):

    Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.

  • name(String):

    Returns the name of the profile, used to identify it.

  • email(Option<String>):

    Returns the email address associated with this customer profile.

  • phone(String):

    Returns the phone number associated with the profile.

  • business_name(String):

    Returns the name for the business associated with this profile.

  • logging(Option<Logging>):

    Returns whether or not logging is enabled for this profile.

  • log_group_name(Option<String>):

    Returns the name of the logging group.

  • created_at(DateTime):

    Returns a timestamp for creation date and time of the transformer.

  • modified_at(Option<DateTime>):

    Returns a timestamp for last time the profile was modified.

• On failure, responds with SdkError<GetProfileError>

impl Client

pub fn get_transformer(&self) -> GetTransformerFluentBuilder

Constructs a fluent builder for the GetTransformer operation.

• The fluent builder is configurable:
  • transformer_id(impl Into<String>) / set_transformer_id(Option<String>):
    required: true
    

    Specifies the system-assigned unique identifier for the transformer.

    
    
• On success, responds with GetTransformerOutput with field(s):
  • transformer_id(String):

    Returns the system-assigned unique identifier for the transformer.

  • transformer_arn(String):

    Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.

  • name(String):

    Returns the name of the transformer, used to identify it.

  • file_format(FileFormat):

    Returns that the currently supported file formats for EDI transformations are JSON and XML.

  • mapping_template(String):

    Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.

  • status(TransformerStatus):

    Returns the state of the newly created transformer. The transformer can be either active or inactive. For the transformer to be used in a capability, its status must active.

  • edi_type(Option<EdiType>):

    Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.

  • sample_document(Option<String>):

    Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.

  • created_at(DateTime):

    Returns a timestamp for creation date and time of the transformer.

  • modified_at(Option<DateTime>):

    Returns a timestamp for last time the transformer was modified.

• On failure, responds with SdkError<GetTransformerError>

impl Client

pub fn get_transformer_job(&self) -> GetTransformerJobFluentBuilder

Constructs a fluent builder for the GetTransformerJob operation.

• The fluent builder is configurable:
  • transformer_job_id(impl Into<String>) / set_transformer_job_id(Option<String>):
    required: true
    

    Specifies the unique, system-generated identifier for a transformer run.

    
    
  • transformer_id(impl Into<String>) / set_transformer_id(Option<String>):
    required: true
    

    Specifies the system-assigned unique identifier for the transformer.

    
    
• On success, responds with GetTransformerJobOutput with field(s):
  • status(TransformerJobStatus):

    Returns the current state of the transformer job, either running, succeeded, or failed.

  • output_files(Option<Vec::<S3Location>>):

    Returns the location for the output files. If the caller specified a directory for the output, then this contains the full path to the output file, including the file name generated by the service.

  • message(Option<String>):

    Returns an optional error message, which gets populated when the job is not run successfully.

• On failure, responds with SdkError<GetTransformerJobError>

impl Client

pub fn list_capabilities(&self) -> ListCapabilitiesFluentBuilder

Constructs a fluent builder for the ListCapabilities operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    When additional results are obtained from the command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional resources.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    Specifies the maximum number of capabilities to return.

    
    
• On success, responds with ListCapabilitiesOutput with field(s):
  • capabilities(Vec::<CapabilitySummary>):

    Returns one or more capabilities associated with this partnership.

  • next_token(Option<String>):

    When additional results are obtained from the command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional resources.

• On failure, responds with SdkError<ListCapabilitiesError>

impl Client

pub fn list_partnerships(&self) -> ListPartnershipsFluentBuilder

Constructs a fluent builder for the ListPartnerships operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • profile_id(impl Into<String>) / set_profile_id(Option<String>):
    required: false
    

    Specifies the unique, system-generated identifier for the profile connected to this partnership.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    When additional results are obtained from the command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional resources.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    Specifies the maximum number of capabilities to return.

    
    
• On success, responds with ListPartnershipsOutput with field(s):
  • partnerships(Vec::<PartnershipSummary>):

    Specifies a list of your partnerships.

  • next_token(Option<String>):

    When additional results are obtained from the command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional resources.

• On failure, responds with SdkError<ListPartnershipsError>

impl Client

pub fn list_profiles(&self) -> ListProfilesFluentBuilder

Constructs a fluent builder for the ListProfiles operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    When additional results are obtained from the command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional resources.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    Specifies the maximum number of profiles to return.

    
    
• On success, responds with ListProfilesOutput with field(s):
  • profiles(Vec::<ProfileSummary>):

    Returns an array of ProfileSummary objects.

  • next_token(Option<String>):

    When additional results are obtained from the command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional resources.

• On failure, responds with SdkError<ListProfilesError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    Requests the tags associated with a particular Amazon Resource Name (ARN). An ARN is an identifier for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Option<Vec::<Tag>>):

    Returns the key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to resources (capabilities, partnerships, and so on) for any purpose.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn list_transformers(&self) -> ListTransformersFluentBuilder

Constructs a fluent builder for the ListTransformers operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    When additional results are obtained from the command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional resources.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    Specifies the number of items to return for the API response.

    
    
• On success, responds with ListTransformersOutput with field(s):
  • transformers(Vec::<TransformerSummary>):

    Returns an array of one or more transformer objects.

    For each transformer, a TransformerSummary object is returned. The TransformerSummary contains all the details for a specific transformer.

  • next_token(Option<String>):

    When additional results are obtained from the command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional resources.

• On failure, responds with SdkError<ListTransformersError>

impl Client

pub fn start_transformer_job(&self) -> StartTransformerJobFluentBuilder

Constructs a fluent builder for the StartTransformerJob operation.

• The fluent builder is configurable:
  • input_file(S3Location) / set_input_file(Option<S3Location>):
    required: true
    

    Specifies the location of the input file for the transformation. The location consists of an Amazon S3 bucket and prefix.

    
    
  • output_location(S3Location) / set_output_location(Option<S3Location>):
    required: true
    

    Specifies the location of the output file for the transformation. The location consists of an Amazon S3 bucket and prefix.

    
    
  • transformer_id(impl Into<String>) / set_transformer_id(Option<String>):
    required: true
    

    Specifies the system-assigned unique identifier for the transformer.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    Reserved for future use.

    
    
• On success, responds with StartTransformerJobOutput with field(s):
  • transformer_job_id(String):

    Returns the unique, system-generated identifier for a transformer run.

• On failure, responds with SdkError<StartTransformerJobError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    Specifies an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: true
    

    Specifies the key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to resources (capabilities, partnerships, and so on) for any purpose.

    
    
• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

pub fn test_mapping(&self) -> TestMappingFluentBuilder

Constructs a fluent builder for the TestMapping operation.

• The fluent builder is configurable:
  • input_file_content(impl Into<String>) / set_input_file_content(Option<String>):
    required: true
    

    Specify the contents of the EDI (electronic data interchange) XML or JSON file that is used as input for the transform.

    
    
  • mapping_template(impl Into<String>) / set_mapping_template(Option<String>):
    required: true
    

    Specifies the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.

    
    
  • file_format(FileFormat) / set_file_format(Option<FileFormat>):
    required: true
    

    Specifies that the currently supported file formats for EDI transformations are JSON and XML.

    
    
• On success, responds with TestMappingOutput with field(s):
  • mapped_file_content(String):

    Returns a string for the mapping that can be used to identify the mapping. Similar to a fingerprint

• On failure, responds with SdkError<TestMappingError>

impl Client

pub fn test_parsing(&self) -> TestParsingFluentBuilder

Constructs a fluent builder for the TestParsing operation.

• The fluent builder is configurable:
  • input_file(S3Location) / set_input_file(Option<S3Location>):
    required: true
    

    Specifies an S3Location object, which contains the Amazon S3 bucket and prefix for the location of the input file.

    
    
  • file_format(FileFormat) / set_file_format(Option<FileFormat>):
    required: true
    

    Specifies that the currently supported file formats for EDI transformations are JSON and XML.

    
    
  • edi_type(EdiType) / set_edi_type(Option<EdiType>):
    required: true
    

    Specifies the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.

    
    
• On success, responds with TestParsingOutput with field(s):
  • parsed_file_content(String):

    Returns the contents of the input file being tested, parsed according to the specified EDI (electronic data interchange) type.

• On failure, responds with SdkError<TestParsingError>

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    Specifies an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    Specifies the key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to resources (capabilities, partnerships, and so on) for any purpose.

    
    
• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn update_capability(&self) -> UpdateCapabilityFluentBuilder

Constructs a fluent builder for the UpdateCapability operation.

• The fluent builder is configurable:
  • capability_id(impl Into<String>) / set_capability_id(Option<String>):
    required: true
    

    Specifies a system-assigned unique identifier for the capability.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    Specifies a new name for the capability, to replace the existing name.

    
    
  • configuration(CapabilityConfiguration) / set_configuration(Option<CapabilityConfiguration>):
    required: false
    

    Specifies a structure that contains the details for a capability.

    
    
  • instructions_documents(S3Location) / set_instructions_documents(Option<Vec::<S3Location>>):
    required: false
    

    Specifies one or more locations in Amazon S3, each specifying an EDI document that can be used with this capability. Each item contains the name of the bucket and the key, to identify the document’s location.

    
    
• On success, responds with UpdateCapabilityOutput with field(s):
  • capability_id(String):

    Returns a system-assigned unique identifier for the capability.

  • capability_arn(String):

    Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.

  • name(String):

    Returns the name of the capability, used to identify it.

  • r#type(CapabilityType):

    Returns the type of the capability. Currently, only edi is supported.

  • configuration(Option<CapabilityConfiguration>):

    Returns a structure that contains the details for a capability.

  • instructions_documents(Option<Vec::<S3Location>>):

    Returns one or more locations in Amazon S3, each specifying an EDI document that can be used with this capability. Each item contains the name of the bucket and the key, to identify the document’s location.

  • created_at(DateTime):

    Returns a timestamp for creation date and time of the capability.

  • modified_at(Option<DateTime>):

    Returns a timestamp for last time the capability was modified.

• On failure, responds with SdkError<UpdateCapabilityError>

impl Client

pub fn update_partnership(&self) -> UpdatePartnershipFluentBuilder

Constructs a fluent builder for the UpdatePartnership operation.

• The fluent builder is configurable:
  • partnership_id(impl Into<String>) / set_partnership_id(Option<String>):
    required: true
    

    Specifies the unique, system-generated identifier for a partnership.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The name of the partnership, used to identify it.

    
    
  • capabilities(impl Into<String>) / set_capabilities(Option<Vec::<String>>):
    required: false
    

    List of the capabilities associated with this partnership.

    
    
• On success, responds with UpdatePartnershipOutput with field(s):
  • profile_id(String):

    Returns the unique, system-generated identifier for the profile connected to this partnership.

  • partnership_id(String):

    Returns the unique, system-generated identifier for a partnership.

  • partnership_arn(String):

    Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.

  • name(Option<String>):

    The name of the partnership, used to identify it.

  • email(Option<String>):

    Returns the email address associated with this trading partner.

  • phone(Option<String>):

    Returns the phone number associated with the partnership.

  • capabilities(Option<Vec::<String>>):

    Returns one or more capabilities associated with this partnership.

  • trading_partner_id(Option<String>):

    Returns the unique, system-generated identifier for a trading partner.

  • created_at(DateTime):

    Returns a timestamp that identifies the most recent date and time that the partnership was modified.

  • modified_at(Option<DateTime>):

    Returns a timestamp that identifies the most recent date and time that the partnership was modified.

• On failure, responds with SdkError<UpdatePartnershipError>

impl Client

pub fn update_profile(&self) -> UpdateProfileFluentBuilder

Constructs a fluent builder for the UpdateProfile operation.

• The fluent builder is configurable:
  • profile_id(impl Into<String>) / set_profile_id(Option<String>):
    required: true
    

    Specifies the unique, system-generated identifier for the profile.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The name of the profile, used to identify it.

    
    
  • email(impl Into<String>) / set_email(Option<String>):
    required: false
    

    Specifies the email address associated with this customer profile.

    
    
  • phone(impl Into<String>) / set_phone(Option<String>):
    required: false
    

    Specifies the phone number associated with the profile.

    
    
  • business_name(impl Into<String>) / set_business_name(Option<String>):
    required: false
    

    Specifies the name for the business associated with this profile.

    
    
• On success, responds with UpdateProfileOutput with field(s):
  • profile_id(String):

    Returns the unique, system-generated identifier for the profile.

  • profile_arn(String):

    Returns an Amazon Resource Name (ARN) for the profile.

  • name(String):

    Returns the name of the profile.

  • email(Option<String>):

    Returns the email address associated with this customer profile.

  • phone(String):

    Returns the phone number associated with the profile.

  • business_name(String):

    Returns the name for the business associated with this profile.

  • logging(Option<Logging>):

    Specifies whether or not logging is enabled for this profile.

  • log_group_name(Option<String>):

    Returns the name of the logging group.

  • created_at(DateTime):

    Returns a timestamp for creation date and time of the profile.

  • modified_at(Option<DateTime>):

    Returns a timestamp for last time the profile was modified.

• On failure, responds with SdkError<UpdateProfileError>

impl Client

pub fn update_transformer(&self) -> UpdateTransformerFluentBuilder

Constructs a fluent builder for the UpdateTransformer operation.

• The fluent builder is configurable:
  • transformer_id(impl Into<String>) / set_transformer_id(Option<String>):
    required: true
    

    Specifies the system-assigned unique identifier for the transformer.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    Specify a new name for the transformer, if you want to update it.

    
    
  • file_format(FileFormat) / set_file_format(Option<FileFormat>):
    required: false
    

    Specifies that the currently supported file formats for EDI transformations are JSON and XML.

    
    
  • mapping_template(impl Into<String>) / set_mapping_template(Option<String>):
    required: false
    

    Specifies the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.

    
    
  • status(TransformerStatus) / set_status(Option<TransformerStatus>):
    required: false
    

    Specifies the transformer’s status. You can update the state of the transformer, from active to inactive, or inactive to active.

    
    
  • edi_type(EdiType) / set_edi_type(Option<EdiType>):
    required: false
    

    Specifies the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.

    
    
  • sample_document(impl Into<String>) / set_sample_document(Option<String>):
    required: false
    

    Specifies a sample EDI document that is used by a transformer as a guide for processing the EDI data.

    
    
• On success, responds with UpdateTransformerOutput with field(s):
  • transformer_id(String):

    Returns the system-assigned unique identifier for the transformer.

  • transformer_arn(String):

    Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.

  • name(String):

    Returns the name of the transformer.

  • file_format(FileFormat):

    Returns that the currently supported file formats for EDI transformations are JSON and XML.

  • mapping_template(String):

    Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.

  • status(TransformerStatus):

    Returns the state of the newly created transformer. The transformer can be either active or inactive. For the transformer to be used in a capability, its status must active.

  • edi_type(Option<EdiType>):

    Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.

  • sample_document(Option<String>):

    Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.

  • created_at(DateTime):

    Returns a timestamp for creation date and time of the transformer.

  • modified_at(DateTime):

    Returns a timestamp for last time the transformer was modified.

• On failure, responds with SdkError<UpdateTransformerError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.