EdiConfiguration edi
An EDI (electronic data interchange) configuration object.
String capabilityId
Returns a system-assigned unique identifier for the capability.
String name
The display name of the capability.
String type
Returns the type of the capability. Currently, only edi is supported.
Date createdAt
Returns a timestamp for creation date and time of the capability.
Date modifiedAt
Returns a timestamp that identifies the most recent date and time that the capability was modified.
String name
Specifies the name of the capability, used to identify it.
String type
Specifies the type of the capability. Currently, only edi is supported.
CapabilityConfiguration configuration
Specifies a structure that contains the details for a capability.
List<E> instructionsDocuments
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.
String clientToken
Reserved for future use.
List<E> tags
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.
String capabilityId
Returns a system-assigned unique identifier for the capability.
String capabilityArn
Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.
String name
Returns the name of the capability used to identify it.
String type
Returns the type of the capability. Currently, only edi is supported.
CapabilityConfiguration configuration
Returns a structure that contains the details for a capability.
List<E> instructionsDocuments
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.
Date createdAt
Returns a timestamp for creation date and time of the capability.
String profileId
Specifies the unique, system-generated identifier for the profile connected to this partnership.
String name
Specifies a descriptive name for the partnership.
String email
Specifies the email address associated with this trading partner.
String phone
Specifies the phone number associated with the partnership.
List<E> capabilities
Specifies a list of the capabilities associated with this partnership.
String clientToken
Reserved for future use.
List<E> tags
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.
String profileId
Returns the unique, system-generated identifier for the profile connected to this partnership.
String partnershipId
Returns the unique, system-generated identifier for a partnership.
String partnershipArn
Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.
String name
Returns a descriptive name for the partnership.
String email
Returns the email address associated with this trading partner.
String phone
Returns the phone number associated with the partnership.
List<E> capabilities
Returns one or more capabilities associated with this partnership.
String tradingPartnerId
Returns the unique, system-generated identifier for a trading partner.
Date createdAt
Returns a timestamp for creation date and time of the partnership.
String name
Specifies the name of the profile.
String email
Specifies the email address associated with this customer profile.
String phone
Specifies the phone number associated with the profile.
String businessName
Specifies the name for the business associated with this profile.
String logging
Specifies whether or not logging is enabled for this profile.
String clientToken
Reserved for future use.
List<E> tags
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.
String profileId
Returns the unique, system-generated identifier for the profile.
String profileArn
Returns an Amazon Resource Name (ARN) for the profile.
String name
Returns the name of the profile, used to identify it.
String businessName
Returns the name for the business associated with this profile.
String phone
Returns the phone number associated with the profile.
String email
Returns the email address associated with this customer profile.
String logging
Returns whether or not logging is turned on for this profile.
String logGroupName
Returns the name of the logging group.
Date createdAt
Returns a timestamp representing the time the profile was created.
String name
Specifies the name of the transformer, used to identify it.
String fileFormat
Specifies that the currently supported file formats for EDI transformations are JSON and
XML.
String mappingTemplate
Specifies the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
EdiType ediType
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.
String sampleDocument
Specifies a sample EDI document that is used by a transformer as a guide for processing the EDI data.
String clientToken
Reserved for future use.
List<E> tags
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.
String transformerId
Returns the system-assigned unique identifier for the transformer.
String transformerArn
Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.
String name
Returns the name of the transformer, used to identify it.
String fileFormat
Returns that the currently supported file formats for EDI transformations are JSON and
XML.
String mappingTemplate
Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
String status
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.
EdiType 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.
String sampleDocument
Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.
Date createdAt
Returns a timestamp for creation date and time of the transformer.
String capabilityId
Specifies a system-assigned unique identifier for the capability.
String partnershipId
Specifies the unique, system-generated identifier for a partnership.
String profileId
Specifies the unique, system-generated identifier for the profile.
String transformerId
Specifies the system-assigned unique identifier for the transformer.
EdiType type
Returns the type of the capability. Currently, only edi is supported.
S3Location inputLocation
Contains the Amazon S3 bucket and prefix for the location of the input file, which is contained in an
S3Location object.
S3Location outputLocation
Contains the Amazon S3 bucket and prefix for the location of the output file, which is contained in an
S3Location object.
String transformerId
Returns the system-assigned unique identifier for the transformer.
X12Details x12Details
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.
String capabilityId
Specifies a system-assigned unique identifier for the capability.
String capabilityId
Returns a system-assigned unique identifier for the capability.
String capabilityArn
Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.
String name
Returns the name of the capability, used to identify it.
String type
Returns the type of the capability. Currently, only edi is supported.
CapabilityConfiguration configuration
Returns a structure that contains the details for a capability.
List<E> instructionsDocuments
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.
Date createdAt
Returns a timestamp for creation date and time of the capability.
Date modifiedAt
Returns a timestamp for last time the capability was modified.
String partnershipId
Specifies the unique, system-generated identifier for a partnership.
String profileId
Returns the unique, system-generated identifier for the profile connected to this partnership.
String partnershipId
Returns the unique, system-generated identifier for a partnership.
String partnershipArn
Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.
String name
Returns the display name of the partnership
String email
Returns the email address associated with this trading partner.
String phone
Returns the phone number associated with the partnership.
List<E> capabilities
Returns one or more capabilities associated with this partnership.
String tradingPartnerId
Returns the unique identifier for the partner for this partnership.
Date createdAt
Returns a timestamp for creation date and time of the partnership.
Date modifiedAt
Returns a timestamp that identifies the most recent date and time that the partnership was modified.
String profileId
Specifies the unique, system-generated identifier for the profile.
String profileId
Returns the unique, system-generated identifier for the profile.
String profileArn
Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.
String name
Returns the name of the profile, used to identify it.
String email
Returns the email address associated with this customer profile.
String phone
Returns the phone number associated with the profile.
String businessName
Returns the name for the business associated with this profile.
String logging
Returns whether or not logging is enabled for this profile.
String logGroupName
Returns the name of the logging group.
Date createdAt
Returns a timestamp for creation date and time of the transformer.
Date modifiedAt
Returns a timestamp for last time the profile was modified.
String status
Returns the current state of the transformer job, either running, succeeded, or
failed.
List<E> outputFiles
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.
String message
Returns an optional error message, which gets populated when the job is not run successfully.
String transformerId
Specifies the system-assigned unique identifier for the transformer.
String transformerId
Returns the system-assigned unique identifier for the transformer.
String transformerArn
Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.
String name
Returns the name of the transformer, used to identify it.
String fileFormat
Returns that the currently supported file formats for EDI transformations are JSON and
XML.
String mappingTemplate
Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
String status
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.
EdiType 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.
String sampleDocument
Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.
Date createdAt
Returns a timestamp for creation date and time of the transformer.
Date modifiedAt
Returns a timestamp for last time the transformer was modified.
Integer retryAfterSeconds
The server attempts to retry a failed command.
String nextToken
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.
Integer maxResults
Specifies the maximum number of capabilities to return.
List<E> capabilities
Returns one or more capabilities associated with this partnership.
String nextToken
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.
String profileId
Specifies the unique, system-generated identifier for the profile connected to this partnership.
String nextToken
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.
Integer maxResults
Specifies the maximum number of capabilities to return.
List<E> partnerships
Specifies a list of your partnerships.
String nextToken
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.
String nextToken
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.
Integer maxResults
Specifies the maximum number of profiles to return.
List<E> profiles
Returns an array of ProfileSummary objects.
String nextToken
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.
String resourceARN
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.
String nextToken
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.
Integer maxResults
Specifies the number of items to return for the API response.
List<E> transformers
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.
String nextToken
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.
String profileId
Returns the unique, system-generated identifier for the profile connected to this partnership.
String partnershipId
Returns the unique, system-generated identifier for a partnership.
String name
Returns the name of the partnership.
List<E> capabilities
Returns one or more capabilities associated with this partnership.
String tradingPartnerId
Returns the unique, system-generated identifier for a trading partner.
Date createdAt
Returns a timestamp for creation date and time of the partnership.
Date modifiedAt
Returns a timestamp that identifies the most recent date and time that the partnership was modified.
String profileId
Returns the unique, system-generated identifier for the profile.
String name
Returns the display name for profile.
String businessName
Returns the name for the business associated with this profile.
String logging
Specifies whether or not logging is enabled for this profile.
String logGroupName
Returns the name of the logging group.
Date createdAt
Returns the timestamp for creation date and time of the profile.
Date modifiedAt
Returns the timestamp that identifies the most recent date and time that the profile was modified.
String resourceId
The ID for the resource that exceeded the quota, which caused the exception.
String resourceType
The resource type (profile, partnership, transformer, or capability) that exceeded the quota, which caused the exception.
String serviceCode
The code responsible for exceeding the quota, which caused the exception.
String quotaCode
The quota that was exceeded, which caused the exception.
S3Location inputFile
Specifies the location of the input file for the transformation. The location consists of an Amazon S3 bucket and prefix.
S3Location outputLocation
Specifies the location of the output file for the transformation. The location consists of an Amazon S3 bucket and prefix.
String transformerId
Specifies the system-assigned unique identifier for the transformer.
String clientToken
Reserved for future use.
String transformerJobId
Returns the unique, system-generated identifier for a transformer run.
String resourceARN
Specifies an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.
List<E> tags
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.
String inputFileContent
Specify the contents of the EDI (electronic data interchange) XML or JSON file that is used as input for the transform.
String mappingTemplate
Specifies the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
String fileFormat
Specifies that the currently supported file formats for EDI transformations are JSON and
XML.
String mappedFileContent
Returns a string for the mapping that can be used to identify the mapping. Similar to a fingerprint
S3Location inputFile
Specifies an S3Location object, which contains the Amazon S3 bucket and prefix for the location of
the input file.
String fileFormat
Specifies that the currently supported file formats for EDI transformations are JSON and
XML.
EdiType ediType
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.
String parsedFileContent
Returns the contents of the input file being tested, parsed according to the specified EDI (electronic data interchange) type.
Integer retryAfterSeconds
The server attempts to retry a command that was throttled.
String transformerId
Returns the system-assigned unique identifier for the transformer.
String name
Returns the descriptive name for the transformer.
String fileFormat
Returns that the currently supported file formats for EDI transformations are JSON and
XML.
String mappingTemplate
Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
String status
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.
EdiType 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.
String sampleDocument
Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.
Date createdAt
Returns a timestamp indicating when the transformer was created. For example,
2023-07-20T19:58:44.624Z.
Date modifiedAt
Returns a timestamp representing the date and time for the most recent change for the transformer object.
String resourceARN
Specifies an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.
List<E> tagKeys
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.
String capabilityId
Specifies a system-assigned unique identifier for the capability.
String name
Specifies a new name for the capability, to replace the existing name.
CapabilityConfiguration configuration
Specifies a structure that contains the details for a capability.
List<E> instructionsDocuments
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.
String capabilityId
Returns a system-assigned unique identifier for the capability.
String capabilityArn
Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.
String name
Returns the name of the capability, used to identify it.
String type
Returns the type of the capability. Currently, only edi is supported.
CapabilityConfiguration configuration
Returns a structure that contains the details for a capability.
List<E> instructionsDocuments
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.
Date createdAt
Returns a timestamp for creation date and time of the capability.
Date modifiedAt
Returns a timestamp for last time the capability was modified.
String profileId
Returns the unique, system-generated identifier for the profile connected to this partnership.
String partnershipId
Returns the unique, system-generated identifier for a partnership.
String partnershipArn
Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.
String name
The name of the partnership, used to identify it.
String email
Returns the email address associated with this trading partner.
String phone
Returns the phone number associated with the partnership.
List<E> capabilities
Returns one or more capabilities associated with this partnership.
String tradingPartnerId
Returns the unique, system-generated identifier for a trading partner.
Date createdAt
Returns a timestamp that identifies the most recent date and time that the partnership was modified.
Date modifiedAt
Returns a timestamp that identifies the most recent date and time that the partnership was modified.
String profileId
Specifies the unique, system-generated identifier for the profile.
String name
The name of the profile, used to identify it.
String email
Specifies the email address associated with this customer profile.
String phone
Specifies the phone number associated with the profile.
String businessName
Specifies the name for the business associated with this profile.
String profileId
Returns the unique, system-generated identifier for the profile.
String profileArn
Returns an Amazon Resource Name (ARN) for the profile.
String name
Returns the name of the profile.
String email
Returns the email address associated with this customer profile.
String phone
Returns the phone number associated with the profile.
String businessName
Returns the name for the business associated with this profile.
String logging
Specifies whether or not logging is enabled for this profile.
String logGroupName
Returns the name of the logging group.
Date createdAt
Returns a timestamp for creation date and time of the profile.
Date modifiedAt
Returns a timestamp for last time the profile was modified.
String transformerId
Specifies the system-assigned unique identifier for the transformer.
String name
Specify a new name for the transformer, if you want to update it.
String fileFormat
Specifies that the currently supported file formats for EDI transformations are JSON and
XML.
String mappingTemplate
Specifies the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
String status
Specifies the transformer's status. You can update the state of the transformer, from active to
inactive, or inactive to active.
EdiType ediType
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.
String sampleDocument
Specifies a sample EDI document that is used by a transformer as a guide for processing the EDI data.
String transformerId
Returns the system-assigned unique identifier for the transformer.
String transformerArn
Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.
String name
Returns the name of the transformer.
String fileFormat
Returns that the currently supported file formats for EDI transformations are JSON and
XML.
String mappingTemplate
Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
String status
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.
EdiType 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.
String sampleDocument
Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.
Date createdAt
Returns a timestamp for creation date and time of the transformer.
Date modifiedAt
Returns a timestamp for last time the transformer was modified.
Copyright © 2024. All rights reserved.